Release 4B 5 Ballot

This page is part of the FHIR Specification (v4.3.0: R4B (v5.0.0-ballot: R5 Ballot - STU see ballot notes ). 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 icon Work Group Maturity Level : 0   Trial Use Security Category : Business Compartments : Not linked to any defined compartments

Detailed Descriptions for the elements in the Citation resource.

0..1 Comments humanName.family can match MEDLINE-based lastName (used for surname or single name), humanName.given can match MEDLINE-based forename (used for remainder of name except for suffix), humanName.suffix can match MEDLINE-based suffix (eg 2nd, 3rd, Jr, Sr).
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 DomainResource MetadataResource
Summary false
Invariants
Defined on this element
cnl-0 Warning Name should be usable as an identifier for the module by machine processing applications such as code generation name.exists() implies name.matches('[A-Z]([A-Za-z0-9_]){0,254}') 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 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.

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

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

Summary true
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.

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

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

Short Display Identifier for the Citation resource 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.

Summary true
Comments

May include DOI, PMID, PMCID, etc. This element will contain unique identifiers that support de-duplication of citations. This identifier can be valid for only one citation resource.

Citation.version
Element Id Citation.version
Definition

The identifier that is used to identify this version of the citation when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the citation 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
Note This is a business versionId, not a resource version id (see discussion )
Cardinality 0..1
Type string
Summary true
Comments

There may be different citation 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 with the format [url]|[version]. The version SHOULD NOT contain a '#' - see Business Version .

Citation.name
Element Id Citation.name
Definition

A natural language name identifying the citation. 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 (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-0 Warning Name should be usable as an identifier for the module by machine processing applications such as code generation name.exists() implies name.matches('[A-Z]([A-Za-z0-9_]){0,254}') 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.

Short Display Name for this citation (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.

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 citations that are appropriate for use versus not.

Summary true
Comments

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

Citation.experimental
Element Id Citation.experimental
Definition

A Boolean value to indicate that this citation 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.

Summary true
Comments

Allows filtering of citations that are appropriate for use versus not.

Citation.date
Element Id Citation.date
Definition

The date (and optionally time) when the citation was published. 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 changes.

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

Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the citation. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.

Citation.publisher
Element Id Citation.publisher
Definition

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

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

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

Summary true
Comments

Usually an organization but may be an individual. The publisher (or steward) of the citation is the organization or individual primarily responsible for the maintenance and upkeep of the citation. 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. 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 Resource
Cardinality 0..*
Type ContactDetail
Summary true
Comments

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

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 why the citation was built, 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 instances.

Short Display The context that the Citation Resource 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
Element Id Citation.jurisdiction
Definition

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

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

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

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, not for the cited artifact.

Short Display Use and/or publishing restrictions for the Citation, not for the cited artifact
Cardinality 0..1
Type markdown
Summary false
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 was approved by publisher
Cardinality 0..1
Type date
Summary false
Comments

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

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 was last reviewed
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 false
Comments

If specified, this date follows the original approval date.

Citation.effectivePeriod
Element Id Citation.effectivePeriod
Definition

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

Short Display When the citation 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 are or are expected to be used instead.

Summary true
Comments

The effective period for a citation 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 Id Citation.author
Definition

Who authored the Citation.

Short Display Who authored the Citation
Cardinality 0..*
Type ContactDetail
Summary false
Citation.editor
Element Id Citation.editor
Definition

Who edited the Citation.

Short Display Who edited the Citation
Cardinality 0..*
Type ContactDetail
Summary false
Citation.reviewer
Element Id Citation.reviewer
Definition

Who reviewed the Citation.

Short Display Who reviewed the Citation
Cardinality 0..*
Type ContactDetail
Summary false
Citation.endorser
Element Id Citation.endorser
Definition

Who endorsed the Citation.

Short Display Who endorsed the Citation
Cardinality 0..*
Type ContactDetail
Summary false
Citation.summary
Element Id Citation.summary
Definition

A human-readable display of the citation.

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

Format for display of the citation.

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

The human-readable display of the citation.

Short Display The human-readable display of the citation
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
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 CitationClassificationType ( Extensible )
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 CitationArtifactClassifier ( 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.

Short Display The status of the citation
Cardinality 0..*
Terminology Binding CitationStatusType ( Example )
Type CodeableConcept
Summary false
Citation.statusDate
Element Id Citation.statusDate
Definition

An effective date or period for a status of the citation.

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

Classification of the status.

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

Either occurred or expected.

Short Display Either occurred or expected
Cardinality 0..1
Type boolean
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.relatesTo Citation.relatedArtifact
Element Id Citation.relatesTo Citation.relatedArtifact
Definition

Artifact related to the Citation Resource.

Cardinality 0..* Summary false Citation.relatesTo.relationshipType Element Id Citation.relatesTo.relationshipType Definition Short Display How the Citation resource relates Artifact related to the target artifact. Cardinality 1..1 Terminology Binding ArtifactRelationshipType ( Extensible ) Type CodeableConcept Summary false Citation.relatesTo.targetClassifier Element Id Citation.relatesTo.targetClassifier Definition The clasification of the related artifact. Citation Resource
Cardinality 0..*
Terminology Binding CitationArtifactClassifier ( Example ) Type CodeableConcept RelatedArtifact
Summary false
Citation.relatesTo.target[x] Citation.citedArtifact
Element Id Citation.relatesTo.target[x] Citation.citedArtifact
Definition

The article or artifact that the Citation Resource is related to. being described.

Cardinality 1..1 Type uri | Identifier | Reference ( Any )| Attachment [x] Note See Choice of Data Types for further information about how to use [x] Summary false Citation.citedArtifact Element Id Citation.citedArtifact Definition Short Display The article or artifact being described. described
Cardinality 0..1
Summary false
Citation.citedArtifact.identifier
Element Id Citation.citedArtifact.identifier
Definition

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

Short Display 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 this citation.

Summary true
Comments

May include DOI, PMID, PMCID, etc. This element will contain unique identifiers that support de-duplication of citations. This identifier can be valid for only one citation resource.

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

A formal identifier that is used to identify things closely related to this citation.

Short Display May include trial registry identifiers
Cardinality 0..*
Type Identifier
Requirements

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

Summary true
Comments

May include trial registry identifiers, e.g. NCT04372602 from clinicaltrials.gov. This identifier can be valid for multiple citation resources.

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
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
Summary false
Citation.citedArtifact.version.value
Element Id Citation.citedArtifact.version.value
Definition

The version number or other version identifier.

Short Display The version number or other version identifier
Cardinality 1..1
Type string
Summary false
Citation.citedArtifact.version.baseCitation
Element Id Citation.citedArtifact.version.baseCitation
Definition

Citation for the main version of the cited artifact.

Short Display Citation for the main version of the cited artifact
Cardinality 0..1
Type Reference ( Citation )
Summary false
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 CitedArtifactStatusType ( Extensible )
Type CodeableConcept
Summary false
Citation.citedArtifact.statusDate
Element Id Citation.citedArtifact.statusDate
Definition

An effective date or period 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

Classification of the status.

Short Display Classification of the status
Cardinality 1..1
Terminology Binding CitedArtifactStatusType ( 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
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 or specific aspect for the title.

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

Used to express the specific language.

Short Display Used to express the specific language
Cardinality 0..1
Terminology Binding Common Languages ( Preferred )
Type CodeableConcept
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

Summary of the article or artifact.

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 or specific aspect for the abstract.

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

Used to express the specific language.

Short Display Used to express the specific language
Cardinality 0..1
Terminology Binding Common Languages ( Preferred )
Type CodeableConcept
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
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 CitedArtifactPartType ( 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.part.baseCitation
Element Id Citation.citedArtifact.part.baseCitation
Definition

The citation for the full article or artifact.

Short Display The citation for the full article or artifact
Cardinality 0..1
Type Reference ( Citation )
Summary false
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
Citation.citedArtifact.relatesTo.relationshipType Citation.citedArtifact.relatesTo.type
Element Id Citation.citedArtifact.relatesTo.relationshipType Citation.citedArtifact.relatesTo.type
Definition

How the cited artifact relates The type of relationship to the target 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 ArtifactRelationshipType RelatedArtifactTypeExpanded ( Extensible Required )
Type CodeableConcept code
Summary false
Citation.citedArtifact.relatesTo.targetClassifier Citation.citedArtifact.relatesTo.classifier
Element Id Citation.citedArtifact.relatesTo.targetClassifier Citation.citedArtifact.relatesTo.classifier
Definition

The clasification Provides additional classifiers of the related artifact.

Short Display Additional classifiers
Cardinality 0..*
Terminology Binding CitationArtifactClassifier ( Example Extensible )
Type CodeableConcept
Summary false
Citation.citedArtifact.relatesTo.target[x] Citation.citedArtifact.relatesTo.label
Element Id Citation.citedArtifact.relatesTo.target[x] Citation.citedArtifact.relatesTo.label
Definition

The article or artifact A short label that can be used to reference the cited citation from elsewhere in the containing artifact, such as a footnote index.

Short Display Short label
Cardinality 0..1
Type string
Summary false
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 is
Cardinality 0..1
Type string
Summary false
Citation.citedArtifact.relatesTo.citation
Element Id Citation.citedArtifact.relatesTo.citation
Definition

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

Short Display Bibliographic citation for the artifact
Cardinality 1..1 0..1
Type uri markdown | Identifier
Summary | Reference false
Comments

Additional structured information about citations should be captured as extensions.

( Any Citation.citedArtifact.relatesTo.document
Element Id Citation.citedArtifact.relatesTo.document
Definition

The document being referenced, represented as an attachment. This is exclusive with the resource element.

Short Display What document is being referenced
Cardinality )| 0..1
Type Attachment
[x] Note Summary See Choice of Data Types false
for further information about how 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 use [x] 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

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 PublishedInType ( 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 the publisher.

Short Display Name of 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.

Cardinality Short Display 0..1 Geographic location of the publisher
Type Cardinality string 0..1
Summary false Type Citation.citedArtifact.publicationForm.periodicRelease Element Id Citation.citedArtifact.publicationForm.periodicRelease Definition The specific issue in which the cited article resides. Cardinality string
Summary false
Citation.citedArtifact.publicationForm.periodicRelease.citedMedium Citation.citedArtifact.publicationForm.citedMedium
Element Id Citation.citedArtifact.publicationForm.periodicRelease.citedMedium Citation.citedArtifact.publicationForm.citedMedium
Definition

Describes the form of the medium cited. Common codes are "Internet" or "Print".

Short Display Internet or Print
Cardinality 0..1
Terminology Binding CitedMedium ( Extensible )
Type CodeableConcept
Summary false
Comments

National Library of Medicine uses the codes "Internet" or "Print".

Citation.citedArtifact.publicationForm.periodicRelease.volume Citation.citedArtifact.publicationForm.volume
Element Id Citation.citedArtifact.publicationForm.periodicRelease.volume Citation.citedArtifact.publicationForm.volume
Definition

Volume number of journal in which the article is published.

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

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

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

Defining the date Year on which the issue of the journal was published.

Cardinality 0..1 Summary false Citation.citedArtifact.publicationForm.periodicRelease.dateOfPublication.date Element Id Citation.citedArtifact.publicationForm.periodicRelease.dateOfPublication.date Definition Short Display Date Year on which the issue of the journal was published. published
Cardinality 0..1
Type date string
Summary false
Citation.citedArtifact.publicationForm.periodicRelease.dateOfPublication.year Citation.citedArtifact.publicationForm.publicationDateMonth
Element Id Citation.citedArtifact.publicationForm.periodicRelease.dateOfPublication.year Citation.citedArtifact.publicationForm.publicationDateMonth
Definition

Year Month on which the issue of the journal was published.

Cardinality 0..1 Type string Summary false Citation.citedArtifact.publicationForm.periodicRelease.dateOfPublication.month Element Id Citation.citedArtifact.publicationForm.periodicRelease.dateOfPublication.month Definition Short Display Month on which the issue of the journal was published. published
Cardinality 0..1
Type string
Summary false
Citation.citedArtifact.publicationForm.periodicRelease.dateOfPublication.day Citation.citedArtifact.publicationForm.publicationDateDay
Element Id Citation.citedArtifact.publicationForm.periodicRelease.dateOfPublication.day Citation.citedArtifact.publicationForm.publicationDateDay
Definition

Day on which the issue of the journal was published.

Short Display Day on which the issue of the journal was published
Cardinality 0..1
Type string
Summary false
Citation.citedArtifact.publicationForm.periodicRelease.dateOfPublication.season Citation.citedArtifact.publicationForm.publicationDateSeason
Element Id Citation.citedArtifact.publicationForm.periodicRelease.dateOfPublication.season Citation.citedArtifact.publicationForm.publicationDateSeason
Definition

Spring, Summer, Fall/Autumn, Winter.

Short Display Season on which the issue of the journal was published
Cardinality 0..1
Type string
Summary false
Citation.citedArtifact.publicationForm.periodicRelease.dateOfPublication.text Citation.citedArtifact.publicationForm.publicationDateText
Element Id Citation.citedArtifact.publicationForm.periodicRelease.dateOfPublication.text Citation.citedArtifact.publicationForm.publicationDateText
Definition

Text representation of the date of which the issue of the journal was published.

Short Display Text representation of the date of which the issue of the journal was 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 (which may differ from the journal issue publication date).

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
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
Citation.citedArtifact.publicationForm.language
Element Id Citation.citedArtifact.publicationForm.language
Definition

Language in which this form of the article is published.

Short Display Language in which this form of the article is published
Cardinality 0..*
Terminology Binding Common Languages ( Preferred )
Type CodeableConcept
Summary false
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.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
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.

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
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.type Citation.citedArtifact.webLocation.classifier
Element Id Citation.citedArtifact.webLocation.type Citation.citedArtifact.webLocation.classifier
Definition

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

Short Display Code the reason for different URLs, e.g. abstract and full-text
Cardinality 0..1 0..*
Terminology Binding ArticleUrlType ArtifactUrlClassifier ( Extensible )
Type CodeableConcept
Summary false
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 CitedArtifactClassificationType ( Extensible )
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 CitationArtifactClassifier ( Example )
Type CodeableConcept
Summary false
Citation.citedArtifact.classification.whoClassified Element Id Citation.citedArtifact.classification.whoClassified Definition Provenance and copyright of classification. Cardinality 0..1 Summary false Citation.citedArtifact.classification.whoClassified.person Element Id Citation.citedArtifact.classification.whoClassified.person Definition Person who created the classification. Cardinality 0..1 Type Reference ( Person | Practitioner ) Summary false Citation.citedArtifact.classification.whoClassified.organization Citation.citedArtifact.classification.artifactAssessment
Element Id Citation.citedArtifact.classification.whoClassified.organization Citation.citedArtifact.classification.artifactAssessment
Definition

Organization who Complex or externally created the classification.

Cardinality 0..1 Type Reference ( Organization ) Summary false Citation.citedArtifact.classification.whoClassified.publisher Element Id Citation.citedArtifact.classification.whoClassified.publisher Definition Short Display The publisher of the classification, not the publisher of the article Complex or artifact being cited. externally created classification
Cardinality 0..1 0..*
Type Reference ( Organization ArtifactAssessment )
Summary false
Citation.citedArtifact.classification.whoClassified.classifierCopyright Element Id Citation.citedArtifact.classification.whoClassified.classifierCopyright Definition Rights management statement for the classification. Cardinality 0..1 Type string Summary false Citation.citedArtifact.classification.whoClassified.freeToShare Element Id Citation.citedArtifact.classification.whoClassified.freeToShare Definition Acceptable to re-use the classification. Cardinality 0..1 Type boolean Summary false 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

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

Short Display Indicates if the list includes all authors and/or contributors
Cardinality 0..1
Type boolean
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 in the author list or contributor list.

Short Display An individual entity named in the list
Cardinality 0..*
Summary false
Comments

Used to report contributorship in individualized ways.

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

A name associated with The identity of the individual. individual entity.

Short Display The identity of the individual entity
Cardinality 0..1 1..1
Type HumanName Reference ( Practitioner | Organization )
Summary false
Citation.citedArtifact.contributorship.entry.initials Citation.citedArtifact.contributorship.entry.forenameInitials
Element Id Citation.citedArtifact.contributorship.entry.initials Citation.citedArtifact.contributorship.entry.forenameInitials
Definition

Initials for forename.

Cardinality 0..1 Type string Summary false Comments This element is used in Medline based citations, but not supported fully by FHIR HumanName datatype. Citation.citedArtifact.contributorship.entry.collectiveName Element Id Citation.citedArtifact.contributorship.entry.collectiveName Definition Short Display Used Initials for collective or corporate name as an author. forename
Cardinality 0..1
Type string
Summary false
Comments

This element is used in Medline based citations, but not supported fully by FHIR HumanName datatype.

Citation.citedArtifact.contributorship.entry.identifier Element Id Citation.citedArtifact.contributorship.entry.identifier Definition Unique person identifier. Note This is a business identifier, not a resource identifier (see discussion ) Cardinality 0..* Type Identifier Summary false Comments Avoids needing to disambiguate common last names or changes of name. ORCID is commonly used as author identifier. Citation.citedArtifact.contributorship.entry.affiliationInfo Citation.citedArtifact.contributorship.entry.affiliation
Element Id Citation.citedArtifact.contributorship.entry.affiliationInfo Citation.citedArtifact.contributorship.entry.affiliation
Definition

Organization affiliated with the entity.

Cardinality 0..* Summary false Citation.citedArtifact.contributorship.entry.affiliationInfo.affiliation Element Id Citation.citedArtifact.contributorship.entry.affiliationInfo.affiliation Definition Short Display for the organization. Cardinality 0..1 Type string Summary false Citation.citedArtifact.contributorship.entry.affiliationInfo.role Element Id Citation.citedArtifact.contributorship.entry.affiliationInfo.role Definition Role within the organization, such as professional title. Cardinality 0..1 Type string Summary false Citation.citedArtifact.contributorship.entry.affiliationInfo.identifier Element Id Citation.citedArtifact.contributorship.entry.affiliationInfo.identifier Definition Identifier for the organization. Note This is a business identifier, not a resource identifier (see discussion ) Cardinality 0..* Type Identifier Summary false Citation.citedArtifact.contributorship.entry.address Element Id Citation.citedArtifact.contributorship.entry.address Definition Physical mailing address for the author or contributor. Organizational affiliation
Cardinality 0..*
Type Address Summary false Citation.citedArtifact.contributorship.entry.telecom Element Id Citation.citedArtifact.contributorship.entry.telecom Definition Email or telephone contact methods for the author or contributor. Cardinality Reference 0..* Type ( Organization ContactPoint | PractitionerRole )
Summary false
Citation.citedArtifact.contributorship.entry.contributionType
Element Id Citation.citedArtifact.contributorship.entry.contributionType
Definition

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

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

The CreDiT taxonomy provides a way to encode contribution information inside article XML files. 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).

Short Display The role of the contributor (e.g. author, editor, reviewer)
Cardinality 0..1
Terminology Binding ContributorRole ( 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 ArtifactContributionInstanceType ( Extensible )
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

Indication of which contributor is the corresponding contributor for the role.

Short Display Indication of which contributor is the corresponding contributor for the role
Cardinality 0..1
Type boolean
Summary false
Citation.citedArtifact.contributorship.entry.listOrder Citation.citedArtifact.contributorship.entry.rankingOrder
Element Id Citation.citedArtifact.contributorship.entry.listOrder Citation.citedArtifact.contributorship.entry.rankingOrder
Definition

Used Provides a numerical ranking to code order represent the degree of authors. 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
Citation.citedArtifact.contributorship.summary
Element Id Citation.citedArtifact.contributorship.summary
Definition

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

Short Display Used to record a display of the author/contributor list without separate coding 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 Either authorList or contributorshipStatement
Cardinality 0..1
Terminology Binding ContributorSummaryType ( Extensible )
Type CodeableConcept
Summary false
Citation.citedArtifact.contributorship.summary.style
Element Id Citation.citedArtifact.contributorship.summary.style
Definition

The format for the display string.

Short Display The format for the display string
Cardinality 0..1
Terminology Binding ContributorSummaryStyle ( Extensible )
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 ContributorSummarySource ( Extensible )
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