Extensions for Using Data Elements from FHIR R5 in FHIR R4B
0.1.0 - STU International flag

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

Resource Profile: Profile_R5_ConceptMap_R4B

Official URL: http://hl7.org/fhir/5.0/StructureDefinition/profile-ConceptMap Version: 0.1.0
Standards status: Trial-use Maturity Level: 0 Computable Name: Profile_R5_ConceptMap_R4B

This cross-version profile allows R5 ConceptMap content to be represented via FHIR R4B ConceptMap resources.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ConceptMap C 0..* ConceptMap(4.3.0) A map from one set of concepts to one or more other concepts
Constraints: cmd-0
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
.... extension:versionAlgorithm 0..1 Coding R5: How to compare versions (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm
Binding: version-algorithm (??) (extensible)
Constraints: ext-1
.... extension:copyrightLabel 0..1 string R5: Copyright holder and year(s) (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
Constraints: ext-1
.... extension:approvalDate 0..1 date R5: When the ConceptMap was approved by publisher (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-approvalDate
Constraints: ext-1
.... extension:lastReviewDate 0..1 date R5: When the ConceptMap was last reviewed by the publisher (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-lastReviewDate
Constraints: ext-1
.... extension:effectivePeriod 0..1 Period R5: When the ConceptMap is expected to be used (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-effectivePeriod
Constraints: ext-1
.... extension:topic 0..* CodeableConcept R5: E.g. Education, Treatment, Assessment, etc (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-topic
Binding: DefinitionTopic (example): Topics associated with the artifact
Constraints: ext-1
.... extension:author 0..* ContactDetail R5: Who authored the ConceptMap (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-author
Constraints: ext-1
.... extension:editor 0..* ContactDetail R5: Who edited the ConceptMap (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-editor
Constraints: ext-1
.... extension:reviewer 0..* ContactDetail R5: Who reviewed the ConceptMap (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-reviewer
Constraints: ext-1
.... extension:endorser 0..* ContactDetail R5: Who endorsed the ConceptMap (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-endorser
Constraints: ext-1
.... extension:relatedArtifact 0..* RelatedArtifact R5: Additional documentation, citations, etc (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact
Constraints: ext-1
.... extension:property 0..* (Complex) R5: Additional properties of the mapping (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ConceptMap.property
Constraints: ext-1
.... extension:additionalAttribute 0..* (Complex) R5: Definition of an additional attribute to act as a data source or target (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ConceptMap.additionalAttribute
Constraints: ext-1
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ConceptMap.status Base required PublicationStatus 📍4.3.0 FHIR Std.

Constraints

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.exists() implies 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.exists() and ('#'+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(uri) = '#').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:versionAlgorithm, ConceptMap.extension:copyrightLabel, ConceptMap.extension:approvalDate, ConceptMap.extension:lastReviewDate, ConceptMap.extension:effectivePeriod, ConceptMap.extension:topic, ConceptMap.extension:author, ConceptMap.extension:editor, ConceptMap.extension:reviewer, ConceptMap.extension:endorser, ConceptMap.extension:relatedArtifact, ConceptMap.extension:property, ConceptMap.extension:additionalAttribute, 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:versionAlgorithm, ConceptMap.extension:copyrightLabel, ConceptMap.extension:approvalDate, ConceptMap.extension:lastReviewDate, ConceptMap.extension:effectivePeriod, ConceptMap.extension:topic, ConceptMap.extension:author, ConceptMap.extension:editor, ConceptMap.extension:reviewer, ConceptMap.extension:endorser, ConceptMap.extension:relatedArtifact, ConceptMap.extension:property, ConceptMap.extension:additionalAttribute, ConceptMap.modifierExtension Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from ConceptMap

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ConceptMap 0..* ConceptMap(4.3.0) A map from one set of concepts to one or more other concepts
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:versionAlgorithm 0..1 Coding R5: How to compare versions (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm
Binding: version-algorithm (??) (extensible)
.... extension:copyrightLabel 0..1 string R5: Copyright holder and year(s) (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
.... extension:approvalDate 0..1 date R5: When the ConceptMap was approved by publisher (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-approvalDate
.... extension:lastReviewDate 0..1 date R5: When the ConceptMap was last reviewed by the publisher (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-lastReviewDate
.... extension:effectivePeriod 0..1 Period R5: When the ConceptMap is expected to be used (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-effectivePeriod
.... extension:topic 0..* CodeableConcept R5: E.g. Education, Treatment, Assessment, etc (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-topic
Binding: DefinitionTopic (example): Topics associated with the artifact
.... extension:author 0..* ContactDetail R5: Who authored the ConceptMap (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-author
.... extension:editor 0..* ContactDetail R5: Who edited the ConceptMap (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-editor
.... extension:reviewer 0..* ContactDetail R5: Who reviewed the ConceptMap (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-reviewer
.... extension:endorser 0..* ContactDetail R5: Who endorsed the ConceptMap (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-endorser
.... extension:relatedArtifact 0..* RelatedArtifact R5: Additional documentation, citations, etc (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact
.... extension:property 0..* (Complex) R5: Additional properties of the mapping (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ConceptMap.property
.... extension:additionalAttribute 0..* (Complex) R5: Definition of an additional attribute to act as a data source or target (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ConceptMap.additionalAttribute
... group
.... element
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:valueSet 0..1 canonical(Cross-version Profile for R5.ValueSet for use in FHIR R4B(0.1.0) | ValueSet) R5: Identifies the set of concepts being mapped (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ConceptMap.group.element.valueSet
..... target
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:valueSet 0..1 canonical(Cross-version Profile for R5.ValueSet for use in FHIR R4B(0.1.0) | ValueSet) R5: Identifies the set of target concepts (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ConceptMap.group.element.target.valueSet
....... extension:property 0..* (Complex) R5: Property value for the source -> target mapping (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ConceptMap.group.element.target.property
...... equivalence
....... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
........ extension:noMap 0..1 boolean R5: No mapping to a target concept for this source concept additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ConceptMap.group.element.noMap
...... dependsOn
....... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
........ extension:value 0..1 Coding, boolean, Quantity R5: Value of the referenced data element additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ConceptMap.group.element.target.dependsOn.value
........ extension:valueSet 0..1 canonical(Cross-version Profile for R5.ValueSet for use in FHIR R4B(0.1.0) | ValueSet) R5: The mapping depends on a data element with a value from this value set (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ConceptMap.group.element.target.dependsOn.valueSet
....... property
........ Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
......... extension:attribute 0..1 code R5: A reference to a mapping attribute defined in ConceptMap.additionalAttribute additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ConceptMap.group.element.target.dependsOn.attribute
.... unmapped
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:valueSet 0..1 canonical(Cross-version Profile for R5.ValueSet for use in FHIR R4B(0.1.0) | ValueSet) R5: Fixed code set when mode = fixed (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ConceptMap.group.unmapped.valueSet
..... Slices for modifierExtension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... modifierExtension:relationship 0..1 code R5: related-to | equivalent | source-is-narrower-than-target | source-is-broader-than-target | not-related-to (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ConceptMap.group.unmapped.relationship
Binding: ConceptMapEquivalence (required): The default relationship value to apply between the source and target concepts when no concept mapping is specified.

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ConceptMap C 0..* ConceptMap(4.3.0) 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
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... 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
... contained 0..* Resource Contained, inline Resources
Constraints: dom-r4b
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
.... extension:versionAlgorithm 0..1 Coding R5: How to compare versions (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm
Binding: version-algorithm (??) (extensible)
Constraints: ext-1
.... extension:copyrightLabel 0..1 string R5: Copyright holder and year(s) (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
Constraints: ext-1
.... extension:approvalDate 0..1 date R5: When the ConceptMap was approved by publisher (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-approvalDate
Constraints: ext-1
.... extension:lastReviewDate 0..1 date R5: When the ConceptMap was last reviewed by the publisher (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-lastReviewDate
Constraints: ext-1
.... extension:effectivePeriod 0..1 Period R5: When the ConceptMap is expected to be used (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-effectivePeriod
Constraints: ext-1
.... extension:topic 0..* CodeableConcept R5: E.g. Education, Treatment, Assessment, etc (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-topic
Binding: DefinitionTopic (example): Topics associated with the artifact
Constraints: ext-1
.... extension:author 0..* ContactDetail R5: Who authored the ConceptMap (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-author
Constraints: ext-1
.... extension:editor 0..* ContactDetail R5: Who edited the ConceptMap (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-editor
Constraints: ext-1
.... extension:reviewer 0..* ContactDetail R5: Who reviewed the ConceptMap (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-reviewer
Constraints: ext-1
.... extension:endorser 0..* ContactDetail R5: Who endorsed the ConceptMap (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-endorser
Constraints: ext-1
.... extension:relatedArtifact 0..* RelatedArtifact R5: Additional documentation, citations, etc (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact
Constraints: ext-1
.... extension:property 0..* (Complex) R5: Additional properties of the mapping (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ConceptMap.property
Constraints: ext-1
.... extension:additionalAttribute 0..* (Complex) R5: Definition of an additional attribute to act as a data source or target (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ConceptMap.additionalAttribute
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
... version Σ 0..1 string Business version of the concept map
... name Σ 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
... 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
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:valueSet 0..1 canonical(Cross-version Profile for R5.ValueSet for use in FHIR R4B(0.1.0) | ValueSet) R5: Identifies the set of concepts being mapped (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ConceptMap.group.element.valueSet
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
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
....... extension:valueSet 0..1 canonical(Cross-version Profile for R5.ValueSet for use in FHIR R4B(0.1.0) | ValueSet) R5: Identifies the set of target concepts (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ConceptMap.group.element.target.valueSet
Constraints: ext-1
....... extension:property 0..* (Complex) R5: Property value for the source -> target mapping (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ConceptMap.group.element.target.property
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.
....... id 0..1 string xml:id (or equivalent in JSON)
....... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
........ extension:noMap 0..1 boolean R5: No mapping to a target concept for this source concept additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ConceptMap.group.element.noMap
Constraints: ext-1
....... value 0..1 code Primitive value for code
...... 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
....... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
........ extension:value 0..1 Coding, boolean, Quantity R5: Value of the referenced data element additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ConceptMap.group.element.target.dependsOn.value
Constraints: ext-1
........ extension:valueSet 0..1 canonical(Cross-version Profile for R5.ValueSet for use in FHIR R4B(0.1.0) | ValueSet) R5: The mapping depends on a data element with a value from this value set (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ConceptMap.group.element.target.dependsOn.valueSet
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
........ id 0..1 string xml:id (or equivalent in JSON)
........ Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
......... extension:attribute 0..1 code R5: A reference to a mapping attribute defined in ConceptMap.additionalAttribute additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ConceptMap.group.element.target.dependsOn.attribute
Constraints: ext-1
........ value 0..1 uri Primitive value for uri
....... 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
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:valueSet 0..1 canonical(Cross-version Profile for R5.ValueSet for use in FHIR R4B(0.1.0) | ValueSet) R5: Fixed code set when mode = fixed (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ConceptMap.group.unmapped.valueSet
Constraints: ext-1
..... Slices for modifierExtension ?!Σ 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... modifierExtension:relationship ?!Σ 0..1 code R5: related-to | equivalent | source-is-narrower-than-target | source-is-broader-than-target | not-related-to (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ConceptMap.group.unmapped.relationship
Binding: ConceptMapEquivalence (required): The default relationship value to apply between the source and target concepts when no concept mapping is specified.
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

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ConceptMap.language Base preferred Common Languages 📍4.3.0 FHIR Std.
ConceptMap.status Base required PublicationStatus 📍4.3.0 FHIR Std.
ConceptMap.jurisdiction Base extensible Jurisdiction 📍4.3.0 FHIR Std.
ConceptMap.group.element.​target.equivalence Base required ConceptMapEquivalence 📍4.3.0 FHIR Std.
ConceptMap.group.unmapped.​mode Base required ConceptMapGroupUnmappedMode 📍4.3.0 FHIR Std.

Constraints

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.exists() implies 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.exists() and ('#'+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(uri) = '#').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()
dom-r4b warning ConceptMap.contained Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems ($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)
ele-1 error ConceptMap.meta, ConceptMap.implicitRules, ConceptMap.language, ConceptMap.text, ConceptMap.extension, ConceptMap.extension:versionAlgorithm, ConceptMap.extension:copyrightLabel, ConceptMap.extension:approvalDate, ConceptMap.extension:lastReviewDate, ConceptMap.extension:effectivePeriod, ConceptMap.extension:topic, ConceptMap.extension:author, ConceptMap.extension:editor, ConceptMap.extension:reviewer, ConceptMap.extension:endorser, ConceptMap.extension:relatedArtifact, ConceptMap.extension:property, ConceptMap.extension:additionalAttribute, ConceptMap.modifierExtension, ConceptMap.url, ConceptMap.identifier, ConceptMap.version, ConceptMap.name, ConceptMap.title, ConceptMap.status, ConceptMap.experimental, ConceptMap.date, ConceptMap.publisher, ConceptMap.contact, 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.extension:valueSet, 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.extension:valueSet, ConceptMap.group.element.target.extension:property, ConceptMap.group.element.target.modifierExtension, ConceptMap.group.element.target.code, ConceptMap.group.element.target.display, ConceptMap.group.element.target.equivalence, ConceptMap.group.element.target.equivalence.extension, ConceptMap.group.element.target.equivalence.extension:noMap, ConceptMap.group.element.target.comment, ConceptMap.group.element.target.dependsOn, ConceptMap.group.element.target.dependsOn.extension, ConceptMap.group.element.target.dependsOn.extension:value, ConceptMap.group.element.target.dependsOn.extension:valueSet, ConceptMap.group.element.target.dependsOn.modifierExtension, ConceptMap.group.element.target.dependsOn.property, ConceptMap.group.element.target.dependsOn.property.extension, ConceptMap.group.element.target.dependsOn.property.extension:attribute, 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.extension:valueSet, ConceptMap.group.unmapped.modifierExtension, ConceptMap.group.unmapped.modifierExtension:relationship, 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.extension, ConceptMap.extension:versionAlgorithm, ConceptMap.extension:copyrightLabel, ConceptMap.extension:approvalDate, ConceptMap.extension:lastReviewDate, ConceptMap.extension:effectivePeriod, ConceptMap.extension:topic, ConceptMap.extension:author, ConceptMap.extension:editor, ConceptMap.extension:reviewer, ConceptMap.extension:endorser, ConceptMap.extension:relatedArtifact, ConceptMap.extension:property, ConceptMap.extension:additionalAttribute, ConceptMap.modifierExtension, ConceptMap.group.extension, ConceptMap.group.modifierExtension, ConceptMap.group.element.extension, ConceptMap.group.element.extension:valueSet, ConceptMap.group.element.modifierExtension, ConceptMap.group.element.target.extension, ConceptMap.group.element.target.extension:valueSet, ConceptMap.group.element.target.extension:property, ConceptMap.group.element.target.modifierExtension, ConceptMap.group.element.target.equivalence.extension, ConceptMap.group.element.target.equivalence.extension:noMap, ConceptMap.group.element.target.dependsOn.extension, ConceptMap.group.element.target.dependsOn.extension:value, ConceptMap.group.element.target.dependsOn.extension:valueSet, ConceptMap.group.element.target.dependsOn.modifierExtension, ConceptMap.group.element.target.dependsOn.property.extension, ConceptMap.group.element.target.dependsOn.property.extension:attribute, ConceptMap.group.unmapped.extension, ConceptMap.group.unmapped.extension:valueSet, ConceptMap.group.unmapped.modifierExtension, ConceptMap.group.unmapped.modifierExtension:relationship Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from ConceptMap

Summary

Extensions

This structure refers to these extensions:

Maturity: 0

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ConceptMap C 0..* ConceptMap(4.3.0) A map from one set of concepts to one or more other concepts
Constraints: cmd-0
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
.... extension:versionAlgorithm 0..1 Coding R5: How to compare versions (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm
Binding: version-algorithm (??) (extensible)
Constraints: ext-1
.... extension:copyrightLabel 0..1 string R5: Copyright holder and year(s) (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
Constraints: ext-1
.... extension:approvalDate 0..1 date R5: When the ConceptMap was approved by publisher (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-approvalDate
Constraints: ext-1
.... extension:lastReviewDate 0..1 date R5: When the ConceptMap was last reviewed by the publisher (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-lastReviewDate
Constraints: ext-1
.... extension:effectivePeriod 0..1 Period R5: When the ConceptMap is expected to be used (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-effectivePeriod
Constraints: ext-1
.... extension:topic 0..* CodeableConcept R5: E.g. Education, Treatment, Assessment, etc (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-topic
Binding: DefinitionTopic (example): Topics associated with the artifact
Constraints: ext-1
.... extension:author 0..* ContactDetail R5: Who authored the ConceptMap (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-author
Constraints: ext-1
.... extension:editor 0..* ContactDetail R5: Who edited the ConceptMap (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-editor
Constraints: ext-1
.... extension:reviewer 0..* ContactDetail R5: Who reviewed the ConceptMap (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-reviewer
Constraints: ext-1
.... extension:endorser 0..* ContactDetail R5: Who endorsed the ConceptMap (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-endorser
Constraints: ext-1
.... extension:relatedArtifact 0..* RelatedArtifact R5: Additional documentation, citations, etc (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact
Constraints: ext-1
.... extension:property 0..* (Complex) R5: Additional properties of the mapping (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ConceptMap.property
Constraints: ext-1
.... extension:additionalAttribute 0..* (Complex) R5: Definition of an additional attribute to act as a data source or target (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ConceptMap.additionalAttribute
Constraints: ext-1
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ConceptMap.status Base required PublicationStatus 📍4.3.0 FHIR Std.

Constraints

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.exists() implies 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.exists() and ('#'+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(uri) = '#').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:versionAlgorithm, ConceptMap.extension:copyrightLabel, ConceptMap.extension:approvalDate, ConceptMap.extension:lastReviewDate, ConceptMap.extension:effectivePeriod, ConceptMap.extension:topic, ConceptMap.extension:author, ConceptMap.extension:editor, ConceptMap.extension:reviewer, ConceptMap.extension:endorser, ConceptMap.extension:relatedArtifact, ConceptMap.extension:property, ConceptMap.extension:additionalAttribute, 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:versionAlgorithm, ConceptMap.extension:copyrightLabel, ConceptMap.extension:approvalDate, ConceptMap.extension:lastReviewDate, ConceptMap.extension:effectivePeriod, ConceptMap.extension:topic, ConceptMap.extension:author, ConceptMap.extension:editor, ConceptMap.extension:reviewer, ConceptMap.extension:endorser, ConceptMap.extension:relatedArtifact, ConceptMap.extension:property, ConceptMap.extension:additionalAttribute, ConceptMap.modifierExtension Must have either extensions or value[x], not both extension.exists() != value.exists()

Differential View

This structure is derived from ConceptMap

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ConceptMap 0..* ConceptMap(4.3.0) A map from one set of concepts to one or more other concepts
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:versionAlgorithm 0..1 Coding R5: How to compare versions (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm
Binding: version-algorithm (??) (extensible)
.... extension:copyrightLabel 0..1 string R5: Copyright holder and year(s) (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
.... extension:approvalDate 0..1 date R5: When the ConceptMap was approved by publisher (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-approvalDate
.... extension:lastReviewDate 0..1 date R5: When the ConceptMap was last reviewed by the publisher (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-lastReviewDate
.... extension:effectivePeriod 0..1 Period R5: When the ConceptMap is expected to be used (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-effectivePeriod
.... extension:topic 0..* CodeableConcept R5: E.g. Education, Treatment, Assessment, etc (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-topic
Binding: DefinitionTopic (example): Topics associated with the artifact
.... extension:author 0..* ContactDetail R5: Who authored the ConceptMap (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-author
.... extension:editor 0..* ContactDetail R5: Who edited the ConceptMap (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-editor
.... extension:reviewer 0..* ContactDetail R5: Who reviewed the ConceptMap (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-reviewer
.... extension:endorser 0..* ContactDetail R5: Who endorsed the ConceptMap (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-endorser
.... extension:relatedArtifact 0..* RelatedArtifact R5: Additional documentation, citations, etc (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact
.... extension:property 0..* (Complex) R5: Additional properties of the mapping (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ConceptMap.property
.... extension:additionalAttribute 0..* (Complex) R5: Definition of an additional attribute to act as a data source or target (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ConceptMap.additionalAttribute
... group
.... element
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:valueSet 0..1 canonical(Cross-version Profile for R5.ValueSet for use in FHIR R4B(0.1.0) | ValueSet) R5: Identifies the set of concepts being mapped (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ConceptMap.group.element.valueSet
..... target
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:valueSet 0..1 canonical(Cross-version Profile for R5.ValueSet for use in FHIR R4B(0.1.0) | ValueSet) R5: Identifies the set of target concepts (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ConceptMap.group.element.target.valueSet
....... extension:property 0..* (Complex) R5: Property value for the source -> target mapping (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ConceptMap.group.element.target.property
...... equivalence
....... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
........ extension:noMap 0..1 boolean R5: No mapping to a target concept for this source concept additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ConceptMap.group.element.noMap
...... dependsOn
....... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
........ extension:value 0..1 Coding, boolean, Quantity R5: Value of the referenced data element additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ConceptMap.group.element.target.dependsOn.value
........ extension:valueSet 0..1 canonical(Cross-version Profile for R5.ValueSet for use in FHIR R4B(0.1.0) | ValueSet) R5: The mapping depends on a data element with a value from this value set (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ConceptMap.group.element.target.dependsOn.valueSet
....... property
........ Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
......... extension:attribute 0..1 code R5: A reference to a mapping attribute defined in ConceptMap.additionalAttribute additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ConceptMap.group.element.target.dependsOn.attribute
.... unmapped
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:valueSet 0..1 canonical(Cross-version Profile for R5.ValueSet for use in FHIR R4B(0.1.0) | ValueSet) R5: Fixed code set when mode = fixed (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ConceptMap.group.unmapped.valueSet
..... Slices for modifierExtension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... modifierExtension:relationship 0..1 code R5: related-to | equivalent | source-is-narrower-than-target | source-is-broader-than-target | not-related-to (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ConceptMap.group.unmapped.relationship
Binding: ConceptMapEquivalence (required): The default relationship value to apply between the source and target concepts when no concept mapping is specified.

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ConceptMap C 0..* ConceptMap(4.3.0) 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
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... 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
... contained 0..* Resource Contained, inline Resources
Constraints: dom-r4b
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
.... extension:versionAlgorithm 0..1 Coding R5: How to compare versions (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm
Binding: version-algorithm (??) (extensible)
Constraints: ext-1
.... extension:copyrightLabel 0..1 string R5: Copyright holder and year(s) (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
Constraints: ext-1
.... extension:approvalDate 0..1 date R5: When the ConceptMap was approved by publisher (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-approvalDate
Constraints: ext-1
.... extension:lastReviewDate 0..1 date R5: When the ConceptMap was last reviewed by the publisher (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-lastReviewDate
Constraints: ext-1
.... extension:effectivePeriod 0..1 Period R5: When the ConceptMap is expected to be used (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-effectivePeriod
Constraints: ext-1
.... extension:topic 0..* CodeableConcept R5: E.g. Education, Treatment, Assessment, etc (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-topic
Binding: DefinitionTopic (example): Topics associated with the artifact
Constraints: ext-1
.... extension:author 0..* ContactDetail R5: Who authored the ConceptMap (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-author
Constraints: ext-1
.... extension:editor 0..* ContactDetail R5: Who edited the ConceptMap (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-editor
Constraints: ext-1
.... extension:reviewer 0..* ContactDetail R5: Who reviewed the ConceptMap (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-reviewer
Constraints: ext-1
.... extension:endorser 0..* ContactDetail R5: Who endorsed the ConceptMap (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-endorser
Constraints: ext-1
.... extension:relatedArtifact 0..* RelatedArtifact R5: Additional documentation, citations, etc (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact
Constraints: ext-1
.... extension:property 0..* (Complex) R5: Additional properties of the mapping (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ConceptMap.property
Constraints: ext-1
.... extension:additionalAttribute 0..* (Complex) R5: Definition of an additional attribute to act as a data source or target (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ConceptMap.additionalAttribute
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
... version Σ 0..1 string Business version of the concept map
... name Σ 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
... 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
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:valueSet 0..1 canonical(Cross-version Profile for R5.ValueSet for use in FHIR R4B(0.1.0) | ValueSet) R5: Identifies the set of concepts being mapped (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ConceptMap.group.element.valueSet
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
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
....... extension:valueSet 0..1 canonical(Cross-version Profile for R5.ValueSet for use in FHIR R4B(0.1.0) | ValueSet) R5: Identifies the set of target concepts (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ConceptMap.group.element.target.valueSet
Constraints: ext-1
....... extension:property 0..* (Complex) R5: Property value for the source -> target mapping (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ConceptMap.group.element.target.property
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.
....... id 0..1 string xml:id (or equivalent in JSON)
....... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
........ extension:noMap 0..1 boolean R5: No mapping to a target concept for this source concept additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ConceptMap.group.element.noMap
Constraints: ext-1
....... value 0..1 code Primitive value for code
...... 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
....... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
........ extension:value 0..1 Coding, boolean, Quantity R5: Value of the referenced data element additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ConceptMap.group.element.target.dependsOn.value
Constraints: ext-1
........ extension:valueSet 0..1 canonical(Cross-version Profile for R5.ValueSet for use in FHIR R4B(0.1.0) | ValueSet) R5: The mapping depends on a data element with a value from this value set (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ConceptMap.group.element.target.dependsOn.valueSet
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
........ id 0..1 string xml:id (or equivalent in JSON)
........ Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
......... extension:attribute 0..1 code R5: A reference to a mapping attribute defined in ConceptMap.additionalAttribute additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ConceptMap.group.element.target.dependsOn.attribute
Constraints: ext-1
........ value 0..1 uri Primitive value for uri
....... 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
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:valueSet 0..1 canonical(Cross-version Profile for R5.ValueSet for use in FHIR R4B(0.1.0) | ValueSet) R5: Fixed code set when mode = fixed (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ConceptMap.group.unmapped.valueSet
Constraints: ext-1
..... Slices for modifierExtension ?!Σ 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... modifierExtension:relationship ?!Σ 0..1 code R5: related-to | equivalent | source-is-narrower-than-target | source-is-broader-than-target | not-related-to (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ConceptMap.group.unmapped.relationship
Binding: ConceptMapEquivalence (required): The default relationship value to apply between the source and target concepts when no concept mapping is specified.
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

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ConceptMap.language Base preferred Common Languages 📍4.3.0 FHIR Std.
ConceptMap.status Base required PublicationStatus 📍4.3.0 FHIR Std.
ConceptMap.jurisdiction Base extensible Jurisdiction 📍4.3.0 FHIR Std.
ConceptMap.group.element.​target.equivalence Base required ConceptMapEquivalence 📍4.3.0 FHIR Std.
ConceptMap.group.unmapped.​mode Base required ConceptMapGroupUnmappedMode 📍4.3.0 FHIR Std.

Constraints

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.exists() implies 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.exists() and ('#'+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(uri) = '#').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()
dom-r4b warning ConceptMap.contained Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems ($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)
ele-1 error ConceptMap.meta, ConceptMap.implicitRules, ConceptMap.language, ConceptMap.text, ConceptMap.extension, ConceptMap.extension:versionAlgorithm, ConceptMap.extension:copyrightLabel, ConceptMap.extension:approvalDate, ConceptMap.extension:lastReviewDate, ConceptMap.extension:effectivePeriod, ConceptMap.extension:topic, ConceptMap.extension:author, ConceptMap.extension:editor, ConceptMap.extension:reviewer, ConceptMap.extension:endorser, ConceptMap.extension:relatedArtifact, ConceptMap.extension:property, ConceptMap.extension:additionalAttribute, ConceptMap.modifierExtension, ConceptMap.url, ConceptMap.identifier, ConceptMap.version, ConceptMap.name, ConceptMap.title, ConceptMap.status, ConceptMap.experimental, ConceptMap.date, ConceptMap.publisher, ConceptMap.contact, 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.extension:valueSet, 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.extension:valueSet, ConceptMap.group.element.target.extension:property, ConceptMap.group.element.target.modifierExtension, ConceptMap.group.element.target.code, ConceptMap.group.element.target.display, ConceptMap.group.element.target.equivalence, ConceptMap.group.element.target.equivalence.extension, ConceptMap.group.element.target.equivalence.extension:noMap, ConceptMap.group.element.target.comment, ConceptMap.group.element.target.dependsOn, ConceptMap.group.element.target.dependsOn.extension, ConceptMap.group.element.target.dependsOn.extension:value, ConceptMap.group.element.target.dependsOn.extension:valueSet, ConceptMap.group.element.target.dependsOn.modifierExtension, ConceptMap.group.element.target.dependsOn.property, ConceptMap.group.element.target.dependsOn.property.extension, ConceptMap.group.element.target.dependsOn.property.extension:attribute, 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.extension:valueSet, ConceptMap.group.unmapped.modifierExtension, ConceptMap.group.unmapped.modifierExtension:relationship, 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.extension, ConceptMap.extension:versionAlgorithm, ConceptMap.extension:copyrightLabel, ConceptMap.extension:approvalDate, ConceptMap.extension:lastReviewDate, ConceptMap.extension:effectivePeriod, ConceptMap.extension:topic, ConceptMap.extension:author, ConceptMap.extension:editor, ConceptMap.extension:reviewer, ConceptMap.extension:endorser, ConceptMap.extension:relatedArtifact, ConceptMap.extension:property, ConceptMap.extension:additionalAttribute, ConceptMap.modifierExtension, ConceptMap.group.extension, ConceptMap.group.modifierExtension, ConceptMap.group.element.extension, ConceptMap.group.element.extension:valueSet, ConceptMap.group.element.modifierExtension, ConceptMap.group.element.target.extension, ConceptMap.group.element.target.extension:valueSet, ConceptMap.group.element.target.extension:property, ConceptMap.group.element.target.modifierExtension, ConceptMap.group.element.target.equivalence.extension, ConceptMap.group.element.target.equivalence.extension:noMap, ConceptMap.group.element.target.dependsOn.extension, ConceptMap.group.element.target.dependsOn.extension:value, ConceptMap.group.element.target.dependsOn.extension:valueSet, ConceptMap.group.element.target.dependsOn.modifierExtension, ConceptMap.group.element.target.dependsOn.property.extension, ConceptMap.group.element.target.dependsOn.property.extension:attribute, ConceptMap.group.unmapped.extension, ConceptMap.group.unmapped.extension:valueSet, ConceptMap.group.unmapped.modifierExtension, ConceptMap.group.unmapped.modifierExtension:relationship Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from ConceptMap

Summary

Extensions

This structure refers to these extensions:

Maturity: 0

 

Other representations of profile: CSV, Excel, Schematron