Specyfikacja interoperacyjności prototypu SSIDL
0.1.1 - ci-build

Specyfikacja interoperacyjności prototypu SSIDL, published by Uniwersytet Medyczny w Łodzi. This guide is not an authorized publication; it is the continuous build for version 0.1.1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/SSIDL/ssidl-ig/ and changes regularly. See the Directory of published versions

Resource Profile: SsidlCitationSourceInfo - Detailed Descriptions

Draft as of 2025-08-28

Definitions for the ssidl-citation-sourceInfo resource profile.

Guidance on how to interpret the contents of this table can be foundhere

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

ShortA description of identification, location, or contributorship of a publication (article or artifact)
Control0..*
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantscnl-0: 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_]){1,254}$'))
2. Citation.implicitRules
Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

ShortA set of rules under which this content was created
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.

Control0..1
Typeuri
Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
4. Citation.contained
Definition

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

ShortContained, inline Resources
Comments

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.

Control0..*
This element is affected by the following invariants: dom-2, dom-4, dom-3, dom-5
TypeResource
Is Modifierfalse
Must Supportfalse
Summaryfalse
Alternate Namesinline resources, anonymous resources, contained resources
6. Citation.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Must Supportfalse
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
8. Citation.url
Definition

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

ShortCanonical identifier for this citation record, represented as a globally unique URI
Comments

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

Control0..01
Typeuri
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summarytrue
Requirements

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

Invariantscnl-1: URL should not contain | or # - these characters make processing canonical references problematic (exists() implies matches('^[^|# ]+$'))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
10. Citation.identifier
Definition

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

ShortIdentifier for the citation record itself
Comments

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

NoteThis is a business identifier, not a resource identifier (see discussion)
Control10..1*
TypeIdentifier
Is Modifierfalse
Must Supporttrue
Summarytrue
Requirements

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

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
12. Citation.identifier.use
Definition

The purpose of this identifier.

Shortusual | official | temp | secondary | old (If known)
Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Control0..01
BindingThe codes SHALL be taken from IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|5.0.0
(required to http://hl7.org/fhir/ValueSet/identifier-use|5.0.0)

Identifies the purpose for this identifier, if known .

Typecode
Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
14. Citation.identifier.type
Definition

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

ShortDescription of identifier
Comments

This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

Control0..01
BindingUnless not suitable, these codes SHALL be taken from IdentifierTypeCodeshttp://hl7.org/fhir/ValueSet/identifier-type
(extensible to http://hl7.org/fhir/ValueSet/identifier-type)

A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

TypeCodeableConcept
Is Modifierfalse
Summarytrue
Requirements

Allows users to make use of identifiers when the identifier system is not known.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
16. Citation.identifier.system
Definition

Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique.

ShortThe namespace for the identifier value
Comments

Identifier.system is always case sensitive.

Control10..1
Typeuri
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

ExampleGeneral: http://www.acme.com/identifiers/patient
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
18. Citation.identifier.value
Definition

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

ShortThe value that is unique
Comments

If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the http://hl7.org/fhir/StructureDefinition/rendered-value). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

Control10..1
This element is affected by the following invariants: ident-1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
ExampleGeneral: 123456
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
20. Citation.identifier.period
Definition

Time period during which identifier is/was valid for use.

ShortTime period when id is/was valid for use
Control0..01
TypePeriod
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
22. Citation.identifier.assigner
Definition

Organization that issued/manages the identifier.

ShortOrganization that issued id (may be just text)
Comments

The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

Control0..01
TypeReference(Organization)
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
24. Citation.version
Definition

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

ShortBusiness version of the citation record
Comments

There may be different citation record instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the citation record with the format [url]|[version]. The version SHOULD NOT contain a '#' - see Business Version.

NoteThis is a business version Id, not a resource version Id (see discussion)
Control0..01
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
26. Citation.versionAlgorithm[x]
Definition

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

ShortHow to compare versions
Comments

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

Control0..01
BindingUnless not suitable, these codes SHALL be taken from VersionAlgorithmhttp://hl7.org/fhir/ValueSet/version-algorithm
(extensible to http://hl7.org/fhir/ValueSet/version-algorithm)
TypeChoice of: string, Coding
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
28. Citation.name
Definition

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

ShortName for this citation record (computer friendly)
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.

Control0..01
This element is affected by the following invariants: cnl-0
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summarytrue
Requirements

Support human navigation and code generation.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
30. Citation.title
Definition

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

ShortName for this citation record (human friendly)
Comments

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

Control0..01
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
32. Citation.status
Definition

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

Shortdraft | active | retired | unknown
Comments

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

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


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.

Control1..1
BindingThe codes SHALL be taken from PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|5.0.0
(required to http://hl7.org/fhir/ValueSet/publication-status|5.0.0)
Typecode
Is Modifiertrue because This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Requirements

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

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
34. Citation.experimental
Definition

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

ShortFor testing purposes, not real usage
Comments

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

Control0..01
Typeboolean
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summarytrue
Requirements

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

Meaning if MissingIf absent, this resource is treated as though it is not experimental.
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
36. Citation.date
Definition

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

ShortDate last changed
Comments

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

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


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.

Control0..01
TypedateTime
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summarytrue
Alternate NamesRevision Date
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
38. Citation.publisher
Definition

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

ShortThe publisher of the citation record, not the publisher of the article or artifact being cited
Comments

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

Control0..01
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summarytrue
Requirements

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

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
40. Citation.contact
Definition

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

ShortContact details for the publisher of the citation record
Comments

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

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


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

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

Control0..0*
TypeContactDetail
Is Modifierfalse
Must Supportfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
42. Citation.description
Definition

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

ShortNatural language description of the citation
Comments

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

Control0..01
Typemarkdown
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
44. Citation.useContext
Definition

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

ShortThe context that the citation record content is intended to support
Comments

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

Control0..0*
TypeUsageContext
Is Modifierfalse
Must Supportfalse
Summarytrue
Requirements

Assist in searching for appropriate content.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
46. Citation.jurisdiction
Definition

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

ShortIntended jurisdiction for citation record (if applicable)
Comments

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

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

Control0..0*
BindingUnless not suitable, these codes SHALL be taken from JurisdictionValueSethttp://hl7.org/fhir/ValueSet/jurisdiction
(extensible to http://hl7.org/fhir/ValueSet/jurisdiction)
TypeCodeableConcept
Is Modifierfalse
Must Supportfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
48. Citation.purpose
Definition

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

ShortWhy this citation is defined
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.

Control0..01
Typemarkdown
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
50. Citation.copyright
Definition

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

ShortUse and/or publishing restrictions for the citation record, not for the cited artifact
Control0..01
Typemarkdown
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
52. Citation.copyrightLabel
Definition

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

ShortCopyright holder and year(s) for the ciation record, not for the cited artifact
Comments

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

Control0..01
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summaryfalse
Requirements

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

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
54. 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.

ShortWhen the citation record was approved by publisher
Comments

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

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


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.

Control0..01
Typedate
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
56. 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.

ShortWhen the citation record was last reviewed by the publisher
Comments

If specified, this date follows the original approval date.

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


If specified, this date follows the original approval date.

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

Control0..01
Typedate
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summaryfalse
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.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
58. Citation.effectivePeriod
Definition

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

ShortWhen the citation record is expected to be used
Comments

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

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


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.

Control0..01
TypePeriod
Is Modifierfalse
Must Supportfalse
Summarytrue
Requirements

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

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
60. Citation.author
Definition

Who authored or created the citation record.

ShortWho authored the citation record
Comments

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

Control0..0*
TypeContactDetail
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
62. Citation.editor
Definition

Who edited or revised the citation record.

ShortWho edited the citation record
Comments

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

Control0..0*
TypeContactDetail
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
64. Citation.reviewer
Definition

Who reviewed the citation record.

ShortWho reviewed the citation record
Comments

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

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


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.

Control0..0*
TypeContactDetail
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
66. Citation.endorser
Definition

Who endorsed the citation record.

ShortWho endorsed the citation record
Comments

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

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


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.

Control0..0*
TypeContactDetail
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
68. Citation.summary
Definition

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

ShortA human-readable display of key concepts to represent the citation
Control10..1*
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
70. Citation.summary.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
72. Citation.summary.style
Definition

Format for display of the citation summary.

ShortFormat for display of the citation summary
Control0..01
BindingUnless not suitable, these codes SHALL be taken from CitationSummaryStylehttp://hl7.org/fhir/ValueSet/citation-summary-style
(extensible to http://hl7.org/fhir/ValueSet/citation-summary-style)
TypeCodeableConcept
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
74. Citation.summary.text
Definition

The human-readable display of the citation summary.

ShortThe human-readable display of the citation summary
Control1..1
Typemarkdown
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
76. Citation.classification
Definition

The assignment to an organizing scheme.

ShortThe assignment to an organizing scheme
Comments

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

Control0..0*
TypeBackboneElement
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
79. Citation.currentState
Definition

The status of the citation record.

ShortThe status of the citation record
Comments

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

Control0..0*
BindingFor example codes, see CitationStatusTypehttp://hl7.org/fhir/ValueSet/citation-status-type
(example to http://hl7.org/fhir/ValueSet/citation-status-type)
TypeCodeableConcept
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
81. Citation.statusDate
Definition

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

ShortAn effective date or period for a status of the citation record
Comments

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

Control0..0*
TypeBackboneElement
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
86. Citation.relatedArtifact
Definition

Artifact related to the citation record.

ShortArtifact related to the citation record
Comments

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

Control0..0*
TypeRelatedArtifact
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
88. Citation.citedArtifact
Definition

The article or artifact being described.

ShortThe article or artifact being described
Control0..1
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
90. Citation.citedArtifact.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
92. Citation.citedArtifact.identifier
Definition

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

ShortUnique identifier. May include DOI, PMID, PMCID, etc
Comments

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

NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..0*
TypeIdentifier
Is Modifierfalse
Must Supportfalse
Summarytrue
Requirements

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

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
94. Citation.citedArtifact.relatedIdentifier
Definition

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

ShortIdentifier not unique to the cited artifact. May include trial registry identifiers
Comments

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

Control0..0*
TypeIdentifier
Is Modifierfalse
Must Supportfalse
Summarytrue
Requirements

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

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
96. Citation.citedArtifact.dateAccessed
Definition

When the cited artifact was accessed.

ShortWhen the cited artifact was accessed
Comments

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

Control0..01
TypedateTime
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
98. Citation.citedArtifact.version
Definition

The defined version of the cited artifact.

ShortThe defined version of the cited artifact
NoteThis is a business version Id, not a resource version Id (see discussion)
Control0..01
TypeBackboneElement
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
102. Citation.citedArtifact.currentState
Definition

The status of the cited artifact.

ShortThe status of the cited artifact
Control0..0*
BindingUnless not suitable, these codes SHALL be taken from CitedArtifactStatusTypehttp://hl7.org/fhir/ValueSet/cited-artifact-status-type
(extensible to http://hl7.org/fhir/ValueSet/cited-artifact-status-type)
TypeCodeableConcept
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
104. Citation.citedArtifact.statusDate
Definition

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

ShortAn effective date or period for a status of the cited artifact
Control0..0*
TypeBackboneElement
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
109. Citation.citedArtifact.title
Definition

The title details of the article or artifact.

ShortThe title details of the article or artifact
Control0..0*
TypeBackboneElement
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
113. Citation.citedArtifact.abstract
Definition

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

ShortSummary of the article or artifact
Control0..0*
TypeBackboneElement
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
117. Citation.citedArtifact.part
Definition

The component of the article or artifact.

ShortThe component of the article or artifact
Control0..01
TypeBackboneElement
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
120. Citation.citedArtifact.relatesTo
Definition

The artifact related to the cited artifact.

ShortThe artifact related to the cited artifact
Comments

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

Control0..0*
TypeBackboneElement
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
124. Citation.citedArtifact.publicationForm
Definition

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

ShortIf multiple, used to represent alternative forms of the article that are not separate citations
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.

Control0..0*
TypeBackboneElement
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
127. Citation.citedArtifact.webLocation
Definition

Used for any URL for the article or artifact cited.

ShortUsed for any URL for the article or artifact cited
Control10..1*
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
129. Citation.citedArtifact.webLocation.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
131. Citation.citedArtifact.webLocation.classifier
Definition

A characterization of the object expected at the web location.

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

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

Control0..0*
BindingUnless not suitable, these codes SHALL be taken from ArtifactUrlClassifierhttp://hl7.org/fhir/ValueSet/artifact-url-classifier
(extensible to http://hl7.org/fhir/ValueSet/artifact-url-classifier)
TypeCodeableConcept
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
133. Citation.citedArtifact.webLocation.url
Definition

The specific URL.

ShortThe specific URL
Comments

Persistent URLs, like doi, are preferred.

Control10..1
Typeuri
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
135. Citation.citedArtifact.classification
Definition

The assignment to an organizing scheme.

ShortThe assignment to an organizing scheme
Control0..0*
TypeBackboneElement
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
138. Citation.citedArtifact.contributorship
Definition

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

ShortAttribution of authors and other contributors
Control0..01
TypeBackboneElement
Is Modifierfalse
Must Supportfalse
Summaryfalse
Requirements

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

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
141. Citation.citedArtifact.note
Definition

Any additional information or content for the article or artifact.

ShortAny additional information or content for the article or artifact
Control0..0*
TypeAnnotation
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

Guidance on how to interpret the contents of this table can be foundhere

0. Citation
2. Citation.url
Control0..0
4. Citation.identifier
NoteThis is a business identifier, not a resource identifier (see discussion)
Control1..1
Must Supporttrue
6. Citation.identifier.use
Control0..0
8. Citation.identifier.type
Control0..0
10. Citation.identifier.system
Control1..?
Must Supporttrue
12. Citation.identifier.value
Control1..?
Must Supporttrue
14. Citation.identifier.period
Control0..0
16. Citation.identifier.assigner
Control0..0
18. Citation.version
NoteThis is a business version Id, not a resource version Id (see discussion)
Control0..0
20. Citation.versionAlgorithm[x]
Control0..0
22. Citation.name
Control0..0
24. Citation.title
Control0..0
26. Citation.status
Must Supporttrue
28. Citation.experimental
Control0..0
30. Citation.date
Control0..0
32. Citation.publisher
Control0..0
34. Citation.contact
Control0..0
36. Citation.description
Control0..0
38. Citation.useContext
Control0..0
40. Citation.jurisdiction
Control0..0
42. Citation.purpose
Control0..0
44. Citation.copyright
Control0..0
46. Citation.copyrightLabel
Control0..0
48. Citation.approvalDate
Control0..0
50. Citation.lastReviewDate
Control0..0
52. Citation.effectivePeriod
Control0..0
54. Citation.author
Control0..0
56. Citation.editor
Control0..0
58. Citation.reviewer
Control0..0
60. Citation.endorser
Control0..0
62. Citation.summary
Control1..1
Must Supporttrue
64. Citation.summary.style
Control0..0
66. Citation.summary.text
Must Supporttrue
68. Citation.classification
Control0..0
70. Citation.currentState
Control0..0
72. Citation.statusDate
Control0..0
74. Citation.relatedArtifact
Control0..0
76. Citation.citedArtifact
Must Supporttrue
78. Citation.citedArtifact.identifier
NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..0
80. Citation.citedArtifact.relatedIdentifier
Control0..0
82. Citation.citedArtifact.dateAccessed
Control0..0
84. Citation.citedArtifact.version
NoteThis is a business version Id, not a resource version Id (see discussion)
Control0..0
86. Citation.citedArtifact.currentState
Control0..0
88. Citation.citedArtifact.statusDate
Control0..0
90. Citation.citedArtifact.title
Control0..0
92. Citation.citedArtifact.abstract
Control0..0
94. Citation.citedArtifact.part
Control0..0
96. Citation.citedArtifact.relatesTo
Control0..0
98. Citation.citedArtifact.publicationForm
Control0..0
100. Citation.citedArtifact.webLocation
Control1..1
Must Supporttrue
102. Citation.citedArtifact.webLocation.classifier
Control0..0
104. Citation.citedArtifact.webLocation.url
Control1..?
Must Supporttrue
106. Citation.citedArtifact.classification
Control0..0
108. Citation.citedArtifact.contributorship
Control0..0
110. Citation.citedArtifact.note
Control0..0

Guidance on how to interpret the contents of this table can be foundhere

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

ShortA description of identification, location, or contributorship of a publication (article or artifact)
Control0..*
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantscnl-0: 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_]){1,254}$'))
2. Citation.id
Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

ShortLogical id of this artifact
Comments

Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.

Control0..1
Typeid
Is Modifierfalse
Must Supportfalse
Summarytrue
4. Citation.meta
Definition

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

ShortMetadata about the resource
Control0..1
TypeMeta
Is Modifierfalse
Must Supportfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
6. Citation.implicitRules
Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

ShortA set of rules under which this content was created
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.

Control0..1
Typeuri
Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
8. Citation.language
Definition

The base language in which the resource is written.

ShortLanguage of the resource content
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).

Control0..1
BindingThe codes SHALL be taken from AllLanguages
(required to http://hl7.org/fhir/ValueSet/all-languages|5.0.0)

IETF language tag for a human language

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
10. Citation.text
Definition

A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

ShortText summary of the resource, for human interpretation
Comments

Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

Control0..1
This element is affected by the following invariants: dom-6
TypeNarrative
Is Modifierfalse
Must Supportfalse
Summaryfalse
Alternate Namesnarrative, html, xhtml, display
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
12. Citation.contained
Definition

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

ShortContained, inline Resources
Comments

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.

Control0..*
This element is affected by the following invariants: dom-2, dom-4, dom-3, dom-5
TypeResource
Is Modifierfalse
Must Supportfalse
Summaryfalse
Alternate Namesinline resources, anonymous resources, contained resources
14. Citation.extension
Definition

May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifierfalse
Must Supportfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
16. Citation.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Must Supportfalse
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
18. Citation.url
Definition

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

ShortCanonical identifier for this citation record, represented as a globally unique URI
Comments

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

Control0..0
Typeuri
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summarytrue
Requirements

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

Invariantscnl-1: URL should not contain | or # - these characters make processing canonical references problematic (exists() implies matches('^[^|# ]+$'))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
20. Citation.identifier
Definition

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

ShortIdentifier for the citation record itself
Comments

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

NoteThis is a business identifier, not a resource identifier (see discussion)
Control1..1
TypeIdentifier
Is Modifierfalse
Must Supporttrue
Summarytrue
Requirements

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

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
22. Citation.identifier.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
This element is affected by the following invariants: ele-1
Typeid
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
24. Citation.identifier.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Citation.identifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 26. Citation.identifier.use
    Definition

    The purpose of this identifier.

    Shortusual | official | temp | secondary | old (If known)
    Comments

    Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

    Control0..0
    BindingThe codes SHALL be taken from IdentifierUse
    (required to http://hl7.org/fhir/ValueSet/identifier-use|5.0.0)

    Identifies the purpose for this identifier, if known .

    Typecode
    Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Requirements

    Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    28. Citation.identifier.type
    Definition

    A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

    ShortDescription of identifier
    Comments

    This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

    Control0..0
    BindingUnless not suitable, these codes SHALL be taken from IdentifierTypeCodes
    (extensible to http://hl7.org/fhir/ValueSet/identifier-type)

    A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

    TypeCodeableConcept
    Is Modifierfalse
    Summarytrue
    Requirements

    Allows users to make use of identifiers when the identifier system is not known.

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    30. Citation.identifier.system
    Definition

    Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique.

    ShortThe namespace for the identifier value
    Comments

    Identifier.system is always case sensitive.

    Control1..1
    Typeuri
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Must Supporttrue
    Summarytrue
    Requirements

    There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

    ExampleGeneral: http://www.acme.com/identifiers/patient
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    32. Citation.identifier.value
    Definition

    The portion of the identifier typically relevant to the user and which is unique within the context of the system.

    ShortThe value that is unique
    Comments

    If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the http://hl7.org/fhir/StructureDefinition/rendered-value). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

    Control1..1
    This element is affected by the following invariants: ident-1
    Typestring
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Must Supporttrue
    Summarytrue
    ExampleGeneral: 123456
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    34. Citation.identifier.period
    Definition

    Time period during which identifier is/was valid for use.

    ShortTime period when id is/was valid for use
    Control0..0
    TypePeriod
    Is Modifierfalse
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    36. Citation.identifier.assigner
    Definition

    Organization that issued/manages the identifier.

    ShortOrganization that issued id (may be just text)
    Comments

    The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

    Control0..0
    TypeReference(Organization)
    Is Modifierfalse
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    38. Citation.version
    Definition

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

    ShortBusiness version of the citation record
    Comments

    There may be different citation record instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the citation record with the format [url]|[version]. The version SHOULD NOT contain a '#' - see Business Version.

    NoteThis is a business version Id, not a resource version Id (see discussion)
    Control0..0
    Typestring
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Must Supportfalse
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    40. Citation.versionAlgorithm[x]
    Definition

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

    ShortHow to compare versions
    Comments

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

    Control0..0
    BindingUnless not suitable, these codes SHALL be taken from VersionAlgorithm
    (extensible to http://hl7.org/fhir/ValueSet/version-algorithm)
    TypeChoice of: string, Coding
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Must Supportfalse
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    42. Citation.name
    Definition

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

    ShortName for this citation record (computer friendly)
    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.

    Control0..0
    This element is affected by the following invariants: cnl-0
    Typestring
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Must Supportfalse
    Summarytrue
    Requirements

    Support human navigation and code generation.

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    44. Citation.title
    Definition

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

    ShortName for this citation record (human friendly)
    Comments

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

    Control0..0
    Typestring
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Must Supportfalse
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    46. Citation.status
    Definition

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

    Shortdraft | active | retired | unknown
    Comments

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

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

    Control1..1
    BindingThe codes SHALL be taken from PublicationStatus
    (required to http://hl7.org/fhir/ValueSet/publication-status|5.0.0)
    Typecode
    Is Modifiertrue because This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Must Supporttrue
    Summarytrue
    Requirements

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

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    48. Citation.experimental
    Definition

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

    ShortFor testing purposes, not real usage
    Comments

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

    Control0..0
    Typeboolean
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Must Supportfalse
    Summarytrue
    Requirements

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

    Meaning if MissingIf absent, this resource is treated as though it is not experimental.
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    50. Citation.date
    Definition

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

    ShortDate last changed
    Comments

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

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

    Control0..0
    TypedateTime
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Must Supportfalse
    Summarytrue
    Alternate NamesRevision Date
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    52. Citation.publisher
    Definition

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

    ShortThe publisher of the citation record, not the publisher of the article or artifact being cited
    Comments

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

    Control0..0
    Typestring
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Must Supportfalse
    Summarytrue
    Requirements

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

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    54. Citation.contact
    Definition

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

    ShortContact details for the publisher of the citation record
    Comments

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

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

    Control0..0
    TypeContactDetail
    Is Modifierfalse
    Must Supportfalse
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    56. Citation.description
    Definition

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

    ShortNatural language description of the citation
    Comments

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

    Control0..0
    Typemarkdown
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Must Supportfalse
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    58. Citation.useContext
    Definition

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

    ShortThe context that the citation record content is intended to support
    Comments

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

    Control0..0
    TypeUsageContext
    Is Modifierfalse
    Must Supportfalse
    Summarytrue
    Requirements

    Assist in searching for appropriate content.

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    60. Citation.jurisdiction
    Definition

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

    ShortIntended jurisdiction for citation record (if applicable)
    Comments

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

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

    Control0..0
    BindingUnless not suitable, these codes SHALL be taken from JurisdictionValueSet
    (extensible to http://hl7.org/fhir/ValueSet/jurisdiction)
    TypeCodeableConcept
    Is Modifierfalse
    Must Supportfalse
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    62. Citation.purpose
    Definition

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

    ShortWhy this citation is defined
    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.

    Control0..0
    Typemarkdown
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Must Supportfalse
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    64. Citation.copyright
    Definition

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

    ShortUse and/or publishing restrictions for the citation record, not for the cited artifact
    Control0..0
    Typemarkdown
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Must Supportfalse
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    66. Citation.copyrightLabel
    Definition

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

    ShortCopyright holder and year(s) for the ciation record, not for the cited artifact
    Comments

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

    Control0..0
    Typestring
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Must Supportfalse
    Summaryfalse
    Requirements

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

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    68. 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.

    ShortWhen the citation record was approved by publisher
    Comments

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

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

    Control0..0
    Typedate
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Must Supportfalse
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    70. 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.

    ShortWhen the citation record was last reviewed by the publisher
    Comments

    If specified, this date follows the original approval date.

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

    Control0..0
    Typedate
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Must Supportfalse
    Summaryfalse
    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.

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    72. Citation.effectivePeriod
    Definition

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

    ShortWhen the citation record is expected to be used
    Comments

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

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

    Control0..0
    TypePeriod
    Is Modifierfalse
    Must Supportfalse
    Summarytrue
    Requirements

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

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    74. Citation.author
    Definition

    Who authored or created the citation record.

    ShortWho authored the citation record
    Comments

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

    Control0..0
    TypeContactDetail
    Is Modifierfalse
    Must Supportfalse
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    76. Citation.editor
    Definition

    Who edited or revised the citation record.

    ShortWho edited the citation record
    Comments

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

    Control0..0
    TypeContactDetail
    Is Modifierfalse
    Must Supportfalse
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    78. Citation.reviewer
    Definition

    Who reviewed the citation record.

    ShortWho reviewed the citation record
    Comments

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

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

    Control0..0
    TypeContactDetail
    Is Modifierfalse
    Must Supportfalse
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    80. Citation.endorser
    Definition

    Who endorsed the citation record.

    ShortWho endorsed the citation record
    Comments

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

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

    Control0..0
    TypeContactDetail
    Is Modifierfalse
    Must Supportfalse
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    82. Citation.summary
    Definition

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

    ShortA human-readable display of key concepts to represent the citation
    Control1..1
    TypeBackboneElement
    Is Modifierfalse
    Must Supporttrue
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    84. Citation.summary.id
    Definition

    Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

    ShortUnique id for inter-element referencing
    Control0..1
    This element is affected by the following invariants: ele-1
    Typestring
    Is Modifierfalse
    XML FormatIn the XML format, this property is represented as an attribute.
    Summaryfalse
    86. Citation.summary.extension
    Definition

    May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

    ShortAdditional content defined by implementations
    Comments

    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

    Control0..*
    TypeExtension
    Is Modifierfalse
    Summaryfalse
    Alternate Namesextensions, user content
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    88. Citation.summary.modifierExtension
    Definition

    May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

    Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

    ShortExtensions that cannot be ignored even if unrecognized
    Comments

    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

    Control0..*
    TypeExtension
    Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
    Summarytrue
    Requirements

    Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

    Alternate Namesextensions, user content, modifiers
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    90. Citation.summary.style
    Definition

    Format for display of the citation summary.

    ShortFormat for display of the citation summary
    Control0..0
    BindingUnless not suitable, these codes SHALL be taken from CitationSummaryStyle
    (extensible to http://hl7.org/fhir/ValueSet/citation-summary-style)
    TypeCodeableConcept
    Is Modifierfalse
    Must Supportfalse
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    92. Citation.summary.text
    Definition

    The human-readable display of the citation summary.

    ShortThe human-readable display of the citation summary
    Control1..1
    Typemarkdown
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Must Supporttrue
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    94. Citation.classification
    Definition

    The assignment to an organizing scheme.

    ShortThe assignment to an organizing scheme
    Comments

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

    Control0..0
    TypeBackboneElement
    Is Modifierfalse
    Must Supportfalse
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    101. Citation.note
    Definition

    Used for general notes and annotations not coded elsewhere.

    ShortUsed for general notes and annotations not coded elsewhere
    Control0..*
    TypeAnnotation
    Is Modifierfalse
    Must Supportfalse
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    103. Citation.currentState
    Definition

    The status of the citation record.

    ShortThe status of the citation record
    Comments

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

    Control0..0
    BindingFor example codes, see CitationStatusType
    (example to http://hl7.org/fhir/ValueSet/citation-status-type)
    TypeCodeableConcept
    Is Modifierfalse
    Must Supportfalse
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    105. Citation.statusDate
    Definition

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

    ShortAn effective date or period for a status of the citation record
    Comments

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

    Control0..0
    TypeBackboneElement
    Is Modifierfalse
    Must Supportfalse
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    113. Citation.relatedArtifact
    Definition

    Artifact related to the citation record.

    ShortArtifact related to the citation record
    Comments

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

    Control0..0
    TypeRelatedArtifact
    Is Modifierfalse
    Must Supportfalse
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    115. Citation.citedArtifact
    Definition

    The article or artifact being described.

    ShortThe article or artifact being described
    Control0..1
    TypeBackboneElement
    Is Modifierfalse
    Must Supporttrue
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    117. Citation.citedArtifact.id
    Definition

    Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

    ShortUnique id for inter-element referencing
    Control0..1
    This element is affected by the following invariants: ele-1
    Typestring
    Is Modifierfalse
    XML FormatIn the XML format, this property is represented as an attribute.
    Summaryfalse
    119. Citation.citedArtifact.extension
    Definition

    May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

    ShortAdditional content defined by implementations
    Comments

    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

    Control0..*
    TypeExtension
    Is Modifierfalse
    Summaryfalse
    Alternate Namesextensions, user content
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    121. Citation.citedArtifact.modifierExtension
    Definition

    May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

    Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

    ShortExtensions that cannot be ignored even if unrecognized
    Comments

    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

    Control0..*
    TypeExtension
    Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
    Summarytrue
    Requirements

    Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

    Alternate Namesextensions, user content, modifiers
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    123. Citation.citedArtifact.identifier
    Definition

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

    ShortUnique identifier. May include DOI, PMID, PMCID, etc
    Comments

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

    NoteThis is a business identifier, not a resource identifier (see discussion)
    Control0..0
    TypeIdentifier
    Is Modifierfalse
    Must Supportfalse
    Summarytrue
    Requirements

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

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    125. Citation.citedArtifact.relatedIdentifier
    Definition

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

    ShortIdentifier not unique to the cited artifact. May include trial registry identifiers
    Comments

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

    Control0..0
    TypeIdentifier
    Is Modifierfalse
    Must Supportfalse
    Summarytrue
    Requirements

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

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    127. Citation.citedArtifact.dateAccessed
    Definition

    When the cited artifact was accessed.

    ShortWhen the cited artifact was accessed
    Comments

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

    Control0..0
    TypedateTime
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Must Supportfalse
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    129. Citation.citedArtifact.version
    Definition

    The defined version of the cited artifact.

    ShortThe defined version of the cited artifact
    NoteThis is a business version Id, not a resource version Id (see discussion)
    Control0..0
    TypeBackboneElement
    Is Modifierfalse
    Must Supportfalse
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    136. Citation.citedArtifact.currentState
    Definition

    The status of the cited artifact.

    ShortThe status of the cited artifact
    Control0..0
    BindingUnless not suitable, these codes SHALL be taken from CitedArtifactStatusType
    (extensible to http://hl7.org/fhir/ValueSet/cited-artifact-status-type)
    TypeCodeableConcept
    Is Modifierfalse
    Must Supportfalse
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    138. Citation.citedArtifact.statusDate
    Definition

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

    ShortAn effective date or period for a status of the cited artifact
    Control0..0
    TypeBackboneElement
    Is Modifierfalse
    Must Supportfalse
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    146. Citation.citedArtifact.title
    Definition

    The title details of the article or artifact.

    ShortThe title details of the article or artifact
    Control0..0
    TypeBackboneElement
    Is Modifierfalse
    Must Supportfalse
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    154. Citation.citedArtifact.abstract
    Definition

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

    ShortSummary of the article or artifact
    Control0..0
    TypeBackboneElement
    Is Modifierfalse
    Must Supportfalse
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    163. Citation.citedArtifact.part
    Definition

    The component of the article or artifact.

    ShortThe component of the article or artifact
    Control0..0
    TypeBackboneElement
    Is Modifierfalse
    Must Supportfalse
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    171. Citation.citedArtifact.relatesTo
    Definition

    The artifact related to the cited artifact.

    ShortThe artifact related to the cited artifact
    Comments

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

    Control0..0
    TypeBackboneElement
    Is Modifierfalse
    Must Supportfalse
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    184. Citation.citedArtifact.publicationForm
    Definition

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

    ShortIf multiple, used to represent alternative forms of the article that are not separate citations
    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.

    Control0..0
    TypeBackboneElement
    Is Modifierfalse
    Must Supportfalse
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    212. Citation.citedArtifact.webLocation
    Definition

    Used for any URL for the article or artifact cited.

    ShortUsed for any URL for the article or artifact cited
    Control1..1
    TypeBackboneElement
    Is Modifierfalse
    Must Supporttrue
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    214. Citation.citedArtifact.webLocation.id
    Definition

    Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

    ShortUnique id for inter-element referencing
    Control0..1
    This element is affected by the following invariants: ele-1
    Typestring
    Is Modifierfalse
    XML FormatIn the XML format, this property is represented as an attribute.
    Summaryfalse
    216. Citation.citedArtifact.webLocation.extension
    Definition

    May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

    ShortAdditional content defined by implementations
    Comments

    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

    Control0..*
    TypeExtension
    Is Modifierfalse
    Summaryfalse
    Alternate Namesextensions, user content
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    218. Citation.citedArtifact.webLocation.modifierExtension
    Definition

    May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

    Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

    ShortExtensions that cannot be ignored even if unrecognized
    Comments

    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

    Control0..*
    TypeExtension
    Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
    Summarytrue
    Requirements

    Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

    Alternate Namesextensions, user content, modifiers
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    220. Citation.citedArtifact.webLocation.classifier
    Definition

    A characterization of the object expected at the web location.

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

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

    Control0..0
    BindingUnless not suitable, these codes SHALL be taken from ArtifactUrlClassifier
    (extensible to http://hl7.org/fhir/ValueSet/artifact-url-classifier)
    TypeCodeableConcept
    Is Modifierfalse
    Must Supportfalse
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    222. Citation.citedArtifact.webLocation.url
    Definition

    The specific URL.

    ShortThe specific URL
    Comments

    Persistent URLs, like doi, are preferred.

    Control1..1
    Typeuri
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Must Supporttrue
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    224. Citation.citedArtifact.classification
    Definition

    The assignment to an organizing scheme.

    ShortThe assignment to an organizing scheme
    Control0..0
    TypeBackboneElement
    Is Modifierfalse
    Must Supportfalse
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    232. Citation.citedArtifact.contributorship
    Definition

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

    ShortAttribution of authors and other contributors
    Control0..0
    TypeBackboneElement
    Is Modifierfalse
    Must Supportfalse
    Summaryfalse
    Requirements

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

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    263. Citation.citedArtifact.note
    Definition

    Any additional information or content for the article or artifact.

    ShortAny additional information or content for the article or artifact
    Control0..0
    TypeAnnotation
    Is Modifierfalse
    Must Supportfalse
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))