Extensions for Using Data Elements from FHIR DSTU2 in FHIR R4
0.1.0 - STU
Extensions for Using Data Elements from FHIR DSTU2 in FHIR R4
0.1.0 - STU
Extensions for Using Data Elements from FHIR DSTU2 in FHIR R4 - Downloaded Version null See the Directory of published versions
| Official URL: http://hl7.org/fhir/1.0/StructureDefinition/profile-ConceptMap | Version: 0.1.0 | |||
| Standards status: Trial-use | Maturity Level: 0 | Computable Name: Profile_R2_ConceptMap_R4 | ||
This cross-version profile allows DSTU2 ConceptMap content to be represented via FHIR R4 ConceptMap resources.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Path | Status | Usage | ValueSet | Version | Source |
| ConceptMap.status | Base | required | PublicationStatus | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| cmd-0 | warning | ConceptMap | Name should be usable as an identifier for the module by machine processing applications such as code generation |
name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
|
| dom-2 | error | ConceptMap | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | ConceptMap | 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 | error | ConceptMap | 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 | error | ConceptMap | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | ConceptMap | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | ConceptMap.implicitRules, ConceptMap.extension, ConceptMap.extension:source, ConceptMap.extension:target, ConceptMap.modifierExtension, ConceptMap.status | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | ConceptMap.extension, ConceptMap.extension:source, ConceptMap.extension:target, ConceptMap.modifierExtension | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from ConceptMap
| Name | Flags | Card. | Type | Description & Constraints Filter:   | ||||
|---|---|---|---|---|---|---|---|---|
  ConceptMap |
C | 0..* | ConceptMap(4.0.1) | A map from one set of concepts to one or more other concepts Constraints: cmd-0 | ||||
  id |
Σ | 0..1 | id | Logical id of this artifact | ||||
  meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
 id |
0..1 | string | Unique id for inter-element referencing | |||||
 Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
  extension:meta |
0..1 | Meta | DSTU2: meta additional types URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-ConceptMap.meta Constraints: ext-1 | |||||
| versionId |
Σ | 0..1 | id | Version specific identifier | ||||
| lastUpdated |
Σ | 0..1 | instant | When the resource version last changed | ||||
| source |
Σ | 0..1 | uri | Identifies where the resource comes from | ||||
| profile |
Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
| security |
Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels  (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
 tag |
Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:text |
0..1 | (Complex) | DSTU2: text additional types URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-ConceptMap.text Constraints: ext-1 | |||||
| status |
1..1 | code | generated | extensions | additional | empty Binding: NarrativeStatus (required): The status of a resource narrative. | |||||
| div |
C | 1..1 | xhtml | Limited xhtml content Constraints: txt-1, txt-2 | ||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
2..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
 extension:source |
1..1 | Reference(Cross-version Profile for DSTU2.ValueSet for use in FHIR R4(0.1.0) | ValueSet | Cross-version Profile for DSTU2.StructureDefinition for use in FHIR R4(0.1.0) | StructureDefinition) | DSTU2: Identifies the source of the concepts which are being mapped additional types URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-ConceptMap.source Constraints: ext-1 | |||||
| extension:target |
1..1 | Reference(Cross-version Profile for DSTU2.ValueSet for use in FHIR R4(0.1.0) | ValueSet | Cross-version Profile for DSTU2.StructureDefinition for use in FHIR R4(0.1.0) | StructureDefinition) | DSTU2: Provides context to the mappings additional types URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-ConceptMap.target Constraints: ext-1 | |||||
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 | ||||
| url |
Σ | 0..1 | uri | Canonical identifier for this concept map, represented as a URI (globally unique) | ||||
| identifier |
Σ | 0..1 | Identifier | Additional identifier for the concept map | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:identifier |
0..1 | Identifier | DSTU2: identifier additional types URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-ConceptMap.identifier Constraints: ext-1 | |||||
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type |
Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
| system |
Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
| value |
Σ | 0..1 | string | The value that is unique Example General: 123456 | ||||
| period |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
 assigner |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| version |
Σ | 0..1 | string | Business version of the concept map | ||||
| name |
ΣC | 0..1 | string | Name for this concept map (computer friendly) | ||||
| title |
Σ | 0..1 | string | Name for this concept map (human friendly) | ||||
| status |
?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. | ||||
| experimental |
Σ | 0..1 | boolean | For testing purposes, not real usage | ||||
| date |
Σ | 0..1 | dateTime | Date last changed | ||||
| publisher |
Σ | 0..1 | string | Name of the publisher (organization or individual) | ||||
| contact |
Σ | 0..* | ContactDetail | Contact details for the publisher | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:name |
0..1 | string | DSTU2: Name of a individual to contact (new) URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-ConceptMap.contact.name Constraints: ext-1 | |||||
| extension:telecom |
0..* | ContactPoint | DSTU2: Contact details for individual or publisher (new) URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-ConceptMap.contact.telecom Constraints: ext-1 | |||||
| name |
Σ | 0..1 | string | Name of an individual to contact | ||||
| telecom |
Σ | 0..* | ContactPoint | Contact details for individual or organization | ||||
| description |
0..1 | markdown | Natural language description of the concept map | |||||
| useContext |
Σ | 0..* | UsageContext | The context that the content is intended to support | ||||
| jurisdiction |
Σ | 0..* | CodeableConcept | Intended jurisdiction for concept map (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use. | ||||
| purpose |
0..1 | markdown | Why this concept map is defined | |||||
| copyright |
0..1 | markdown | Use and/or publishing restrictions | |||||
 source[x] |
Σ | 0..1 | The source value set that contains the concepts that are being mapped | |||||
| sourceUri |
uri | |||||||
| sourceCanonical |
canonical(ValueSet) | |||||||
| target[x] |
Σ | 0..1 | The target value set which provides context for the mappings | |||||
| targetUri |
uri | |||||||
| targetCanonical |
canonical(ValueSet) | |||||||
 group |
0..* | BackboneElement | Same source and target systems | |||||
 id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| source |
0..1 | uri | Source system where concepts to be mapped are defined | |||||
| sourceVersion |
0..1 | string | Specific version of the code system | |||||
| target |
0..1 | uri | Target system that the concepts are to be mapped to | |||||
| targetVersion |
0..1 | string | Specific version of the code system | |||||
| element |
1..* | BackboneElement | Mappings for a concept from the source set | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| code |
0..1 | code | Identifies element being mapped | |||||
| display |
0..1 | string | Display for the code | |||||
| target |
C | 0..* | BackboneElement | Concept in target system for element Constraints: cmd-1 | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| code |
0..1 | code | Code that identifies the target element | |||||
| display |
0..1 | string | Display for the code | |||||
| equivalence |
?! | 1..1 | code | relatedto | equivalent | equal | wider | subsumes | narrower | specializes | inexact | unmatched | disjoint Binding: ConceptMapEquivalence (required): The degree of equivalence between concepts. | ||||
| comment |
C | 0..1 | string | Description of status/issues in mapping | ||||
| dependsOn |
0..* | BackboneElement | Other elements required for this mapping (from context) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| property |
1..1 | uri | Reference to property mapping depends on | |||||
| system |
0..1 | canonical(CodeSystem) | Code System (if necessary) | |||||
| value |
1..1 | string | Value of the referenced element | |||||
| display |
0..1 | string | Display for the code (if value is a code) | |||||
 product |
0..* | See dependsOn (ConceptMap) | Other concepts that this mapping also produces | |||||
| unmapped |
C | 0..1 | BackboneElement | What to do when there is no mapping for the source concept Constraints: cmd-2, cmd-3 | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| mode |
1..1 | code | provided | fixed | other-map Binding: ConceptMapGroupUnmappedMode (required): Defines which action to take if there is no match in the group. | |||||
| code |
0..1 | code | Fixed code when mode = fixed | |||||
| display |
0..1 | string | Display for the code | |||||
| url |
0..1 | canonical(ConceptMap) | canonical reference to an additional ConceptMap to use for mapping if the source concept is unmapped | |||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| ConceptMap.meta.security | Base | extensible |
SecurityLabels
|
📍4.0.1 | tx.fhir.org |
| ConceptMap.meta.tag | Base | example | Common Tags | 📍4.0.1 | FHIR Std. |
| ConceptMap.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| ConceptMap.text.status | Base | required | NarrativeStatus | 📍4.0.1 | FHIR Std. |
| ConceptMap.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| ConceptMap.identifier.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| ConceptMap.status | Base | required | PublicationStatus | 📍4.0.1 | FHIR Std. |
| ConceptMap.jurisdiction | Base | extensible | Jurisdiction | 📍4.0.1 | FHIR Std. |
| ConceptMap.group.element.target.equivalence | Base | required | ConceptMapEquivalence | 📍4.0.1 | FHIR Std. |
| ConceptMap.group.unmapped.mode | Base | required | ConceptMapGroupUnmappedMode | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| cmd-0 | warning | ConceptMap | Name should be usable as an identifier for the module by machine processing applications such as code generation |
name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
|
| cmd-1 | error | ConceptMap.group.element.target | If the map is narrower or inexact, there SHALL be some comments |
comment.exists() or equivalence.empty() or ((equivalence != 'narrower') and (equivalence != 'inexact'))
|
| cmd-2 | error | ConceptMap.group.unmapped | If the mode is 'fixed', a code must be provided |
(mode = 'fixed') implies code.exists()
|
| cmd-3 | error | ConceptMap.group.unmapped | If the mode is 'other-map', a url must be provided |
(mode = 'other-map') implies url.exists()
|
| dom-2 | error | ConceptMap | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | ConceptMap | 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 | error | ConceptMap | 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 | error | ConceptMap | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | ConceptMap | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | ConceptMap.meta, ConceptMap.meta.extension, ConceptMap.meta.extension:meta, ConceptMap.meta.versionId, ConceptMap.meta.lastUpdated, ConceptMap.meta.source, ConceptMap.meta.profile, ConceptMap.meta.security, ConceptMap.meta.tag, ConceptMap.implicitRules, ConceptMap.language, ConceptMap.text, ConceptMap.text.extension, ConceptMap.text.extension:text, ConceptMap.text.status, ConceptMap.text.div, ConceptMap.extension, ConceptMap.extension:source, ConceptMap.extension:target, ConceptMap.modifierExtension, ConceptMap.url, ConceptMap.identifier, ConceptMap.identifier.extension, ConceptMap.identifier.extension:identifier, ConceptMap.identifier.use, ConceptMap.identifier.type, ConceptMap.identifier.system, ConceptMap.identifier.value, ConceptMap.identifier.period, ConceptMap.identifier.assigner, ConceptMap.version, ConceptMap.name, ConceptMap.title, ConceptMap.status, ConceptMap.experimental, ConceptMap.date, ConceptMap.publisher, ConceptMap.contact, ConceptMap.contact.extension, ConceptMap.contact.extension:name, ConceptMap.contact.extension:telecom, ConceptMap.contact.name, ConceptMap.contact.telecom, ConceptMap.description, ConceptMap.useContext, ConceptMap.jurisdiction, ConceptMap.purpose, ConceptMap.copyright, ConceptMap.source[x], ConceptMap.target[x], ConceptMap.group, ConceptMap.group.extension, ConceptMap.group.modifierExtension, ConceptMap.group.source, ConceptMap.group.sourceVersion, ConceptMap.group.target, ConceptMap.group.targetVersion, ConceptMap.group.element, ConceptMap.group.element.extension, ConceptMap.group.element.modifierExtension, ConceptMap.group.element.code, ConceptMap.group.element.display, ConceptMap.group.element.target, ConceptMap.group.element.target.extension, ConceptMap.group.element.target.modifierExtension, ConceptMap.group.element.target.code, ConceptMap.group.element.target.display, ConceptMap.group.element.target.equivalence, ConceptMap.group.element.target.comment, ConceptMap.group.element.target.dependsOn, ConceptMap.group.element.target.dependsOn.extension, ConceptMap.group.element.target.dependsOn.modifierExtension, ConceptMap.group.element.target.dependsOn.property, ConceptMap.group.element.target.dependsOn.system, ConceptMap.group.element.target.dependsOn.value, ConceptMap.group.element.target.dependsOn.display, ConceptMap.group.element.target.product, ConceptMap.group.unmapped, ConceptMap.group.unmapped.extension, ConceptMap.group.unmapped.modifierExtension, ConceptMap.group.unmapped.mode, ConceptMap.group.unmapped.code, ConceptMap.group.unmapped.display, ConceptMap.group.unmapped.url | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | ConceptMap.meta.extension, ConceptMap.meta.extension:meta, ConceptMap.text.extension, ConceptMap.text.extension:text, ConceptMap.extension, ConceptMap.extension:source, ConceptMap.extension:target, ConceptMap.modifierExtension, ConceptMap.identifier.extension, ConceptMap.identifier.extension:identifier, ConceptMap.contact.extension, ConceptMap.contact.extension:name, ConceptMap.contact.extension:telecom, ConceptMap.group.extension, ConceptMap.group.modifierExtension, ConceptMap.group.element.extension, ConceptMap.group.element.modifierExtension, ConceptMap.group.element.target.extension, ConceptMap.group.element.target.modifierExtension, ConceptMap.group.element.target.dependsOn.extension, ConceptMap.group.element.target.dependsOn.modifierExtension, ConceptMap.group.unmapped.extension, ConceptMap.group.unmapped.modifierExtension | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| txt-1 | error | ConceptMap.text.div | The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes |
htmlChecks()
|
| txt-2 | error | ConceptMap.text.div | The narrative SHALL have some non-whitespace content |
htmlChecks()
|
This structure is derived from ConceptMap
Summary
Mandatory: 2 elements
Extensions
This structure refers to these extensions:
Maturity: 0
Key Elements View
| Path | Status | Usage | ValueSet | Version | Source |
| ConceptMap.status | Base | required | PublicationStatus | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| cmd-0 | warning | ConceptMap | Name should be usable as an identifier for the module by machine processing applications such as code generation |
name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
|
| dom-2 | error | ConceptMap | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | ConceptMap | 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 | error | ConceptMap | 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 | error | ConceptMap | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | ConceptMap | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | ConceptMap.implicitRules, ConceptMap.extension, ConceptMap.extension:source, ConceptMap.extension:target, ConceptMap.modifierExtension, ConceptMap.status | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | ConceptMap.extension, ConceptMap.extension:source, ConceptMap.extension:target, ConceptMap.modifierExtension | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
Differential View
This structure is derived from ConceptMap
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| ConceptMap |
C | 0..* | ConceptMap(4.0.1) | A map from one set of concepts to one or more other concepts Constraints: cmd-0 | ||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:meta |
0..1 | Meta | DSTU2: meta additional types URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-ConceptMap.meta Constraints: ext-1 | |||||
| versionId |
Σ | 0..1 | id | Version specific identifier | ||||
| lastUpdated |
Σ | 0..1 | instant | When the resource version last changed | ||||
| source |
Σ | 0..1 | uri | Identifies where the resource comes from | ||||
| profile |
Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
| security |
Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
| tag |
Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:text |
0..1 | (Complex) | DSTU2: text additional types URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-ConceptMap.text Constraints: ext-1 | |||||
| status |
1..1 | code | generated | extensions | additional | empty Binding: NarrativeStatus (required): The status of a resource narrative. | |||||
| div |
C | 1..1 | xhtml | Limited xhtml content Constraints: txt-1, txt-2 | ||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
2..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:source |
1..1 | Reference(Cross-version Profile for DSTU2.ValueSet for use in FHIR R4(0.1.0) | ValueSet | Cross-version Profile for DSTU2.StructureDefinition for use in FHIR R4(0.1.0) | StructureDefinition) | DSTU2: Identifies the source of the concepts which are being mapped additional types URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-ConceptMap.source Constraints: ext-1 | |||||
| extension:target |
1..1 | Reference(Cross-version Profile for DSTU2.ValueSet for use in FHIR R4(0.1.0) | ValueSet | Cross-version Profile for DSTU2.StructureDefinition for use in FHIR R4(0.1.0) | StructureDefinition) | DSTU2: Provides context to the mappings additional types URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-ConceptMap.target Constraints: ext-1 | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 | ||||
| url |
Σ | 0..1 | uri | Canonical identifier for this concept map, represented as a URI (globally unique) | ||||
| identifier |
Σ | 0..1 | Identifier | Additional identifier for the concept map | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:identifier |
0..1 | Identifier | DSTU2: identifier additional types URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-ConceptMap.identifier Constraints: ext-1 | |||||
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type |
Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
| system |
Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
| value |
Σ | 0..1 | string | The value that is unique Example General: 123456 | ||||
| period |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| version |
Σ | 0..1 | string | Business version of the concept map | ||||
| name |
ΣC | 0..1 | string | Name for this concept map (computer friendly) | ||||
| title |
Σ | 0..1 | string | Name for this concept map (human friendly) | ||||
| status |
?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. | ||||
| experimental |
Σ | 0..1 | boolean | For testing purposes, not real usage | ||||
| date |
Σ | 0..1 | dateTime | Date last changed | ||||
| publisher |
Σ | 0..1 | string | Name of the publisher (organization or individual) | ||||
| contact |
Σ | 0..* | ContactDetail | Contact details for the publisher | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:name |
0..1 | string | DSTU2: Name of a individual to contact (new) URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-ConceptMap.contact.name Constraints: ext-1 | |||||
| extension:telecom |
0..* | ContactPoint | DSTU2: Contact details for individual or publisher (new) URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-ConceptMap.contact.telecom Constraints: ext-1 | |||||
| name |
Σ | 0..1 | string | Name of an individual to contact | ||||
| telecom |
Σ | 0..* | ContactPoint | Contact details for individual or organization | ||||
| description |
0..1 | markdown | Natural language description of the concept map | |||||
| useContext |
Σ | 0..* | UsageContext | The context that the content is intended to support | ||||
| jurisdiction |
Σ | 0..* | CodeableConcept | Intended jurisdiction for concept map (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use. | ||||
| purpose |
0..1 | markdown | Why this concept map is defined | |||||
| copyright |
0..1 | markdown | Use and/or publishing restrictions | |||||
| source[x] |
Σ | 0..1 | The source value set that contains the concepts that are being mapped | |||||
| sourceUri |
uri | |||||||
| sourceCanonical |
canonical(ValueSet) | |||||||
| target[x] |
Σ | 0..1 | The target value set which provides context for the mappings | |||||
| targetUri |
uri | |||||||
| targetCanonical |
canonical(ValueSet) | |||||||
| group |
0..* | BackboneElement | Same source and target systems | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| source |
0..1 | uri | Source system where concepts to be mapped are defined | |||||
| sourceVersion |
0..1 | string | Specific version of the code system | |||||
| target |
0..1 | uri | Target system that the concepts are to be mapped to | |||||
| targetVersion |
0..1 | string | Specific version of the code system | |||||
| element |
1..* | BackboneElement | Mappings for a concept from the source set | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| code |
0..1 | code | Identifies element being mapped | |||||
| display |
0..1 | string | Display for the code | |||||
| target |
C | 0..* | BackboneElement | Concept in target system for element Constraints: cmd-1 | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| code |
0..1 | code | Code that identifies the target element | |||||
| display |
0..1 | string | Display for the code | |||||
| equivalence |
?! | 1..1 | code | relatedto | equivalent | equal | wider | subsumes | narrower | specializes | inexact | unmatched | disjoint Binding: ConceptMapEquivalence (required): The degree of equivalence between concepts. | ||||
| comment |
C | 0..1 | string | Description of status/issues in mapping | ||||
| dependsOn |
0..* | BackboneElement | Other elements required for this mapping (from context) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| property |
1..1 | uri | Reference to property mapping depends on | |||||
| system |
0..1 | canonical(CodeSystem) | Code System (if necessary) | |||||
| value |
1..1 | string | Value of the referenced element | |||||
| display |
0..1 | string | Display for the code (if value is a code) | |||||
| product |
0..* | See dependsOn (ConceptMap) | Other concepts that this mapping also produces | |||||
| unmapped |
C | 0..1 | BackboneElement | What to do when there is no mapping for the source concept Constraints: cmd-2, cmd-3 | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| mode |
1..1 | code | provided | fixed | other-map Binding: ConceptMapGroupUnmappedMode (required): Defines which action to take if there is no match in the group. | |||||
| code |
0..1 | code | Fixed code when mode = fixed | |||||
| display |
0..1 | string | Display for the code | |||||
| url |
0..1 | canonical(ConceptMap) | canonical reference to an additional ConceptMap to use for mapping if the source concept is unmapped | |||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| ConceptMap.meta.security | Base | extensible |
SecurityLabels
|
📍4.0.1 | tx.fhir.org |
| ConceptMap.meta.tag | Base | example | Common Tags | 📍4.0.1 | FHIR Std. |
| ConceptMap.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| ConceptMap.text.status | Base | required | NarrativeStatus | 📍4.0.1 | FHIR Std. |
| ConceptMap.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| ConceptMap.identifier.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| ConceptMap.status | Base | required | PublicationStatus | 📍4.0.1 | FHIR Std. |
| ConceptMap.jurisdiction | Base | extensible | Jurisdiction | 📍4.0.1 | FHIR Std. |
| ConceptMap.group.element.target.equivalence | Base | required | ConceptMapEquivalence | 📍4.0.1 | FHIR Std. |
| ConceptMap.group.unmapped.mode | Base | required | ConceptMapGroupUnmappedMode | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| cmd-0 | warning | ConceptMap | Name should be usable as an identifier for the module by machine processing applications such as code generation |
name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
|
| cmd-1 | error | ConceptMap.group.element.target | If the map is narrower or inexact, there SHALL be some comments |
comment.exists() or equivalence.empty() or ((equivalence != 'narrower') and (equivalence != 'inexact'))
|
| cmd-2 | error | ConceptMap.group.unmapped | If the mode is 'fixed', a code must be provided |
(mode = 'fixed') implies code.exists()
|
| cmd-3 | error | ConceptMap.group.unmapped | If the mode is 'other-map', a url must be provided |
(mode = 'other-map') implies url.exists()
|
| dom-2 | error | ConceptMap | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | ConceptMap | 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 | error | ConceptMap | 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 | error | ConceptMap | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | ConceptMap | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | ConceptMap.meta, ConceptMap.meta.extension, ConceptMap.meta.extension:meta, ConceptMap.meta.versionId, ConceptMap.meta.lastUpdated, ConceptMap.meta.source, ConceptMap.meta.profile, ConceptMap.meta.security, ConceptMap.meta.tag, ConceptMap.implicitRules, ConceptMap.language, ConceptMap.text, ConceptMap.text.extension, ConceptMap.text.extension:text, ConceptMap.text.status, ConceptMap.text.div, ConceptMap.extension, ConceptMap.extension:source, ConceptMap.extension:target, ConceptMap.modifierExtension, ConceptMap.url, ConceptMap.identifier, ConceptMap.identifier.extension, ConceptMap.identifier.extension:identifier, ConceptMap.identifier.use, ConceptMap.identifier.type, ConceptMap.identifier.system, ConceptMap.identifier.value, ConceptMap.identifier.period, ConceptMap.identifier.assigner, ConceptMap.version, ConceptMap.name, ConceptMap.title, ConceptMap.status, ConceptMap.experimental, ConceptMap.date, ConceptMap.publisher, ConceptMap.contact, ConceptMap.contact.extension, ConceptMap.contact.extension:name, ConceptMap.contact.extension:telecom, ConceptMap.contact.name, ConceptMap.contact.telecom, ConceptMap.description, ConceptMap.useContext, ConceptMap.jurisdiction, ConceptMap.purpose, ConceptMap.copyright, ConceptMap.source[x], ConceptMap.target[x], ConceptMap.group, ConceptMap.group.extension, ConceptMap.group.modifierExtension, ConceptMap.group.source, ConceptMap.group.sourceVersion, ConceptMap.group.target, ConceptMap.group.targetVersion, ConceptMap.group.element, ConceptMap.group.element.extension, ConceptMap.group.element.modifierExtension, ConceptMap.group.element.code, ConceptMap.group.element.display, ConceptMap.group.element.target, ConceptMap.group.element.target.extension, ConceptMap.group.element.target.modifierExtension, ConceptMap.group.element.target.code, ConceptMap.group.element.target.display, ConceptMap.group.element.target.equivalence, ConceptMap.group.element.target.comment, ConceptMap.group.element.target.dependsOn, ConceptMap.group.element.target.dependsOn.extension, ConceptMap.group.element.target.dependsOn.modifierExtension, ConceptMap.group.element.target.dependsOn.property, ConceptMap.group.element.target.dependsOn.system, ConceptMap.group.element.target.dependsOn.value, ConceptMap.group.element.target.dependsOn.display, ConceptMap.group.element.target.product, ConceptMap.group.unmapped, ConceptMap.group.unmapped.extension, ConceptMap.group.unmapped.modifierExtension, ConceptMap.group.unmapped.mode, ConceptMap.group.unmapped.code, ConceptMap.group.unmapped.display, ConceptMap.group.unmapped.url | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | ConceptMap.meta.extension, ConceptMap.meta.extension:meta, ConceptMap.text.extension, ConceptMap.text.extension:text, ConceptMap.extension, ConceptMap.extension:source, ConceptMap.extension:target, ConceptMap.modifierExtension, ConceptMap.identifier.extension, ConceptMap.identifier.extension:identifier, ConceptMap.contact.extension, ConceptMap.contact.extension:name, ConceptMap.contact.extension:telecom, ConceptMap.group.extension, ConceptMap.group.modifierExtension, ConceptMap.group.element.extension, ConceptMap.group.element.modifierExtension, ConceptMap.group.element.target.extension, ConceptMap.group.element.target.modifierExtension, ConceptMap.group.element.target.dependsOn.extension, ConceptMap.group.element.target.dependsOn.modifierExtension, ConceptMap.group.unmapped.extension, ConceptMap.group.unmapped.modifierExtension | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| txt-1 | error | ConceptMap.text.div | The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes |
htmlChecks()
|
| txt-2 | error | ConceptMap.text.div | The narrative SHALL have some non-whitespace content |
htmlChecks()
|
This structure is derived from ConceptMap
Summary
Mandatory: 2 elements
Extensions
This structure refers to these extensions:
Maturity: 0
Other representations of profile: CSV, Excel, Schematron
IG © 2025+ FHIR Infrastructure. Package hl7.fhir.uv.xver-r2.r4#0.1.0 based on FHIR 4.0.1. Generated 2026-03-20
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change