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.

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.

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

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.

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.

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

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

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.

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

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

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.

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.

Support human navigation and code generation.

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.

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

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.

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

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

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

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

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.

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

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

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.

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

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

Who authored or created the citation record.

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.

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

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

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.

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

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

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

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

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

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.

Assist in searching for appropriate content.

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

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

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

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

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

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.

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

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').

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

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.

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

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

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

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

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.

If specified, this date follows the original approval date.

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

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

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.

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

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

Who entered the data for the citation record.

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

Who edited or revised the citation record.

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.

Who reviewed the citation record.

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

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

Who endorsed the citation record.

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

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

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

Format for display of the citation summary.

The human-readable display of the citation summary.

The assignment to an organizing scheme.

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

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

The specific classification value.

Used for general notes and annotations not coded elsewhere.

The status of the citation record.

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.

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

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.

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

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

When the status started and/or ended.

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

Artifact related to the citation record.

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.

The article or artifact being described.

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.

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

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/"

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

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

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

When the cited artifact was accessed.

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.

The defined version of the cited artifact.

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

The status of the cited artifact.

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

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

Either occurred or expected.

When the status started and/or ended.

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

The title details of the article or artifact.

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

Used to express the specific language of the title.

The title of the article or artifact.

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

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

Used to express the specific language of the abstract.

Abstract content.

Copyright notice for the abstract.

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

The component of the article or artifact.

The kind of component.

The specification of the component.

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

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

The artifact related to the cited artifact.

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.

The type of relationship to the related artifact.

Provides additional classifiers of the related artifact.

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

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

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

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

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.

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

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

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

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

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.

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

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.

The collection the cited article or artifact is published in.

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

Journals and newspapers are coded as Periodical.

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

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

ClinicalTrials.gov is a name of a database.

Name of or resource describing the publisher.

Geographic location of the publisher.

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.

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

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

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

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

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

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.

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

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

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

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

Entry number or identifier for inclusion in a database.

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.

Used for full display of pagination.

Used for isolated representation of first page.

Used for isolated representation of last page.

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

Copyright notice for the full article or artifact.

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

Used for any URL for the article or artifact cited.

A characterization of the object expected at the web location.

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

The specific URL.

Persistent URLs, like doi, are preferred.

The assignment to an organizing scheme.

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

The specific classification value.

Complex or externally created classification.

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.

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

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

Indication whether all authors are included in the entry content.

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

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

Used to report contributorship in individualized ways.

The identity of the individual contributor.

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.

For citation styles that use initials.

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.

Organization affiliated with the contributor.

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.

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

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.

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

Contributions with accounting for time or number.

The specific contribution.

The time that the contribution was made.

Whether the contributor is the corresponding contributor for the role.

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

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.

Used to retain order of authorship as structured data

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

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

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

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

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

Any additional information or content for the article or artifact.