Extensions for Using Data Elements from FHIR R5 in FHIR R4 - Downloaded Version null See the Directory of published versions
| Official URL: http://hl7.org/fhir/uv/xver/ConceptMap/R5-Requirements-element-map-to-R4 | Version: 0.1.0 | |||
| Standards status: Trial-use | Maturity Level: 0 | Computable Name: R5RequirementsElementMapToR4 | ||
This ConceptMap represents cross-version mappings for elements from a FHIR R5 Requirements to FHIR R4.
Mapping from http://hl7.org/fhir/5.0 to http://hl7.org/fhir/4.0
Group 1 Mapping from Requirements to Basic
| Source Code | Card. | Type | Relationship | Target Code | Card. | Type | Comment |
| Requirements.meta | 0..1 | todo | is equivalent to | Basic.meta | 0..1 | todo | Element matches Basic element path `Basic.meta` (`Resource.meta`), use that element instead. Element `Requirements.meta` is not mapped to FHIR R4, since FHIR R5 `Requirements` is not mapped. Element `Requirements.meta` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). |
| Requirements.implicitRules | 0..1 | todo | is equivalent to | Basic.implicitRules | 0..1 | todo | Element matches Basic element path `Basic.implicitRules` (`Resource.implicitRules`), use that element instead. Element `Requirements.implicitRules` is not mapped to FHIR R4, since FHIR R5 `Requirements` is not mapped. Element `Requirements.implicitRules` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc. |
| Requirements.language | 0..1 | todo | is equivalent to | Basic.language | 0..1 | todo | Element matches Basic element path `Basic.language` (`Resource.language`), use that element instead. Element `Requirements.language` is not mapped to FHIR R4, since FHIR R5 `Requirements` is not mapped. Element `Requirements.language` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). 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). |
| Requirements.text | 0..1 | todo | is equivalent to | Basic.text | 0..1 | todo | Element matches Basic element path `Basic.text` (`DomainResource.text`), use that element instead. Element `Requirements.text` is not mapped to FHIR R4, since FHIR R5 `Requirements` is not mapped. Element `Requirements.text` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. |
| Requirements.contained | 0..* | todo | is equivalent to | Basic.contained | 0..* | todo | Element matches Basic element path `Basic.contained` (`DomainResource.contained`), use that element instead. Element `Requirements.contained` is not mapped to FHIR R4, since FHIR R5 `Requirements` is not mapped. Element `Requirements.contained` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). 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. |
| Requirements.identifier | 0..* | todo | is equivalent to | Basic.identifier | 0..* | todo | Element matches Basic element path `Basic.identifier` (`Basic.identifier`), use that element instead. Element `Requirements.identifier` is not mapped to FHIR R4, since FHIR R5 `Requirements` is not mapped. Element `Requirements.identifier` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). |
Group 2 Mapping from Requirements to R5: Canonical identifier for this Requirements, represented as a URI (globally unique) (new)
| Source Code | Card. | Type | Relationship | Target Code | Card. | Type | Comment |
| Requirements.url | 0..1 | todo | maps to wider concept | Extension | 0..1 | todo | 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](https://hl7.org/fhir/resource..html#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](https://hl7.org/fhir/resou.html#meta) element to indicate where the current master source of the resource can be found. |
Group 3 Mapping from Requirements to R5: Business version of the Requirements (new)
| Source Code | Card. | Type | Relationship | Target Code | Card. | Type | Comment |
| Requirements.version | 0..1 | todo | maps to wider concept | Extension | 0..1 | todo | 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](https://hl7.org/fhir/resource.h.html#bv-format). |
Group 4 Mapping from Requirements to R5: How to compare versions (new)
| Source Code | Card. | Type | Relationship | Target Code | Card. | Type | Comment |
| Requirements.versionAlgorithm[x] | 0..1 | todo | maps to wider concept | Extension | 0..1 | todo | 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. |
Group 5 Mapping from Requirements to R5: Name for this Requirements (computer friendly) (new)
| Source Code | Card. | Type | Relationship | Target Code | Card. | Type | Comment |
| Requirements.name | 0..1 | todo | maps to wider concept | Extension | 0..1 | todo | 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. |
Group 6 Mapping from Requirements to R5: Name for this Requirements (human friendly) (new)
| Source Code | Card. | Type | Relationship | Target Code | Card. | Type | Comment |
| Requirements.title | 0..1 | todo | maps to wider concept | Extension | 0..1 | todo | 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. |
Group 7 Mapping from Requirements to R5: draft | active | retired | unknown (new)
| Source Code | Card. | Type | Relationship | Target Code | Card. | Type | Comment |
| Requirements.status | 1..1 | todo | maps to wider concept | Extension | 1..1 | todo | 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](https://hl7.org/fhir/canonicalreso.html#localization). |
Group 8 Mapping from Requirements to R5: For testing purposes, not real usage (new)
| Source Code | Card. | Type | Relationship | Target Code | Card. | Type | Comment |
| Requirements.experimental | 0..1 | todo | maps to wider concept | Extension | 0..1 | todo | 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. |
Group 9 Mapping from Requirements to R5: Date last changed (new)
| Source Code | Card. | Type | Relationship | Target Code | Card. | Type | Comment |
| Requirements.date | 0..1 | todo | maps to wider concept | Extension | 0..1 | todo | 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](https://hl7.org/fhir/canonicalreso.html#localization). |
Group 10 Mapping from Requirements to R5: Name of the publisher/steward (organization or individual) (new)
| Source Code | Card. | Type | Relationship | Target Code | Card. | Type | Comment |
| Requirements.publisher | 0..1 | todo | maps to wider concept | Extension | 0..1 | todo | 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. |
Group 11 Mapping from Requirements to R5: Contact details for the publisher (new)
| Source Code | Card. | Type | Relationship | Target Code | Card. | Type | Comment |
| Requirements.contact | 0..* | todo | maps to wider concept | Extension | 0..* | todo | 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](https://hl7.org/fhir/canonicalreso.html#localization). |
Group 12 Mapping from Requirements to R5: Natural language description of the requirements (new)
| Source Code | Card. | Type | Relationship | Target Code | Card. | Type | Comment |
| Requirements.description | 0..1 | todo | maps to wider concept | Extension | 0..1 | todo | 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. |
Group 13 Mapping from Requirements to R5: The context that the content is intended to support (new)
| Source Code | Card. | Type | Relationship | Target Code | Card. | Type | Comment |
| Requirements.useContext | 0..* | todo | maps to wider concept | Extension | 0..* | todo | 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. |
Group 14 Mapping from Requirements to R5: Intended jurisdiction for Requirements (if applicable) (new)
| Source Code | Card. | Type | Relationship | Target Code | Card. | Type | Comment |
| Requirements.jurisdiction | 0..* | todo | maps to wider concept | Extension | 0..* | todo | 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.). |
Group 15 Mapping from Requirements to R5: Why this Requirements is defined (new)
| Source Code | Card. | Type | Relationship | Target Code | Card. | Type | Comment |
| Requirements.purpose | 0..1 | todo | maps to wider concept | Extension | 0..1 | todo | 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. |
Group 16 Mapping from Requirements to R5: Use and/or publishing restrictions (new)
| Source Code | Card. | Type | Relationship | Target Code | Card. | Type | Comment |
| Requirements.copyright | 0..1 | todo | maps to wider concept | Extension | 0..1 | todo | 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). ... |
Group 17 Mapping from Requirements to R5: Copyright holder and year(s) (new)
| Source Code | Card. | Type | Relationship | Target Code | Card. | Type | Comment |
| Requirements.copyrightLabel | 0..1 | todo | maps to wider concept | Extension | 0..1 | todo | 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. |
Group 18 Mapping from Requirements to R5: Other set of Requirements this builds on (new)
| Source Code | Card. | Type | Relationship | Target Code | Card. | Type | Comment |
| Requirements.derivedFrom | 0..* | todo | maps to wider concept | Extension | 0..* | todo | 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. |
Group 19 Mapping from Requirements to R5: External artifact (rule/document etc. that) created this set of requirements (new)
| Source Code | Card. | Type | Relationship | Target Code | Card. | Type | Comment |
| Requirements.reference | 0..* | todo | maps to wider concept | Extension | 0..* | todo | 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). |
Group 20 Mapping from Requirements to R5: Actor for these requirements (new)
| Source Code | Card. | Type | Relationship | Target Code | Card. | Type | Comment |
| Requirements.actor | 0..* | todo | maps to wider concept | Extension | 0..* | todo | 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. |
Group 21 Mapping from Requirements to R5: Actual statement as markdown (new)
| Source Code | Card. | Type | Relationship | Target Code | Card. | Type | Comment |
| Requirements.statement | 0..* | todo | maps to wider concept | Extension | 0..* | todo | 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). |
| Requirements.statement.key | 1..1 | todo | maps to wider concept | Extension.extension:key | 1..1 | todo | Element `Requirements.statement.key` is part of an existing definition because parent element `Requirements.statement` requires a cross-version extension. Element `Requirements.statement.key` is not mapped to FHIR R4, since FHIR R5 `Requirements` is not mapped. Element `Requirements.statement.key` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). Refer directly to the statement by {url}#{key} |
| Requirements.statement.label | 0..1 | todo | maps to wider concept | Extension.extension:label | 0..1 | todo | Element `Requirements.statement.label` is part of an existing definition because parent element `Requirements.statement` requires a cross-version extension. Element `Requirements.statement.label` is not mapped to FHIR R4, since FHIR R5 `Requirements` is not mapped. Element `Requirements.statement.label` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). The key is intended for computers, while this is intended for humans. In its absence, the key should be convenient for a human to say (e.g. not a UUID) |
| Requirements.statement.conformance | 0..* | todo | maps to wider concept | Extension.extension:conformance | 0..* | todo | Element `Requirements.statement.conformance` is part of an existing definition because parent element `Requirements.statement` requires a cross-version extension. Element `Requirements.statement.conformance` is not mapped to FHIR R4, since FHIR R5 `Requirements` is not mapped. Element `Requirements.statement.conformance` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). The conformance code is extracted from the requirement to make indexing and display easier. The requirement needs to express the conformance verbs directly in the markdown content. It's not unusual to mix verbs in a single sentence (e.g. System SHALL do X and SHOULD do Y) |
| Requirements.statement.conditionality | 0..1 | todo | maps to wider concept | Extension.extension:conditionality | 0..1 | todo | Element `Requirements.statement.conditionality` is part of an existing definition because parent element `Requirements.statement` requires a cross-version extension. Element `Requirements.statement.conditionality` is not mapped to FHIR R4, since FHIR R5 `Requirements` is not mapped. Element `Requirements.statement.conditionality` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). There is no intent that the conditional statement by evaluatable |
| Requirements.statement.requirement | 1..1 | todo | maps to wider concept | Extension.extension:requirement | 1..1 | todo | Element `Requirements.statement.requirement` is part of an existing definition because parent element `Requirements.statement` requires a cross-version extension. Element `Requirements.statement.requirement` is not mapped to FHIR R4, since FHIR R5 `Requirements` is not mapped. Element `Requirements.statement.requirement` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). |
| Requirements.statement.derivedFrom | 0..1 | todo | maps to wider concept | Extension.extension:derivedFrom | 0..1 | todo | Element `Requirements.statement.derivedFrom` is part of an existing definition because parent element `Requirements.statement` requires a cross-version extension. Element `Requirements.statement.derivedFrom` is not mapped to FHIR R4, since FHIR R5 `Requirements` is not mapped. Element `Requirements.statement.derivedFrom` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). This can be just a key, if there is only one matching statement in the requirements statements referenced in Requirements.derivedFrom. If there is more than one, it should be in the format ```url#key``` |
| Requirements.statement.parent | 0..1 | todo | maps to wider concept | Extension.extension:parent | 0..1 | todo | Element `Requirements.statement.parent` is part of an existing definition because parent element `Requirements.statement` requires a cross-version extension. Element `Requirements.statement.parent` is not mapped to FHIR R4, since FHIR R5 `Requirements` is not mapped. Element `Requirements.statement.parent` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). Follows the same convention as statement.derivedFrom, where a reference is the canonical of the Requirements followed by '#' and the 'key' of the specific requirement. |
| Requirements.statement.satisfiedBy | 0..* | todo | maps to wider concept | Extension.extension:satisfiedBy | 0..* | todo | Element `Requirements.statement.satisfiedBy` is part of an existing definition because parent element `Requirements.statement` requires a cross-version extension. Element `Requirements.statement.satisfiedBy` is not mapped to FHIR R4, since FHIR R5 `Requirements` is not mapped. Element `Requirements.statement.satisfiedBy` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). This is for use when the requirement is met be a pre-existing artifact e.g. a rule that's met by the base FHIR spec, or a national implementation guide. |
| Requirements.statement.reference | 0..* | todo | maps to wider concept | Extension.extension:reference | 0..* | todo | Element `Requirements.statement.reference` is part of an existing definition because parent element `Requirements.statement` requires a cross-version extension. Element `Requirements.statement.reference` is not mapped to FHIR R4, since FHIR R5 `Requirements` is not mapped. Element `Requirements.statement.reference` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). |
| Requirements.statement.source | 0..* | todo | maps to wider concept | Extension.extension:source | 0..* | todo | Element `Requirements.statement.source` is part of an existing definition because parent element `Requirements.statement` requires a cross-version extension. Element `Requirements.statement.source` is not mapped to FHIR R4, since FHIR R5 `Requirements` is not mapped. Element `Requirements.statement.source` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). |