FHIR IG analytics| Package | hl7.fhir.uv.xver-r5.r4 |
| Resource Type | ConceptMap |
| Id | ConceptMap-R5-CodeSystem-element-map-to-R4.json |
| FHIR Version | R4 |
| Source | http://hl7.org/fhir/uv/xver-r5.r4/0.1.0/ConceptMap-R5-CodeSystem-element-map-to-R4.html |
| URL | http://hl7.org/fhir/uv/xver/ConceptMap/R5-CodeSystem-element-map-to-R4 |
| Version | 0.1.0 |
| Status | active |
| Date | 2026-03-17T16:04:44.662611-05:00 |
| Name | R5CodeSystemElementMapToR4 |
| Title | Cross-version mapping for FHIR R5 CodeSystem to FHIR R4 CodeSystem |
| Realm | uv |
| Authority | hl7 |
| Description | This ConceptMap represents cross-version mappings for elements from a FHIR R5 CodeSystem to FHIR R4. |
No resources found
| StructureDefinition | ||
| hl7.fhir.uv.xver-r5.r4.r4#0.0.1-snapshot-2 | extension-CodeSystem.concept.designation.additionalUse | Cross-version Extension for R5.CodeSystem.concept.designation.additionalUse for use in FHIR R4 |
| hl7.fhir.uv.xver-r5.r4.r4#0.0.1-snapshot-2 | extension-CodeSystem.filter.operator | Cross-version Extension for R5.CodeSystem.filter.operator for use in FHIR R4 |
Note: links and images are rebased to the (stated) source
Generated Narrative: ConceptMap R5-CodeSystem-element-map-to-R4
Mapping from http://hl7.org/fhir/5.0 to http://hl7.org/fhir/4.0
Group 1 Mapping from http://hl7.org/fhir/StructureDefinition/CodeSystem|5.0.0 to CodeSystemversion: 4.0.1)
| Source Code | Relationship | Target Code | Comment |
| CodeSystem.meta (meta) | is equivalent to | CodeSystem.meta | Element `CodeSystem.meta` is mapped to FHIR R4 element `CodeSystem.meta` as `Equivalent`. |
| CodeSystem.implicitRules (implicitRules) | is equivalent to | CodeSystem.implicitRules | Element `CodeSystem.implicitRules` is mapped to FHIR R4 element `CodeSystem.implicitRules` as `Equivalent`. 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. |
| CodeSystem.language (language) | is equivalent to | CodeSystem.language | Element `CodeSystem.language` is mapped to FHIR R4 element `CodeSystem.language` as `Equivalent`. 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). |
| CodeSystem.text (text) | is equivalent to | CodeSystem.text | Element `CodeSystem.text` is mapped to FHIR R4 element `CodeSystem.text` as `Equivalent`. 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. |
| CodeSystem.contained (contained) | is equivalent to | CodeSystem.contained | Element `CodeSystem.contained` is mapped to FHIR R4 element `CodeSystem.contained` as `Equivalent`. 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. |
| CodeSystem.url (url) | is equivalent to | CodeSystem.url | Element `CodeSystem.url` is mapped to FHIR R4 element `CodeSystem.url` as `Equivalent`. 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. |
| CodeSystem.identifier (identifier) | is equivalent to | CodeSystem.identifier | Element `CodeSystem.identifier` is mapped to FHIR R4 element `CodeSystem.identifier` as `Equivalent`. Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this code system outside of FHIR, where it is not possible to use the logical URI. Note that HL7 defines at least three identifiers for many of its code systems - the FHIR canonical URL, the OID and the V2 Table 0396 mnemonic code. |
| CodeSystem.version (version) | is equivalent to | CodeSystem.version | Element `CodeSystem.version` is mapped to FHIR R4 element `CodeSystem.version` as `Equivalent`. There may be different code system 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 code system with the format [url]|[version]. The version SHOULD NOT contain a '#' - see [Business Version](https://hl7.org/fhir/resource.h.html#bv-format). |
| CodeSystem.name (name) | is equivalent to | CodeSystem.name | Element `CodeSystem.name` is mapped to FHIR R4 element `CodeSystem.name` as `Equivalent`. 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. |
| CodeSystem.title (title) | is equivalent to | CodeSystem.title | Element `CodeSystem.title` is mapped to FHIR R4 element `CodeSystem.title` as `Equivalent`. This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc. |
| CodeSystem.status (status) | is equivalent to | CodeSystem.status | Element `CodeSystem.status` is mapped to FHIR R4 element `CodeSystem.status` as `Equivalent`. Allows filtering of code systems that are appropriate for use versus not. See guidance around (not) making local changes to elements [here](https://hl7.org/fhir/canonicalreso.html#localization). |
| CodeSystem.experimental (experimental) | is equivalent to | CodeSystem.experimental | Element `CodeSystem.experimental` is mapped to FHIR R4 element `CodeSystem.experimental` as `Equivalent`. Allows filtering of code systems that are appropriate for use versus not. |
| CodeSystem.date (date) | is equivalent to | CodeSystem.date | Element `CodeSystem.date` is mapped to FHIR R4 element `CodeSystem.date` as `Equivalent`. The date is often not tracked until the resource is published, but may be present on draft content. Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the code system. 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). |
| CodeSystem.publisher (publisher) | is equivalent to | CodeSystem.publisher | Element `CodeSystem.publisher` is mapped to FHIR R4 element `CodeSystem.publisher` as `Equivalent`. Usually an organization but may be an individual. The publisher (or steward) of the code system is the organization or individual primarily responsible for the maintenance and upkeep of the code system. 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 code system. This item SHOULD be populated unless the information is available from context. |
| CodeSystem.contact (contact) | is equivalent to | CodeSystem.contact | Element `CodeSystem.contact` is mapped to FHIR R4 element `CodeSystem.contact` as `Equivalent`. 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). |
| CodeSystem.description (description) | is equivalent to | CodeSystem.description | Element `CodeSystem.description` is mapped to FHIR R4 element `CodeSystem.description` as `Equivalent`. This description can be used to capture details such as comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the code system as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the code system is presumed to be the predominant language in the place the code system was created). |
| CodeSystem.useContext (useContext) | is equivalent to | CodeSystem.useContext | Element `CodeSystem.useContext` is mapped to FHIR R4 element `CodeSystem.useContext` as `Equivalent`. When multiple useContexts are specified, there is no expectation that all or any of the contexts apply. |
| CodeSystem.jurisdiction (jurisdiction) | is equivalent to | CodeSystem.jurisdiction | Element `CodeSystem.jurisdiction` is mapped to FHIR R4 element `CodeSystem.jurisdiction` as `Equivalent`. Element `CodeSystem.jurisdiction` has been flagged as deprecated. It may be possible for the code system 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.) |
| CodeSystem.purpose (purpose) | is equivalent to | CodeSystem.purpose | Element `CodeSystem.purpose` is mapped to FHIR R4 element `CodeSystem.purpose` as `Equivalent`. This element does not describe the usage of the code system. 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 code system. |
| CodeSystem.copyright (copyright) | is equivalent to | CodeSystem.copyright | Element `CodeSystem.copyright` is mapped to FHIR R4 element `CodeSystem.copyright` as `Equivalent`. ... Sometimes, the copyright differs between the code system and the codes that are included. The copyright statement should clearly differentiate between these when required. |
| CodeSystem.caseSensitive (caseSensitive) | is equivalent to | CodeSystem.caseSensitive | Element `CodeSystem.caseSensitive` is mapped to FHIR R4 element `CodeSystem.caseSensitive` as `Equivalent`. If this value is missing, then it is not specified whether a code system is case sensitive or not. When the rule is not known, Postel's law should be followed: produce codes with the correct case, and accept codes in any case. This element is primarily provided to support validation software. |
| CodeSystem.valueSet (valueSet) | is equivalent to | CodeSystem.valueSet | Element `CodeSystem.valueSet` is mapped to FHIR R4 element `CodeSystem.valueSet` as `Equivalent`. The definition of the value set SHALL include all codes from this code system, independent of concept status, and only codes from this code system. It SHALL be immutable, and operations SHOULD support validation of any allowed code compositions. |
| CodeSystem.hierarchyMeaning (hierarchyMeaning) | is equivalent to | CodeSystem.hierarchyMeaning | Element `CodeSystem.hierarchyMeaning` is mapped to FHIR R4 element `CodeSystem.hierarchyMeaning` as `Equivalent`. Note that other representations might have a different hierarchy or none at all, and represent the information using properties. |
| CodeSystem.compositional (compositional) | is equivalent to | CodeSystem.compositional | Element `CodeSystem.compositional` is mapped to FHIR R4 element `CodeSystem.compositional` as `Equivalent`. Note that the code system resource does not define what the compositional grammar is, only whether or not there is one. |
| CodeSystem.versionNeeded (versionNeeded) | is equivalent to | CodeSystem.versionNeeded | Element `CodeSystem.versionNeeded` is mapped to FHIR R4 element `CodeSystem.versionNeeded` as `Equivalent`. Best practice is that code systems do not redefine concepts, or that if concepts are redefined, a new code system definition is created. But this is not always possible, so some code systems may be defined as 'versionNeeded'. Most code systems occasionally refine the displays defined for concepts between versions. Contexts in which the concept display values are validated may require that the version be specified for some code systems irrespective of the value of this property. |
| CodeSystem.content (content) | is equivalent to | CodeSystem.content | Element `CodeSystem.content` is mapped to FHIR R4 element `CodeSystem.content` as `Equivalent`. |
| CodeSystem.supplements (supplements) | is equivalent to | CodeSystem.supplements | Element `CodeSystem.supplements` is mapped to FHIR R4 element `CodeSystem.supplements` as `Equivalent`. The most common use of a code system supplement is to add additional language support. |
| CodeSystem.count (count) | is equivalent to | CodeSystem.count | Element `CodeSystem.count` is mapped to FHIR R4 element `CodeSystem.count` as `Equivalent`. The count of concepts defined in this resource cannot be more than this value but may be less for several reasons - see the content element. |
| CodeSystem.filter (filter) | maps to wider concept | CodeSystem.filter | Element `CodeSystem.filter` is mapped to FHIR R4 element `CodeSystem.filter` as `Equivalent`. Note that filters defined in code systems usually require custom code on the part of any terminology engine that will make them available for use in value set filters. For this reason, they are generally only seen in high value published terminologies. |
| CodeSystem.filter.code (code) | is equivalent to | CodeSystem.filter.code | Element `CodeSystem.filter.code` is mapped to FHIR R4 element `CodeSystem.filter.code` as `Equivalent`. |
| CodeSystem.filter.description (description) | is equivalent to | CodeSystem.filter.description | Element `CodeSystem.filter.description` is mapped to FHIR R4 element `CodeSystem.filter.description` as `Equivalent`. |
| CodeSystem.filter.operator (operator) | maps to wider concept | CodeSystem.filter.operator | Element `CodeSystem.filter.operator` is mapped to FHIR R4 element `CodeSystem.filter.operator` as `SourceIsBroaderThanTarget`. |
| CodeSystem.filter.value (value) | is equivalent to | CodeSystem.filter.value | Element `CodeSystem.filter.value` is mapped to FHIR R4 element `CodeSystem.filter.value` as `Equivalent`. |
| CodeSystem.property (property) | maps to wider concept | CodeSystem.property | Element `CodeSystem.property` is mapped to FHIR R4 element `CodeSystem.property` as `Equivalent`. Multiple occurrences of CodeSystem.concept.property may occur for a CodeSystem.property where CodeSystem.concept.property.code is the same and CodeSystem.concept.property.value differs. For example: multiple designations for a single concept. |
| CodeSystem.property.code (code) | is equivalent to | CodeSystem.property.code | Element `CodeSystem.property.code` is mapped to FHIR R4 element `CodeSystem.property.code` as `Equivalent`. |
| CodeSystem.property.uri (uri) | is equivalent to | CodeSystem.property.uri | Element `CodeSystem.property.uri` is mapped to FHIR R4 element `CodeSystem.property.uri` as `Equivalent`. |
| CodeSystem.property.description (description) | is equivalent to | CodeSystem.property.description | Element `CodeSystem.property.description` is mapped to FHIR R4 element `CodeSystem.property.description` as `Equivalent`. |
| CodeSystem.property.type (type) | is equivalent to | CodeSystem.property.type | Element `CodeSystem.property.type` is mapped to FHIR R4 element `CodeSystem.property.type` as `Equivalent`. |
| CodeSystem.concept (concept) | maps to wider concept | CodeSystem.concept | Element `CodeSystem.concept` is mapped to FHIR R4 element `CodeSystem.concept` as `Equivalent`. If this is empty, it means that the code system resource does not represent the content of the code system. |
| CodeSystem.concept.code (code) | is equivalent to | CodeSystem.concept.code | Element `CodeSystem.concept.code` is mapped to FHIR R4 element `CodeSystem.concept.code` as `Equivalent`. |
| CodeSystem.concept.display (display) | is equivalent to | CodeSystem.concept.display | Element `CodeSystem.concept.display` is mapped to FHIR R4 element `CodeSystem.concept.display` as `Equivalent`. |
| CodeSystem.concept.definition (definition) | is equivalent to | CodeSystem.concept.definition | Element `CodeSystem.concept.definition` is mapped to FHIR R4 element `CodeSystem.concept.definition` as `Equivalent`. |
| CodeSystem.concept.designation (designation) | maps to wider concept | CodeSystem.concept.designation | Element `CodeSystem.concept.designation` is mapped to FHIR R4 element `CodeSystem.concept.designation` as `Equivalent`. Concepts have both a ```display``` and an array of ```designation```. The display is equivalent to a special designation with an implied ```designation.use``` of "primary code" and a language equal to the [Resource Language](https://hl7.org/fhir/resource..html#language). |
| CodeSystem.concept.designation.language (language) | is equivalent to | CodeSystem.concept.designation.language | Element `CodeSystem.concept.designation.language` is mapped to FHIR R4 element `CodeSystem.concept.designation.language` as `Equivalent`. In the absence of a language, the resource language applies. |
| CodeSystem.concept.designation.use (use) | is equivalent to | CodeSystem.concept.designation.use | Element `CodeSystem.concept.designation.use` is mapped to FHIR R4 element `CodeSystem.concept.designation.use` as `Equivalent`. If no use is provided, the designation can be assumed to be suitable for general display to a human user. |
| CodeSystem.concept.designation.value (value) | is equivalent to | CodeSystem.concept.designation.value | Element `CodeSystem.concept.designation.value` is mapped to FHIR R4 element `CodeSystem.concept.designation.value` as `Equivalent`. |
| CodeSystem.concept.property (property) | maps to wider concept | CodeSystem.concept.property | Element `CodeSystem.concept.property` is mapped to FHIR R4 element `CodeSystem.concept.property` as `Equivalent`. |
| CodeSystem.concept.property.code (code) | is equivalent to | CodeSystem.concept.property.code | Element `CodeSystem.concept.property.code` is mapped to FHIR R4 element `CodeSystem.concept.property.code` as `Equivalent`. |
| CodeSystem.concept.property.value[x] (value[x]) | is equivalent to | CodeSystem.concept.property.value[x] | Element `CodeSystem.concept.property.value[x]` is mapped to FHIR R4 element `CodeSystem.concept.property.value[x]` as `Equivalent`. The target context `CodeSystem.concept.property.value[x]` is a choice-type element and cannot directly hold extensions. The context is moved up to parent element `CodeSystem.concept.property`. |
| CodeSystem.concept.concept (concept) | is equivalent to | CodeSystem.concept.concept | Element `CodeSystem.concept.concept` is mapped to FHIR R4 element `CodeSystem.concept.concept` as `Equivalent`. |
Group 2 Mapping from http://hl7.org/fhir/StructureDefinition/CodeSystem|5.0.0 to R5: = | is-a | descendent-of | is-not-a | regex | in | not-in | generalizes | child-of | descendent-leaf | existsversion: 0.1.0)
| Source Code | Relationship | Target Code | Comment |
| CodeSystem.filter.operator (operator) | is equivalent to | Extension (R5: = | is-a | descendent-of | is-not-a | regex | in | not-in | generalizes | child-of | descendent-leaf | exists) | Element `CodeSystem.filter.operator` is mapped to FHIR R4 element `CodeSystem.filter.operator` as `SourceIsBroaderThanTarget`. |
Group 3 Mapping from http://hl7.org/fhir/StructureDefinition/CodeSystem|5.0.0 to R5: Additional ways how this designation would be used (new)version: 0.1.0)
| Source Code | Relationship | Target Code | Comment |
| CodeSystem.concept.designation.additionalUse (additionalUse) | maps to wider concept | Extension (R5: Additional ways how this designation would be used (new)) | Element `CodeSystem.concept.designation.additionalUse` has a context of CodeSystem.concept.designation based on following the parent source element upwards and mapping to `CodeSystem`. Element `CodeSystem.concept.designation.additionalUse` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). This was added rather than increasing the cardinality of .use to 0..* in order to maintain backward compatibility. |
FHIR
FHIRsmith{
"resourceType": "ConceptMap",
"id": "R5-CodeSystem-element-map-to-R4",
"text": {
"status": "generated",
"div": "<!-- snip (see above) -->"
},
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode": "fhir"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger": 0,
"_valueInteger": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
"valueCanonical": "http://hl7.org/fhir/uv/xver/ImplementationGuide/hl7.fhir.uv.xver-r5.r4"
}
]
}
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "trial-use",
"_valueCode": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
"valueCanonical": "http://hl7.org/fhir/uv/xver/ImplementationGuide/hl7.fhir.uv.xver-r5.r4"
}
]
}
}
],
"url": "http://hl7.org/fhir/uv/xver/ConceptMap/R5-CodeSystem-element-map-to-R4",
"version": "0.1.0",
"name": "R5CodeSystemElementMapToR4",
"title": "Cross-version mapping for FHIR R5 CodeSystem to FHIR R4 CodeSystem",
"status": "active",
"experimental": false,
"date": "2026-03-17T16:04:44.662611-05:00",
"contact": [
{
"name": "FHIR Infrastructure",
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/fiwg"
}
]
}
],
"description": "This ConceptMap represents cross-version mappings for elements from a FHIR R5 CodeSystem to FHIR R4.",
"jurisdiction": [
{
"coding": [
{
"system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
"code": "001",
"display": "World"
}
]
}
],
"sourceCanonical": "http://hl7.org/fhir/5.0",
"targetUri": "http://hl7.org/fhir/4.0",
"group": [
{
"source": "http://hl7.org/fhir/StructureDefinition/CodeSystem",
"sourceVersion": "5.0.0",
"target": "http://hl7.org/fhir/StructureDefinition/CodeSystem",
"targetVersion": "4.0.1",
"element": [
{
"code": "CodeSystem.meta",
"display": "meta",
"target": [
{
"code": "CodeSystem.meta",
"display": "CodeSystem.meta",
"equivalence": "equivalent",
"comment": "Element `CodeSystem.meta` is mapped to FHIR R4 element `CodeSystem.meta` as `Equivalent`."
}
]
},
{
"code": "CodeSystem.implicitRules",
"display": "implicitRules",
"target": [
{
"code": "CodeSystem.implicitRules",
"display": "CodeSystem.implicitRules",
"equivalence": "equivalent",
"comment": "Element `CodeSystem.implicitRules` is mapped to FHIR R4 element `CodeSystem.implicitRules` as `Equivalent`.\nAsserting 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."
}
]
},
{
"code": "CodeSystem.language",
"display": "language",
"target": [
{
"code": "CodeSystem.language",
"display": "CodeSystem.language",
"equivalence": "equivalent",
"comment": "Element `CodeSystem.language` is mapped to FHIR R4 element `CodeSystem.language` as `Equivalent`.\nLanguage 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)."
}
]
},
{
"code": "CodeSystem.text",
"display": "text",
"target": [
{
"code": "CodeSystem.text",
"display": "CodeSystem.text",
"equivalence": "equivalent",
"comment": "Element `CodeSystem.text` is mapped to FHIR R4 element `CodeSystem.text` as `Equivalent`.\nContained 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."
}
]
},
{
"code": "CodeSystem.contained",
"display": "contained",
"target": [
{
"code": "CodeSystem.contained",
"display": "CodeSystem.contained",
"equivalence": "equivalent",
"comment": "Element `CodeSystem.contained` is mapped to FHIR R4 element `CodeSystem.contained` as `Equivalent`.\nThis 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."
}
]
},
{
"code": "CodeSystem.url",
"display": "url",
"target": [
{
"code": "CodeSystem.url",
"display": "CodeSystem.url",
"equivalence": "equivalent",
"comment": "Element `CodeSystem.url` is mapped to FHIR R4 element `CodeSystem.url` as `Equivalent`.\nCan 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.\n\nThe 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). \n\nIn 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."
}
]
},
{
"code": "CodeSystem.identifier",
"display": "identifier",
"target": [
{
"code": "CodeSystem.identifier",
"display": "CodeSystem.identifier",
"equivalence": "equivalent",
"comment": "Element `CodeSystem.identifier` is mapped to FHIR R4 element `CodeSystem.identifier` as `Equivalent`.\nTypically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this code system outside of FHIR, where it is not possible to use the logical URI. Note that HL7 defines at least three identifiers for many of its code systems - the FHIR canonical URL, the OID and the V2 Table 0396 mnemonic code."
}
]
},
{
"code": "CodeSystem.version",
"display": "version",
"target": [
{
"code": "CodeSystem.version",
"display": "CodeSystem.version",
"equivalence": "equivalent",
"comment": "Element `CodeSystem.version` is mapped to FHIR R4 element `CodeSystem.version` as `Equivalent`.\nThere may be different code system 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 code system with the format [url]|[version]. The version SHOULD NOT contain a '#' - see [Business Version](https://hl7.org/fhir/resource.h.html#bv-format)."
}
]
},
{
"code": "CodeSystem.name",
"display": "name",
"target": [
{
"code": "CodeSystem.name",
"display": "CodeSystem.name",
"equivalence": "equivalent",
"comment": "Element `CodeSystem.name` is mapped to FHIR R4 element `CodeSystem.name` as `Equivalent`.\nThe 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."
}
]
},
{
"code": "CodeSystem.title",
"display": "title",
"target": [
{
"code": "CodeSystem.title",
"display": "CodeSystem.title",
"equivalence": "equivalent",
"comment": "Element `CodeSystem.title` is mapped to FHIR R4 element `CodeSystem.title` as `Equivalent`.\nThis name does not need to be machine-processing friendly and may contain punctuation, white-space, etc."
}
]
},
{
"code": "CodeSystem.status",
"display": "status",
"target": [
{
"code": "CodeSystem.status",
"display": "CodeSystem.status",
"equivalence": "equivalent",
"comment": "Element `CodeSystem.status` is mapped to FHIR R4 element `CodeSystem.status` as `Equivalent`.\nAllows filtering of code systems that are appropriate for use versus not.\n\nSee guidance around (not) making local changes to elements [here](https://hl7.org/fhir/canonicalreso.html#localization)."
}
]
},
{
"code": "CodeSystem.experimental",
"display": "experimental",
"target": [
{
"code": "CodeSystem.experimental",
"display": "CodeSystem.experimental",
"equivalence": "equivalent",
"comment": "Element `CodeSystem.experimental` is mapped to FHIR R4 element `CodeSystem.experimental` as `Equivalent`.\nAllows filtering of code systems that are appropriate for use versus not."
}
]
},
{
"code": "CodeSystem.date",
"display": "date",
"target": [
{
"code": "CodeSystem.date",
"display": "CodeSystem.date",
"equivalence": "equivalent",
"comment": "Element `CodeSystem.date` is mapped to FHIR R4 element `CodeSystem.date` as `Equivalent`.\nThe date is often not tracked until the resource is published, but may be present on draft content. Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the code system. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.\n\nSee guidance around (not) making local changes to elements [here](https://hl7.org/fhir/canonicalreso.html#localization)."
}
]
},
{
"code": "CodeSystem.publisher",
"display": "publisher",
"target": [
{
"code": "CodeSystem.publisher",
"display": "CodeSystem.publisher",
"equivalence": "equivalent",
"comment": "Element `CodeSystem.publisher` is mapped to FHIR R4 element `CodeSystem.publisher` as `Equivalent`.\nUsually an organization but may be an individual. The publisher (or steward) of the code system is the organization or individual primarily responsible for the maintenance and upkeep of the code system. 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 code system. This item SHOULD be populated unless the information is available from context."
}
]
},
{
"code": "CodeSystem.contact",
"display": "contact",
"target": [
{
"code": "CodeSystem.contact",
"display": "CodeSystem.contact",
"equivalence": "equivalent",
"comment": "Element `CodeSystem.contact` is mapped to FHIR R4 element `CodeSystem.contact` as `Equivalent`.\nMay be a web site, an email address, a telephone number, etc.\n\nSee guidance around (not) making local changes to elements [here](https://hl7.org/fhir/canonicalreso.html#localization)."
}
]
},
{
"code": "CodeSystem.description",
"display": "description",
"target": [
{
"code": "CodeSystem.description",
"display": "CodeSystem.description",
"equivalence": "equivalent",
"comment": "Element `CodeSystem.description` is mapped to FHIR R4 element `CodeSystem.description` as `Equivalent`.\nThis description can be used to capture details such as comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the code system as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the code system is presumed to be the predominant language in the place the code system was created)."
}
]
},
{
"code": "CodeSystem.useContext",
"display": "useContext",
"target": [
{
"code": "CodeSystem.useContext",
"display": "CodeSystem.useContext",
"equivalence": "equivalent",
"comment": "Element `CodeSystem.useContext` is mapped to FHIR R4 element `CodeSystem.useContext` as `Equivalent`.\nWhen multiple useContexts are specified, there is no expectation that all or any of the contexts apply."
}
]
},
{
"code": "CodeSystem.jurisdiction",
"display": "jurisdiction",
"target": [
{
"code": "CodeSystem.jurisdiction",
"display": "CodeSystem.jurisdiction",
"equivalence": "equivalent",
"comment": "Element `CodeSystem.jurisdiction` is mapped to FHIR R4 element `CodeSystem.jurisdiction` as `Equivalent`.\nElement `CodeSystem.jurisdiction` has been flagged as deprecated.\nIt may be possible for the code system to be used in jurisdictions other than those for which it was originally designed or intended.\n\nDEPRECATION 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.)"
}
]
},
{
"code": "CodeSystem.purpose",
"display": "purpose",
"target": [
{
"code": "CodeSystem.purpose",
"display": "CodeSystem.purpose",
"equivalence": "equivalent",
"comment": "Element `CodeSystem.purpose` is mapped to FHIR R4 element `CodeSystem.purpose` as `Equivalent`.\nThis element does not describe the usage of the code system. 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 code system."
}
]
},
{
"code": "CodeSystem.copyright",
"display": "copyright",
"target": [
{
"code": "CodeSystem.copyright",
"display": "CodeSystem.copyright",
"equivalence": "equivalent",
"comment": "Element `CodeSystem.copyright` is mapped to FHIR R4 element `CodeSystem.copyright` as `Equivalent`.\n... Sometimes, the copyright differs between the code system and the codes that are included. The copyright statement should clearly differentiate between these when required."
}
]
},
{
"code": "CodeSystem.caseSensitive",
"display": "caseSensitive",
"target": [
{
"code": "CodeSystem.caseSensitive",
"display": "CodeSystem.caseSensitive",
"equivalence": "equivalent",
"comment": "Element `CodeSystem.caseSensitive` is mapped to FHIR R4 element `CodeSystem.caseSensitive` as `Equivalent`.\nIf this value is missing, then it is not specified whether a code system is case sensitive or not. When the rule is not known, Postel's law should be followed: produce codes with the correct case, and accept codes in any case. This element is primarily provided to support validation software."
}
]
},
{
"code": "CodeSystem.valueSet",
"display": "valueSet",
"target": [
{
"code": "CodeSystem.valueSet",
"display": "CodeSystem.valueSet",
"equivalence": "equivalent",
"comment": "Element `CodeSystem.valueSet` is mapped to FHIR R4 element `CodeSystem.valueSet` as `Equivalent`.\nThe definition of the value set SHALL include all codes from this code system, independent of concept status, and only codes from this code system. It SHALL be immutable, and operations SHOULD support validation of any allowed code compositions."
}
]
},
{
"code": "CodeSystem.hierarchyMeaning",
"display": "hierarchyMeaning",
"target": [
{
"code": "CodeSystem.hierarchyMeaning",
"display": "CodeSystem.hierarchyMeaning",
"equivalence": "equivalent",
"comment": "Element `CodeSystem.hierarchyMeaning` is mapped to FHIR R4 element `CodeSystem.hierarchyMeaning` as `Equivalent`.\nNote that other representations might have a different hierarchy or none at all, and represent the information using properties."
}
]
},
{
"code": "CodeSystem.compositional",
"display": "compositional",
"target": [
{
"code": "CodeSystem.compositional",
"display": "CodeSystem.compositional",
"equivalence": "equivalent",
"comment": "Element `CodeSystem.compositional` is mapped to FHIR R4 element `CodeSystem.compositional` as `Equivalent`.\nNote that the code system resource does not define what the compositional grammar is, only whether or not there is one."
}
]
},
{
"code": "CodeSystem.versionNeeded",
"display": "versionNeeded",
"target": [
{
"code": "CodeSystem.versionNeeded",
"display": "CodeSystem.versionNeeded",
"equivalence": "equivalent",
"comment": "Element `CodeSystem.versionNeeded` is mapped to FHIR R4 element `CodeSystem.versionNeeded` as `Equivalent`.\nBest practice is that code systems do not redefine concepts, or that if concepts are redefined, a new code system definition is created. But this is not always possible, so some code systems may be defined as 'versionNeeded'.\n\nMost code systems occasionally refine the displays defined for concepts between versions. Contexts in which the concept display values are validated may require that the version be specified for some code systems irrespective of the value of this property."
}
]
},
{
"code": "CodeSystem.content",
"display": "content",
"target": [
{
"code": "CodeSystem.content",
"display": "CodeSystem.content",
"equivalence": "equivalent",
"comment": "Element `CodeSystem.content` is mapped to FHIR R4 element `CodeSystem.content` as `Equivalent`."
}
]
},
{
"code": "CodeSystem.supplements",
"display": "supplements",
"target": [
{
"code": "CodeSystem.supplements",
"display": "CodeSystem.supplements",
"equivalence": "equivalent",
"comment": "Element `CodeSystem.supplements` is mapped to FHIR R4 element `CodeSystem.supplements` as `Equivalent`.\nThe most common use of a code system supplement is to add additional language support."
}
]
},
{
"code": "CodeSystem.count",
"display": "count",
"target": [
{
"code": "CodeSystem.count",
"display": "CodeSystem.count",
"equivalence": "equivalent",
"comment": "Element `CodeSystem.count` is mapped to FHIR R4 element `CodeSystem.count` as `Equivalent`.\nThe count of concepts defined in this resource cannot be more than this value but may be less for several reasons - see the content element."
}
]
},
{
"code": "CodeSystem.filter",
"display": "filter",
"target": [
{
"code": "CodeSystem.filter",
"display": "CodeSystem.filter",
"equivalence": "wider",
"comment": "Element `CodeSystem.filter` is mapped to FHIR R4 element `CodeSystem.filter` as `Equivalent`.\nNote that filters defined in code systems usually require custom code on the part of any terminology engine that will make them available for use in value set filters. For this reason, they are generally only seen in high value published terminologies."
}
]
},
{
"code": "CodeSystem.filter.code",
"display": "code",
"target": [
{
"code": "CodeSystem.filter.code",
"display": "CodeSystem.filter.code",
"equivalence": "equivalent",
"comment": "Element `CodeSystem.filter.code` is mapped to FHIR R4 element `CodeSystem.filter.code` as `Equivalent`."
}
]
},
{
"code": "CodeSystem.filter.description",
"display": "description",
"target": [
{
"code": "CodeSystem.filter.description",
"display": "CodeSystem.filter.description",
"equivalence": "equivalent",
"comment": "Element `CodeSystem.filter.description` is mapped to FHIR R4 element `CodeSystem.filter.description` as `Equivalent`."
}
]
},
{
"code": "CodeSystem.filter.operator",
"display": "operator",
"target": [
{
"code": "CodeSystem.filter.operator",
"display": "CodeSystem.filter.operator",
"equivalence": "wider",
"comment": "Element `CodeSystem.filter.operator` is mapped to FHIR R4 element `CodeSystem.filter.operator` as `SourceIsBroaderThanTarget`."
}
]
},
{
"code": "CodeSystem.filter.value",
"display": "value",
"target": [
{
"code": "CodeSystem.filter.value",
"display": "CodeSystem.filter.value",
"equivalence": "equivalent",
"comment": "Element `CodeSystem.filter.value` is mapped to FHIR R4 element `CodeSystem.filter.value` as `Equivalent`."
}
]
},
{
"code": "CodeSystem.property",
"display": "property",
"target": [
{
"code": "CodeSystem.property",
"display": "CodeSystem.property",
"equivalence": "wider",
"comment": "Element `CodeSystem.property` is mapped to FHIR R4 element `CodeSystem.property` as `Equivalent`.\nMultiple occurrences of CodeSystem.concept.property may occur for a CodeSystem.property where CodeSystem.concept.property.code is the same and CodeSystem.concept.property.value differs. For example: multiple designations for a single concept."
}
]
},
{
"code": "CodeSystem.property.code",
"display": "code",
"target": [
{
"code": "CodeSystem.property.code",
"display": "CodeSystem.property.code",
"equivalence": "equivalent",
"comment": "Element `CodeSystem.property.code` is mapped to FHIR R4 element `CodeSystem.property.code` as `Equivalent`."
}
]
},
{
"code": "CodeSystem.property.uri",
"display": "uri",
"target": [
{
"code": "CodeSystem.property.uri",
"display": "CodeSystem.property.uri",
"equivalence": "equivalent",
"comment": "Element `CodeSystem.property.uri` is mapped to FHIR R4 element `CodeSystem.property.uri` as `Equivalent`."
}
]
},
{
"code": "CodeSystem.property.description",
"display": "description",
"target": [
{
"code": "CodeSystem.property.description",
"display": "CodeSystem.property.description",
"equivalence": "equivalent",
"comment": "Element `CodeSystem.property.description` is mapped to FHIR R4 element `CodeSystem.property.description` as `Equivalent`."
}
]
},
{
"code": "CodeSystem.property.type",
"display": "type",
"target": [
{
"code": "CodeSystem.property.type",
"display": "CodeSystem.property.type",
"equivalence": "equivalent",
"comment": "Element `CodeSystem.property.type` is mapped to FHIR R4 element `CodeSystem.property.type` as `Equivalent`."
}
]
},
{
"code": "CodeSystem.concept",
"display": "concept",
"target": [
{
"code": "CodeSystem.concept",
"display": "CodeSystem.concept",
"equivalence": "wider",
"comment": "Element `CodeSystem.concept` is mapped to FHIR R4 element `CodeSystem.concept` as `Equivalent`.\nIf this is empty, it means that the code system resource does not represent the content of the code system."
}
]
},
{
"code": "CodeSystem.concept.code",
"display": "code",
"target": [
{
"code": "CodeSystem.concept.code",
"display": "CodeSystem.concept.code",
"equivalence": "equivalent",
"comment": "Element `CodeSystem.concept.code` is mapped to FHIR R4 element `CodeSystem.concept.code` as `Equivalent`."
}
]
},
{
"code": "CodeSystem.concept.display",
"display": "display",
"target": [
{
"code": "CodeSystem.concept.display",
"display": "CodeSystem.concept.display",
"equivalence": "equivalent",
"comment": "Element `CodeSystem.concept.display` is mapped to FHIR R4 element `CodeSystem.concept.display` as `Equivalent`."
}
]
},
{
"code": "CodeSystem.concept.definition",
"display": "definition",
"target": [
{
"code": "CodeSystem.concept.definition",
"display": "CodeSystem.concept.definition",
"equivalence": "equivalent",
"comment": "Element `CodeSystem.concept.definition` is mapped to FHIR R4 element `CodeSystem.concept.definition` as `Equivalent`."
}
]
},
{
"code": "CodeSystem.concept.designation",
"display": "designation",
"target": [
{
"code": "CodeSystem.concept.designation",
"display": "CodeSystem.concept.designation",
"equivalence": "wider",
"comment": "Element `CodeSystem.concept.designation` is mapped to FHIR R4 element `CodeSystem.concept.designation` as `Equivalent`.\nConcepts have both a ```display``` and an array of ```designation```. The display is equivalent to a special designation with an implied ```designation.use``` of \"primary code\" and a language equal to the [Resource Language](https://hl7.org/fhir/resource..html#language)."
}
]
},
{
"code": "CodeSystem.concept.designation.language",
"display": "language",
"target": [
{
"code": "CodeSystem.concept.designation.language",
"display": "CodeSystem.concept.designation.language",
"equivalence": "equivalent",
"comment": "Element `CodeSystem.concept.designation.language` is mapped to FHIR R4 element `CodeSystem.concept.designation.language` as `Equivalent`.\nIn the absence of a language, the resource language applies."
}
]
},
{
"code": "CodeSystem.concept.designation.use",
"display": "use",
"target": [
{
"code": "CodeSystem.concept.designation.use",
"display": "CodeSystem.concept.designation.use",
"equivalence": "equivalent",
"comment": "Element `CodeSystem.concept.designation.use` is mapped to FHIR R4 element `CodeSystem.concept.designation.use` as `Equivalent`.\nIf no use is provided, the designation can be assumed to be suitable for general display to a human user."
}
]
},
{
"code": "CodeSystem.concept.designation.value",
"display": "value",
"target": [
{
"code": "CodeSystem.concept.designation.value",
"display": "CodeSystem.concept.designation.value",
"equivalence": "equivalent",
"comment": "Element `CodeSystem.concept.designation.value` is mapped to FHIR R4 element `CodeSystem.concept.designation.value` as `Equivalent`."
}
]
},
{
"code": "CodeSystem.concept.property",
"display": "property",
"target": [
{
"code": "CodeSystem.concept.property",
"display": "CodeSystem.concept.property",
"equivalence": "wider",
"comment": "Element `CodeSystem.concept.property` is mapped to FHIR R4 element `CodeSystem.concept.property` as `Equivalent`."
}
]
},
{
"code": "CodeSystem.concept.property.code",
"display": "code",
"target": [
{
"code": "CodeSystem.concept.property.code",
"display": "CodeSystem.concept.property.code",
"equivalence": "equivalent",
"comment": "Element `CodeSystem.concept.property.code` is mapped to FHIR R4 element `CodeSystem.concept.property.code` as `Equivalent`."
}
]
},
{
"code": "CodeSystem.concept.property.value[x]",
"display": "value[x]",
"target": [
{
"code": "CodeSystem.concept.property.value[x]",
"display": "CodeSystem.concept.property.value[x]",
"equivalence": "equivalent",
"comment": "Element `CodeSystem.concept.property.value[x]` is mapped to FHIR R4 element `CodeSystem.concept.property.value[x]` as `Equivalent`.\nThe target context `CodeSystem.concept.property.value[x]` is a choice-type element and cannot directly hold extensions. The context is moved up to parent element `CodeSystem.concept.property`."
}
]
},
{
"code": "CodeSystem.concept.concept",
"display": "concept",
"target": [
{
"code": "CodeSystem.concept.concept",
"display": "CodeSystem.concept.concept",
"equivalence": "equivalent",
"comment": "Element `CodeSystem.concept.concept` is mapped to FHIR R4 element `CodeSystem.concept.concept` as `Equivalent`."
}
]
}
]
},
{
"source": "http://hl7.org/fhir/StructureDefinition/CodeSystem",
"sourceVersion": "5.0.0",
"target": "http://hl7.org/fhir/5.0/StructureDefinition/extension-CodeSystem.filter.operator",
"targetVersion": "0.1.0",
"element": [
{
"code": "CodeSystem.filter.operator",
"display": "operator",
"target": [
{
"code": "Extension",
"equivalence": "equivalent",
"comment": "Element `CodeSystem.filter.operator` is mapped to FHIR R4 element `CodeSystem.filter.operator` as `SourceIsBroaderThanTarget`."
}
]
}
]
},
{
"source": "http://hl7.org/fhir/StructureDefinition/CodeSystem",
"sourceVersion": "5.0.0",
"target": "http://hl7.org/fhir/5.0/StructureDefinition/extension-CodeSystem.concept.designation.additionalUse",
"targetVersion": "0.1.0",
"element": [
{
"code": "CodeSystem.concept.designation.additionalUse",
"display": "additionalUse",
"target": [
{
"code": "Extension",
"equivalence": "wider",
"comment": "Element `CodeSystem.concept.designation.additionalUse` has a context of CodeSystem.concept.designation based on following the parent source element upwards and mapping to `CodeSystem`.\nElement `CodeSystem.concept.designation.additionalUse` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).\nThis was added rather than increasing the cardinality of .use to 0..* in order to maintain backward compatibility."
}
]
}
]
}
]
}