Profile_R5_Requirements_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_Requirements_R4 - Detailed Descriptions

Page standards status: Trial-use

Maturity Level: 0

Definitions for the profile-Requirements 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: `Requirements.url` (new:uri)
Short	R5: Canonical identifier for this Requirements, represented as a URI (globally unique) (new)
Comments	Element `Requirements.url` is not mapped to FHIR R4, since FHIR R5 `Requirements` is not mapped. Element `Requirements.url` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version. The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in Technical and Business Versions. 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 Requirements, represented as a URI (globally unique) (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: `Requirements.version` (new:string)
Short	R5: Business version of the Requirements (new)
Comments	Element `Requirements.version` is not mapped to FHIR R4, since FHIR R5 `Requirements` is not mapped. Element `Requirements.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 Requirements 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 Requirements 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 Requirements (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: `Requirements.versionAlgorithm[x]` (new:Coding, string)
Short	R5: How to compare versions (new)
Comments	Element `Requirements.versionAlgorithm[x]` is not mapped to FHIR R4, since FHIR R5 `Requirements` is not mapped. Element `Requirements.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 and a 0 if the version ordering can't be 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: `Requirements.name` (new:string)
Short	R5: Name for this Requirements (computer friendly) (new)
Comments	Element `Requirements.name` is not mapped to FHIR R4, since FHIR R5 `Requirements` is not mapped. Element `Requirements.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 Requirements (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: `Requirements.title` (new:string)
Short	R5: Name for this Requirements (human friendly) (new)
Comments	Element `Requirements.title` is not mapped to FHIR R4, since FHIR R5 `Requirements` is not mapped. Element `Requirements.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.
Control	0..1 This element is affected by the following invariants: ele-1
Type	Extension(R5: Name for this Requirements (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: `Requirements.experimental` (new:boolean)
Short	R5: For testing purposes, not real usage (new)
Comments	Element `Requirements.experimental` is not mapped to FHIR R4, since FHIR R5 `Requirements` is not mapped. Element `Requirements.experimental` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). Allows filtering of Requirements 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: `Requirements.date` (new:dateTime)
Short	R5: Date last changed (new)
Comments	Element `Requirements.date` is not mapped to FHIR R4, since FHIR R5 `Requirements` is not mapped. Element `Requirements.date` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the Requirements. 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: `Requirements.publisher` (new:string)
Short	R5: Name of the publisher/steward (organization or individual) (new)
Comments	Element `Requirements.publisher` is not mapped to FHIR R4, since FHIR R5 `Requirements` is not mapped. Element `Requirements.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 Requirements is the organization or individual primarily responsible for the maintenance and upkeep of the Requirements. 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 Requirements. 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: Name of the publisher/steward (organization or individual) (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: `Requirements.contact` (new:ContactDetail)
Short	R5: Contact details for the publisher (new)
Comments	Element `Requirements.contact` is not mapped to FHIR R4, since FHIR R5 `Requirements` is not mapped. Element `Requirements.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 (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: `Requirements.description` (new:markdown)
Short	R5: Natural language description of the requirements (new)
Comments	Element `Requirements.description` is not mapped to FHIR R4, since FHIR R5 `Requirements` is not mapped. Element `Requirements.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 for a general description of the requirements, and which covers why it was defined.
Control	0..1 This element is affected by the following invariants: ele-1
Type	Extension(R5: Natural language description of the requirements (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: `Requirements.useContext` (new:UsageContext)
Short	R5: The context that the content is intended to support (new)
Comments	Element `Requirements.useContext` is not mapped to FHIR R4, since FHIR R5 `Requirements` is not mapped. Element `Requirements.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 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: `Requirements.jurisdiction` (new:CodeableConcept)
Short	R5: Intended jurisdiction for Requirements (if applicable) (new)
Comments	Element `Requirements.jurisdiction` is not mapped to FHIR R4, since FHIR R5 `Requirements` is not mapped. Element `Requirements.jurisdiction` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). Element `Requirements.jurisdiction` has been flagged as deprecated. It may be possible for the Requirements 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 Requirements (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: `Requirements.purpose` (new:markdown)
Short	R5: Why this Requirements is defined (new)
Comments	Element `Requirements.purpose` is not mapped to FHIR R4, since FHIR R5 `Requirements` is not mapped. Element `Requirements.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 Requirements. 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 Requirements.
Control	0..1 This element is affected by the following invariants: ele-1
Type	Extension(R5: Why this Requirements 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: `Requirements.copyright` (new:markdown)
Short	R5: Use and/or publishing restrictions (new)
Comments	Element `Requirements.copyright` is not mapped to FHIR R4, since FHIR R5 `Requirements` is not mapped. Element `Requirements.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 (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: `Requirements.copyrightLabel` (new:string)
Short	R5: Copyright holder and year(s) (new)
Comments	Element `Requirements.copyrightLabel` is not mapped to FHIR R4, since FHIR R5 `Requirements` is not mapped. Element `Requirements.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) (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:derivedFrom
Slice Name	derivedFrom
Definition	R5: `Requirements.derivedFrom` (new:canonical(Requirements))
Short	R5: Other set of Requirements this builds on (new)
Comments	Element `Requirements.derivedFrom` is not mapped to FHIR R4, since FHIR R5 `Requirements` is not mapped. Element `Requirements.derivedFrom` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). Existing statements (by key) may be narrowed or clarified, and additional statements added.
Control	0..* This element is affected by the following invariants: ele-1
Type	Extension(R5: Other set of Requirements this builds on (new)) (Extension Type: canonical(Cross-version Profile for R5.Requirements for use in FHIR R4, Basic))
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:reference
Slice Name	reference
Definition	R5: `Requirements.reference` (new:url)
Short	R5: External artifact (rule/document etc. that) created this set of requirements (new)
Comments	Element `Requirements.reference` is not mapped to FHIR R4, since FHIR R5 `Requirements` is not mapped. Element `Requirements.reference` 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: External artifact (rule/document etc. that) created this set of requirements (new)) (Extension Type: url)
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:actor
Slice Name	actor
Definition	R5: `Requirements.actor` (new:canonical(ActorDefinition))
Short	R5: Actor for these requirements (new)
Comments	Element `Requirements.actor` is not mapped to FHIR R4, since FHIR R5 `Requirements` is not mapped. Element `Requirements.actor` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). If more than one actor is specified, then it's up to the statements to describe in narrative if they don't apply to all actors.
Control	0..* This element is affected by the following invariants: ele-1
Type	Extension(R5: Actor for these requirements (new)) (Extension Type: canonical(Cross-version Profile for R5.ActorDefinition for use in FHIR R4, Basic))
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:statement
Slice Name	statement
Definition	R5: `Requirements.statement` (new:BackboneElement)
Short	R5: Actual statement as markdown (new)
Comments	Element `Requirements.statement` is not mapped to FHIR R4, since FHIR R5 `Requirements` is not mapped. Element `Requirements.statement` 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: Actual statement as markdown (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()`)
44. 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
46. Basic.modifierExtension:status
Slice Name	status
Definition	R5: `Requirements.status` (new:code)
Short	R5: draft \| active \| retired \| unknown (new)
Comments	Element `Requirements.status` is not mapped to FHIR R4, since FHIR R5 `Requirements` is not mapped. Element `Requirements.status` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). Allows filtering of Requirements that are appropriate for use versus not. 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 designs and applications should not use a retired Requirements 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())
48. 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: `Requirements.url` (new:uri)
Short	R5: Canonical identifier for this Requirements, represented as a URI (globally unique) (new)
Comments	Element `Requirements.url` is not mapped to FHIR R4, since FHIR R5 `Requirements` is not mapped. Element `Requirements.url` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version. The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in Technical and Business Versions. 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 Requirements, represented as a URI (globally unique) (new)) (Extension Type: uri)
6. Basic.extension:version
Slice Name	version
Definition	R5: `Requirements.version` (new:string)
Short	R5: Business version of the Requirements (new)
Comments	Element `Requirements.version` is not mapped to FHIR R4, since FHIR R5 `Requirements` is not mapped. Element `Requirements.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 Requirements 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 Requirements with the format [url]\|[version]. The version SHOULD NOT contain a '#' - see Business Version.
Control	0..1
Type	Extension(R5: Business version of the Requirements (new)) (Extension Type: string)
8. Basic.extension:versionAlgorithm
Slice Name	versionAlgorithm
Definition	R5: `Requirements.versionAlgorithm[x]` (new:Coding, string)
Short	R5: How to compare versions (new)
Comments	Element `Requirements.versionAlgorithm[x]` is not mapped to FHIR R4, since FHIR R5 `Requirements` is not mapped. Element `Requirements.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 and a 0 if the version ordering can't be 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: `Requirements.name` (new:string)
Short	R5: Name for this Requirements (computer friendly) (new)
Comments	Element `Requirements.name` is not mapped to FHIR R4, since FHIR R5 `Requirements` is not mapped. Element `Requirements.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 Requirements (computer friendly) (new)) (Extension Type: string)
12. Basic.extension:title
Slice Name	title
Definition	R5: `Requirements.title` (new:string)
Short	R5: Name for this Requirements (human friendly) (new)
Comments	Element `Requirements.title` is not mapped to FHIR R4, since FHIR R5 `Requirements` is not mapped. Element `Requirements.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.
Control	0..1
Type	Extension(R5: Name for this Requirements (human friendly) (new)) (Extension Type: string)
14. Basic.extension:experimental
Slice Name	experimental
Definition	R5: `Requirements.experimental` (new:boolean)
Short	R5: For testing purposes, not real usage (new)
Comments	Element `Requirements.experimental` is not mapped to FHIR R4, since FHIR R5 `Requirements` is not mapped. Element `Requirements.experimental` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). Allows filtering of Requirements 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: `Requirements.date` (new:dateTime)
Short	R5: Date last changed (new)
Comments	Element `Requirements.date` is not mapped to FHIR R4, since FHIR R5 `Requirements` is not mapped. Element `Requirements.date` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the Requirements. 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: `Requirements.publisher` (new:string)
Short	R5: Name of the publisher/steward (organization or individual) (new)
Comments	Element `Requirements.publisher` is not mapped to FHIR R4, since FHIR R5 `Requirements` is not mapped. Element `Requirements.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 Requirements is the organization or individual primarily responsible for the maintenance and upkeep of the Requirements. 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 Requirements. This item SHOULD be populated unless the information is available from context.
Control	0..1
Type	Extension(R5: Name of the publisher/steward (organization or individual) (new)) (Extension Type: string)
20. Basic.extension:contact
Slice Name	contact
Definition	R5: `Requirements.contact` (new:ContactDetail)
Short	R5: Contact details for the publisher (new)
Comments	Element `Requirements.contact` is not mapped to FHIR R4, since FHIR R5 `Requirements` is not mapped. Element `Requirements.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 (new)) (Extension Type: ContactDetail)
22. Basic.extension:description
Slice Name	description
Definition	R5: `Requirements.description` (new:markdown)
Short	R5: Natural language description of the requirements (new)
Comments	Element `Requirements.description` is not mapped to FHIR R4, since FHIR R5 `Requirements` is not mapped. Element `Requirements.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 for a general description of the requirements, and which covers why it was defined.
Control	0..1
Type	Extension(R5: Natural language description of the requirements (new)) (Extension Type: markdown)
24. Basic.extension:useContext
Slice Name	useContext
Definition	R5: `Requirements.useContext` (new:UsageContext)
Short	R5: The context that the content is intended to support (new)
Comments	Element `Requirements.useContext` is not mapped to FHIR R4, since FHIR R5 `Requirements` is not mapped. Element `Requirements.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 content is intended to support (new)) (Extension Type: UsageContext)
26. Basic.extension:jurisdiction
Slice Name	jurisdiction
Definition	R5: `Requirements.jurisdiction` (new:CodeableConcept)
Short	R5: Intended jurisdiction for Requirements (if applicable) (new)
Comments	Element `Requirements.jurisdiction` is not mapped to FHIR R4, since FHIR R5 `Requirements` is not mapped. Element `Requirements.jurisdiction` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). Element `Requirements.jurisdiction` has been flagged as deprecated. It may be possible for the Requirements 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 Requirements (if applicable) (new)) (Extension Type: CodeableConcept)
28. Basic.extension:purpose
Slice Name	purpose
Definition	R5: `Requirements.purpose` (new:markdown)
Short	R5: Why this Requirements is defined (new)
Comments	Element `Requirements.purpose` is not mapped to FHIR R4, since FHIR R5 `Requirements` is not mapped. Element `Requirements.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 Requirements. 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 Requirements.
Control	0..1
Type	Extension(R5: Why this Requirements is defined (new)) (Extension Type: markdown)
30. Basic.extension:copyright
Slice Name	copyright
Definition	R5: `Requirements.copyright` (new:markdown)
Short	R5: Use and/or publishing restrictions (new)
Comments	Element `Requirements.copyright` is not mapped to FHIR R4, since FHIR R5 `Requirements` is not mapped. Element `Requirements.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 (new)) (Extension Type: markdown)
32. Basic.extension:copyrightLabel
Slice Name	copyrightLabel
Definition	R5: `Requirements.copyrightLabel` (new:string)
Short	R5: Copyright holder and year(s) (new)
Comments	Element `Requirements.copyrightLabel` is not mapped to FHIR R4, since FHIR R5 `Requirements` is not mapped. Element `Requirements.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) (new)) (Extension Type: string)
34. Basic.extension:derivedFrom
Slice Name	derivedFrom
Definition	R5: `Requirements.derivedFrom` (new:canonical(Requirements))
Short	R5: Other set of Requirements this builds on (new)
Comments	Element `Requirements.derivedFrom` is not mapped to FHIR R4, since FHIR R5 `Requirements` is not mapped. Element `Requirements.derivedFrom` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). Existing statements (by key) may be narrowed or clarified, and additional statements added.
Control	0..*
Type	Extension(R5: Other set of Requirements this builds on (new)) (Extension Type: canonical(Cross-version Profile for R5.Requirements for use in FHIR R4, Basic))
36. Basic.extension:reference
Slice Name	reference
Definition	R5: `Requirements.reference` (new:url)
Short	R5: External artifact (rule/document etc. that) created this set of requirements (new)
Comments	Element `Requirements.reference` is not mapped to FHIR R4, since FHIR R5 `Requirements` is not mapped. Element `Requirements.reference` 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: External artifact (rule/document etc. that) created this set of requirements (new)) (Extension Type: url)
38. Basic.extension:actor
Slice Name	actor
Definition	R5: `Requirements.actor` (new:canonical(ActorDefinition))
Short	R5: Actor for these requirements (new)
Comments	Element `Requirements.actor` is not mapped to FHIR R4, since FHIR R5 `Requirements` is not mapped. Element `Requirements.actor` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). If more than one actor is specified, then it's up to the statements to describe in narrative if they don't apply to all actors.
Control	0..*
Type	Extension(R5: Actor for these requirements (new)) (Extension Type: canonical(Cross-version Profile for R5.ActorDefinition for use in FHIR R4, Basic))
40. Basic.extension:statement
Slice Name	statement
Definition	R5: `Requirements.statement` (new:BackboneElement)
Short	R5: Actual statement as markdown (new)
Comments	Element `Requirements.statement` is not mapped to FHIR R4, since FHIR R5 `Requirements` is not mapped. Element `Requirements.statement` 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: Actual statement as markdown (new)) (Complex Extension)
42. 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
44. Basic.modifierExtension:status
Slice Name	status
Definition	R5: `Requirements.status` (new:code)
Short	R5: draft \| active \| retired \| unknown (new)
Comments	Element `Requirements.status` is not mapped to FHIR R4, since FHIR R5 `Requirements` is not mapped. Element `Requirements.status` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). Allows filtering of Requirements that are appropriate for use versus not. 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: Requirements.url (new:uri)

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

Comments

Element Requirements.url is not mapped to FHIR R4, since FHIR R5 Requirements is not mapped. Element Requirements.url has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.

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

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 Requirements, represented as a URI (globally unique) (new)) (Extension Type: uri)

Is Modifier false

Summary false

18. Basic.extension:version

Slice Name version

Definition

R5: Requirements.version (new:string)

Short R5: Business version of the Requirements (new)

Comments

Element Requirements.version is not mapped to FHIR R4, since FHIR R5 Requirements is not mapped. Element Requirements.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 Requirements 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 Requirements 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 Requirements (new)) (Extension Type: string)

Is Modifier false

Summary false

20. Basic.extension:versionAlgorithm

Slice Name versionAlgorithm

Definition

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

Short R5: How to compare versions (new)

Comments

Element Requirements.versionAlgorithm[x] is not mapped to FHIR R4, since FHIR R5 Requirements is not mapped. Element Requirements.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 and a 0 if the version ordering can't be 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: Requirements.name (new:string)

Short R5: Name for this Requirements (computer friendly) (new)

Comments

Element Requirements.name is not mapped to FHIR R4, since FHIR R5 Requirements is not mapped. Element Requirements.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 Requirements (computer friendly) (new)) (Extension Type: string)

Is Modifier false

Summary false

24. Basic.extension:title

Slice Name title

Definition

R5: Requirements.title (new:string)

Short R5: Name for this Requirements (human friendly) (new)

Comments

Element Requirements.title is not mapped to FHIR R4, since FHIR R5 Requirements is not mapped. Element Requirements.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.

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

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

Is Modifier false

Summary false

26. Basic.extension:experimental

Slice Name experimental

Definition

R5: Requirements.experimental (new:boolean)

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

Comments

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

Short R5: Date last changed (new)

Comments

Element Requirements.date is not mapped to FHIR R4, since FHIR R5 Requirements is not mapped. Element Requirements.date has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the Requirements. 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: Requirements.publisher (new:string)

Short R5: Name of the publisher/steward (organization or individual) (new)

Comments

Element Requirements.publisher is not mapped to FHIR R4, since FHIR R5 Requirements is not mapped. Element Requirements.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 Requirements is the organization or individual primarily responsible for the maintenance and upkeep of the Requirements. 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 Requirements. 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: Name of the publisher/steward (organization or individual) (new)) (Extension Type: string)

Is Modifier false

Summary false

32. Basic.extension:contact

Slice Name contact

Definition

R5: Requirements.contact (new:ContactDetail)

Short R5: Contact details for the publisher (new)

Comments

Element Requirements.contact is not mapped to FHIR R4, since FHIR R5 Requirements is not mapped. Element Requirements.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 (new)) (Extension Type: ContactDetail)

Is Modifier false

Summary false

34. Basic.extension:description

Slice Name description

Definition

R5: Requirements.description (new:markdown)

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

Comments

Element Requirements.description is not mapped to FHIR R4, since FHIR R5 Requirements is not mapped. Element Requirements.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 for a general description of the requirements, and which covers why it was defined.

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

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

Is Modifier false

Summary false

36. Basic.extension:useContext

Slice Name useContext

Definition

R5: Requirements.useContext (new:UsageContext)

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

Comments

Element Requirements.useContext is not mapped to FHIR R4, since FHIR R5 Requirements is not mapped. Element Requirements.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 content is intended to support (new)) (Extension Type: UsageContext)

Is Modifier false

Summary false

38. Basic.extension:jurisdiction

Slice Name jurisdiction

Definition

R5: Requirements.jurisdiction (new:CodeableConcept)

Short R5: Intended jurisdiction for Requirements (if applicable) (new)

Comments

Element Requirements.jurisdiction is not mapped to FHIR R4, since FHIR R5 Requirements is not mapped. Element Requirements.jurisdiction has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). Element Requirements.jurisdiction has been flagged as deprecated. It may be possible for the Requirements 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 Requirements (if applicable) (new)) (Extension Type: CodeableConcept)

Is Modifier false

Summary false

40. Basic.extension:purpose

Slice Name purpose

Definition

R5: Requirements.purpose (new:markdown)

Short R5: Why this Requirements is defined (new)

Comments

Element Requirements.purpose is not mapped to FHIR R4, since FHIR R5 Requirements is not mapped. Element Requirements.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 Requirements. 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 Requirements.

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

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

Is Modifier false

Summary false

42. Basic.extension:copyright

Slice Name copyright

Definition

R5: Requirements.copyright (new:markdown)

Short R5: Use and/or publishing restrictions (new)

Comments

Element Requirements.copyright is not mapped to FHIR R4, since FHIR R5 Requirements is not mapped. Element Requirements.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 (new)) (Extension Type: markdown)

Is Modifier false

Summary false

44. Basic.extension:copyrightLabel

Slice Name copyrightLabel

Definition

R5: Requirements.copyrightLabel (new:string)

Short R5: Copyright holder and year(s) (new)

Comments

Element Requirements.copyrightLabel is not mapped to FHIR R4, since FHIR R5 Requirements is not mapped. Element Requirements.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) (new)) (Extension Type: string)

Is Modifier false

Summary false

46. Basic.extension:derivedFrom

Slice Name derivedFrom

Definition

R5: Requirements.derivedFrom (new:canonical(Requirements))

Short R5: Other set of Requirements this builds on (new)

Comments

Element Requirements.derivedFrom is not mapped to FHIR R4, since FHIR R5 Requirements is not mapped. Element Requirements.derivedFrom has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). Existing statements (by key) may be narrowed or clarified, and additional statements added.

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

Type Extension(R5: Other set of Requirements this builds on (new)) (Extension Type: canonical(Cross-version Profile for R5.Requirements for use in FHIR R4, Basic))

Is Modifier false

Summary false

48. Basic.extension:reference

Slice Name reference

Definition

R5: Requirements.reference (new:url)

Short R5: External artifact (rule/document etc. that) created this set of requirements (new)

Comments

Element Requirements.reference is not mapped to FHIR R4, since FHIR R5 Requirements is not mapped. Element Requirements.reference 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: External artifact (rule/document etc. that) created this set of requirements (new)) (Extension Type: url)

Is Modifier false

Summary false

50. Basic.extension:actor

Slice Name actor

Definition

R5: Requirements.actor (new:canonical(ActorDefinition))

Short R5: Actor for these requirements (new)

Comments

Element Requirements.actor is not mapped to FHIR R4, since FHIR R5 Requirements is not mapped. Element Requirements.actor has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). If more than one actor is specified, then it's up to the statements to describe in narrative if they don't apply to all actors.

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

Type Extension(R5: Actor for these requirements (new)) (Extension Type: canonical(Cross-version Profile for R5.ActorDefinition for use in FHIR R4, Basic))

Is Modifier false

Summary false

52. Basic.extension:statement

Slice Name statement

Definition

R5: Requirements.statement (new:BackboneElement)

Short R5: Actual statement as markdown (new)

Comments

Element Requirements.statement is not mapped to FHIR R4, since FHIR R5 Requirements is not mapped. Element Requirements.statement 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: Actual statement as markdown (new)) (Complex Extension)

Is Modifier false

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

56. Basic.modifierExtension:status

Slice Name status

Definition

R5: Requirements.status (new:code)

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

Comments

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

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 designs and applications should not use a retired Requirements without due consideration

Summary false

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

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

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

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

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