FHIR CI-Build

This is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions icon

Clinical Decision Support icon Work GroupMaturity Level: 1 Trial UseSecurity Category: Business Compartments: No defined compartments

Detailed Descriptions for the elements in the Citation resource.

Citation
Element Id Citation
Definition

The Citation Resource enables reference to any knowledge artifact for purposes of identification and attribution. The Citation Resource supports existing reference structures and developing publication practices such as versioning, expressing complex contributorship roles, and referencing computable resources.

Short Display A description of identification, location, or contributorship of a publication (article or artifact)
Cardinality 0..*
Type MetadataResource
Summary false
Invariants
Defined on this element
cnl-0Warning Name should be usable as an identifier for the module by machine processing applications such as code generationname.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$')
Citation.url
Element Id Citation.url
Definition

An absolute URI that is used to identify this citation record when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this summary is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the summary is stored on different servers.

Short Display Canonical identifier for this citation record, represented as a globally unique URI
Cardinality 0..1
Type uri
Requirements

Allows the citation record to be referenced by a single globally unique identifier.

Summary true
Comments

In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the meta.source element to indicate where the current master source of the resource can be found.

Invariants
Defined on this element
cnl-1Warning URL should not contain | or # - these characters make processing canonical references problematicexists() implies matches('^[^|# ]+$')
Citation.identifier
Element Id Citation.identifier
Definition

A formal identifier that is used to identify this citation record when it is represented in other formats, or referenced in a specification, model, design or an instance.

Short Display Identifier for the citation record itself
Note This is a business identifier, not a resource identifier (see discussion)
Cardinality 0..*
Type Identifier
Requirements

Allows externally provided and/or usable identifiers to be associated with this citation record.

Summary true
Comments

Use this element if you need to identify the citation record independently from identifying the cited artifact.

Citation.version
Element Id Citation.version
Definition

The identifier that is used to identify this version of the citation record when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the citation record author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.

Short Display Business version of the citation record
Note This is a business versionId, not a resource version id (see discussion)
Cardinality 0..1
Type string
Summary true
Comments

This is a business version label used for display in understanding the formal version of the citation record, not a resource version id or technical version number for an archival system. There may be different citation record instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the citation record with the format [url]|[version]. The version SHOULD NOT contain a '#' - see Business Version.

Citation.versionAlgorithm[x]
Element Id Citation.versionAlgorithm[x]
Definition

Indicates the mechanism used to compare versions to determine which is more current.

Short Display How to compare versions
Cardinality 0..1
Terminology Binding Version Algorithm (Extensible)
Type string|Coding
[x] Note See Choice of Datatypes for further information about how to use [x]
Summary true
Comments

If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 is newer, and a 0 if the version ordering can't successfully be determined.

Citation.name
Element Id Citation.name
Definition

A natural language name identifying the citation record. This name should be usable as an identifier for the module by machine processing applications such as code generation.

Short Display Name for this citation record (computer friendly)
Cardinality 0..1
Type string
Requirements

Support human navigation and code generation.

Summary true
Comments

The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.

Invariants
Affect this element
cnl-0Warning Name should be usable as an identifier for the module by machine processing applications such as code generationname.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$')
Citation.title
Element Id Citation.title
Definition

A short, descriptive, user-friendly title for the citation record.

Short Display Name for this citation record (human friendly)
Cardinality 0..1
Type string
Summary true
Comments

This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc. Use this element if you have a need for naming the citation record for human use, such as a display name for the citation record that is used when selecting citations from a list.

Citation.status
Element Id Citation.status
Definition

The status of this summary. Enables tracking the life-cycle of the content.

Short Display draft | active | retired | unknown
Cardinality 1..1
Terminology Binding PublicationStatus (Required)
Type code
Is Modifier true (Reason: This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration)
Requirements

Allows filtering of citation records that are appropriate for use versus not.

Summary true
Comments

Allows filtering of summaries that are appropriate for use versus not. Use "active" when the citation record is the version for others to actively use, "draft" while you are developing the content, and "retired" when this record should no longer be used for any purpose.

See guidance around (not) making local changes to elements here.

Citation.experimental
Element Id Citation.experimental
Definition

A Boolean value to indicate that this citation record is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.

Short Display For testing purposes, not real usage
Cardinality 0..1
Type boolean
Meaning if Missing If absent, this resource is treated as though it is not experimental.
Requirements

Enables experimental content to be developed following the same lifecycle that would be used for a production-level citation record.

Summary true
Comments

Allows filtering of citation records that are appropriate for use versus not.

Citation.date
Element Id Citation.date
Definition

The date (and optionally time) when the citation record was last significantly changed. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the citation record changes.

Short Display Date last changed
Cardinality 0..1
Type dateTime
Alternate Names Revision Date
Summary true
Comments

The date is often not tracked until the resource is published, but may be present on draft content. Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the citation record. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.

See guidance around (not) making local changes to elements here.

Citation.author
Element Id Citation.author
Definition

Who authored or created the citation record.

Short Display Who authored the citation record
Cardinality 0..*
Type ContactDetail
Summary false
Comments

The Citation.author element is structured to support a name (with a string datatype) and contact point information for the author/creator, and is not structured to support unique identifiers for the author. If detailed contributorship data is needed for the authorship of the citation record, then one can create a Citation Resource for the Citation Resource.

Citation.publisher
Element Id Citation.publisher
Definition

The name of the organization or individual that published the citation record.

Short Display The publisher of the citation record, not the publisher of the article or artifact being cited
Cardinality 0..1
Type string
Requirements

Helps establish the "authority/credibility" of the citation record. May also allow for contact.

Summary true
Comments

Usually an organization but may be an individual. The publisher (or steward) of the citation record is the organization or individual primarily responsible for the maintenance and upkeep of the citation record. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the citation record. This item SHOULD be populated unless the information is available from context.

Citation.contact
Element Id Citation.contact
Definition

Contact details to assist a user in finding and communicating with the publisher.

Short Display Contact details for the publisher of the citation record
Cardinality 0..*
Type ContactDetail
Summary true
Comments

May be a web site, an email address, a telephone number, etc.

See guidance around (not) making local changes to elements here.

Citation.description
Element Id Citation.description
Definition

A free text natural language description of the citation from a consumer's perspective.

Short Display Natural language description of the citation
Cardinality 0..1
Type markdown
Summary false
Comments

This description can be used to capture details such as comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the citation as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the citation is presumed to be the predominant language in the place the citation was created).

Citation.useContext
Element Id Citation.useContext
Definition

The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate citation record instances.

Short Display The context that the citation record content is intended to support
Cardinality 0..*
Type UsageContext
Requirements

Assist in searching for appropriate content.

Summary true
Comments

When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.

Citation.jurisdiction
Standards Status This element has a standards status of "Deprecated" which is different from the status of the whole resource
Element Id Citation.jurisdiction
Definition

A legal or geographic region in which the citation record is intended to be used.

Short Display Intended jurisdiction for citation record (if applicable)
Cardinality 0..*
Terminology Binding Jurisdiction ValueSet (Extensible)
Type CodeableConcept
Summary true
Comments

It may be possible for the citation record to be used in jurisdictions other than those for which it was originally designed or intended.

DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'jurisdiction' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#jurisdiction and useContext.valueCodeableConcept indicating the jurisdiction.)

Citation.purpose
Element Id Citation.purpose
Definition

Explanation of why this citation is needed and why it has been designed as it has.

Short Display Why this citation is defined
Cardinality 0..1
Type markdown
Summary false
Comments

This element does not describe the usage of the citation. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this citation.

Citation.copyright
Element Id Citation.copyright
Definition

Use and/or publishing restrictions for the citation record, not for the cited artifact.

Short Display Use and/or publishing restrictions for the citation record, not for the cited artifact
Cardinality 0..1
Type markdown
Summary false
Citation.copyrightLabel
Element Id Citation.copyrightLabel
Definition

A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved').

Short Display Copyright holder and year(s) for the ciation record, not for the cited artifact
Cardinality 0..1
Type string
Requirements

Defines the content expected to be rendered in all representations of the artifact.

Summary false
Comments

The (c) symbol should NOT be included in this string. It will be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element.

Citation.approvalDate
Element Id Citation.approvalDate
Definition

The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.

Short Display When the citation record was approved by publisher
Cardinality 0..1
Type date
Summary true
Comments

The 'date' element may be more recent than the approval date because of minor changes or editorial corrections.

See guidance around (not) making local changes to elements here.

Citation.lastReviewDate
Element Id Citation.lastReviewDate
Definition

The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.

Short Display When the citation record was last reviewed by the publisher
Cardinality 0..1
Type date
Requirements

Gives a sense of how "current" the content is. Resources that have not been reviewed in a long time may have a risk of being less appropriate/relevant.

Summary true
Comments

If specified, this date follows the original approval date.

See guidance around (not) making local changes to elements here.

Citation.effectivePeriod
Element Id Citation.effectivePeriod
Definition

The period during which the citation record content was or is planned to be in active use.

Short Display When the citation record is expected to be used
Cardinality 0..1
Type Period
Requirements

Allows establishing a transition before a resource comes into effect and also allows for a sunsetting process when new versions of the citation record are or are expected to be used instead.

Summary true
Comments

The effective period for a citation record determines when the content is applicable for usage and is independent of publication and review dates. For example, a citation intended to be used for the year 2016 might be published in 2015.

See guidance around (not) making local changes to elements here.

Citation.recorder
Element Id Citation.recorder
Definition

Who entered the data for the citation record.

Short Display Who entered the data for the citation record
Cardinality 0..*
Type ContactDetail
Summary false
Comments

The Citation.recorder element is structured to support a name (with a string datatype) and contact point information for the recorder, and is not structured to support unique identifiers for the recorder. If detailed contributorship data is needed, then one can create a Citation Resource for the Citation Resource.

Citation.editor
Element Id Citation.editor
Definition

Who edited or revised the citation record.

Short Display Who edited the citation record
Cardinality 0..*
Type ContactDetail
Summary false
Comments

The Citation.editor element is structured to support a name (with a string datatype) and contact point information for the editor, and is not structured to support unique identifiers for the editor. If detailed contributorship data is needed for the editing of the citation record, then one can create a Citation Resource for the Citation Resource.

Citation.reviewer
Element Id Citation.reviewer
Definition

Who reviewed the citation record.

Short Display Who reviewed the citation record
Cardinality 0..*
Type ContactDetail
Summary false
Comments

The Citation.reviewer element is structured to support a name (with a string datatype) and contact point information for the reviewer, and is not structured to support unique identifiers for the reviewer. If detailed contributorship data is needed for the review of the citation record, then one can create a Citation Resource for the Citation Resource.

See guidance around (not) making local changes to elements here.

Citation.endorser
Element Id Citation.endorser
Definition

Who endorsed the citation record.

Short Display Who endorsed the citation record
Cardinality 0..*
Type ContactDetail
Summary false
Comments

The Citation.endorser element is structured to support a name (with a string datatype) and contact point information for the endorser, and is not structured to support unique identifiers for the endorser. If detailed contributorship data is needed for the endorsement of the citation record, then one can create a Citation Resource for the Citation Resource.

See guidance around (not) making local changes to elements here.

Citation.summary
Element Id Citation.summary
Definition

A human-readable display of key concepts to represent the citation.

Short Display A human-readable display of key concepts to represent the citation
Cardinality 0..*
Summary false
Citation.summary.style
Element Id Citation.summary.style
Definition

Format for display of the citation summary.

Short Display Format for display of the citation summary
Cardinality 0..1
Terminology Binding Citation Summary Style (Preferred)
Type CodeableConcept
Summary false
Citation.summary.text
Element Id Citation.summary.text
Definition

The human-readable display of the citation summary.

Short Display The human-readable display of the citation summary
Cardinality 1..1
Type markdown
Summary true
Citation.classification
Element Id Citation.classification
Definition

The assignment to an organizing scheme.

Short Display The assignment to an organizing scheme
Cardinality 0..*
Summary false
Comments

Use this element if you need to classify the citation record independently from classifying the cited artifact.

Citation.classification.type
Element Id Citation.classification.type
Definition

The kind of classifier (e.g. publication type, keyword).

Short Display The kind of classifier (e.g. publication type, keyword)
Cardinality 0..1
Terminology Binding Citation Classification Type (Preferred)
Type CodeableConcept
Summary false
Citation.classification.classifier
Element Id Citation.classification.classifier
Definition

The specific classification value.

Short Display The specific classification value
Cardinality 0..*
Terminology Binding Citation Artifact Classifier (Example)
Type CodeableConcept
Summary false
Citation.note
Element Id Citation.note
Definition

Used for general notes and annotations not coded elsewhere.

Short Display Used for general notes and annotations not coded elsewhere
Cardinality 0..*
Type Annotation
Summary false
Citation.currentState
Element Id Citation.currentState
Definition

The status of the citation record.

Short Display The status of the citation record
Cardinality 0..*
Terminology Binding Citation Status Type (Example)
Type CodeableConcept
Summary false
Comments

Use this if needed for reporting the state or status of the citation record, NOT FOR reporting the state or status of the cited article.

Citation.statusDate
Element Id Citation.statusDate
Definition

The state or status of the citation record paired with an effective date or period for that state.

Short Display An effective date or period for a status of the citation record
Cardinality 0..*
Summary false
Comments

Use this if needed for reporting the state or status of the citation record, NOT FOR reporting the state or status of the cited article.

Citation.statusDate.activity
Element Id Citation.statusDate.activity
Definition

The state or status of the citation record (that will be paired with the period).

Short Display Classification of the status
Cardinality 1..1
Terminology Binding Citation Status Type (Example)
Type CodeableConcept
Summary false
Citation.statusDate.actual
Element Id Citation.statusDate.actual
Definition

Whether the status date is actual (has occurred) or expected (estimated or anticipated).

Short Display Either occurred or expected
Cardinality 0..1
Type boolean
Meaning if Missing Value unknown
Summary false
Citation.statusDate.period
Element Id Citation.statusDate.period
Definition

When the status started and/or ended.

Short Display When the status started and/or ended
Cardinality 1..1
Type Period
Summary false
Comments

For an instance, place the same value in both start and end elements.

Citation.relatedArtifact
Element Id Citation.relatedArtifact
Definition

Artifact related to the citation record.

Short Display Artifact related to the citation record
Cardinality 0..*
Type RelatedArtifact
Summary false
Comments

Use this if needed for reporting artifacts related to the citation record, NOT FOR reporting artifacts related to the cited article. For example, one may use this element to report the data source for generation of the Citation Resource instance if it was automatically generated, such as conversion from a citation repository.

Citation.citedArtifact
Element Id Citation.citedArtifact
Definition

The article or artifact being described.

Short Display The article or artifact being described
Cardinality 0..1
Summary false
Citation.citedArtifact.identifier
Element Id Citation.citedArtifact.identifier
Definition

A formal identifier that is used to identify the cited artifact when it is represented in other formats, or referenced in a specification, model, design or an instance.

Short Display Unique identifier. May include DOI, PMID, PMCID, etc
Note This is a business identifier, not a resource identifier (see discussion)
Cardinality 0..*
Type Identifier
Requirements

Allows externally provided and/or usable identifiers to be associated with the cited artifact.

Summary true
Comments

This element will contain unique identifiers that support de-duplication of citations. Commonly used identifiers for study citations include digital object identifier (DOI), PubMed ID (PMID), and PubMed Central ID (PMCID). To maintain interoperability, the suggested identifier.system values to use for these 3 identifiers are: DOI = "https://doi.org" PMID = "https://pubmed.ncbi.nlm.nih.gov" PMCID = "https://www.ncbi.nlm.nih.gov/pmc/"

Citation.citedArtifact.relatedIdentifier
Element Id Citation.citedArtifact.relatedIdentifier
Definition

A formal identifier that is used to identify things closely related to the cited artifact.

Short Display Identifier not unique to the cited artifact. May include trial registry identifiers
Cardinality 0..*
Type Identifier
Requirements

Allows externally provided and/or usable identifiers to be associated with this the cited artifact.

Summary true
Comments

May include trial registry identifiers, e.g. NCT04372602 from clinicaltrials.gov. This related identifier would not be used as a unique identifier for the cited artifact itself. Multiple published articles (each with their own unique identifier) may relate to the same study record in a research registry. Commonly used related identifiers for study registries include ClinicalTrials.gov identifier (NCTId) and PROSPERO identifier (used for registration of systematic reviews). To maintain interoperability, the suggested identifier.system values to use for these 2 identifiers are: ClinicalTrials.gov = "https://clinicaltrials.gov" PROSPERO = "https://www.crd.york.ac.uk/prospero/"

Citation.citedArtifact.dateAccessed
Element Id Citation.citedArtifact.dateAccessed
Definition

When the cited artifact was accessed.

Short Display When the cited artifact was accessed
Cardinality 0..1
Type dateTime
Summary true
Comments

Use this element when citing an artifact from a potentially unstable source, such as a webpage, to note the date (and time) the source was accessed.

Citation.citedArtifact.version
Element Id Citation.citedArtifact.version
Definition

The defined version of the cited artifact.

Short Display The defined version of the cited artifact
Note This is a business versionId, not a resource version id (see discussion)
Cardinality 0..1
Type string
Summary false
Comments

This is a business version label used for display in understanding the formal version of the cited artifact, not a resource version id or technical version number for an archival system.

Citation.citedArtifact.currentState
Element Id Citation.citedArtifact.currentState
Definition

The status of the cited artifact.

Short Display The status of the cited artifact
Cardinality 0..*
Terminology Binding Cited Artifact Status Type (Extensible)
Type CodeableConcept
Summary false
Citation.citedArtifact.statusDate
Element Id Citation.citedArtifact.statusDate
Definition

An effective date or period, historical or future, actual or expected, for a status of the cited artifact.

Short Display An effective date or period for a status of the cited artifact
Cardinality 0..*
Summary false
Citation.citedArtifact.statusDate.activity
Element Id Citation.citedArtifact.statusDate.activity
Definition

A definition of the status associated with a date or period.

Short Display Classification of the status
Cardinality 1..1
Terminology Binding Cited Artifact Status Type (Extensible)
Type CodeableConcept
Summary false
Citation.citedArtifact.statusDate.actual
Element Id Citation.citedArtifact.statusDate.actual
Definition

Either occurred or expected.

Short Display Either occurred or expected
Cardinality 0..1
Type boolean
Meaning if Missing Value unknown
Summary false
Citation.citedArtifact.statusDate.period
Element Id Citation.citedArtifact.statusDate.period
Definition

When the status started and/or ended.

Short Display When the status started and/or ended
Cardinality 1..1
Type Period
Summary false
Comments

For an instance, place the same value in both start and end elements.

Citation.citedArtifact.title
Element Id Citation.citedArtifact.title
Definition

The title details of the article or artifact.

Short Display The title details of the article or artifact
Cardinality 0..*
Summary false
Citation.citedArtifact.title.type
Element Id Citation.citedArtifact.title.type
Definition

Used to express the reason for or classification of the title.

Short Display The kind of title
Cardinality 0..*
Terminology Binding Title Type (Extensible)
Type CodeableConcept
Summary false
Citation.citedArtifact.title.language
Element Id Citation.citedArtifact.title.language
Definition

Used to express the specific language of the title.

Short Display Used to express the specific language
Cardinality 0..1
Terminology Binding All Languages (Required)
Additional BindingsPurpose
Common Languages Starter Set
Type code
Summary false
Citation.citedArtifact.title.text
Element Id Citation.citedArtifact.title.text
Definition

The title of the article or artifact.

Short Display The title of the article or artifact
Cardinality 1..1
Type markdown
Summary false
Citation.citedArtifact.abstract
Element Id Citation.citedArtifact.abstract
Definition

The abstract may be used to convey article-contained abstracts, externally-created abstracts, or other descriptive summaries.

Short Display Summary of the article or artifact
Cardinality 0..*
Summary false
Citation.citedArtifact.abstract.type
Element Id Citation.citedArtifact.abstract.type
Definition

Used to express the reason for or classification of the abstract.

Short Display The kind of abstract
Cardinality 0..*
Terminology Binding Cited Artifact Abstract Type (Extensible)
Type CodeableConcept
Summary false
Citation.citedArtifact.abstract.language
Element Id Citation.citedArtifact.abstract.language
Definition

Used to express the specific language of the abstract.

Short Display Used to express the specific language
Cardinality 0..1
Terminology Binding All Languages (Required)
Additional BindingsPurpose
Common Languages Starter Set
Type code
Summary false
Citation.citedArtifact.abstract.text
Element Id Citation.citedArtifact.abstract.text
Definition

Abstract content.

Short Display Abstract content
Cardinality 1..1
Type markdown
Summary false
Citation.citedArtifact.abstract.copyright
Element Id Citation.citedArtifact.abstract.copyright
Definition

Copyright notice for the abstract.

Short Display Copyright notice for the abstract
Cardinality 0..1
Type markdown
Summary false
Comments

There is also a copyright element in the publicationForm element, so this copyright element is intended for copyright of the abstract.

Citation.citedArtifact.part
Element Id Citation.citedArtifact.part
Definition

The component of the article or artifact.

Short Display The component of the article or artifact
Cardinality 0..1
Summary false
Citation.citedArtifact.part.type
Element Id Citation.citedArtifact.part.type
Definition

The kind of component.

Short Display The kind of component
Cardinality 0..1
Terminology Binding Cited Artifact Part Type (Extensible)
Type CodeableConcept
Summary false
Citation.citedArtifact.part.value
Element Id Citation.citedArtifact.part.value
Definition

The specification of the component.

Short Display The specification of the component
Cardinality 0..1
Type string
Summary false
Citation.citedArtifact.baseCitation
Element Id Citation.citedArtifact.baseCitation
Definition

Citation for the primary version and complete form of the cited artifact.

Short Display Citation for the primary version and complete form of the cited artifact
Cardinality 0..1
Type Reference(Citation)
Summary false
Comments

When referencing a baseCitation, one may inherit any data from the referenced Citation Resource and consider any data in the current Citation Resource as superceding to be version-specific or part-specific. For example, the part-specific Citation may have additional contributorship data that supercedes the contributorship data for the full citation when there is a need to uniquely report the contributorship for an image or supplement associated with the fuller citation record.

Citation.citedArtifact.relatesTo
Element Id Citation.citedArtifact.relatesTo
Definition

The artifact related to the cited artifact.

Short Display The artifact related to the cited artifact
Cardinality 0..*
Summary false
Comments

The citedArtifact.relatesTo element uses a BackboneElement instead of the RelatedArtifact Datatype to enable use of an extended value set for the required code for the type of relationship.

Citation.citedArtifact.relatesTo.type
Element Id Citation.citedArtifact.relatesTo.type
Definition

The type of relationship to the related artifact.

Short Display documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of | part-of | amends | amended-with | appends | appended-with | cites | cited-by | comments-on | comment-in | contains | contained-in | corrects | correction-in | replaces | replaced-with | retracts | retracted-by | signs | similar-to | supports | supported-with | transforms | transformed-into | transformed-with | documents | specification-of | created-with | cite-as | reprint | reprint-of
Cardinality 1..1
Terminology Binding Related Artifact Type All (Required)
Type code
Summary false
Citation.citedArtifact.relatesTo.classifier
Element Id Citation.citedArtifact.relatesTo.classifier
Definition

Provides additional classifiers of the related artifact.

Short Display Additional classifiers
Cardinality 0..*
Terminology Binding Citation Artifact Classifier (Extensible)
Type CodeableConcept
Summary false
Citation.citedArtifact.relatesTo.label
Element Id Citation.citedArtifact.relatesTo.label
Definition

A short label that can be used to reference the related artifact from elsewhere in the containing artifact, such as a footnote index.

Short Display Short label
Cardinality 0..1
Type string
Summary false
Comments

Though not commonly used in citation records, this could be used for referencing other articles in the abstract or explanatory notes.

Citation.citedArtifact.relatesTo.display
Element Id Citation.citedArtifact.relatesTo.display
Definition

A brief description of the document or knowledge resource being referenced, suitable for display to a consumer.

Short Display Brief description of the related artifact
Cardinality 0..1
Type string
Summary false
Citation.citedArtifact.relatesTo.citation
Element Id Citation.citedArtifact.relatesTo.citation
Definition

A bibliographic citation for the related artifact. This text SHOULD be formatted according to an accepted citation format.

Short Display Bibliographic citation for the artifact
Cardinality 0..1
Type markdown
Summary false
Citation.citedArtifact.relatesTo.document
Element Id Citation.citedArtifact.relatesTo.document
Definition

The document being referenced, represented as an attachment. Do not use this element if using the resource element to provide the canonical to the related artifact.

Short Display What document is being referenced
Cardinality 0..1
Type Attachment
Summary false
Comments

To refer to related artifacts by URL, the FHIR Attachment Datatype includes a url element, so the path would be Citation.citedArtifact.relatesTo.document.url

Citation.citedArtifact.relatesTo.resource
Element Id Citation.citedArtifact.relatesTo.resource
Definition

The related artifact, such as a library, value set, profile, or other knowledge resource.

Short Display What artifact is being referenced
Cardinality 0..1
Type canonical
Summary false
Comments

If the type is predecessor, this is a reference to the succeeding knowledge resource. If the type is successor, this is a reference to the prior knowledge resource

Citation.citedArtifact.relatesTo.resourceReference
Element Id Citation.citedArtifact.relatesTo.resourceReference
Definition

The related artifact, if the artifact is not a canonical resource, or a resource reference to a canonical resource.

Short Display What artifact, if not a conformance resource
Cardinality 0..1
Type Reference
Summary false
Comments

If both resource and resourceReference are present, they SHOULD be consistent and reference the same resource. Although relatedArtifact is intended to support references to definitional resources, there are cases where non-definitional resources can be definitional (such as Location where the kind is mode). Related artifacts SHOULD be used to reference definitional resources, and profiles SHOULD be used to make that explicit for particular use cases.

Citation.citedArtifact.publicationForm
Element Id Citation.citedArtifact.publicationForm
Definition

Where, when and how the artifact was published. If multiple, used to represent alternative forms of the article that are not separate citations.

Short Display If multiple, used to represent alternative forms of the article that are not separate citations
Cardinality 0..*
Summary false
Comments

A common use is a journal article with a publication date and pagination for a print version and a different publication date for the online version of the same article.

Citation.citedArtifact.publicationForm.publishedIn
Element Id Citation.citedArtifact.publicationForm.publishedIn
Definition

The collection the cited article or artifact is published in.

Short Display The collection the cited article or artifact is published in
Cardinality 0..1
Summary false
Citation.citedArtifact.publicationForm.publishedIn.type
Element Id Citation.citedArtifact.publicationForm.publishedIn.type
Definition

Kind of container (e.g. Periodical, database, or book).

Short Display Kind of container (e.g. Periodical, database, or book)
Cardinality 0..1
Terminology Binding Published In Type (Extensible)
Type CodeableConcept
Summary false
Comments

Journals and newspapers are coded as Periodical.

Citation.citedArtifact.publicationForm.publishedIn.identifier
Element Id Citation.citedArtifact.publicationForm.publishedIn.identifier
Definition

Journal identifiers include ISSN, ISO Abbreviation and NLMuniqueID; Book identifiers include ISBN.

Short Display Journal identifiers include ISSN, ISO Abbreviation and NLMuniqueID; Book identifiers include ISBN
Note This is a business identifier, not a resource identifier (see discussion)
Cardinality 0..*
Type Identifier
Summary false
Citation.citedArtifact.publicationForm.publishedIn.title
Element Id Citation.citedArtifact.publicationForm.publishedIn.title
Definition

Name of the database or title of the book or journal.

Short Display Name of the database or title of the book or journal
Cardinality 0..1
Type string
Summary false
Comments

ClinicalTrials.gov is a name of a database.

Citation.citedArtifact.publicationForm.publishedIn.publisher
Element Id Citation.citedArtifact.publicationForm.publishedIn.publisher
Definition

Name of or resource describing the publisher.

Short Display Name of or resource describing the publisher
Cardinality 0..1
Type Reference(Organization)
Summary false
Citation.citedArtifact.publicationForm.publishedIn.publisherLocation
Element Id Citation.citedArtifact.publicationForm.publishedIn.publisherLocation
Definition

Geographic location of the publisher.

Short Display Geographic location of the publisher
Cardinality 0..1
Type string
Summary false
Citation.citedArtifact.publicationForm.citedMedium
Element Id Citation.citedArtifact.publicationForm.citedMedium
Definition

Describes the form of the medium cited. Common codes are "Internet" or "Print". The CitedMedium value set has 6 codes. The codes internet, print, and offline-digital-storage are the common codes for a typical publication form, though internet and print are more common for study citations. Three additional codes (each appending one of the primary codes with "-without-issue" are used for situations when a study is published both within an issue (of a periodical release as commonly done for journals) AND is published separately from the issue (as commonly done with early online publication), to represent specific identification of the publication form not associated with the issue.

Short Display Internet or Print
Cardinality 0..1
Terminology Binding Cited Medium (Extensible)
Type CodeableConcept
Summary false
Citation.citedArtifact.publicationForm.volume
Element Id Citation.citedArtifact.publicationForm.volume
Definition

Volume number of journal or other collection in which the article is published.

Short Display Volume number of journal or other collection in which the article is published
Cardinality 0..1
Type string
Summary false
Citation.citedArtifact.publicationForm.issue
Element Id Citation.citedArtifact.publicationForm.issue
Definition

Issue, part or supplement of journal or other collection in which the article is published.

Short Display Issue, part or supplement of journal or other collection in which the article is published
Cardinality 0..1
Type string
Summary false
Citation.citedArtifact.publicationForm.articleDate
Element Id Citation.citedArtifact.publicationForm.articleDate
Definition

The date the article was added to the database, or the date the article was released.

Short Display The date the article was added to the database, or the date the article was released
Cardinality 0..1
Type dateTime
Summary false
Comments

The articleDate is the preferred element for expressing the publication date as structured data.

Citation.citedArtifact.publicationForm.publicationDateText
Element Id Citation.citedArtifact.publicationForm.publicationDateText
Definition

Text representation of the date on which the issue of the cited artifact was published.

Short Display Text representation of the date on which the issue of the cited artifact was published
Cardinality 0..1
Type string
Summary false
Comments

The publicationDateText element is prefererntially used when a date is not represented in a form that can be handled as structured data in other elements.

Citation.citedArtifact.publicationForm.publicationDateSeason
Element Id Citation.citedArtifact.publicationForm.publicationDateSeason
Definition

Season in which the cited artifact was published, e.g. Spring, Summer, Fall/Autumn, Winter.

Short Display Season in which the cited artifact was published
Cardinality 0..1
Type string
Summary false
Citation.citedArtifact.publicationForm.lastRevisionDate
Element Id Citation.citedArtifact.publicationForm.lastRevisionDate
Definition

The date the article was last revised or updated in the database.

Short Display The date the article was last revised or updated in the database
Cardinality 0..1
Type dateTime
Summary false
Comments

The lastRevisionDate is used for the cited article and not the date the Citation Resource is last revised.

Citation.citedArtifact.publicationForm.language
Element Id Citation.citedArtifact.publicationForm.language
Definition

The language or languages in which this form of the article is published.

Short Display Language(s) in which this form of the article is published
Cardinality 0..*
Terminology Binding All Languages (Required)
Additional BindingsPurpose
Common Languages Starter Set
Type code
Summary false
Citation.citedArtifact.publicationForm.accessionNumber
Element Id Citation.citedArtifact.publicationForm.accessionNumber
Definition

Entry number or identifier for inclusion in a database.

Short Display Entry number or identifier for inclusion in a database
Cardinality 0..1
Type string
Summary false
Comments

Accession numbers may be used instead of or in addition to page numbers. Accession numbers are functionally identifiers when coupled with the identity of the database for which they are accession numbers. Accession numbers which are used for indexing citations in a dataset of citations should NOT be entered in Citation.citedArtifact.publicationForm.accessionNumber -- this use would be a type of Citation.identifier for the citation record itself.

Citation.citedArtifact.publicationForm.pageString
Element Id Citation.citedArtifact.publicationForm.pageString
Definition

Used for full display of pagination.

Short Display Used for full display of pagination
Cardinality 0..1
Type string
Summary false
Citation.citedArtifact.publicationForm.firstPage
Element Id Citation.citedArtifact.publicationForm.firstPage
Definition

Used for isolated representation of first page.

Short Display Used for isolated representation of first page
Cardinality 0..1
Type string
Summary false
Citation.citedArtifact.publicationForm.lastPage
Element Id Citation.citedArtifact.publicationForm.lastPage
Definition

Used for isolated representation of last page.

Short Display Used for isolated representation of last page
Cardinality 0..1
Type string
Summary false
Citation.citedArtifact.publicationForm.pageCount
Element Id Citation.citedArtifact.publicationForm.pageCount
Definition

Actual or approximate number of pages or screens. Distinct from reporting the page numbers.

Short Display Number of pages or screens
Cardinality 0..1
Type string
Summary false
Citation.citedArtifact.publicationForm.copyright
Element Id Citation.citedArtifact.publicationForm.copyright
Definition

Copyright notice for the full article or artifact.

Short Display Copyright notice for the full article or artifact
Cardinality 0..1
Type markdown
Summary false
Comments

It is possible that different publication forms have different copyright notices.

Citation.citedArtifact.webLocation
Element Id Citation.citedArtifact.webLocation
Definition

Used for any URL for the article or artifact cited.

Short Display Used for any URL for the article or artifact cited
Cardinality 0..*
Summary false
Citation.citedArtifact.webLocation.classifier
Element Id Citation.citedArtifact.webLocation.classifier
Definition

A characterization of the object expected at the web location.

Short Display Code the reason for different URLs, e.g. abstract and full-text
Cardinality 0..*
Terminology Binding Artifact Url Classifier (Extensible)
Type CodeableConcept
Summary false
Comments

Categories that may be frequently used for study citations may include abstract, full-text, supplement, webpage, and doi-based.

Citation.citedArtifact.webLocation.url
Element Id Citation.citedArtifact.webLocation.url
Definition

The specific URL.

Short Display The specific URL
Cardinality 0..1
Type uri
Summary false
Comments

Persistent URLs, like doi, are preferred.

Citation.citedArtifact.classification
Element Id Citation.citedArtifact.classification
Definition

The assignment to an organizing scheme.

Short Display The assignment to an organizing scheme
Cardinality 0..*
Summary false
Citation.citedArtifact.classification.type
Element Id Citation.citedArtifact.classification.type
Definition

The kind of classifier (e.g. publication type, keyword).

Short Display The kind of classifier (e.g. publication type, keyword)
Cardinality 0..1
Terminology Binding Cited Artifact Classification Type (Preferred)
Type CodeableConcept
Summary false
Citation.citedArtifact.classification.classifier
Element Id Citation.citedArtifact.classification.classifier
Definition

The specific classification value.

Short Display The specific classification value
Cardinality 0..*
Terminology Binding Citation Artifact Classifier (Example)
Type CodeableConcept
Summary false
Citation.citedArtifact.classification.artifactAssessment
Element Id Citation.citedArtifact.classification.artifactAssessment
Definition

Complex or externally created classification.

Short Display Complex or externally created classification
Cardinality 0..*
Type Reference(ArtifactAssessment)
Summary false
Comments

Examples relevant to study citations include MeSH Headings or Keywords that contain qualifier codings or sub-classifications, and include risk of bias assessments created by persons different from the creator of the citation record.

Citation.citedArtifact.contributorship
Element Id Citation.citedArtifact.contributorship
Definition

This element is used to list authors and other contributors, their contact information, specific contributions, and summary statements.

Short Display Attribution of authors and other contributors
Cardinality 0..1
Requirements

Need to support individualized and collective attribution of authorship and contributorship to people and groups.

Summary false
Citation.citedArtifact.contributorship.complete
Element Id Citation.citedArtifact.contributorship.complete
Definition

Indication whether all authors are included in the entry content.

Short Display Indicates if all authors are included
Cardinality 0..1
Type boolean
Meaning if Missing Value unknown
Summary false
Comments

If list is incomplete, "et al" can be appended to Contributorship.summary.value for display purposes.

Citation.citedArtifact.contributorship.entry
Element Id Citation.citedArtifact.contributorship.entry
Definition

An individual entity named as a contributor, for example in the author list or contributor list.

Short Display An individual entity named as a contributor
Cardinality 0..*
Summary false
Comments

Used to report contributorship in individualized ways.

Citation.citedArtifact.contributorship.entry.contributor
Element Id Citation.citedArtifact.contributorship.entry.contributor
Definition

The identity of the individual contributor.

Short Display The identity of the individual contributor
Cardinality 1..1
Type Reference(Practitioner | Organization)
Summary false
Comments

If naming a contributor without additional detail or further structured data, the display element within the Reference datatype may be used for a simple string without referencing another resource.

Citation.citedArtifact.contributorship.entry.forenameInitials
Element Id Citation.citedArtifact.contributorship.entry.forenameInitials
Definition

For citation styles that use initials.

Short Display For citation styles that use initials
Cardinality 0..1
Type string
Summary false
Comments

This element is used to support a data element used for citations that is not otherwise supported fully by FHIR HumanName datatype. In some citation summary styles (e.g. Medline), authors are presented with full spelling of their last name (family name) and initials for all forenames (first names, middle names, preceding names, given names). As the FHIR HumanName Datatype does not have a specific element for forename initials and this is common in citation usage, the element is added to contributorship.entry directly.

Citation.citedArtifact.contributorship.entry.affiliation
Element Id Citation.citedArtifact.contributorship.entry.affiliation
Definition

Organization affiliated with the contributor.

Short Display Organizational affiliation
Cardinality 0..*
Type Reference(Organization | PractitionerRole)
Summary false
Comments

If naming an organization without additional detail or further structured data, the display element within the Reference datatype may be used for a simple string without referencing another resource.

Citation.citedArtifact.contributorship.entry.contributionType
Element Id Citation.citedArtifact.contributorship.entry.contributionType
Definition

The specific nature of an individual’s contribution with respect to the cited work.

Short Display The specific contribution
Cardinality 0..*
Terminology Binding Artifact Contribution Type (Extensible)
Type CodeableConcept
Summary false
Comments

The CreDiT taxonomy provides a way to encode contribution information. The purpose of CRediT is to provide transparency in contributions to scholarly published work, to enable improved systems of attribution, credit, and accountability.

Citation.citedArtifact.contributorship.entry.role
Element Id Citation.citedArtifact.contributorship.entry.role
Definition

The role of the contributor (e.g. author, editor, reviewer, funder).

Short Display The role of the contributor (e.g. author, editor, reviewer, funder)
Cardinality 0..1
Terminology Binding Contributor Role (Extensible)
Type CodeableConcept
Summary false
Citation.citedArtifact.contributorship.entry.contributionInstance
Element Id Citation.citedArtifact.contributorship.entry.contributionInstance
Definition

Contributions with accounting for time or number.

Short Display Contributions with accounting for time or number
Cardinality 0..*
Summary false
Citation.citedArtifact.contributorship.entry.contributionInstance.type
Element Id Citation.citedArtifact.contributorship.entry.contributionInstance.type
Definition

The specific contribution.

Short Display The specific contribution
Cardinality 1..1
Terminology Binding Artifact Contribution Instance Type (Preferred)
Type CodeableConcept
Summary false
Citation.citedArtifact.contributorship.entry.contributionInstance.time
Element Id Citation.citedArtifact.contributorship.entry.contributionInstance.time
Definition

The time that the contribution was made.

Short Display The time that the contribution was made
Cardinality 0..1
Type dateTime
Summary false
Citation.citedArtifact.contributorship.entry.correspondingContact
Element Id Citation.citedArtifact.contributorship.entry.correspondingContact
Definition

Whether the contributor is the corresponding contributor for the role.

Short Display Whether the contributor is the corresponding contributor for the role
Cardinality 0..1
Type boolean
Meaning if Missing Value unknown
Summary false
Comments

If there are multiple authors and one serves as the corresponding author, then that one would have correspondingContact = true.

Citation.citedArtifact.contributorship.entry.rankingOrder
Element Id Citation.citedArtifact.contributorship.entry.rankingOrder
Definition

Provides a numerical ranking to represent the degree of contributorship relative to other contributors, such as 1 for first author and 2 for second author.

Short Display Ranked order of contribution
Cardinality 0..1
Type positiveInt
Summary false
Comments

Used to retain order of authorship as structured data

Citation.citedArtifact.contributorship.summary
Element Id Citation.citedArtifact.contributorship.summary
Definition

Used to record a display of the author/contributor list without separate data element for each list member.

Short Display Used to record a display of the author/contributor list without separate data element for each list member
Cardinality 0..*
Summary false
Citation.citedArtifact.contributorship.summary.type
Element Id Citation.citedArtifact.contributorship.summary.type
Definition

Used most commonly to express an author list or a contributorship statement.

Short Display Such as author list, contributorship statement, funding statement, acknowledgements statement, or conflicts of interest statement
Cardinality 0..1
Terminology Binding Contributor Summary Type (Extensible)
Type CodeableConcept
Summary false
Citation.citedArtifact.contributorship.summary.style
Element Id Citation.citedArtifact.contributorship.summary.style
Definition

The format for the display string, such as author last name with first letter capitalized followed by forename initials.

Short Display The format for the display string
Cardinality 0..*
Terminology Binding Contributor Summary Style (Example)
Type CodeableConcept
Summary false
Citation.citedArtifact.contributorship.summary.source
Element Id Citation.citedArtifact.contributorship.summary.source
Definition

Used to code the producer or rule for creating the display string.

Short Display Used to code the producer or rule for creating the display string
Cardinality 0..1
Terminology Binding Contributor Summary Source (Preferred)
Type CodeableConcept
Summary false
Citation.citedArtifact.contributorship.summary.value
Element Id Citation.citedArtifact.contributorship.summary.value
Definition

The display string for the author list, contributor list, or contributorship statement.

Short Display The display string for the author list, contributor list, or contributorship statement
Cardinality 1..1
Type markdown
Summary false
Citation.citedArtifact.note
Element Id Citation.citedArtifact.note
Definition

Any additional information or content for the article or artifact.

Short Display Any additional information or content for the article or artifact
Cardinality 0..*
Type Annotation
Summary false