Release 5 Preview #2

This page is part of the FHIR Specification (v4.4.0: R5 Preview #2). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B

Clinical Decision Support 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.

Cardinality0..*
TypeMetadataResource
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.matches('[A-Z]([A-Za-z0-9_]){0,254}')
Citation.url
Element IdCitation.url
Definition

An absolute URI that is used to identify this citation 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 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.

Cardinality0..1
Typeuri
Requirements

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

Summarytrue
Comments

Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.

Citation.version
Element IdCitation.version
Definition

The identifier that is used to identify this version of the summary when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the summary 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.

NoteThis is a business versionId, not a resource version id (see discussion)
Cardinality0..1
Typestring
Summarytrue
Comments

The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in Technical and Business Versions.

Citation.status
Element IdCitation.status
Definition

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

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)
Summarytrue
Comments

Allows filtering of summarys s that are appropriate for use versus not.

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

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.identifier
Element IdCitation.identifier
Definition

A formal identifier that is used to identify this summary when it is represented in other formats, or referenced in a specification, model, design or an instance. 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 business identifiers to be easily associated with the module.

Summarytrue
Comments

Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this summary outside of FHIR, where it is not possible to use the logical URI.

Citation.relatedIdentifier
Element IdCitation.relatedIdentifier
Definition

May include trial registry identifiers.

Cardinality0..*
TypeIdentifier
Summarytrue
Citation.dateCited
Element IdCitation.dateCited
Definition

Date Cited.

Cardinality0..1
TypedateTime
Summarytrue
Citation.variantCitation
Element IdCitation.variantCitation
Definition

Variant citation.

Cardinality0..1
Citation.variantCitation.type
Element IdCitation.variantCitation.type
Definition

Used to describe the reason for the variant citation, such as version or subpart specification.

Cardinality0..1
Terminology BindingCitationVariantType (Extensible)
TypeCodeableConcept
Citation.variantCitation.value
Element IdCitation.variantCitation.value
Definition

Used to describe the specific variation, such as version number or subpart specification.

Cardinality0..1
Typestring
Citation.variantCitation.baseCitation
Element IdCitation.variantCitation.baseCitation
Definition

Base citation.

Cardinality0..1
TypeReference(Citation)
Citation.publishingModel
Element IdCitation.publishingModel
Definition

Identify the medium/media in which the cited article is published, eg print, electronic or print-electronic.

Cardinality0..1
Terminology BindingPublishingModelType (Extensible)
TypeCodeableConcept
Citation.journal
Element IdCitation.journal
Definition

Contains identifiers and classifiers for the journal cited.

Cardinality0..1
Citation.journal.identifier
Element IdCitation.journal.identifier
Definition

Journal identifiers include ISSN, ISO Abbreviation and NLMuniqueID.

NoteThis is a business identifier, not a resource identifier (see discussion)
Cardinality0..*
TypeIdentifier
Citation.journal.country
Element IdCitation.journal.country
Definition

Place of publication of the journal.

Cardinality0..1
Typestring
Citation.journal.journalIssue
Element IdCitation.journal.journalIssue
Definition

The specific issue in which the cited article resides.

Cardinality0..1
Citation.journal.journalIssue.citedMedium
Element IdCitation.journal.journalIssue.citedMedium
Definition

NLM codes Internet or Print.

Cardinality0..1
Terminology BindingJournalIssueMedium (Extensible)
TypeCodeableConcept
Citation.journal.journalIssue.volume
Element IdCitation.journal.journalIssue.volume
Definition

Volume number of journal in which the article is published.

Cardinality0..1
Typestring
Citation.journal.journalIssue.issue
Element IdCitation.journal.journalIssue.issue
Definition

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

Cardinality0..1
Typestring
Citation.journal.journalIssue.publicationDate
Element IdCitation.journal.journalIssue.publicationDate
Definition

Date on which the issue of the journal was published.

Cardinality0..1
Typestring
Citation.journal.title
Element IdCitation.journal.title
Definition

Journal title.

Cardinality0..1
Typestring
Citation.articleTitle
Element IdCitation.articleTitle
Definition

Full title of the article.

Cardinality0..1
Typemarkdown
Summarytrue
Citation.alternativeTitle
Element IdCitation.alternativeTitle
Definition

Used for variant titles, such as translations.

Cardinality0..*
Citation.alternativeTitle.type
Element IdCitation.alternativeTitle.type
Definition

Used to express the reason and specific aspect for the variant title, such as language and specific language.

Cardinality0..1
Terminology BindingAlternativeTitleType (Extensible)
TypeCodeableConcept
Citation.alternativeTitle.language
Element IdCitation.alternativeTitle.language
Definition

Used to express the specific language.

Cardinality0..1
Terminology BindingCommon Languages (Preferred but limited to All Languages)
TypeCodeableConcept
Citation.alternativeTitle.title
Element IdCitation.alternativeTitle.title
Definition

Full variant title of the article.

Cardinality1..1
Typemarkdown
Citation.pagination
Element IdCitation.pagination
Definition

Indicates the inclusive pages for the article cited.

Cardinality0..1
Citation.pagination.pageString
Element IdCitation.pagination.pageString
Definition

Used for full display of pagination.

Cardinality0..1
Typestring
Citation.pagination.firstPage
Element IdCitation.pagination.firstPage
Definition

Used for isolated representation of first page.

Cardinality0..1
Typestring
Citation.pagination.lastPage
Element IdCitation.pagination.lastPage
Definition

Used for isolated representation of last page.

Cardinality0..1
Typestring
Citation.articleUrl
Element IdCitation.articleUrl
Definition

Used for any URL for the article cited.

Cardinality0..*
Citation.articleUrl.type
Element IdCitation.articleUrl.type
Definition

Code the reason for different URLs, eg abstract and full-text.

Cardinality0..1
Terminology BindingArticleUrlType (Extensible)
TypeCodeableConcept
Citation.articleUrl.url
Element IdCitation.articleUrl.url
Definition

The specific URL.

Cardinality0..1
Typeuri
Citation.abstract
Element IdCitation.abstract
Definition

Abstract text, may include structured labels.

Cardinality0..1
Typemarkdown
Citation.abstractCopyright
Element IdCitation.abstractCopyright
Definition

Copyright information for the abstract text.

Cardinality0..1
Typemarkdown
Citation.alternativeAbstract
Element IdCitation.alternativeAbstract
Definition

Used for variant abstracts, such as translations.

Cardinality0..*
Citation.alternativeAbstract.type
Element IdCitation.alternativeAbstract.type
Definition

Used to express the reason for the variant abstract, such as language.

Cardinality0..1
Terminology BindingAlternativeTitleType (Extensible)
TypeCodeableConcept
Citation.alternativeAbstract.language
Element IdCitation.alternativeAbstract.language
Definition

Used to express the specific language.

Cardinality0..1
Terminology BindingCommon Languages (Preferred but limited to All Languages)
TypeCodeableConcept
Citation.alternativeAbstract.abstract
Element IdCitation.alternativeAbstract.abstract
Definition

Full variant abstract of the article.

Cardinality1..1
Typemarkdown
Citation.alternativeAbstract.abstractCopyright
Element IdCitation.alternativeAbstract.abstractCopyright
Definition

Copyright information for the abstract text.

Cardinality0..1
Typemarkdown
Citation.authorList
Element IdCitation.authorList
Definition

Personal and collective author names.

Cardinality0..1
Citation.authorList.complete
Element IdCitation.authorList.complete
Definition

Indicates if the list includes all authors, else “et al” should be appended for display.

Cardinality0..1
Typeboolean
Citation.authorList.author
Element IdCitation.authorList.author
Definition

An individual entity named in the author list.

Cardinality1..*
Citation.authorList.author.lastName
Element IdCitation.authorList.author.lastName
Definition

Surname or single name.

Cardinality0..1
Typestring
Citation.authorList.author.foreName
Element IdCitation.authorList.author.foreName
Definition

Remainder of name except for suffix.

Cardinality0..1
Typestring
Citation.authorList.author.suffix
Element IdCitation.authorList.author.suffix
Definition

Eg 2nd, 3rd, Jr, Sr.

Cardinality0..1
Typestring
Citation.authorList.author.initials
Element IdCitation.authorList.author.initials
Definition

Initials for forename.

Cardinality0..1
Typestring
Citation.authorList.author.collectiveName
Element IdCitation.authorList.author.collectiveName
Definition

Used for collective or corporate name as an author.

Cardinality0..1
Typestring
Citation.authorList.author.identifier
Element IdCitation.authorList.author.identifier
Definition

Author identifier, eg ORCID.

NoteThis is a business identifier, not a resource identifier (see discussion)
Cardinality0..*
TypeIdentifier
Citation.authorList.author.affiliationInfo
Element IdCitation.authorList.author.affiliationInfo
Definition

Organizational affiliation.

Cardinality0..*
Citation.authorList.author.affiliationInfo.affiliation
Element IdCitation.authorList.author.affiliationInfo.affiliation
Definition

Display for the organization.

Cardinality0..1
Typestring
Citation.authorList.author.affiliationInfo.role
Element IdCitation.authorList.author.affiliationInfo.role
Definition

Role.

Cardinality0..1
Typestring
Citation.authorList.author.affiliationInfo.identifier
Element IdCitation.authorList.author.affiliationInfo.identifier
Definition

Identifier for the organization.

NoteThis is a business identifier, not a resource identifier (see discussion)
Cardinality0..*
TypeIdentifier
Citation.authorList.author.address
Element IdCitation.authorList.author.address
Definition

Physical mailing address for the author.

Cardinality0..*
Typestring
Citation.authorList.author.telecom
Element IdCitation.authorList.author.telecom
Definition

Email or telephone contact methods for the author.

Cardinality0..*
TypeContactPoint
Citation.authorList.author.correspondingAuthor
Element IdCitation.authorList.author.correspondingAuthor
Definition

Indication of which author is the corresponding author for the article cited.

Cardinality0..1
Typeboolean
Citation.authorList.author.listOrder
Element IdCitation.authorList.author.listOrder
Definition

Used to code order of authors.

Cardinality0..1
TypepositiveInt
Citation.authorString
Element IdCitation.authorString
Definition

Used to record a display of the author list without separate coding for each author.

Cardinality0..*
Citation.authorString.source
Element IdCitation.authorString.source
Definition

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

Cardinality0..1
Terminology BindingAuthorStringSource (Extensible)
TypeCodeableConcept
Citation.authorString.value
Element IdCitation.authorString.value
Definition

The display string for the author list.

Cardinality1..1
Typestring
Citation.contributorList
Element IdCitation.contributorList
Definition

Personal and collective contributor names.

Cardinality0..1
Citation.contributorList.complete
Element IdCitation.contributorList.complete
Definition

Indicates if the list includes all contributors.

Cardinality0..1
Typeboolean
Citation.contributorList.contributor
Element IdCitation.contributorList.contributor
Definition

An individual entity named in the contributor list.

Cardinality1..*
Citation.contributorList.contributor.lastName
Element IdCitation.contributorList.contributor.lastName
Definition

Surname or single name.

Cardinality0..1
Typestring
Citation.contributorList.contributor.foreName
Element IdCitation.contributorList.contributor.foreName
Definition

Remainder of name except for suffix.

Cardinality0..1
Typestring
Citation.contributorList.contributor.suffix
Element IdCitation.contributorList.contributor.suffix
Definition

Eg 2nd, 3rd, Jr, Sr.

Cardinality0..1
Typestring
Citation.contributorList.contributor.initials
Element IdCitation.contributorList.contributor.initials
Definition

Initials for forename.

Cardinality0..1
Typestring
Citation.contributorList.contributor.collectiveName
Element IdCitation.contributorList.contributor.collectiveName
Definition

Used for collective or corporate name as a contributor.

Cardinality0..1
Typestring
Citation.contributorList.contributor.identifier
Element IdCitation.contributorList.contributor.identifier
Definition

Contributor identifier, eg ORCID.

NoteThis is a business identifier, not a resource identifier (see discussion)
Cardinality0..*
TypeIdentifier
Citation.contributorList.contributor.contribution
Element IdCitation.contributorList.contributor.contribution
Definition

The specific contributions.

Cardinality0..*
Terminology BindingCitationContribution (Extensible)
TypeCodeableConcept
Citation.contributorList.contributor.affiliationInfo
Element IdCitation.contributorList.contributor.affiliationInfo
Definition

Organizational affiliation.

Cardinality0..*
Citation.contributorList.contributor.affiliationInfo.affiliation
Element IdCitation.contributorList.contributor.affiliationInfo.affiliation
Definition

Display for the organization.

Cardinality0..1
Typestring
Citation.contributorList.contributor.affiliationInfo.role
Element IdCitation.contributorList.contributor.affiliationInfo.role
Definition

Role.

Cardinality0..1
Typestring
Citation.contributorList.contributor.affiliationInfo.identifier
Element IdCitation.contributorList.contributor.affiliationInfo.identifier
Definition

Identifier for the organization.

NoteThis is a business identifier, not a resource identifier (see discussion)
Cardinality0..*
TypeIdentifier
Citation.contributorList.contributor.listOrder
Element IdCitation.contributorList.contributor.listOrder
Definition

Used to code order of contributors.

Cardinality0..1
TypepositiveInt
Citation.articleLanguage
Element IdCitation.articleLanguage
Definition

The language in which the article is published.

Cardinality0..1
Terminology BindingCommon Languages (Preferred but limited to All Languages)
TypeCodeableConcept
Citation.alternativeForm
Element IdCitation.alternativeForm
Definition

Used to represent alternative forms of the article that are not separate citations.

Cardinality0..*
Citation.alternativeForm.publishingModel
Element IdCitation.alternativeForm.publishingModel
Definition

Identify the medium/media in which the cited article is published, eg print, electronic or print-electronic.

Cardinality0..1
Terminology BindingPublishingModelType (Extensible)
TypeCodeableConcept
Citation.alternativeForm.language
Element IdCitation.alternativeForm.language
Definition

Language in which the article is published.

Cardinality0..1
Terminology BindingCommon Languages (Preferred but limited to All Languages)
TypeCodeableConcept
Comments

Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

Citation.alternativeForm.journalIssue
Element IdCitation.alternativeForm.journalIssue
Definition

The specific issue in which the cited article resides.

Cardinality0..1
Citation.alternativeForm.journalIssue.citedMedium
Element IdCitation.alternativeForm.journalIssue.citedMedium
Definition

NLM codes Internet or Print.

Cardinality0..1
Terminology BindingJournalIssueMedium (Extensible)
TypeCodeableConcept
Citation.alternativeForm.journalIssue.volume
Element IdCitation.alternativeForm.journalIssue.volume
Definition

Volume number of journal in which the article is published.

Cardinality0..1
Typestring
Citation.alternativeForm.journalIssue.issue
Element IdCitation.alternativeForm.journalIssue.issue
Definition

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

Cardinality0..1
Typestring
Citation.alternativeForm.journalIssue.publicationDate
Element IdCitation.alternativeForm.journalIssue.publicationDate
Definition

Date on which the issue of the journal was published.

Cardinality0..1
Typestring
Citation.alternativeForm.pagination
Element IdCitation.alternativeForm.pagination
Definition

Indicates the inclusive pages for the article cited.

Cardinality0..1
Citation.alternativeForm.pagination.pageString
Element IdCitation.alternativeForm.pagination.pageString
Definition

Used for full display of pagination.

Cardinality0..1
Typestring
Citation.alternativeForm.pagination.firstPage
Element IdCitation.alternativeForm.pagination.firstPage
Definition

Used for isolated representation of first page.

Cardinality0..1
Typestring
Citation.alternativeForm.pagination.lastPage
Element IdCitation.alternativeForm.pagination.lastPage
Definition

Used for isolated representation of last page.

Cardinality0..1
Typestring
Citation.classifier
Element IdCitation.classifier
Definition

Used for many classifiers including PublicationType, CitationSubset, MeshHeading, Chemical.

Cardinality0..*
Terminology BindingCitationClassifier (Extensible)
TypeCodeableConcept
Citation.relatedArtifact
Element IdCitation.relatedArtifact
Definition

Used for referencing EvidenceReport resource.

Cardinality0..*
TypeRelatedArtifact
Citation.note
Element IdCitation.note
Definition

Used for general notes and annotations not coded elsewhere.

Cardinality0..*
TypeAnnotation
Citation.medlinePubMed
Element IdCitation.medlinePubMed
Definition

These elements are items with values assigned by MEDLINE or PubMed management.

Cardinality0..1
Citation.medlinePubMed.medlineState
Element IdCitation.medlinePubMed.medlineState
Definition

Used for status.

Cardinality0..1
Terminology BindingMedlinePubMedStatus (Extensible)
TypeCodeableConcept
Citation.medlinePubMed.owner
Element IdCitation.medlinePubMed.owner
Definition

Used for owner.

Cardinality0..1
Terminology BindingMedlinePubMedOwner (Extensible)
TypeCodeableConcept
Citation.medlinePubMed.pmid
Element IdCitation.medlinePubMed.pmid
Definition

PubMed ID.

Cardinality0..1
TypepositiveInt
Citation.medlinePubMed.pmidVersion
Element IdCitation.medlinePubMed.pmidVersion
Definition

PubMed ID Version.

Cardinality0..1
TypepositiveInt
Citation.medlinePubMed.dateCreated
Element IdCitation.medlinePubMed.dateCreated
Definition

Creation date.

Cardinality0..1
Typedate
Citation.medlinePubMed.dateCompleted
Element IdCitation.medlinePubMed.dateCompleted
Definition

Completion date.

Cardinality0..1
Typedate
Citation.medlinePubMed.dateRevised
Element IdCitation.medlinePubMed.dateRevised
Definition

Revision date.

Cardinality0..1
Typedate
Citation.medlinePubMed.pubMedPubDate
Element IdCitation.medlinePubMed.pubMedPubDate
Definition

Subcomponent of certainty.

Cardinality0..*
Citation.medlinePubMed.pubMedPubDate.publicationState
Element IdCitation.medlinePubMed.pubMedPubDate.publicationState
Definition

PubMed Publication Status.

Cardinality0..1
Terminology BindingPubMedPubStatus (Extensible)
TypeCodeableConcept
Citation.medlinePubMed.pubMedPubDate.date
Element IdCitation.medlinePubMed.pubMedPubDate.date
Definition

PubMed Publication Date.

Cardinality0..1
TypedateTime
Citation.medlinePubMed.publicationState
Element IdCitation.medlinePubMed.publicationState
Definition

Publication Status.

Cardinality0..1
Terminology BindingPubMedPubStatus (Extensible)
TypeCodeableConcept
Citation.medlinePubMed.relatedArticle
Element IdCitation.medlinePubMed.relatedArticle
Definition

Related article.

Cardinality0..*
Citation.medlinePubMed.relatedArticle.citationReference
Element IdCitation.medlinePubMed.relatedArticle.citationReference
Definition

Citation Resource for related article.

Cardinality0..1
TypeReference(Citation)
Citation.medlinePubMed.relatedArticle.citationMarkdown
Element IdCitation.medlinePubMed.relatedArticle.citationMarkdown
Definition

Citation string for related article.

Cardinality0..1
Typemarkdown
Citation.medlinePubMed.relatedArticle.identifier
Element IdCitation.medlinePubMed.relatedArticle.identifier
Definition

Identifier for related article.

NoteThis is a business identifier, not a resource identifier (see discussion)
Cardinality0..*
TypeIdentifier