Profile_R5_Citation_R4 - Definitions - Extensions for Using Data Elements from FHIR R5 in FHIR R4 v0.1.0

Extensions for Using Data Elements from FHIR R5 in FHIR R4 - Downloaded Version null See the Directory of published versions

Resource Profile: Profile_R5_Citation_R4 - Detailed Descriptions

Page standards status: Trial-use

Maturity Level: 0

Definitions for the profile-Citation resource profile.

Key Elements Table
Differential Elements Table
Snapshot Elements Table

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

0. Basic
Definition	Basic is used for handling concepts not yet defined in FHIR, narrative-only resources that don't map to an existing resource, and custom resources not appropriate for inclusion in the FHIR specification.
Short	Resource for non-supported content
Control	0..*
Is Modifier	false
Summary	false
Alternate Names	Z-resource, Extension-resource, Custom-resource
Invariants	dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (`contained.contained.empty()`) dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (`contained.where((('#'+id in (%resource.descendants().reference \| %resource.descendants().as(canonical) \| %resource.descendants().as(uri) \| %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()`) dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (`contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()`) dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (`contained.meta.security.empty()`) dom-6: A resource should have narrative for robust management (text.`div`.exists()) dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty()) dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (contained.where((('#'+id in (%resource.descendants().reference \| %resource.descendants().as(canonical) \| %resource.descendants().as(uri) \| %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()) dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()) dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty()) dom-6: A resource should have narrative for robust management (text.`div`.exists())
2. Basic.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.
Short	A 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 it's narrative along with other profiles, value sets, etc.
Control	0..1
Type	uri
Is Modifier	true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
Summary	true
Invariants	ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
4. Basic.extension
Definition	An Extension 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 manageable, 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.
Short	ExtensionAdditional 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.
Control	0..*
Type	Extension
Is Modifier	false
Summary	false
Alternate Names	extensions, user content
Invariants	ele-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()`) ele-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())
Slicing	This element introduces a set of slices on `Basic.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
6. Basic.extension:url
Slice Name	url
Definition	R5: `Citation.url` (new:uri)
Short	R5: Canonical identifier for this citation record, represented as a globally unique URI (new)
Comments	Element `Citation.url` is not mapped to FHIR R4, since FHIR R5 `Citation` is not mapped. Element `Citation.url` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). 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.
Control	0..1 This element is affected by the following invariants: ele-1
Type	Extension(R5: Canonical identifier for this citation record, represented as a globally unique URI (new)) (Extension Type: uri)
Is Modifier	false
Summary	false
Invariants	ele-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()`) ele-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. Basic.extension:version
Slice Name	version
Definition	R5: `Citation.version` (new:string)
Short	R5: Business version of the citation record (new)
Comments	Element `Citation.version` is not mapped to FHIR R4, since FHIR R5 `Citation` is not mapped. Element `Citation.version` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). 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.
Control	0..1 This element is affected by the following invariants: ele-1
Type	Extension(R5: Business version of the citation record (new)) (Extension Type: string)
Is Modifier	false
Summary	false
Invariants	ele-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()`) ele-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())
10. Basic.extension:versionAlgorithm
Slice Name	versionAlgorithm
Definition	R5: `Citation.versionAlgorithm[x]` (new:Coding, string)
Short	R5: How to compare versions (new)
Comments	Element `Citation.versionAlgorithm[x]` is not mapped to FHIR R4, since FHIR R5 `Citation` is not mapped. Element `Citation.versionAlgorithm[x]` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). 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.
Control	0..1 This element is affected by the following invariants: ele-1
Type	Extension(R5: How to compare versions (new)) (Extension Type: Choice of: string, Coding)
Is Modifier	false
Summary	false
Invariants	ele-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()`) ele-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())
12. Basic.extension:name
Slice Name	name
Definition	R5: `Citation.name` (new:string)
Short	R5: Name for this citation record (computer friendly) (new)
Comments	Element `Citation.name` is not mapped to FHIR R4, since FHIR R5 `Citation` is not mapped. Element `Citation.name` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). 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.
Control	0..1 This element is affected by the following invariants: ele-1
Type	Extension(R5: Name for this citation record (computer friendly) (new)) (Extension Type: string)
Is Modifier	false
Summary	false
Invariants	ele-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()`) ele-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())
14. Basic.extension:title
Slice Name	title
Definition	R5: `Citation.title` (new:string)
Short	R5: Name for this citation record (human friendly) (new)
Comments	Element `Citation.title` is not mapped to FHIR R4, since FHIR R5 `Citation` is not mapped. Element `Citation.title` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). 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.
Control	0..1 This element is affected by the following invariants: ele-1
Type	Extension(R5: Name for this citation record (human friendly) (new)) (Extension Type: string)
Is Modifier	false
Summary	false
Invariants	ele-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()`) ele-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. Basic.extension:experimental
Slice Name	experimental
Definition	R5: `Citation.experimental` (new:boolean)
Short	R5: For testing purposes, not real usage (new)
Comments	Element `Citation.experimental` is not mapped to FHIR R4, since FHIR R5 `Citation` is not mapped. Element `Citation.experimental` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). Allows filtering of citation records that are appropriate for use versus not.
Control	0..1 This element is affected by the following invariants: ele-1
Type	Extension(R5: For testing purposes, not real usage (new)) (Extension Type: boolean)
Is Modifier	false
Summary	false
Invariants	ele-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()`) ele-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. Basic.extension:date
Slice Name	date
Definition	R5: `Citation.date` (new:dateTime)
Short	R5: Date last changed (new)
Comments	Element `Citation.date` is not mapped to FHIR R4, since FHIR R5 `Citation` is not mapped. Element `Citation.date` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). 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.
Control	0..1 This element is affected by the following invariants: ele-1
Type	Extension(R5: Date last changed (new)) (Extension Type: dateTime)
Is Modifier	false
Summary	false
Invariants	ele-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()`) ele-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())
20. Basic.extension:publisher
Slice Name	publisher
Definition	R5: `Citation.publisher` (new:string)
Short	R5: The publisher of the citation record, not the publisher of the article or artifact being cited (new)
Comments	Element `Citation.publisher` is not mapped to FHIR R4, since FHIR R5 `Citation` is not mapped. Element `Citation.publisher` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). 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.
Control	0..1 This element is affected by the following invariants: ele-1
Type	Extension(R5: The publisher of the citation record, not the publisher of the article or artifact being cited (new)) (Extension Type: string)
Is Modifier	false
Summary	false
Invariants	ele-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()`) ele-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())
22. Basic.extension:contact
Slice Name	contact
Definition	R5: `Citation.contact` (new:ContactDetail)
Short	R5: Contact details for the publisher of the citation record (new)
Comments	Element `Citation.contact` is not mapped to FHIR R4, since FHIR R5 `Citation` is not mapped. Element `Citation.contact` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). May be a web site, an email address, a telephone number, etc. See guidance around (not) making local changes to elements here.
Control	0..* This element is affected by the following invariants: ele-1
Type	Extension(R5: Contact details for the publisher of the citation record (new)) (Extension Type: ContactDetail)
Is Modifier	false
Summary	false
Invariants	ele-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()`) ele-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())
24. Basic.extension:description
Slice Name	description
Definition	R5: `Citation.description` (new:markdown)
Short	R5: Natural language description of the citation (new)
Comments	Element `Citation.description` is not mapped to FHIR R4, since FHIR R5 `Citation` is not mapped. Element `Citation.description` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). 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).
Control	0..1 This element is affected by the following invariants: ele-1
Type	Extension(R5: Natural language description of the citation (new)) (Extension Type: markdown)
Is Modifier	false
Summary	false
Invariants	ele-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()`) ele-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())
26. Basic.extension:useContext
Slice Name	useContext
Definition	R5: `Citation.useContext` (new:UsageContext)
Short	R5: The context that the citation record content is intended to support (new)
Comments	Element `Citation.useContext` is not mapped to FHIR R4, since FHIR R5 `Citation` is not mapped. Element `Citation.useContext` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.
Control	0..* This element is affected by the following invariants: ele-1
Type	Extension(R5: The context that the citation record content is intended to support (new)) (Extension Type: UsageContext)
Is Modifier	false
Summary	false
Invariants	ele-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()`) ele-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())
28. Basic.extension:jurisdiction
Slice Name	jurisdiction
Definition	R5: `Citation.jurisdiction` (new:CodeableConcept)
Short	R5: Intended jurisdiction for citation record (if applicable) (new)
Comments	Element `Citation.jurisdiction` is not mapped to FHIR R4, since FHIR R5 `Citation` is not mapped. Element `Citation.jurisdiction` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). Element `Citation.jurisdiction` has been flagged as deprecated. 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.)
Control	0..* This element is affected by the following invariants: ele-1
Type	Extension(R5: Intended jurisdiction for citation record (if applicable) (new)) (Extension Type: CodeableConcept)
Is Modifier	false
Summary	false
Invariants	ele-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()`) ele-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())
30. Basic.extension:purpose
Slice Name	purpose
Definition	R5: `Citation.purpose` (new:markdown)
Short	R5: Why this citation is defined (new)
Comments	Element `Citation.purpose` is not mapped to FHIR R4, since FHIR R5 `Citation` is not mapped. Element `Citation.purpose` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). 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.
Control	0..1 This element is affected by the following invariants: ele-1
Type	Extension(R5: Why this citation is defined (new)) (Extension Type: markdown)
Is Modifier	false
Summary	false
Invariants	ele-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()`) ele-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())
32. Basic.extension:copyright
Slice Name	copyright
Definition	R5: `Citation.copyright` (new:markdown)
Short	R5: Use and/or publishing restrictions for the citation record, not for the cited artifact (new)
Comments	Element `Citation.copyright` is not mapped to FHIR R4, since FHIR R5 `Citation` is not mapped. Element `Citation.copyright` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).
Control	0..1 This element is affected by the following invariants: ele-1
Type	Extension(R5: Use and/or publishing restrictions for the citation record, not for the cited artifact (new)) (Extension Type: markdown)
Is Modifier	false
Summary	false
Invariants	ele-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()`) ele-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())
34. Basic.extension:copyrightLabel
Slice Name	copyrightLabel
Definition	R5: `Citation.copyrightLabel` (new:string)
Short	R5: Copyright holder and year(s) for the ciation record, not for the cited artifact (new)
Comments	Element `Citation.copyrightLabel` is not mapped to FHIR R4, since FHIR R5 `Citation` is not mapped. Element `Citation.copyrightLabel` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). 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.
Control	0..1 This element is affected by the following invariants: ele-1
Type	Extension(R5: Copyright holder and year(s) for the ciation record, not for the cited artifact (new)) (Extension Type: string)
Is Modifier	false
Summary	false
Invariants	ele-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()`) ele-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())
36. Basic.extension:approvalDate
Slice Name	approvalDate
Definition	R5: `Citation.approvalDate` (new:date)
Short	R5: When the citation record was approved by publisher (new)
Comments	Element `Citation.approvalDate` is not mapped to FHIR R4, since FHIR R5 `Citation` is not mapped. Element `Citation.approvalDate` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). 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.
Control	0..1 This element is affected by the following invariants: ele-1
Type	Extension(R5: When the citation record was approved by publisher (new)) (Extension Type: date)
Is Modifier	false
Summary	false
Invariants	ele-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()`) ele-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())
38. Basic.extension:lastReviewDate
Slice Name	lastReviewDate
Definition	R5: `Citation.lastReviewDate` (new:date)
Short	R5: When the citation record was last reviewed by the publisher (new)
Comments	Element `Citation.lastReviewDate` is not mapped to FHIR R4, since FHIR R5 `Citation` is not mapped. Element `Citation.lastReviewDate` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). If specified, this date follows the original approval date. See guidance around (not) making local changes to elements here.
Control	0..1 This element is affected by the following invariants: ele-1
Type	Extension(R5: When the citation record was last reviewed by the publisher (new)) (Extension Type: date)
Is Modifier	false
Summary	false
Invariants	ele-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()`) ele-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())
40. Basic.extension:effectivePeriod
Slice Name	effectivePeriod
Definition	R5: `Citation.effectivePeriod` (new:Period)
Short	R5: When the citation record is expected to be used (new)
Comments	Element `Citation.effectivePeriod` is not mapped to FHIR R4, since FHIR R5 `Citation` is not mapped. Element `Citation.effectivePeriod` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). 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.
Control	0..1 This element is affected by the following invariants: ele-1
Type	Extension(R5: When the citation record is expected to be used (new)) (Extension Type: Period)
Is Modifier	false
Summary	false
Invariants	ele-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()`) ele-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())
42. Basic.extension:author
Slice Name	author
Definition	R5: `Citation.author` (new:ContactDetail)
Short	R5: Who authored the citation record (new)
Comments	Element `Citation.author` is not mapped to FHIR R4, since FHIR R5 `Citation` is not mapped. Element `Citation.author` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). While the source element matches Basic element path `(`), the definitions are not compatible (source: `ContactDetail`:0..* -> basic: `Reference(http://hl7.org/fhir/StructureDefinition/Practitioner,http://hl7.org/fhir/StructureDefinition/PractitionerRole,http://hl7.org/fhir/StructureDefinition/Patient,http://hl7.org/fhir/StructureDefinition/RelatedPerson,http://hl7.org/fhir/StructureDefinition/Organization)`:0..1). 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.
Control	0..* This element is affected by the following invariants: ele-1
Type	Extension(R5: Who authored the citation record (new)) (Extension Type: ContactDetail)
Is Modifier	false
Summary	false
Invariants	ele-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()`) ele-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())
44. Basic.extension:editor
Slice Name	editor
Definition	R5: `Citation.editor` (new:ContactDetail)
Short	R5: Who edited the citation record (new)
Comments	Element `Citation.editor` is not mapped to FHIR R4, since FHIR R5 `Citation` is not mapped. Element `Citation.editor` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). 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.
Control	0..* This element is affected by the following invariants: ele-1
Type	Extension(R5: Who edited the citation record (new)) (Extension Type: ContactDetail)
Is Modifier	false
Summary	false
Invariants	ele-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()`) ele-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())
46. Basic.extension:reviewer
Slice Name	reviewer
Definition	R5: `Citation.reviewer` (new:ContactDetail)
Short	R5: Who reviewed the citation record (new)
Comments	Element `Citation.reviewer` is not mapped to FHIR R4, since FHIR R5 `Citation` is not mapped. Element `Citation.reviewer` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). 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.
Control	0..* This element is affected by the following invariants: ele-1
Type	Extension(R5: Who reviewed the citation record (new)) (Extension Type: ContactDetail)
Is Modifier	false
Summary	false
Invariants	ele-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()`) ele-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())
48. Basic.extension:endorser
Slice Name	endorser
Definition	R5: `Citation.endorser` (new:ContactDetail)
Short	R5: Who endorsed the citation record (new)
Comments	Element `Citation.endorser` is not mapped to FHIR R4, since FHIR R5 `Citation` is not mapped. Element `Citation.endorser` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). 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.
Control	0..* This element is affected by the following invariants: ele-1
Type	Extension(R5: Who endorsed the citation record (new)) (Extension Type: ContactDetail)
Is Modifier	false
Summary	false
Invariants	ele-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()`) ele-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())
50. Basic.extension:summary
Slice Name	summary
Definition	R5: `Citation.summary` (new:BackboneElement)
Short	R5: A human-readable display of key concepts to represent the citation (new)
Comments	Element `Citation.summary` is not mapped to FHIR R4, since FHIR R5 `Citation` is not mapped. Element `Citation.summary` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).
Control	0..* This element is affected by the following invariants: ele-1
Type	Extension(R5: A human-readable display of key concepts to represent the citation (new)) (Complex Extension)
Is Modifier	false
Invariants	ele-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()`)
52. Basic.extension:classification
Slice Name	classification
Definition	R5: `Citation.classification` (new:BackboneElement)
Short	R5: The assignment to an organizing scheme (new)
Comments	Element `Citation.classification` is not mapped to FHIR R4, since FHIR R5 `Citation` is not mapped. Element `Citation.classification` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). Use this element if you need to classify the citation record independently from classifying the cited artifact.
Control	0..* This element is affected by the following invariants: ele-1
Type	Extension(R5: The assignment to an organizing scheme (new)) (Complex Extension)
Is Modifier	false
Invariants	ele-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()`)
54. Basic.extension:note
Slice Name	note
Definition	R5: `Citation.note` (new:Annotation)
Short	R5: Used for general notes and annotations not coded elsewhere (new)
Comments	Element `Citation.note` is not mapped to FHIR R4, since FHIR R5 `Citation` is not mapped. Element `Citation.note` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).
Control	0..* This element is affected by the following invariants: ele-1
Type	Extension(R5: Used for general notes and annotations not coded elsewhere (new)) (Extension Type: Annotation)
Is Modifier	false
Summary	false
Invariants	ele-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()`) ele-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())
56. Basic.extension:currentState
Slice Name	currentState
Definition	R5: `Citation.currentState` (new:CodeableConcept)
Short	R5: The status of the citation record (new)
Comments	Element `Citation.currentState` is not mapped to FHIR R4, since FHIR R5 `Citation` is not mapped. Element `Citation.currentState` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). 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.
Control	0..* This element is affected by the following invariants: ele-1
Type	Extension(R5: The status of the citation record (new)) (Extension Type: CodeableConcept)
Is Modifier	false
Summary	false
Invariants	ele-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()`) ele-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())
58. Basic.extension:statusDate
Slice Name	statusDate
Definition	R5: `Citation.statusDate` (new:BackboneElement)
Short	R5: An effective date or period for a status of the citation record (new)
Comments	Element `Citation.statusDate` is not mapped to FHIR R4, since FHIR R5 `Citation` is not mapped. Element `Citation.statusDate` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). 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.
Control	0..* This element is affected by the following invariants: ele-1
Type	Extension(R5: An effective date or period for a status of the citation record (new)) (Complex Extension)
Is Modifier	false
Invariants	ele-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()`)
60. Basic.extension:relatedArtifact
Slice Name	relatedArtifact
Definition	R5: `Citation.relatedArtifact` (new:RelatedArtifact)
Short	R5: Artifact related to the citation record (new)
Comments	Element `Citation.relatedArtifact` is not mapped to FHIR R4, since FHIR R5 `Citation` is not mapped. Element `Citation.relatedArtifact` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). 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.
Control	0..* This element is affected by the following invariants: ele-1
Type	Extension(R5: Artifact related to the citation record (new)) (Extension Type: RelatedArtifact)
Is Modifier	false
Summary	false
Invariants	ele-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()`) ele-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())
62. Basic.extension:citedArtifact
Slice Name	citedArtifact
Definition	R5: `Citation.citedArtifact` (new:BackboneElement)
Short	R5: The article or artifact being described (new)
Comments	Element `Citation.citedArtifact` is not mapped to FHIR R4, since FHIR R5 `Citation` is not mapped. Element `Citation.citedArtifact` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).
Control	0..1 This element is affected by the following invariants: ele-1
Type	Extension(R5: The article or artifact being described (new)) (Complex Extension)
Is Modifier	false
Invariants	ele-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()`)
64. Basic.modifierExtension
Definition	An Extension 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 manageable, 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).
Short	ExtensionExtensions 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.
Control	0..*
Type	Extension
Is Modifier	true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Summary	false
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 Names	extensions, user content
Invariants	ele-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()`) ele-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())
Slicing	This element introduces a set of slices on `Basic.modifierExtension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
66. Basic.modifierExtension:status
Slice Name	status
Definition	R5: `Citation.status` (new:code)
Short	R5: draft \| active \| retired \| unknown (new)
Comments	Element `Citation.status` is not mapped to FHIR R4, since FHIR R5 `Citation` is not mapped. Element `Citation.status` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). 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.
Control	1..1 This element is affected by the following invariants: ele-1
Type	Extension(R5: draft \| active \| retired \| unknown (new)) (Extension Type: code)
Is Modifier	true because This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration
Summary	false
Invariants	ele-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()`) ele-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())
68. Basic.code
Definition	Identifies the 'type' of resource - equivalent to the resource name for other resources.
Short	Kind of Resource
Comments	Because resource references will only be able to indicate 'Basic', the type of reference will need to be specified in a Profile identified as part of the resource. Refer to the resource notes section for information on appropriate terminologies for this code. This element is labeled as a modifier because it defines the meaning of the resource and cannot be ignored.
Control	1..1
Binding	For example codes, see BasicResourceTypeshttp://hl7.org/fhir/ValueSet/basic-resource-type\|4.0.1 (example to `http://hl7.org/fhir/ValueSet/basic-resource-type\|4.0.1`) Codes for identifying types of resources not yet defined by FHIR.
Type	CodeableConcept
Is Modifier	true because This element determines what kind of resource is being represented which drives the meaning of all of the other elements.
Summary	true
Requirements	Must be able to distinguish different types of Basic resources.
Invariants	ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ele-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. Basic
2. Basic.extension
Control	0..*
Slicing	This element introduces a set of slices on `Basic.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
4. Basic.extension:url
Slice Name	url
Definition	R5: `Citation.url` (new:uri)
Short	R5: Canonical identifier for this citation record, represented as a globally unique URI (new)
Comments	Element `Citation.url` is not mapped to FHIR R4, since FHIR R5 `Citation` is not mapped. Element `Citation.url` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). 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.
Control	0..1
Type	Extension(R5: Canonical identifier for this citation record, represented as a globally unique URI (new)) (Extension Type: uri)
6. Basic.extension:version
Slice Name	version
Definition	R5: `Citation.version` (new:string)
Short	R5: Business version of the citation record (new)
Comments	Element `Citation.version` is not mapped to FHIR R4, since FHIR R5 `Citation` is not mapped. Element `Citation.version` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). 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.
Control	0..1
Type	Extension(R5: Business version of the citation record (new)) (Extension Type: string)
8. Basic.extension:versionAlgorithm
Slice Name	versionAlgorithm
Definition	R5: `Citation.versionAlgorithm[x]` (new:Coding, string)
Short	R5: How to compare versions (new)
Comments	Element `Citation.versionAlgorithm[x]` is not mapped to FHIR R4, since FHIR R5 `Citation` is not mapped. Element `Citation.versionAlgorithm[x]` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). 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.
Control	0..1
Type	Extension(R5: How to compare versions (new)) (Extension Type: Choice of: string, Coding)
10. Basic.extension:name
Slice Name	name
Definition	R5: `Citation.name` (new:string)
Short	R5: Name for this citation record (computer friendly) (new)
Comments	Element `Citation.name` is not mapped to FHIR R4, since FHIR R5 `Citation` is not mapped. Element `Citation.name` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). 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.
Control	0..1
Type	Extension(R5: Name for this citation record (computer friendly) (new)) (Extension Type: string)
12. Basic.extension:title
Slice Name	title
Definition	R5: `Citation.title` (new:string)
Short	R5: Name for this citation record (human friendly) (new)
Comments	Element `Citation.title` is not mapped to FHIR R4, since FHIR R5 `Citation` is not mapped. Element `Citation.title` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). 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.
Control	0..1
Type	Extension(R5: Name for this citation record (human friendly) (new)) (Extension Type: string)
14. Basic.extension:experimental
Slice Name	experimental
Definition	R5: `Citation.experimental` (new:boolean)
Short	R5: For testing purposes, not real usage (new)
Comments	Element `Citation.experimental` is not mapped to FHIR R4, since FHIR R5 `Citation` is not mapped. Element `Citation.experimental` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). Allows filtering of citation records that are appropriate for use versus not.
Control	0..1
Type	Extension(R5: For testing purposes, not real usage (new)) (Extension Type: boolean)
16. Basic.extension:date
Slice Name	date
Definition	R5: `Citation.date` (new:dateTime)
Short	R5: Date last changed (new)
Comments	Element `Citation.date` is not mapped to FHIR R4, since FHIR R5 `Citation` is not mapped. Element `Citation.date` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). 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.
Control	0..1
Type	Extension(R5: Date last changed (new)) (Extension Type: dateTime)
18. Basic.extension:publisher
Slice Name	publisher
Definition	R5: `Citation.publisher` (new:string)
Short	R5: The publisher of the citation record, not the publisher of the article or artifact being cited (new)
Comments	Element `Citation.publisher` is not mapped to FHIR R4, since FHIR R5 `Citation` is not mapped. Element `Citation.publisher` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). 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.
Control	0..1
Type	Extension(R5: The publisher of the citation record, not the publisher of the article or artifact being cited (new)) (Extension Type: string)
20. Basic.extension:contact
Slice Name	contact
Definition	R5: `Citation.contact` (new:ContactDetail)
Short	R5: Contact details for the publisher of the citation record (new)
Comments	Element `Citation.contact` is not mapped to FHIR R4, since FHIR R5 `Citation` is not mapped. Element `Citation.contact` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). May be a web site, an email address, a telephone number, etc. See guidance around (not) making local changes to elements here.
Control	0..*
Type	Extension(R5: Contact details for the publisher of the citation record (new)) (Extension Type: ContactDetail)
22. Basic.extension:description
Slice Name	description
Definition	R5: `Citation.description` (new:markdown)
Short	R5: Natural language description of the citation (new)
Comments	Element `Citation.description` is not mapped to FHIR R4, since FHIR R5 `Citation` is not mapped. Element `Citation.description` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). 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).
Control	0..1
Type	Extension(R5: Natural language description of the citation (new)) (Extension Type: markdown)
24. Basic.extension:useContext
Slice Name	useContext
Definition	R5: `Citation.useContext` (new:UsageContext)
Short	R5: The context that the citation record content is intended to support (new)
Comments	Element `Citation.useContext` is not mapped to FHIR R4, since FHIR R5 `Citation` is not mapped. Element `Citation.useContext` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.
Control	0..*
Type	Extension(R5: The context that the citation record content is intended to support (new)) (Extension Type: UsageContext)
26. Basic.extension:jurisdiction
Slice Name	jurisdiction
Definition	R5: `Citation.jurisdiction` (new:CodeableConcept)
Short	R5: Intended jurisdiction for citation record (if applicable) (new)
Comments	Element `Citation.jurisdiction` is not mapped to FHIR R4, since FHIR R5 `Citation` is not mapped. Element `Citation.jurisdiction` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). Element `Citation.jurisdiction` has been flagged as deprecated. 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.)
Control	0..*
Type	Extension(R5: Intended jurisdiction for citation record (if applicable) (new)) (Extension Type: CodeableConcept)
28. Basic.extension:purpose
Slice Name	purpose
Definition	R5: `Citation.purpose` (new:markdown)
Short	R5: Why this citation is defined (new)
Comments	Element `Citation.purpose` is not mapped to FHIR R4, since FHIR R5 `Citation` is not mapped. Element `Citation.purpose` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). 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.
Control	0..1
Type	Extension(R5: Why this citation is defined (new)) (Extension Type: markdown)
30. Basic.extension:copyright
Slice Name	copyright
Definition	R5: `Citation.copyright` (new:markdown)
Short	R5: Use and/or publishing restrictions for the citation record, not for the cited artifact (new)
Comments	Element `Citation.copyright` is not mapped to FHIR R4, since FHIR R5 `Citation` is not mapped. Element `Citation.copyright` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).
Control	0..1
Type	Extension(R5: Use and/or publishing restrictions for the citation record, not for the cited artifact (new)) (Extension Type: markdown)
32. Basic.extension:copyrightLabel
Slice Name	copyrightLabel
Definition	R5: `Citation.copyrightLabel` (new:string)
Short	R5: Copyright holder and year(s) for the ciation record, not for the cited artifact (new)
Comments	Element `Citation.copyrightLabel` is not mapped to FHIR R4, since FHIR R5 `Citation` is not mapped. Element `Citation.copyrightLabel` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). 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.
Control	0..1
Type	Extension(R5: Copyright holder and year(s) for the ciation record, not for the cited artifact (new)) (Extension Type: string)
34. Basic.extension:approvalDate
Slice Name	approvalDate
Definition	R5: `Citation.approvalDate` (new:date)
Short	R5: When the citation record was approved by publisher (new)
Comments	Element `Citation.approvalDate` is not mapped to FHIR R4, since FHIR R5 `Citation` is not mapped. Element `Citation.approvalDate` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). 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.
Control	0..1
Type	Extension(R5: When the citation record was approved by publisher (new)) (Extension Type: date)
36. Basic.extension:lastReviewDate
Slice Name	lastReviewDate
Definition	R5: `Citation.lastReviewDate` (new:date)
Short	R5: When the citation record was last reviewed by the publisher (new)
Comments	Element `Citation.lastReviewDate` is not mapped to FHIR R4, since FHIR R5 `Citation` is not mapped. Element `Citation.lastReviewDate` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). If specified, this date follows the original approval date. See guidance around (not) making local changes to elements here.
Control	0..1
Type	Extension(R5: When the citation record was last reviewed by the publisher (new)) (Extension Type: date)
38. Basic.extension:effectivePeriod
Slice Name	effectivePeriod
Definition	R5: `Citation.effectivePeriod` (new:Period)
Short	R5: When the citation record is expected to be used (new)
Comments	Element `Citation.effectivePeriod` is not mapped to FHIR R4, since FHIR R5 `Citation` is not mapped. Element `Citation.effectivePeriod` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). 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.
Control	0..1
Type	Extension(R5: When the citation record is expected to be used (new)) (Extension Type: Period)
40. Basic.extension:author
Slice Name	author
Definition	R5: `Citation.author` (new:ContactDetail)
Short	R5: Who authored the citation record (new)
Comments	Element `Citation.author` is not mapped to FHIR R4, since FHIR R5 `Citation` is not mapped. Element `Citation.author` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). While the source element matches Basic element path `(`), the definitions are not compatible (source: `ContactDetail`:0..* -> basic: `Reference(http://hl7.org/fhir/StructureDefinition/Practitioner,http://hl7.org/fhir/StructureDefinition/PractitionerRole,http://hl7.org/fhir/StructureDefinition/Patient,http://hl7.org/fhir/StructureDefinition/RelatedPerson,http://hl7.org/fhir/StructureDefinition/Organization)`:0..1). 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.
Control	0..*
Type	Extension(R5: Who authored the citation record (new)) (Extension Type: ContactDetail)
42. Basic.extension:editor
Slice Name	editor
Definition	R5: `Citation.editor` (new:ContactDetail)
Short	R5: Who edited the citation record (new)
Comments	Element `Citation.editor` is not mapped to FHIR R4, since FHIR R5 `Citation` is not mapped. Element `Citation.editor` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). 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.
Control	0..*
Type	Extension(R5: Who edited the citation record (new)) (Extension Type: ContactDetail)
44. Basic.extension:reviewer
Slice Name	reviewer
Definition	R5: `Citation.reviewer` (new:ContactDetail)
Short	R5: Who reviewed the citation record (new)
Comments	Element `Citation.reviewer` is not mapped to FHIR R4, since FHIR R5 `Citation` is not mapped. Element `Citation.reviewer` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). 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.
Control	0..*
Type	Extension(R5: Who reviewed the citation record (new)) (Extension Type: ContactDetail)
46. Basic.extension:endorser
Slice Name	endorser
Definition	R5: `Citation.endorser` (new:ContactDetail)
Short	R5: Who endorsed the citation record (new)
Comments	Element `Citation.endorser` is not mapped to FHIR R4, since FHIR R5 `Citation` is not mapped. Element `Citation.endorser` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). 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.
Control	0..*
Type	Extension(R5: Who endorsed the citation record (new)) (Extension Type: ContactDetail)
48. Basic.extension:summary
Slice Name	summary
Definition	R5: `Citation.summary` (new:BackboneElement)
Short	R5: A human-readable display of key concepts to represent the citation (new)
Comments	Element `Citation.summary` is not mapped to FHIR R4, since FHIR R5 `Citation` is not mapped. Element `Citation.summary` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).
Control	0..*
Type	Extension(R5: A human-readable display of key concepts to represent the citation (new)) (Complex Extension)
50. Basic.extension:classification
Slice Name	classification
Definition	R5: `Citation.classification` (new:BackboneElement)
Short	R5: The assignment to an organizing scheme (new)
Comments	Element `Citation.classification` is not mapped to FHIR R4, since FHIR R5 `Citation` is not mapped. Element `Citation.classification` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). Use this element if you need to classify the citation record independently from classifying the cited artifact.
Control	0..*
Type	Extension(R5: The assignment to an organizing scheme (new)) (Complex Extension)
52. Basic.extension:note
Slice Name	note
Definition	R5: `Citation.note` (new:Annotation)
Short	R5: Used for general notes and annotations not coded elsewhere (new)
Comments	Element `Citation.note` is not mapped to FHIR R4, since FHIR R5 `Citation` is not mapped. Element `Citation.note` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).
Control	0..*
Type	Extension(R5: Used for general notes and annotations not coded elsewhere (new)) (Extension Type: Annotation)
54. Basic.extension:currentState
Slice Name	currentState
Definition	R5: `Citation.currentState` (new:CodeableConcept)
Short	R5: The status of the citation record (new)
Comments	Element `Citation.currentState` is not mapped to FHIR R4, since FHIR R5 `Citation` is not mapped. Element `Citation.currentState` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). 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.
Control	0..*
Type	Extension(R5: The status of the citation record (new)) (Extension Type: CodeableConcept)
56. Basic.extension:statusDate
Slice Name	statusDate
Definition	R5: `Citation.statusDate` (new:BackboneElement)
Short	R5: An effective date or period for a status of the citation record (new)
Comments	Element `Citation.statusDate` is not mapped to FHIR R4, since FHIR R5 `Citation` is not mapped. Element `Citation.statusDate` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). 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.
Control	0..*
Type	Extension(R5: An effective date or period for a status of the citation record (new)) (Complex Extension)
58. Basic.extension:relatedArtifact
Slice Name	relatedArtifact
Definition	R5: `Citation.relatedArtifact` (new:RelatedArtifact)
Short	R5: Artifact related to the citation record (new)
Comments	Element `Citation.relatedArtifact` is not mapped to FHIR R4, since FHIR R5 `Citation` is not mapped. Element `Citation.relatedArtifact` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). 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.
Control	0..*
Type	Extension(R5: Artifact related to the citation record (new)) (Extension Type: RelatedArtifact)
60. Basic.extension:citedArtifact
Slice Name	citedArtifact
Definition	R5: `Citation.citedArtifact` (new:BackboneElement)
Short	R5: The article or artifact being described (new)
Comments	Element `Citation.citedArtifact` is not mapped to FHIR R4, since FHIR R5 `Citation` is not mapped. Element `Citation.citedArtifact` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).
Control	0..1
Type	Extension(R5: The article or artifact being described (new)) (Complex Extension)
62. Basic.modifierExtension
Control	0..*
Slicing	This element introduces a set of slices on `Basic.modifierExtension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
64. Basic.modifierExtension:status
Slice Name	status
Definition	R5: `Citation.status` (new:code)
Short	R5: draft \| active \| retired \| unknown (new)
Comments	Element `Citation.status` is not mapped to FHIR R4, since FHIR R5 `Citation` is not mapped. Element `Citation.status` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). 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.
Control	1..1
Type	Extension(R5: draft \| active \| retired \| unknown (new)) (Extension Type: code)

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

0. Basic

Definition

Basic is used for handling concepts not yet defined in FHIR, narrative-only resources that don't map to an existing resource, and custom resources not appropriate for inclusion in the FHIR specification.

Short Resource for non-supported content

Control 0..*

Is Modifier false

Summary false

Alternate Names Z-resource, Extension-resource, Custom-resource

Invariants dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty())
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
dom-6: A resource should have narrative for robust management (text.`div`.exists())

2. Basic.id

Definition

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

Short Logical id of this artifact

Comments

The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

Control 0..1

Type

Is Modifier false

Summary true

4. Basic.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.

Short Metadata about the resource

Control 0..1

Type

Meta

Is Modifier false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

6. Basic.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.

Short A 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 it's narrative along with other profiles, value sets, etc.

Control 0..1

Type

uri

Is Modifier true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

8. Basic.language

Definition

The base language in which the resource is written.

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

Control 0..1

Binding

The codes SHOULD be taken from CommonLanguages

(preferred to http://hl7.org/fhir/ValueSet/languages|4.0.1)

A human language.

Additional Bindings

Purpose

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

10. Basic.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.

Short Text summary of the resource, for human interpretation

Comments

Contained resources do not have 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.

Control 0..1

Type

Narrative

Is Modifier false

Summary false

Alternate Names narrative, html, xhtml, display

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

12. Basic.contained

Definition

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

Short Contained, 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.

Control 0..*

Type

Resource

Is Modifier false

Summary false

Alternate Names inline resources, anonymous resources, contained resources

14. Basic.extension

Definition

An Extension

Short Extension

Control 0..*

Type

Extension

Is Modifier false

Summary false

Invariants ele-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())

Slicing

This element introduces a set of slices on Basic.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

16. Basic.extension:url

Slice Name url

Definition

R5: Citation.url (new:uri)

Short R5: Canonical identifier for this citation record, represented as a globally unique URI (new)

Comments

Element Citation.url is not mapped to FHIR R4, since FHIR R5 Citation is not mapped. Element Citation.url has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). 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.

Control 0..1
This element is affected by the following invariants: ele-1

Type Extension(R5: Canonical identifier for this citation record, represented as a globally unique URI (new)) (Extension Type: uri)

Is Modifier false

Summary false

18. Basic.extension:version

Slice Name version

Definition

R5: Citation.version (new:string)

Short R5: Business version of the citation record (new)

Comments

Element Citation.version is not mapped to FHIR R4, since FHIR R5 Citation is not mapped. Element Citation.version has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). 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.

Control 0..1
This element is affected by the following invariants: ele-1

Type Extension(R5: Business version of the citation record (new)) (Extension Type: string)

Is Modifier false

Summary false

20. Basic.extension:versionAlgorithm

Slice Name versionAlgorithm

Definition

R5: Citation.versionAlgorithm[x] (new:Coding, string)

Short R5: How to compare versions (new)

Comments

Element Citation.versionAlgorithm[x] is not mapped to FHIR R4, since FHIR R5 Citation is not mapped. Element Citation.versionAlgorithm[x] has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). 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.

Control 0..1
This element is affected by the following invariants: ele-1

Type Extension(R5: How to compare versions (new)) (Extension Type: Choice of: string, Coding)

Is Modifier false

Summary false

22. Basic.extension:name

Slice Name name

Definition

R5: Citation.name (new:string)

Short R5: Name for this citation record (computer friendly) (new)

Comments

Element Citation.name is not mapped to FHIR R4, since FHIR R5 Citation is not mapped. Element Citation.name has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). 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.

Control 0..1
This element is affected by the following invariants: ele-1

Type Extension(R5: Name for this citation record (computer friendly) (new)) (Extension Type: string)

Is Modifier false

Summary false

24. Basic.extension:title

Slice Name title

Definition

R5: Citation.title (new:string)

Short R5: Name for this citation record (human friendly) (new)

Comments

Element Citation.title is not mapped to FHIR R4, since FHIR R5 Citation is not mapped. Element Citation.title has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). 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.

Control 0..1
This element is affected by the following invariants: ele-1

Type Extension(R5: Name for this citation record (human friendly) (new)) (Extension Type: string)

Is Modifier false

Summary false

26. Basic.extension:experimental

Slice Name experimental

Definition

R5: Citation.experimental (new:boolean)

Short R5: For testing purposes, not real usage (new)

Comments

Element Citation.experimental is not mapped to FHIR R4, since FHIR R5 Citation is not mapped. Element Citation.experimental has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). Allows filtering of citation records that are appropriate for use versus not.

Control 0..1
This element is affected by the following invariants: ele-1

Type Extension(R5: For testing purposes, not real usage (new)) (Extension Type: boolean)

Is Modifier false

Summary false

28. Basic.extension:date

Slice Name date

Definition

R5: Citation.date (new:dateTime)

Short R5: Date last changed (new)

Comments

Element Citation.date is not mapped to FHIR R4, since FHIR R5 Citation is not mapped. Element Citation.date has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). 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.

Control 0..1
This element is affected by the following invariants: ele-1

Type Extension(R5: Date last changed (new)) (Extension Type: dateTime)

Is Modifier false

Summary false

30. Basic.extension:publisher

Slice Name publisher

Definition

R5: Citation.publisher (new:string)

Short R5: The publisher of the citation record, not the publisher of the article or artifact being cited (new)

Comments

Element Citation.publisher is not mapped to FHIR R4, since FHIR R5 Citation is not mapped. Element Citation.publisher has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). 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.

Control 0..1
This element is affected by the following invariants: ele-1

Type Extension(R5: The publisher of the citation record, not the publisher of the article or artifact being cited (new)) (Extension Type: string)

Is Modifier false

Summary false

32. Basic.extension:contact

Slice Name contact

Definition

R5: Citation.contact (new:ContactDetail)

Short R5: Contact details for the publisher of the citation record (new)

Comments

Element Citation.contact is not mapped to FHIR R4, since FHIR R5 Citation is not mapped. Element Citation.contact has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). May be a web site, an email address, a telephone number, etc.

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

Control 0..*
This element is affected by the following invariants: ele-1

Type Extension(R5: Contact details for the publisher of the citation record (new)) (Extension Type: ContactDetail)

Is Modifier false

Summary false

34. Basic.extension:description

Slice Name description

Definition

R5: Citation.description (new:markdown)

Short R5: Natural language description of the citation (new)

Comments

Element Citation.description is not mapped to FHIR R4, since FHIR R5 Citation is not mapped. Element Citation.description has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). 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).

Control 0..1
This element is affected by the following invariants: ele-1

Type Extension(R5: Natural language description of the citation (new)) (Extension Type: markdown)

Is Modifier false

Summary false

36. Basic.extension:useContext

Slice Name useContext

Definition

R5: Citation.useContext (new:UsageContext)

Short R5: The context that the citation record content is intended to support (new)

Comments

Element Citation.useContext is not mapped to FHIR R4, since FHIR R5 Citation is not mapped. Element Citation.useContext has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.

Control 0..*
This element is affected by the following invariants: ele-1

Type Extension(R5: The context that the citation record content is intended to support (new)) (Extension Type: UsageContext)

Is Modifier false

Summary false

38. Basic.extension:jurisdiction

Slice Name jurisdiction

Definition

R5: Citation.jurisdiction (new:CodeableConcept)

Short R5: Intended jurisdiction for citation record (if applicable) (new)

Comments

Element Citation.jurisdiction is not mapped to FHIR R4, since FHIR R5 Citation is not mapped. Element Citation.jurisdiction has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). Element Citation.jurisdiction has been flagged as deprecated. 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.)

Control 0..*
This element is affected by the following invariants: ele-1

Type Extension(R5: Intended jurisdiction for citation record (if applicable) (new)) (Extension Type: CodeableConcept)

Is Modifier false

Summary false

40. Basic.extension:purpose

Slice Name purpose

Definition

R5: Citation.purpose (new:markdown)

Short R5: Why this citation is defined (new)

Comments

Element Citation.purpose is not mapped to FHIR R4, since FHIR R5 Citation is not mapped. Element Citation.purpose has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). 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.

Control 0..1
This element is affected by the following invariants: ele-1

Type Extension(R5: Why this citation is defined (new)) (Extension Type: markdown)

Is Modifier false

Summary false

42. Basic.extension:copyright

Slice Name copyright

Definition

R5: Citation.copyright (new:markdown)

Short R5: Use and/or publishing restrictions for the citation record, not for the cited artifact (new)

Comments

Element Citation.copyright is not mapped to FHIR R4, since FHIR R5 Citation is not mapped. Element Citation.copyright has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

Control 0..1
This element is affected by the following invariants: ele-1

Type Extension(R5: Use and/or publishing restrictions for the citation record, not for the cited artifact (new)) (Extension Type: markdown)

Is Modifier false

Summary false

44. Basic.extension:copyrightLabel

Slice Name copyrightLabel

Definition

R5: Citation.copyrightLabel (new:string)

Short R5: Copyright holder and year(s) for the ciation record, not for the cited artifact (new)

Comments

Element Citation.copyrightLabel is not mapped to FHIR R4, since FHIR R5 Citation is not mapped. Element Citation.copyrightLabel has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). 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.

Control 0..1
This element is affected by the following invariants: ele-1

Type Extension(R5: Copyright holder and year(s) for the ciation record, not for the cited artifact (new)) (Extension Type: string)

Is Modifier false

Summary false

46. Basic.extension:approvalDate

Slice Name approvalDate

Definition

R5: Citation.approvalDate (new:date)

Short R5: When the citation record was approved by publisher (new)

Comments

Element Citation.approvalDate is not mapped to FHIR R4, since FHIR R5 Citation is not mapped. Element Citation.approvalDate has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). 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.

Control 0..1
This element is affected by the following invariants: ele-1

Type Extension(R5: When the citation record was approved by publisher (new)) (Extension Type: date)

Is Modifier false

Summary false

48. Basic.extension:lastReviewDate

Slice Name lastReviewDate

Definition

R5: Citation.lastReviewDate (new:date)

Short R5: When the citation record was last reviewed by the publisher (new)

Comments

Element Citation.lastReviewDate is not mapped to FHIR R4, since FHIR R5 Citation is not mapped. Element Citation.lastReviewDate has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). If specified, this date follows the original approval date.

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

Control 0..1
This element is affected by the following invariants: ele-1

Type Extension(R5: When the citation record was last reviewed by the publisher (new)) (Extension Type: date)

Is Modifier false

Summary false

50. Basic.extension:effectivePeriod

Slice Name effectivePeriod

Definition

R5: Citation.effectivePeriod (new:Period)

Short R5: When the citation record is expected to be used (new)

Comments

Element Citation.effectivePeriod is not mapped to FHIR R4, since FHIR R5 Citation is not mapped. Element Citation.effectivePeriod has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). 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.

Control 0..1
This element is affected by the following invariants: ele-1

Type Extension(R5: When the citation record is expected to be used (new)) (Extension Type: Period)

Is Modifier false

Summary false

52. Basic.extension:author

Slice Name author

Definition

R5: Citation.author (new:ContactDetail)

Short R5: Who authored the citation record (new)

Comments

Element Citation.author is not mapped to FHIR R4, since FHIR R5 Citation is not mapped. Element Citation.author has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). While the source element matches Basic element path (), the definitions are not compatible (source: ContactDetail:0..* -> basic: Reference(http://hl7.org/fhir/StructureDefinition/Practitioner,http://hl7.org/fhir/StructureDefinition/PractitionerRole,http://hl7.org/fhir/StructureDefinition/Patient,http://hl7.org/fhir/StructureDefinition/RelatedPerson,http://hl7.org/fhir/StructureDefinition/Organization):0..1). 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.

Control 0..*
This element is affected by the following invariants: ele-1

Type Extension(R5: Who authored the citation record (new)) (Extension Type: ContactDetail)

Is Modifier false

Summary false

54. Basic.extension:editor

Slice Name editor

Definition

R5: Citation.editor (new:ContactDetail)

Short R5: Who edited the citation record (new)

Comments

Element Citation.editor is not mapped to FHIR R4, since FHIR R5 Citation is not mapped. Element Citation.editor has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). 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.

Control 0..*
This element is affected by the following invariants: ele-1

Type Extension(R5: Who edited the citation record (new)) (Extension Type: ContactDetail)

Is Modifier false

Summary false

56. Basic.extension:reviewer

Slice Name reviewer

Definition

R5: Citation.reviewer (new:ContactDetail)

Short R5: Who reviewed the citation record (new)

Comments

Element Citation.reviewer is not mapped to FHIR R4, since FHIR R5 Citation is not mapped. Element Citation.reviewer has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). 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.

Control 0..*
This element is affected by the following invariants: ele-1

Type Extension(R5: Who reviewed the citation record (new)) (Extension Type: ContactDetail)

Is Modifier false

Summary false

58. Basic.extension:endorser

Slice Name endorser

Definition

R5: Citation.endorser (new:ContactDetail)

Short R5: Who endorsed the citation record (new)

Comments

Element Citation.endorser is not mapped to FHIR R4, since FHIR R5 Citation is not mapped. Element Citation.endorser has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). 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.

Control 0..*
This element is affected by the following invariants: ele-1

Type Extension(R5: Who endorsed the citation record (new)) (Extension Type: ContactDetail)

Is Modifier false

Summary false

60. Basic.extension:summary

Slice Name summary

Definition

R5: Citation.summary (new:BackboneElement)

Short R5: A human-readable display of key concepts to represent the citation (new)

Comments

Element Citation.summary is not mapped to FHIR R4, since FHIR R5 Citation is not mapped. Element Citation.summary has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

Control 0..*
This element is affected by the following invariants: ele-1

Type Extension(R5: A human-readable display of key concepts to represent the citation (new)) (Complex Extension)

Is Modifier false

62. Basic.extension:classification

Slice Name classification

Definition

R5: Citation.classification (new:BackboneElement)

Short R5: The assignment to an organizing scheme (new)

Comments

Element Citation.classification is not mapped to FHIR R4, since FHIR R5 Citation is not mapped. Element Citation.classification has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). Use this element if you need to classify the citation record independently from classifying the cited artifact.

Control 0..*
This element is affected by the following invariants: ele-1

Type Extension(R5: The assignment to an organizing scheme (new)) (Complex Extension)

Is Modifier false

64. Basic.extension:note

Slice Name note

Definition

R5: Citation.note (new:Annotation)

Short R5: Used for general notes and annotations not coded elsewhere (new)

Comments

Element Citation.note is not mapped to FHIR R4, since FHIR R5 Citation is not mapped. Element Citation.note has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

Control 0..*
This element is affected by the following invariants: ele-1

Type Extension(R5: Used for general notes and annotations not coded elsewhere (new)) (Extension Type: Annotation)

Is Modifier false

Summary false

66. Basic.extension:currentState

Slice Name currentState

Definition

R5: Citation.currentState (new:CodeableConcept)

Short R5: The status of the citation record (new)

Comments

Element Citation.currentState is not mapped to FHIR R4, since FHIR R5 Citation is not mapped. Element Citation.currentState has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). 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.

Control 0..*
This element is affected by the following invariants: ele-1

Type Extension(R5: The status of the citation record (new)) (Extension Type: CodeableConcept)

Is Modifier false

Summary false

68. Basic.extension:statusDate

Slice Name statusDate

Definition

R5: Citation.statusDate (new:BackboneElement)

Short R5: An effective date or period for a status of the citation record (new)

Comments

Element Citation.statusDate is not mapped to FHIR R4, since FHIR R5 Citation is not mapped. Element Citation.statusDate has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). 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.

Control 0..*
This element is affected by the following invariants: ele-1

Type Extension(R5: An effective date or period for a status of the citation record (new)) (Complex Extension)

Is Modifier false

70. Basic.extension:relatedArtifact

Slice Name relatedArtifact

Definition

R5: Citation.relatedArtifact (new:RelatedArtifact)

Short R5: Artifact related to the citation record (new)

Comments

Element Citation.relatedArtifact is not mapped to FHIR R4, since FHIR R5 Citation is not mapped. Element Citation.relatedArtifact has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). 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.

Control 0..*
This element is affected by the following invariants: ele-1

Type Extension(R5: Artifact related to the citation record (new)) (Extension Type: RelatedArtifact)

Is Modifier false

Summary false

72. Basic.extension:citedArtifact

Slice Name citedArtifact

Definition

R5: Citation.citedArtifact (new:BackboneElement)

Short R5: The article or artifact being described (new)

Comments

Element Citation.citedArtifact is not mapped to FHIR R4, since FHIR R5 Citation is not mapped. Element Citation.citedArtifact has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

Control 0..1
This element is affected by the following invariants: ele-1

Type Extension(R5: The article or artifact being described (new)) (Complex Extension)

Is Modifier false

74. Basic.modifierExtension

Definition

An Extension

Short Extension

Control 0..*

Type

Extension

Is Modifier true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them

Summary false

Slicing

This element introduces a set of slices on Basic.modifierExtension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

76. Basic.modifierExtension:status

Slice Name status

Definition

R5: Citation.status (new:code)

Short R5: draft | active | retired | unknown (new)

Comments

Element Citation.status is not mapped to FHIR R4, since FHIR R5 Citation is not mapped. Element Citation.status has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). 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.

Control 1..1
This element is affected by the following invariants: ele-1

Type Extension(R5: draft | active | retired | unknown (new)) (Extension Type: code)

Is Modifier true because This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration

Summary false

78. Basic.identifier

Definition

Identifier assigned to the resource for business purposes, outside the context of FHIR.

Short Business identifier

Note This is a business identifier, not a resource identifier (see discussion)

Control 0..*

Type

Identifier

Is Modifier false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

80. Basic.code

Definition

Identifies the 'type' of resource - equivalent to the resource name for other resources.

Short Kind of Resource

Comments

Because resource references will only be able to indicate 'Basic', the type of reference will need to be specified in a Profile identified as part of the resource. Refer to the resource notes section for information on appropriate terminologies for this code.

This element is labeled as a modifier because it defines the meaning of the resource and cannot be ignored.

Control 1..1

Binding

For example codes, see BasicResourceTypes
(example to http://hl7.org/fhir/ValueSet/basic-resource-type|4.0.1)

Codes for identifying types of resources not yet defined by FHIR.

Type

CodeableConcept

Is Modifier true because This element determines what kind of resource is being represented which drives the meaning of all of the other elements.

Summary true

Requirements

Must be able to distinguish different types of Basic resources.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

82. Basic.subject

Definition

Identifies the patient, practitioner, device or any other resource that is the "focus" of this resource.

Short Identifies the focus of this resource

Comments

Optional as not all potential resources will have subjects. Resources associated with multiple subjects can handle this via extension.

Control 0..1

Type Reference(Resource)

Is Modifier false

Summary true

Requirements

Needed for partitioning the resource by Patient.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

84. Basic.created

Definition

Identifies when the resource was first created.

Short When created

Control 0..1

Type

date

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Requirements

Allows ordering resource instances by time.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

86. Basic.author

Definition

Indicates who was responsible for creating the resource instance.

Short Who created

Control 0..1

Type Reference(Practitioner, PractitionerRole, Patient, RelatedPerson, Organization)

Is Modifier false

Summary true

Requirements

Needed for partitioning the resource.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))