sul-dlss/cocina-models

View on GitHub
description_types.yml

Summary

Maintainability
Test Coverage
# Description type validation

access.accessContact:
  - value: email
    description: Email address for a contact person or institution concerning the resource.
  - value: repository
    description: Institution providing access to the resource.
access.digitalLocation:
  - value: discovery
    description: Online location for the purpose of discovering the resource.
access.note:
  - value: access restriction
    description: Restrictions on or conditions for gaining access to the resource.
  - value: display label
    description: Display label for the purl.
  - value: license
    description: License describing allowed uses of the resource.
  - value: use and reproduction
    description: Information related to allowed uses of the resource in other contexts.
access.physicalLocation:
  - value: discovery
    description: Location where a user may find the resource.
  - value: location
    description: Physical location of the resource, or path to the resource on a hard drive or disk.
  - value: repository
    description: The institution holding the resource.
  - value: series
    description: Archival series of the resource.
    status: deprecated
    use: relatedResource.title.value with relatedResource type "host" and displayLabel "Series"
  - value: shelf locator
    description: Identifier or shelfmark indicating the location of the resource.
adminMetadata.note:
  - value: record information
    description: General information about the metadata record.
  - value: record origin
    description: The source of the record, such as another record transformed to generate the current record.
contributor:
  - value: conference
    description: An event focusing on a particular topic or discipline.
  - value: event
    description: A time-bound occurrence.
  - value: family
    description: A group of individuals related by blood or personal alliance.
  - value: organization
    description: An institution or other corporate or collective body.
  - value: person
    description: An individual identity.
  - value: unspecified others
    description: Designator for one or more additional contributors not named individually.
contributor.identifier:
  - value: ORCID
    description: Identifier from orcid.org.
  - value: Wikidata
    description: Identifier from wikidata.org.
contributor.name:
  - value: alternative
    description: Additional nonpreferred form of name.
  - value: display
    description: Preferred form of the name for display.
  - value: forename
    description: First or given name or names.
  - value: inverted full name
    description: Name given in last name, first name order.
  - value: pseudonym
    description: Name used that differs from legal or primary form of name.
  - value: surname
    description: Last or family name or names.
  - value: transliteration
    description: Name originally in non-Latin script presented phonetically using Latin characters.
contributor.name.structuredValue:
  - value: activity dates
    description: The date or dates when someone was producing work.
  - value: forename
    description: First or given name or names.
  - value: life dates
    description: Birth and death dates, or dates when an entity was in existence.
  - value: name
    description: Name provided alongside additional information.
  - value: ordinal
    description: Indicator that the name is one in a series (e.g. Elizabeth I, Martin Luther King, Jr.).
  - value: surname
    description: Last or family name or names.
  - value: term of address
    description: Title or other signifier associated with name.
contributor.name.groupedValue:
  - value: alternative
    description: Additional nonpreferred form of name.
  - value: name
    description: Primary form of name within group of values.
  - value: pseudonym
    description: Name used that differs from legal or primary form of name.
contributor.note:
  - value: affiliation
    description: Institution with which the contributor is associated.
  - value: citation status
    description: Indicator of whether the contributor should be included in the citation.
  - value: description
    description: Biographical information about the contributor.
event:
  - value: acquisition
    description: The transferral of ownership of a resource to a repository.
  - value: capture
    description: A record of the resource in a fixed form at a specific time.
  - value: collection
    description: The addition of a resource to a set of other resources.
  - value: copyright
    description: The activity by which a resource may be considered subject to copyright law.
  - value: copyright notice
    description: An explicit statement that a resource is under copyright.
  - value: creation
    description: The coming into being of a resource.
  - value: deaccession
    description: The removal of a resource from a repository.
  - value: degree conferral
    description: The institutional approval of a thesis or other resource leading to an academic degree.
  - value: deposit
    description: The submission of a resource to a repository.
  - value: development
    description: The creation of a print from a photographic negative or other source medium.
  - value: distribution
    description: The delivery of the resource to an external audience.
  - value: generation
    description: The creation of a resource by an automatic or natural process.
  - value: manufacture
    description: The physical assembly of a resource, often in multiple copies, for publication or other distribution.
  - value: modification
    description: A change to an existing resource.
  - value: performance
    description: The enactment of an artistic or cultural work for an audience, such as a play.
  - value: presentation
    description: The discussion of an academic or intellectual work for an audience, such as a seminar.
  - value: production
    description: The physical assembly of a resource not considered published, such as page proofs for a book.
  - value: provenance
    description: The resource's origins and history.
  - value: publication
    description: The publishing or issuing of a resource.
  - value: recording
    description: The initial fixation to a medium of live audio and/or visual activity.
  - value: release
    description: Making a resource available to a broader audience.
  - value: submission
    description: The provision of a resource for review or evaluation.
  - value: validity
    description: When a resource takes effect, such as a revised train schedule.
  - value: withdrawal
    description: The removal of previous access to a resource, often due to its obsolescence.
event.date:
  - value: accompanying letter
    description: Used in Athanasius Kircher project.
    status: deprecated
  - value: acquisition
    description: The transferral of ownership of a resource to a repository.
  - value: capture
    description: A record of the resource in a fixed form at a specific time.
  - value: collection
    description: The addition of a resource to a set of other resources.
  - value: composition
    description: Used in Athanasius Kircher project.
    status: deprecated
  - value: copy
    description: Used in Athanasius Kircher project.
    status: deprecated
  - value: copyright
    description: The activity by which a resource may be considered subject to copyright law.
  - value: coverage
  - value: creation
    description: The coming into being of a resource.
  - value: deaccession
    description: The removal of a resource from a repository.
  - value: degree conferral
    description: The institutional approval of a thesis or other resource leading to an academic degree.
  - value: deposit
    description: The submission of a resource to a repository.
  - value: developed
    description: The creation of a print from a photographic negative or other source medium.
    status: deprecated
    use: development
  - value: development
    description: The creation of a print from a photographic negative or other source medium.
  - value: distribution
    description: The delivery of the resource to an external audience.
  - value: generation
    description: The creation of a resource by an automatic or natural process.
  - value: Gregorian
    status: deprecated
    use: event.date.note.value with type "calendar"
  - value: Hebrew
    status: deprecated
    use: event.date.note.value with type "calendar"
  - value: Hijri calendar
    status: deprecated
    use: event.date.note.value with type "calendar"
  - value: Islamic
    status: deprecated
    use: event.date.note.value with type "calendar"
  - value: Julian
    status: deprecated
    use: event.date.note.value with type "calendar"
  - value: letter
    description: Used in Athanasius Kircher project.
    status: deprecated
  - value: letter referred to
    description: Used in Athanasius Kircher project.
    status: deprecated
  - value: manufacture
    description: The physical assembly of a resource, often in multiple copies, for publication or other distribution.
  - value: manuscript
    description: Used in Athanasius Kircher project.
    status: deprecated
  - value: manuscript referred to
    description: Used in Athanasius Kircher project.
    status: deprecated
  - value: modification
    description: A change to an existing resource.
  - value: new document
    description: Used in Athanasius Kircher project.
    status: deprecated
  - value: new style letter
    description: Used in Athanasius Kircher project.
    status: deprecated
  - value: observation
    description: Used in Athanasius Kircher project.
    status: deprecated
  - value: old style letter
    description: Used in Athanasius Kircher project.
    status: deprecated
  - value: original sent
    description: Used in Athanasius Kircher project.
    status: deprecated
  - value: performance
    description: The enactment of an artistic or cultural work for an audience, such as a play.
  - value: presentation
    description: The discussion of an academic or intellectual work for an audience, such as a seminar.
  - value: proclamation
    description: Used in Athanasius Kircher project.
    status: deprecated
  - value: production
    description: The physical assembly of a resource not considered published, such as page proofs for a book.
  - value: publication
    description: The publishing or issuing of a resource.
  - value: quoted
    description: Used in Athanasius Kircher project.
    status: deprecated
  - value: recording
    description: The initial fixation to a medium of live audio and/or visual activity.
  - value: release
    description: Making a resource available to a broader audience.
  - value: Revolutionary calendar
    status: deprecated
    use: event.date.note.value with type "calendar"
  - value: submission
    description: The provision of a resource for review or evaluation.
  - value: validity
    description: When a resource takes effect, such as a revised train schedule.
  - value: withdrawal
    description: The removal of previous access to a resource, often due to its obsolescence.
event.date.note:
  - value: calendar
    description: The calendar system used for a date.
event.date.structuredValue:
  - value: start
    description: The start date in a range.
  - value: end
    description: The end date in a range.
event.note:
  - value: copyright statement
    description: A formal declaration of copyright on a resource.
  - value: edition
    description: A published version of a resource issued at one time.
  - value: frequency
    description: How often a resource is issued, such as monthly.
  - value: issuance
    description: How the resource is issued, such as serially.
form:
  - value: carrier
    description: Format of the resource's storage medium.
  - value: data format
    description: The structure of a dataset.
  - value: digital origin
    description: The relationship of a digitized resource to a previous format.
  - value: extent
    description: The size or dimensions of the resource.
  - value: form
    description: A description of the materiality of the resource.
  - value: genre
    description: The intellectual category of a resource based on style, form, content, etc.
  - value: map projection
    description: The method used to represent the curvature of a planet on a flat plane.
  - value: map scale
    description: The size ratio of the map image to the depicted area.
  - value: material
    description: The physical components constituting the resource.
  - value: media
    description: The technology required to mediate interactions with a resource.
  - value: media type
  - value: reformatting quality
    description: The use for which the reproduction quality of the resource was intended (e.g. access, preservation).
  - value: resource type
    description: The general format category of the resource.
  - value: technique
    description: The method used to create the resource.
  - value: type
form.structuredValue:
  - value: type
    description: Used for H2 deposits.
  - value: subtype
    description: Used for H2 deposits.
geographic.form:
  - value: data format
  - value: media type
  - value: type
geographic.subject:
  - value: bounding box coordinates
    description: A series of coordinates forming the boundaries of the depicted area.
  - value: coverage
    description: The name of the area the resource depicts.
  - value: point coordinates
    description: A pair of coordinates showing the latitude and longitude of the depicted area.
geographic.subject.structuredValue:
  - value: east
    description: A directional indicator for a point of a bounding box.
  - value: latitude
    description: The angular distance of a place north or south from the equator.
  - value: longitude
    description: The angular distance of a place east or west from the standard meridian.
  - value: north
    description: A directional indicator for a point of a bounding box.
  - value: south
    description: A directional indicator for a point of a bounding box.
  - value: west
    description: A directional indicator for a point of a bounding box.
identifier:
  - value: accession
    status: deprecated
    use: accession number
  - value: accession number
  - value: alternate case number
  - value: anchor
  - value: Apis ID
    code: apis
  - value: ARK
    code: ark
  - value: arXiv
    code: arxiv
  - value: case identifier
  - value: case number
  - value: CCP
  - value: CLC
  - value: CSt
  - value: CStRLIN
  - value: CTC
  - value: Data Provider Digital Object Identifier
  - value: document number
  - value: DOI
    code: doi
  - value: druid
  - value: EUR-OP
  - value: FOLIO
    description: FOLIO HRID for the source record of the metadata.
  - value: GTIN-14 ID
    code: gtin-14
  - value: Handle
    code: hdl
  - value: inventory number
  - value: ISBN
    code: isbn
  - value: ISMN
    code: ismn
  - value: ISRC
    code: isrc
  - value: ISSN
    code: issn
  - value: ISSN-L
    code: issn-l
  - value: issue number
    code: issue-number
  - value: LCCN
    code: lccn
  - value: local
    code: local
  - value: Local ID
  - value: matrix number
    code: matrix-number
  - value: music plate
    code: music-plate
  - value: music publisher
    code: music-publisher
  - value: OCLC
  - value: OCoLC
  - value: PMCID
  - value: PMID
  - value: record id
  - value: ROR
    code: ror
  - value: Senate Number
  - value: Series
  - value: SICI
    code: sici
  - value: SIRSI
  - value: Source ID
  - value: sourceID
    status: deprecated
    use: Source ID
  - value: stock number
    code: stock-number
  - value: SUL catalog key
  - value: Swets (Netherlands) ID
    code: swets
  - value: UPC
    code: upc
  - value: URI
    code: uri
  - value: URN
    code: urn
  - value: videorecording identifier
    code: videorecording-identifier
  - value: 'West Mat #'
  - value: Wikidata
    code: wikidata
note:
  - value: abstract
    description: A short overview of a research article or other work.
  - value: access
    description: Information about gaining access to a resource.
  - value: access note
    status: deprecated
    use: access
  - value: access restriction
    description: Information about restrictions on who may or how to access a resource.
  - value: acquisition
    description: The transfer of a resource to a repository.
  - value: action
  - value: additional physical form
    description: Other formats of the resource.
  - value: additions
    description: Resources added after initial acquisition.
  - value: admin
    status: deprecated
    use: administrative
  - value: administrative
    description: Administrative or internal use.
  - value: affiliation
    description: Institution with which a person or other entity is associated.
  - value: arrangement
    description: The organization of an archival or other collection.
  - value: bibliographic
  - value: bibliography
    description: Other resources with additional information about the resource.
  - value: binding
  - value: biographical/historical
    description: Background on a person, organization, or other entity strongly associated with the resource.
  - value: biographical/historical note
    status: deprecated
    use: biographical/historical
  - value: biography
    description: Background on a person strongly associated with the resource.
  - value: boat note
  - value: citation/reference
    description: Other resources that cite this resource.
  - value: codicology
  - value: collation
  - value: colophon
  - value: condition
    description: Physical wear on an object.
  - value: contact
    description: Contact information for someone responsible for the resource.
  - value: content
    description: The information the resource contains.
  - value: content note
    status: deprecated
    use: content
  - value: content warning
    description: Cautionary information about offensive or triggering resource content.
  - value: contents
    status: deprecated
    use: content
  - value: copyright
    description: A creator's legal ownership of a resource's content.
  - value: creation/production credits
    description: Cast and crew associated with the production of a resource.
  - value: date
    description: Information about a date or dates associated with the resource.
  - value: date/sequential designation
  - value: decoNote
    status: deprecated
    use: decoration
  - value: decoration
  - value: description
    description: Information describing the resource.
  - value: digitization
    description: The process of creating a digital representation of a physical object.
  - value: dimensions
    description: The size of an object in terms of area or volume.
  - value: duration
    description: The length of a time-based resource.
  - value: email
    description: An email address related to the resource.
  - value: event
    description: A time-bound occurrence associated with a resource.
  - value: exhibitions
    description: Public displays of the resource as part of an exhibit.
  - value: explicit
  - value: foliation
  - value: funding
    description: Financial support for producing, acquiring, or otherwise processing the resource.
  - value: general
  - value: genre type
  - value: geography
  - value: hand note
  - value: handNote
    status: deprecated
    use: hand note
  - value: handwritten
  - value: host
  - value: incipit
  - value: instrumentation
    description: Musical instruments involved in the performance of a resource.
  - value: language
  - value: layout
  - value: local
    description: A note with local application.
  - value: location
  - value: material
  - value: medium of performance
  - value: names
  - value: numbering
  - value: original location
  - value: other
  - value: other relation type
  - value: ownership
  - value: part
  - value: performer
  - value: performers
  - value: preferred citation
    description: The preferred form for citing a resource.
  - value: provenance
    description: The resource's origins and history.
  - value: publications
    description: Other published works related to the resource.
  - value: qualifications
  - value: quote
  - value: reassembly
    description: The return of an object to a whole after being separated into parts.
  - value: reference
  - value: references
  - value: reformatting
  - value: related publication
  - value: reproduction
  - value: research
  - value: restriction
  - value: restriction on access
    status: deprecated
    use: access restriction
  - value: rubric
  - value: scope and content
  - value: secfol
    status: deprecated
    use: second folio
  - value: second folio
  - value: secondFolio
    status: deprecated
    use: second folio
  - value: source characteristics
  - value: source identifier
  - value: statement of responsibility
    description: The contributors to a work as transcribed from a title page.
  - value: summary
  - value: system details
  - value: system requirements
  - value: table of contents
  - value: target audience
  - value: technical note
    description: Technological requirements for accessing or using the resource.
  - value: thesis
  - value: transcript
  - value: translation
  - value: unit
  - value: update
  - value: use and reproduction
  - value: venue
    description: The location of a public performance or other event.
  - value: version
  - value: version identification
  - value: writing
note.groupedValue:
  - value: caption
  - value: date
  - value: detail type
  - value: extent unit
  - value: list
  - value: marker
  - value: number
  - value: title
  - value: text
relatedResource:
  - value: has original version
    description: An initial form of the resource.
  - value: has other format
    description: A version of the resource in a different physical or digital format.
  - value: has part
    description: A constituent unit of the resource.
  - value: has version
    description: A version of the resource with different intellectual content.
  - value: in series
    description: The name of a series of publications to which the resource belongs.
  - value: other relation type
    description: Resource type not otherwise described.
  - value: part of
    description: A larger resource to which the resource belongs, such as a collection.
  - value: preceded by
    description: A predecessor to the resource, such as a preceding journal title.
  - value: referenced by
    description: Other resources that cite the resource, such as a catalog.
  - value: references
    description: A resource which the resource references or cites.
  - value: related to
    description: A generically related resource.
  - value: reviewed by
    description: A review of the resource.
  - value: succeeded by
    description: A successor to the resource, such as a subsequent journal title.
subject:
  - value: classification
    description: A coded reference to the main subjects of the resource according to a larger system.
  - value: conference
    description: An event focusing on a particular topic or discipline.
  - value: display
    description: Preferred form of the value for display.
  - value: event
    description: A time-bound occurrence.
  - value: family
    description: A group of individuals related by blood or personal alliance.
  - value: genre
    description: The intellectual category of a resource based on style, form, content, etc.
  - value: map coordinates
    description: Bounding box or point coordinates describing the area represented by a map or other geographic resource.
  - value: name
    description: The name of an entity whose type is not known.
  - value: occupation
    description: A profession or job category associated with the content of a resource.
  - value: organization
    description: An institution or other corporate or collective body.
  - value: person
    description: An individual identity.
  - value: place
    description: A geographic location associated with the content of a resource.
  - value: point coordinates
    description: The latitude and longitude of a place associated with the content of a resource.
  - value: time
    description: The temporal period associated with the content of a resource.
  - value: title
    description: A work that is the subject of the resource.
  - value: topic
    description: Terms representing the information contained in or other relevant attributes of a resource.
subject.note:
  - value: affiliation
    description: Institution with which the contributor is associated.
  - value: description
    description: Biographical information about the contributor.
  - value: role
    description: The relation of the subject entity to the resource.
subject.structuredValue:
  - value: activity dates
    description: The date or dates when someone was producing work.
  - value: area
    description: A non-jurisdictional geographic entity.
  - value: city
    description: An inhabited place incorporated as a city or equivalent.
  - value: city section
    description: A smaller unit within a populated place, such as a neighborhood.
  - value: conference
    description: An event focusing on a particular topic or discipline.
  - value: continent
    description: Large land mass or portion of land mass considered to be a continent.
  - value: country
    description: A political entity considered to be a country.
  - value: county
    description: A political division of a state or the largest local administrative unit.
  - value: display
    description: Preferred form of the value for display.
  - value: east
    description: A directional indicator for a point of a bounding box.
  - value: end
    description: The end date in a range.
  - value: event
    description: A time-bound occurrence.
  - value: extraterrestrial area
    description: An entity, space, or feature not on Earth.
  - value: family
    description: A group of individuals related by blood or personal alliance.
  - value: forename
    description: First or given name or names.
  - value: genre
    description: The intellectual category of a resource based on style, form, content, etc.
  - value: island
    description: A tract of land surrounded by water but not itself a separate continent or country.
  - value: latitude
    description: The angular distance of a place north or south from the equator.
  - value: life dates
    description: Birth and death dates, or dates when an entity was in existence.
  - value: longitude
    description: The angular distance of a place east or west from the standard meridian.
  - value: main title
    description: Title provided alongside additional information.
  - value: name
    description: Name provided alongside additional information.
  - value: nonsorting characters
    description: A string at the beginning of the title to be disregarded when sorting.
  - value: north
    description: A directional indicator for a point of a bounding box.
  - value: occupation
    description: A profession or job category associated with the content of a resource.
  - value: ordinal
    description: Indicator that the name is one in a series (e.g. Elizabeth I, Martin Luther King, Jr.).
  - value: organization
    description: An institution or other corporate or collective body.
  - value: part name
    description: The distinct name of a resource as part of a series or multivolume set.
  - value: part number
    description: The distinct number of a resource as part of a series or multivolume set.
  - value: person
    description: An individual identity.
  - value: place
    description: A geographic location associated with the content of a resource.
  - value: point coordinates
    description: The latitude and longitude of a place associated with the content of a resource.
  - value: region
    description: An area that incorporates more than one first-order jurisdiction.
  - value: south
    description: A directional indicator for a point of a bounding box.
  - value: start
    description: The start date in a range.
  - value: state
    description: A first-order political jurisdiction under country, including provinces, cantons, etc.
  - value: subtitle
    description: The secondary part of a title.
  - value: surname
    description: Last or family name or names.
  - value: term of address
    description: Title or other signifier associated with name.
  - value: territory
    description: A geographical area belonging to or under the jurisdiction of a governmental authority.
  - value: time
    description: The temporal period associated with the content of a resource.
  - value: title
    description: A work that is the subject of the resource.
  - value: topic
    description: Terms representing the information contained in or other relevant attributes of a resource.
  - value: west
    description: A directional indicator for a point of a bounding box.
subject.structuredValue.note:
  - value: affiliation
    description: Institution with which the contributor is associated.
  - value: description
    description: Biographical information about the contributor.
  - value: role
    description: The relation of the subject entity to the resource.
subject.groupedValue:
  - value: uniform
    description: Form of title in Library of Congress title authority file.
title:
  - value: abbreviated
    description: Abbreviated form of title for indexing or identification.
  - value: alternative
    description: Variant title.
  - value: parallel
    description: Title transcribed from the resource in multiple languages or scripts.
  - value: supplied
    description: Title provided by metadata creator rather than transcribed from the resource.
  - value: translated
    description: Title translated into another language.
  - value: transliterated
    description: Title transliterated from non-Latin script to Latin script.
  - value: uniform
    description: Form of title in Library of Congress title authority.
title.note:
  - value: associated name
    description: A name linked to the title, such as for a name-title heading.
  - value: nonsorting character count
    description: The number of characters at the beginning of the string to be disregarded when sorting.
title.structuredValue:
  - value: main title
    description: The primary part of a multipart title.
  - value: nonsorting characters
    description: A string at the beginning of the title to be disregarded when sorting.
  - value: part name
    description: The distinct name of a resource as part of a series or multivolume set.
  - value: part number
    description: The distinct number of a resource as part of a series or multivolume set.
  - value: subtitle
    description: The secondary part of a title.