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: 0 Trial UseSecurity Category: Business Compartments: Not linked to any defined compartments

Detailed Descriptions for the elements in the Citation resource.

Citation
Element IdCitation
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 DisplayA description of identification, location, or contributorship of a publication (article or artifact)
Cardinality0..*
TypeMetadataResource
Summaryfalse
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 IdCitation.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 DisplayCanonical identifier for this citation record, represented as a globally unique URI
Cardinality0..1
Typeuri
Requirements

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

Summarytrue
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 problematicurl.matches('([^|#])*')
Citation.identifier
Element IdCitation.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 DisplayIdentifier for the citation record itself
NoteThis is a business identifier, not a resource identifier (see discussion)
Cardinality0..*
TypeIdentifier
Requirements

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

Summarytrue
Comments

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

Citation.version
Element IdCitation.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 DisplayBusiness version of the citation record
NoteThis is a business versionId, not a resource version id (see discussion)
Cardinality0..1
Typestring
Summarytrue
Comments

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 IdCitation.versionAlgorithm[x]
Definition

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

Short DisplayHow to compare versions
Cardinality0..1
Terminology BindingVersion Algorithm (Extensible)
Typestring|Coding
[x] NoteSee Choice of Datatypes for further information about how to use [x]
Summarytrue
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 IdCitation.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 DisplayName for this citation record (computer friendly)
Cardinality0..1
Typestring
Requirements

Support human navigation and code generation.

Summarytrue
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 IdCitation.title
Definition

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

Short DisplayName for this citation record (human friendly)
Cardinality0..1
Typestring
Summarytrue
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 IdCitation.status
Definition

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

Short Displaydraft | active | retired | unknown
Cardinality1..1
Terminology BindingPublicationStatus (Required)
Typecode
Is Modifiertrue (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.

Summarytrue
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.

Citation.experimental
Element IdCitation.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 DisplayFor testing purposes, not real usage
Cardinality0..1
Typeboolean
Meaning if MissingIf 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.

Summarytrue
Comments

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

Citation.date
Element IdCitation.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 DisplayDate last changed
Cardinality0..1
TypedateTime
Alternate NamesRevision Date
Summarytrue
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.

Citation.publisher
Element IdCitation.publisher
Definition

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

Short DisplayThe publisher of the citation record, not the publisher of the article or artifact being cited
Cardinality0..1
Typestring
Requirements

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

Summarytrue
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 IdCitation.contact
Definition

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

Short DisplayContact details for the publisher of the citation record
Cardinality0..*
TypeContactDetail
Summarytrue
Comments

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

Citation.description
Element IdCitation.description
Definition

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

Short DisplayNatural language description of the citation
Cardinality0..1
Typemarkdown
Summaryfalse
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 IdCitation.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 DisplayThe context that the citation record content is intended to support
Cardinality0..*
TypeUsageContext
Requirements

Assist in searching for appropriate content.

Summarytrue
Comments

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

Citation.jurisdiction
Element IdCitation.jurisdiction
Definition

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

Short DisplayIntended jurisdiction for citation record (if applicable)
Cardinality0..*
Terminology BindingJurisdiction ValueSet (Extensible)
TypeCodeableConcept
Summarytrue
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.

Citation.purpose
Element IdCitation.purpose
Definition

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

Short DisplayWhy this citation is defined
Cardinality0..1
Typemarkdown
Summaryfalse
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 IdCitation.copyright
Definition

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

Short DisplayUse and/or publishing restrictions for the citation record, not for the cited artifact
Cardinality0..1
Typemarkdown
Summaryfalse
Citation.copyrightLabel
Element IdCitation.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 DisplayCopyright holder and year(s) for the ciation record, not for the cited artifact
Cardinality0..1
Typestring
Requirements

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

Summaryfalse
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 IdCitation.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 DisplayWhen the citation record was approved by publisher
Cardinality0..1
Typedate
Summaryfalse
Comments

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

Citation.lastReviewDate
Element IdCitation.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 DisplayWhen the citation record was last reviewed
Cardinality0..1
Typedate
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.

Summaryfalse
Comments

If specified, this date follows the original approval date.

Citation.effectivePeriod
Element IdCitation.effectivePeriod
Definition

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

Short DisplayWhen the citation record is expected to be used
Cardinality0..1
TypePeriod
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.

Summarytrue
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 measure intended to be used for the year 2016 might be published in 2015.

Citation.author
Element IdCitation.author
Definition

Who authored or created the citation record.

Short DisplayWho authored the citation record
Cardinality0..*
TypeContactDetail
Summaryfalse
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.editor
Element IdCitation.editor
Definition

Who edited or revised the citation record.

Short DisplayWho edited the citation record
Cardinality0..*
TypeContactDetail
Summaryfalse
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 IdCitation.reviewer
Definition

Who reviewed the citation record.

Short DisplayWho reviewed the citation record
Cardinality0..*
TypeContactDetail
Summaryfalse
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.

Citation.endorser
Element IdCitation.endorser
Definition

Who endorsed the citation record.

Short DisplayWho endorsed the citation record
Cardinality0..*
TypeContactDetail
Summaryfalse
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.

Citation.summary
Element IdCitation.summary
Definition

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

Short DisplayA human-readable display of key concepts to represent the citation
Cardinality0..*
Summaryfalse
Citation.summary.style
Element IdCitation.summary.style
Definition

Format for display of the citation summary.

Short DisplayFormat for display of the citation summary
Cardinality0..1
Terminology BindingCitationSummaryStyle (Extensible)
TypeCodeableConcept
Summaryfalse
Citation.summary.text
Element IdCitation.summary.text
Definition

The human-readable display of the citation summary.

Short DisplayThe human-readable display of the citation summary
Cardinality1..1
Typemarkdown
Summarytrue
Citation.classification
Element IdCitation.classification
Definition

The assignment to an organizing scheme.

Short DisplayThe assignment to an organizing scheme
Cardinality0..*
Summaryfalse
Comments

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

Citation.classification.type
Element IdCitation.classification.type
Definition

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

Short DisplayThe kind of classifier (e.g. publication type, keyword)
Cardinality0..1
Terminology BindingCitationClassificationType (Extensible)
TypeCodeableConcept
Summaryfalse
Citation.classification.classifier
Element IdCitation.classification.classifier
Definition

The specific classification value.

Short DisplayThe specific classification value
Cardinality0..*
Terminology BindingCitationArtifactClassifier (Example)
TypeCodeableConcept
Summaryfalse
Citation.note
Element IdCitation.note
Definition

Used for general notes and annotations not coded elsewhere.

Short DisplayUsed for general notes and annotations not coded elsewhere
Cardinality0..*
TypeAnnotation
Summaryfalse
Citation.currentState
Element IdCitation.currentState
Definition

The status of the citation record.

Short DisplayThe status of the citation record
Cardinality0..*
Terminology BindingCitationStatusType (Example)
TypeCodeableConcept
Summaryfalse
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 IdCitation.statusDate
Definition

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

Short DisplayAn effective date or period for a status of the citation record
Cardinality0..*
Summaryfalse
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 IdCitation.statusDate.activity
Definition

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

Short DisplayClassification of the status
Cardinality1..1
Terminology BindingCitationStatusType (Example)
TypeCodeableConcept
Summaryfalse
Citation.statusDate.actual
Element IdCitation.statusDate.actual
Definition

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

Short DisplayEither occurred or expected
Cardinality0..1
Typeboolean
Summaryfalse
Citation.statusDate.period
Element IdCitation.statusDate.period
Definition

When the status started and/or ended.

Short DisplayWhen the status started and/or ended
Cardinality1..1
TypePeriod
Summaryfalse
Comments

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

Citation.relatedArtifact
Element IdCitation.relatedArtifact
Definition

Artifact related to the citation record.

Short DisplayArtifact related to the citation record
Cardinality0..*
TypeRelatedArtifact
Summaryfalse
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 IdCitation.citedArtifact
Definition

The article or artifact being described.

Short DisplayThe article or artifact being described
Cardinality0..1
Summaryfalse
Citation.citedArtifact.identifier
Element IdCitation.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 DisplayUnique identifier. May include DOI, PMID, PMCID, etc.
NoteThis is a business identifier, not a resource identifier (see discussion)
Cardinality0..*
TypeIdentifier
Requirements

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

Summarytrue
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 IdCitation.citedArtifact.relatedIdentifier
Definition

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

Short DisplayIdentifier not unique to the cited artifact. May include trial registry identifiers
Cardinality0..*
TypeIdentifier
Requirements

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

Summarytrue
Comments

May include trial registry identifiers, e.g. NCT04372602 from clinicaltrials.gov. This related identifier would not be used as 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 IdCitation.citedArtifact.dateAccessed
Definition

When the cited artifact was accessed.

Short DisplayWhen the cited artifact was accessed
Cardinality0..1
TypedateTime
Summarytrue
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 IdCitation.citedArtifact.version
Definition

The defined version of the cited artifact.

Short DisplayThe defined version of the cited artifact
NoteThis is a business versionId, not a resource version id (see discussion)
Cardinality0..1
Summaryfalse
Citation.citedArtifact.version.value
Element IdCitation.citedArtifact.version.value
Definition

The version number or other version identifier.

Short DisplayThe version number or other version identifier
Cardinality1..1
Typestring
Summaryfalse
Citation.citedArtifact.version.baseCitation
Element IdCitation.citedArtifact.version.baseCitation
Definition

Citation for the main version of the cited artifact.

Short DisplayCitation for the main version of the cited artifact
Cardinality0..1
TypeReference(Citation)
Summaryfalse
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.

Citation.citedArtifact.currentState
Element IdCitation.citedArtifact.currentState
Definition

The status of the cited artifact.

Short DisplayThe status of the cited artifact
Cardinality0..*
Terminology BindingCitedArtifactStatusType (Extensible)
TypeCodeableConcept
Summaryfalse
Citation.citedArtifact.statusDate
Element IdCitation.citedArtifact.statusDate
Definition

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

Short DisplayAn effective date or period for a status of the cited artifact
Cardinality0..*
Summaryfalse
Citation.citedArtifact.statusDate.activity
Element IdCitation.citedArtifact.statusDate.activity
Definition

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

Short DisplayClassification of the status
Cardinality1..1
Terminology BindingCitedArtifactStatusType (Extensible)
TypeCodeableConcept
Summaryfalse
Citation.citedArtifact.statusDate.actual
Element IdCitation.citedArtifact.statusDate.actual
Definition

Either occurred or expected.

Short DisplayEither occurred or expected
Cardinality0..1
Typeboolean
Summaryfalse
Citation.citedArtifact.statusDate.period
Element IdCitation.citedArtifact.statusDate.period
Definition

When the status started and/or ended.

Short DisplayWhen the status started and/or ended
Cardinality1..1
TypePeriod
Summaryfalse
Comments

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

Citation.citedArtifact.title
Element IdCitation.citedArtifact.title
Definition

The title details of the article or artifact.

Short DisplayThe title details of the article or artifact
Cardinality0..*
Summaryfalse
Citation.citedArtifact.title.type
Element IdCitation.citedArtifact.title.type
Definition

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

Short DisplayThe kind of title
Cardinality0..*
Terminology BindingTitleType (Extensible)
TypeCodeableConcept
Summaryfalse
Citation.citedArtifact.title.language
Element IdCitation.citedArtifact.title.language
Definition

Used to express the specific language of the title.

Short DisplayUsed to express the specific language
Cardinality0..1
Terminology BindingCommon Languages (Preferred)
TypeCodeableConcept
Summaryfalse
Citation.citedArtifact.title.text
Element IdCitation.citedArtifact.title.text
Definition

The title of the article or artifact.

Short DisplayThe title of the article or artifact
Cardinality1..1
Typemarkdown
Summaryfalse
Citation.citedArtifact.abstract
Element IdCitation.citedArtifact.abstract
Definition

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

Short DisplaySummary of the article or artifact
Cardinality0..*
Summaryfalse
Citation.citedArtifact.abstract.type
Element IdCitation.citedArtifact.abstract.type
Definition

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

Short DisplayThe kind of abstract
Cardinality0..1
Terminology BindingCitedArtifactAbstractType (Extensible)
TypeCodeableConcept
Summaryfalse
Citation.citedArtifact.abstract.language
Element IdCitation.citedArtifact.abstract.language
Definition

Used to express the specific language of the abstract.

Short DisplayUsed to express the specific language
Cardinality0..1
Terminology BindingCommon Languages (Preferred)
TypeCodeableConcept
Summaryfalse
Citation.citedArtifact.abstract.text
Element IdCitation.citedArtifact.abstract.text
Definition

Abstract content.

Short DisplayAbstract content
Cardinality1..1
Typemarkdown
Summaryfalse
Citation.citedArtifact.abstract.copyright
Element IdCitation.citedArtifact.abstract.copyright
Definition

Copyright notice for the abstract.

Short DisplayCopyright notice for the abstract
Cardinality0..1
Typemarkdown
Summaryfalse
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 IdCitation.citedArtifact.part
Definition

The component of the article or artifact.

Short DisplayThe component of the article or artifact
Cardinality0..1
Summaryfalse
Citation.citedArtifact.part.type
Element IdCitation.citedArtifact.part.type
Definition

The kind of component.

Short DisplayThe kind of component
Cardinality0..1
Terminology BindingCitedArtifactPartType (Extensible)
TypeCodeableConcept
Summaryfalse
Citation.citedArtifact.part.value
Element IdCitation.citedArtifact.part.value
Definition

The specification of the component.

Short DisplayThe specification of the component
Cardinality0..1
Typestring
Summaryfalse
Citation.citedArtifact.part.baseCitation
Element IdCitation.citedArtifact.part.baseCitation
Definition

The citation for the full article or artifact.

Short DisplayThe citation for the full article or artifact
Cardinality0..1
TypeReference(Citation)
Summaryfalse
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 specific to the citation of the specified part. 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 IdCitation.citedArtifact.relatesTo
Definition

The artifact related to the cited artifact.

Short DisplayThe artifact related to the cited artifact
Cardinality0..*
Summaryfalse
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 IdCitation.citedArtifact.relatesTo.type
Definition

The type of relationship to the related artifact.

Short Displaydocumentation | 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
Cardinality1..1
Terminology BindingRelatedArtifactTypeExpanded (Required)
Typecode
Summaryfalse
Citation.citedArtifact.relatesTo.classifier
Element IdCitation.citedArtifact.relatesTo.classifier
Definition

Provides additional classifiers of the related artifact.

Short DisplayAdditional classifiers
Cardinality0..*
Terminology BindingCitationArtifactClassifier (Extensible)
TypeCodeableConcept
Summaryfalse
Citation.citedArtifact.relatesTo.label
Element IdCitation.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 DisplayShort label
Cardinality0..1
Typestring
Summaryfalse
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 IdCitation.citedArtifact.relatesTo.display
Definition

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

Short DisplayBrief description of the related artifact
Cardinality0..1
Typestring
Summaryfalse
Citation.citedArtifact.relatesTo.citation
Element IdCitation.citedArtifact.relatesTo.citation
Definition

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

Short DisplayBibliographic citation for the artifact
Cardinality0..1
Typemarkdown
Summaryfalse
Citation.citedArtifact.relatesTo.document
Element IdCitation.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 DisplayWhat document is being referenced
Cardinality0..1
TypeAttachment
Summaryfalse
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 IdCitation.citedArtifact.relatesTo.resource
Definition

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

Short DisplayWhat artifact is being referenced
Cardinality0..1
Typecanonical
Summaryfalse
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 IdCitation.citedArtifact.relatesTo.resourceReference
Definition

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

Short DisplayWhat artifact, if not a conformance resource
Cardinality0..1
TypeReference
Summaryfalse
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 IdCitation.citedArtifact.publicationForm
Definition

If multiple, used to represent alternative forms of the article that are not separate citations.

Short DisplayIf multiple, used to represent alternative forms of the article that are not separate citations
Cardinality0..*
Summaryfalse
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 IdCitation.citedArtifact.publicationForm.publishedIn
Definition

The collection the cited article or artifact is published in.

Short DisplayThe collection the cited article or artifact is published in
Cardinality0..1
Summaryfalse
Citation.citedArtifact.publicationForm.publishedIn.type
Element IdCitation.citedArtifact.publicationForm.publishedIn.type
Definition

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

Short DisplayKind of container (e.g. Periodical, database, or book)
Cardinality0..1
Terminology BindingPublishedInType (Extensible)
TypeCodeableConcept
Summaryfalse
Comments

Journals and newspapers are coded as Periodical.

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

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

Short DisplayJournal identifiers include ISSN, ISO Abbreviation and NLMuniqueID; Book identifiers include ISBN
NoteThis is a business identifier, not a resource identifier (see discussion)
Cardinality0..*
TypeIdentifier
Summaryfalse
Citation.citedArtifact.publicationForm.publishedIn.title
Element IdCitation.citedArtifact.publicationForm.publishedIn.title
Definition

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

Short DisplayName of the database or title of the book or journal
Cardinality0..1
Typestring
Summaryfalse
Comments

ClinicalTrials.gov is a name of a database.

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

Name of or resource describing the publisher.

Short DisplayName of or resource describing the publisher
Cardinality0..1
TypeReference(Organization)
Summaryfalse
Citation.citedArtifact.publicationForm.publishedIn.publisherLocation
Element IdCitation.citedArtifact.publicationForm.publishedIn.publisherLocation
Definition

Geographic location of the publisher.

Short DisplayGeographic location of the publisher
Cardinality0..1
Typestring
Summaryfalse
Citation.citedArtifact.publicationForm.citedMedium
Element IdCitation.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 DisplayInternet or Print
Cardinality0..1
Terminology BindingCitedMedium (Extensible)
TypeCodeableConcept
Summaryfalse
Citation.citedArtifact.publicationForm.volume
Element IdCitation.citedArtifact.publicationForm.volume
Definition

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

Short DisplayVolume number of journal or other collection in which the article is published
Cardinality0..1
Typestring
Summaryfalse
Citation.citedArtifact.publicationForm.issue
Element IdCitation.citedArtifact.publicationForm.issue
Definition

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

Short DisplayIssue, part or supplement of journal or other collection in which the article is published
Cardinality0..1
Typestring
Summaryfalse
Citation.citedArtifact.publicationForm.articleDate
Element IdCitation.citedArtifact.publicationForm.articleDate
Definition

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

Short DisplayThe date the article was added to the database, or the date the article was released
Cardinality0..1
TypedateTime
Summaryfalse
Comments

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

Citation.citedArtifact.publicationForm.publicationDateText
Element IdCitation.citedArtifact.publicationForm.publicationDateText
Definition

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

Short DisplayText representation of the date on which the issue of the cited artifact was published
Cardinality0..1
Typestring
Summaryfalse
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 IdCitation.citedArtifact.publicationForm.publicationDateSeason
Definition

Spring, Summer, Fall/Autumn, Winter.

Short DisplaySeason in which the cited artifact was published
Cardinality0..1
Typestring
Summaryfalse
Citation.citedArtifact.publicationForm.lastRevisionDate
Element IdCitation.citedArtifact.publicationForm.lastRevisionDate
Definition

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

Short DisplayThe date the article was last revised or updated in the database
Cardinality0..1
TypedateTime
Summaryfalse
Comments

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

Citation.citedArtifact.publicationForm.language
Element IdCitation.citedArtifact.publicationForm.language
Definition

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

Short DisplayLanguage(s) in which this form of the article is published
Cardinality0..*
Terminology BindingCommon Languages (Preferred)
TypeCodeableConcept
Summaryfalse
Citation.citedArtifact.publicationForm.accessionNumber
Element IdCitation.citedArtifact.publicationForm.accessionNumber
Definition

Entry number or identifier for inclusion in a database.

Short DisplayEntry number or identifier for inclusion in a database
Cardinality0..1
Typestring
Summaryfalse
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 IdCitation.citedArtifact.publicationForm.pageString
Definition

Used for full display of pagination.

Short DisplayUsed for full display of pagination
Cardinality0..1
Typestring
Summaryfalse
Citation.citedArtifact.publicationForm.firstPage
Element IdCitation.citedArtifact.publicationForm.firstPage
Definition

Used for isolated representation of first page.

Short DisplayUsed for isolated representation of first page
Cardinality0..1
Typestring
Summaryfalse
Citation.citedArtifact.publicationForm.lastPage
Element IdCitation.citedArtifact.publicationForm.lastPage
Definition

Used for isolated representation of last page.

Short DisplayUsed for isolated representation of last page
Cardinality0..1
Typestring
Summaryfalse
Citation.citedArtifact.publicationForm.pageCount
Element IdCitation.citedArtifact.publicationForm.pageCount
Definition

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

Short DisplayNumber of pages or screens
Cardinality0..1
Typestring
Summaryfalse
Citation.citedArtifact.publicationForm.copyright
Element IdCitation.citedArtifact.publicationForm.copyright
Definition

Copyright notice for the full article or artifact.

Short DisplayCopyright notice for the full article or artifact
Cardinality0..1
Typemarkdown
Summaryfalse
Comments

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

Citation.citedArtifact.webLocation
Element IdCitation.citedArtifact.webLocation
Definition

Used for any URL for the article or artifact cited.

Short DisplayUsed for any URL for the article or artifact cited
Cardinality0..*
Summaryfalse
Citation.citedArtifact.webLocation.classifier
Element IdCitation.citedArtifact.webLocation.classifier
Definition

A characterization of the object expected at the web location.

Short DisplayCode the reason for different URLs, e.g. abstract and full-text
Cardinality0..*
Terminology BindingArtifactUrlClassifier (Extensible)
TypeCodeableConcept
Summaryfalse
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 IdCitation.citedArtifact.webLocation.url
Definition

The specific URL.

Short DisplayThe specific URL
Cardinality0..1
Typeuri
Summaryfalse
Comments

Persistent URLs, like doi, are preferred.

Citation.citedArtifact.classification
Element IdCitation.citedArtifact.classification
Definition

The assignment to an organizing scheme.

Short DisplayThe assignment to an organizing scheme
Cardinality0..*
Summaryfalse
Citation.citedArtifact.classification.type
Element IdCitation.citedArtifact.classification.type
Definition

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

Short DisplayThe kind of classifier (e.g. publication type, keyword)
Cardinality0..1
Terminology BindingCitedArtifactClassificationType (Extensible)
TypeCodeableConcept
Summaryfalse
Citation.citedArtifact.classification.classifier
Element IdCitation.citedArtifact.classification.classifier
Definition

The specific classification value.

Short DisplayThe specific classification value
Cardinality0..*
Terminology BindingCitationArtifactClassifier (Example)
TypeCodeableConcept
Summaryfalse
Citation.citedArtifact.classification.artifactAssessment
Element IdCitation.citedArtifact.classification.artifactAssessment
Definition

Complex or externally created classification.

Short DisplayComplex or externally created classification
Cardinality0..*
TypeReference(ArtifactAssessment)
Summaryfalse
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 IdCitation.citedArtifact.contributorship
Definition

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

Short DisplayAttribution of authors and other contributors
Cardinality0..1
Requirements

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

Summaryfalse
Citation.citedArtifact.contributorship.complete
Element IdCitation.citedArtifact.contributorship.complete
Definition

Indicates if the list includes all authors and/or contributors.

Short DisplayIndicates if the list includes all authors and/or contributors
Cardinality0..1
Typeboolean
Summaryfalse
Comments

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

Citation.citedArtifact.contributorship.entry
Element IdCitation.citedArtifact.contributorship.entry
Definition

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

Short DisplayAn individual entity named as a contributor
Cardinality0..*
Summaryfalse
Comments

Used to report contributorship in individualized ways.

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

The identity of the individual contributor.

Short DisplayThe identity of the individual contributor
Cardinality1..1
TypeReference(Practitioner | Organization)
Summaryfalse
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 IdCitation.citedArtifact.contributorship.entry.forenameInitials
Definition

Initials for forename.

Short DisplayInitials for forename
Cardinality0..1
Typestring
Summaryfalse
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 IdCitation.citedArtifact.contributorship.entry.affiliation
Definition

Organization affiliated with the contributor.

Short DisplayOrganizational affiliation
Cardinality0..*
TypeReference(Organization | PractitionerRole)
Summaryfalse
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 IdCitation.citedArtifact.contributorship.entry.contributionType
Definition

This element identifies the specific nature of an individual’s contribution with respect to the cited work.

Short DisplayThe specific contribution
Cardinality0..*
Terminology BindingArtifactContributionType (Extensible)
TypeCodeableConcept
Summaryfalse
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 IdCitation.citedArtifact.contributorship.entry.role
Definition

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

Short DisplayThe role of the contributor (e.g. author, editor, reviewer, funder)
Cardinality0..1
Terminology BindingContributorRole (Extensible)
TypeCodeableConcept
Summaryfalse
Citation.citedArtifact.contributorship.entry.contributionInstance
Element IdCitation.citedArtifact.contributorship.entry.contributionInstance
Definition

Contributions with accounting for time or number.

Short DisplayContributions with accounting for time or number
Cardinality0..*
Summaryfalse
Citation.citedArtifact.contributorship.entry.contributionInstance.type
Element IdCitation.citedArtifact.contributorship.entry.contributionInstance.type
Definition

The specific contribution.

Short DisplayThe specific contribution
Cardinality1..1
Terminology BindingArtifactContributionInstanceType (Extensible)
TypeCodeableConcept
Summaryfalse
Citation.citedArtifact.contributorship.entry.contributionInstance.time
Element IdCitation.citedArtifact.contributorship.entry.contributionInstance.time
Definition

The time that the contribution was made.

Short DisplayThe time that the contribution was made
Cardinality0..1
TypedateTime
Summaryfalse
Citation.citedArtifact.contributorship.entry.correspondingContact
Element IdCitation.citedArtifact.contributorship.entry.correspondingContact
Definition

Whether the contributor is the corresponding contributor for the role.

Short DisplayWhether the contributor is the corresponding contributor for the role
Cardinality0..1
Typeboolean
Summaryfalse
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 IdCitation.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 DisplayRanked order of contribution
Cardinality0..1
TypepositiveInt
Summaryfalse
Comments

Used to retain order of authorship as structured data

Citation.citedArtifact.contributorship.summary
Element IdCitation.citedArtifact.contributorship.summary
Definition

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

Short DisplayUsed to record a display of the author/contributor list without separate data element for each list member
Cardinality0..*
Summaryfalse
Citation.citedArtifact.contributorship.summary.type
Element IdCitation.citedArtifact.contributorship.summary.type
Definition

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

Short DisplaySuch as author list, contributorship statement, funding statement, acknowledgements statement, or conflicts of interest statement
Cardinality0..1
Terminology BindingContributorSummaryType (Extensible)
TypeCodeableConcept
Summaryfalse
Citation.citedArtifact.contributorship.summary.style
Element IdCitation.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 DisplayThe format for the display string
Cardinality0..1
Terminology BindingContributorSummaryStyle (Extensible)
TypeCodeableConcept
Summaryfalse
Citation.citedArtifact.contributorship.summary.source
Element IdCitation.citedArtifact.contributorship.summary.source
Definition

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

Short DisplayUsed to code the producer or rule for creating the display string
Cardinality0..1
Terminology BindingContributorSummarySource (Extensible)
TypeCodeableConcept
Summaryfalse
Citation.citedArtifact.contributorship.summary.value
Element IdCitation.citedArtifact.contributorship.summary.value
Definition

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

Short DisplayThe display string for the author list, contributor list, or contributorship statement
Cardinality1..1
Typemarkdown
Summaryfalse
Citation.citedArtifact.note
Element IdCitation.citedArtifact.note
Definition

Any additional information or content for the article or artifact.

Short DisplayAny additional information or content for the article or artifact
Cardinality0..*
TypeAnnotation
Summaryfalse