R6 Ballot (2nd Draft)

Publish-box (todo)

4.10.17.2 StructureDefinition: ShareableConceptMap

Terminology Infrastructure icon Work Group  Maturity Level: 0 Trial Use Use Context: Any

The canonical URL for this profile is: 

http://hl7.org/fhir/StructureDefinition/shareableconceptmap

Enforces the minimum information set for the concept map metadata required by HL7 and other organizations that share and publish concept maps

Note to Implementers: All of the shareable, publishable, computable, and executable profiles will be migrating to the new Canonical Resource Management icon implementation guide as part of the next FHIR release. Implementers are encouraged to look there for updates, corrections and clarifications.

This profile was published on Thu, Jan 1, 1970 00:00+0800 as a draft by HL7.

4.10.17.2.1 Formal Views of Profile Content

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

This structure is derived from ConceptMap.

Summary

Mandatory: 5 elements
Must-Support: 10 elements

Extensions

This structure refers to these extensions:

This indicates the differences between this profile and the base ConceptMap structure.

Name iconFlags iconCard. iconType iconDescription & Constraints icondoco icon
.. ConceptMap 1..1 ConceptMap A map from one set of concepts to one or more other concepts
... Slices for extension Content/Rules for all slices
.... knowledgeRepresentationLevel S 0..* code narrative | semi-structured | structured | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeRepresentationLevel
Binding: Knowledge Representation Level (required)
... url S 1..1 uri Canonical identifier for this concept map, represented as a URI (globally unique)
... version S 1..1 string Business version of the concept map
... versionAlgorithm[x] S 0..1 string, Coding How to compare versions
... name S 0..1 string Name for this concept map (computer friendly)
... title S 1..1 string Name for this concept map (human friendly)
... status S 1..1 code draft | active | retired | unknown
... experimental S 1..1 boolean For testing purposes, not real usage
... publisher S 0..1 string Name of the publisher/steward (organization or individual)
... description S 1..1 markdown Natural language description of the concept map

doco Documentation for this format icon

This provides the consolidated view (aka snapshot) of the profile after applying the changes in this profile to the base ConceptMap structure.

Name iconFlags iconCard. iconType iconDescription & Constraints icondoco icon
.. ConceptMap C icon 1..1 ConceptMap A map from one set of concepts to one or more other concepts
cnl-0: Name should be usable as an identifier for the module by machine processing applications such as code generation
... 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
... language 0..1 code Language of the resource content
Binding: All Languages (required): IETF language tag for a human language

Additional BindingsPurpose
Common Languages Starter Set
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... knowledgeRepresentationLevel S 0..* code narrative | semi-structured | structured | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeRepresentationLevel
Binding: Knowledge Representation Level (required)
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... url SΣC icon 1..1 uri Canonical identifier for this concept map, represented as a URI (globally unique)
cnl-1: URL should not contain | or # - these characters make processing canonical references problematic
... identifier Σ 0..* Identifier Additional identifier for the concept map
... version SΣ 1..1 string Business version of the concept map
... versionAlgorithm[x] SΣ 0..1 How to compare versions
Binding: Version Algorithm (extensible)
.... versionAlgorithmString string
.... versionAlgorithmCoding Coding
... name SΣC icon 0..1 string Name for this concept map (computer friendly)
... title SΣ 1..1 string Name for this concept map (human friendly)
... status ?!SΣC icon 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... experimental SΣ 1..1 boolean For testing purposes, not real usage
... date Σ 0..1 dateTime Date last changed
... publisher SΣ 0..1 string Name of the publisher/steward (organization or individual)
... contact Σ 0..* ContactDetail Contact details for the publisher
... description S 1..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
... copyrightLabel 0..1 string Copyright holder and year(s)
... approvalDate 0..1 date When the ConceptMap was approved by publisher
... lastReviewDate 0..1 date When the ConceptMap was last reviewed by the publisher
... effectivePeriod Σ 0..1 Period When the ConceptMap is expected to be used
... topic 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc
Binding: Definition Topic (example)
... author 0..* ContactDetail Who authored the ConceptMap
... editor 0..* ContactDetail Who edited the ConceptMap
... reviewer 0..* ContactDetail Who reviewed the ConceptMap
... endorser 0..* ContactDetail Who endorsed the ConceptMap
... relatedArtifact 0..* RelatedArtifact Additional documentation, citations, etc
... property ΣC icon 0..* BackboneElement Additional properties of the mapping
cmd-11: If the property type is code, a system SHALL be specified
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... code Σ 1..1 code Identifies the property on the mappings, and when referred to in the $translate operation
.... uri Σ 0..1 uri Formal identifier for the property
.... description Σ 0..1 string Why the property is defined, and/or what it conveys
.... type ΣC icon 1..1 code Coding | string | integer | boolean | dateTime | decimal | code
Binding: ConceptMap Property Type (required): The type of a property value.

.... system ΣC icon 0..1 canonical(CodeSystem) The CodeSystem from which code values come
... additionalAttribute Σ 0..* BackboneElement Definition of an additional attribute to act as a data source or target
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... code Σ 1..1 code Identifies this additional attribute through this resource
.... uri Σ 0..1 uri Formal identifier for the data element referred to in this attribte
.... description Σ 0..1 string Why the additional attribute is defined, and/or what the data element it refers to is
.... type Σ 1..1 code code | Coding | string | boolean | Quantity
Binding: ConceptMap Attribute Type (required): The type of a mapping attribute value.

... sourceScope[x] Σ 0..1 The source value set that contains the concepts that are being mapped
.... sourceScopeUri uri
.... sourceScopeCanonical canonical(ValueSet)
... targetScope[x] Σ 0..1 The target value set which provides context for the mappings
.... targetScopeUri uri
.... targetScopeCanonical 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
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... source 0..1 canonical(CodeSystem) Source system where concepts to be mapped are defined
.... target 0..1 canonical(CodeSystem) Target system that the concepts are to be mapped to
.... element C icon 1..* BackboneElement Mappings for a concept from the source set
cmd-4: If noMap is present, target SHALL NOT be present
cmd-5: Either code or valueSet SHALL be present but not both.
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... code C icon 0..1 code Identifies element being mapped
..... display 0..1 string Display for the code
..... valueSet C icon 0..1 canonical(ValueSet) Identifies the set of concepts being mapped
..... noMap C icon 0..1 boolean No mapping to a target concept for this source concept
..... target C icon 0..* BackboneElement Concept in target system for element
cmd-1: If the map is source-is-broader-than-target or not-related-to, there SHALL be some comments, unless the status is 'draft'
cmd-7: Either code or valueSet SHALL be present but not both.
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... code C icon 0..1 code Code that identifies the target element
...... display 0..1 string Display for the code
...... valueSet C icon 0..1 canonical(ValueSet) Identifies the set of target concepts
...... relationship ?!C icon 1..1 code related-to | equivalent | source-is-narrower-than-target | source-is-broader-than-target | not-related-to
Binding: ConceptMapRelationship (required): The relationship between concepts.

...... comment C icon 0..1 string Description of status/issues in mapping
...... property 0..* BackboneElement Property value for the source -> target mapping
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... code 1..1 code Reference to ConceptMap.property.code
....... value[x] 1..1 Value of the property for this concept
........ valueCoding Coding
........ valueString string
........ valueInteger integer
........ valueBoolean boolean
........ valueDateTime dateTime
........ valueDecimal decimal
........ valueCode code
...... dependsOn C icon 0..* BackboneElement Other properties required for this mapping
cmd-6: One of value[x] or valueSet must exist, but not both.
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... attribute 1..1 code A reference to a mapping attribute defined in ConceptMap.additionalAttribute
....... value[x] C icon 0..1 Value of the referenced data element
........ valueCode code
........ valueCoding Coding
........ valueString string
........ valueBoolean boolean
........ valueQuantity Quantity
....... valueSet C icon 0..1 canonical(ValueSet) The mapping depends on a data element with a value from this value set
...... product 0..* See dependsOn (ConceptMap) Other data elements that this mapping also produces
.... unmapped C icon 0..1 BackboneElement What to do when there is no mapping target for the source concept and ConceptMap.group.element.noMap is not true
cmd-2: If the mode is 'fixed', either a code or valueSet must be provided, but not both.
cmd-3: If the mode is 'other-map', a url for the other map must be provided
cmd-8: If the mode is not 'fixed', code, display and valueSet are not allowed
cmd-9: If the mode is not 'other-map', relationship must be provided
cmd-10: If the mode is not 'other-map', otherMap is not allowed
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... mode C icon 1..1 code use-source-code | fixed | other-map
Binding: Concept Map Group Unmapped Mode (required): Defines which action to take if there is no match in the group.

..... code C icon 0..1 code Fixed code when mode = fixed
..... display C icon 0..1 string Display for the code
..... valueSet C icon 0..1 canonical(ValueSet) Fixed code set when mode = fixed
..... relationship ?!C icon 0..1 code related-to | equivalent | source-is-narrower-than-target | source-is-broader-than-target | not-related-to
Binding: ConceptMapRelationship (required): The default relationship value to apply between the source and target concepts when no concept mapping is specified.

..... otherMap C icon 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 icon
<!-- ShareableConceptMap -->doco

<ConceptMap xmlns="http://hl7.org/fhir"
>
  <!-- from Element: extension -->
 <id value="[id]"/><!-- 0..1 Logical id of this artifact -->
 <meta><!-- I 0..1 Meta Metadata about the resource --></meta>
 <implicitRules value="[uri]"/><!-- I 0..1 A set of rules under which this content was created -->
 <language value="[code]"/><!-- I 0..1 Language of the resource content   -->
 <text><!-- I 0..1 Narrative 
     Text summary of the resource, for human interpretation --></text>
 <contained><!-- 0..* Resource Contained, inline Resources --></contained>
 <modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored  --></modifierExtension>
 <url value="[uri]"/><!-- I 1..1 Canonical identifier for this concept map, represented as a URI (globally unique) -->
 <identifier><!-- I 0..* Identifier 
     Additional identifier for the concept map --></identifier>
 <version value="[string]"/><!-- I 1..1 Business version of the concept map -->
 <versionAlgorithm[x]><!-- I 0..1 string|Coding How to compare versions   --></versionAlgorithm[x]>
 <name value="[string]"/><!-- I 0..1 Name for this concept map (computer friendly) -->
 <title value="[string]"/><!-- I 1..1 Name for this concept map (human friendly) -->
 <status value="[code]"/><!-- I 1..1 draft | active | retired | unknown   -->
 <experimental value="[boolean]"/><!-- I 1..1 For testing purposes, not real usage -->
 <date value="[dateTime]"/><!-- I 0..1 Date last changed -->
 <publisher value="[string]"/><!-- I 0..1 Name of the publisher/steward (organization or individual) -->
 <contact><!-- I 0..* ContactDetail Contact details for the publisher --></contact>
 <description value="[markdown]"/><!-- I 1..1 Natural language description of the concept map -->
 <useContext><!-- I 0..* UsageContext 
     The context that the content is intended to support --></useContext>
 <jurisdiction><!-- I 0..* CodeableConcept Intended jurisdiction for concept map (if applicable)   --></jurisdiction>
 <purpose value="[markdown]"/><!-- I 0..1 Why this concept map is defined -->
 <copyright value="[markdown]"/><!-- I 0..1 Use and/or publishing restrictions -->
 <copyrightLabel value="[string]"/><!-- I 0..1 Copyright holder and year(s) -->
 <approvalDate value="[date]"/><!-- I 0..1 When the ConceptMap was approved by publisher -->
 <lastReviewDate value="[date]"/><!-- I 0..1 When the ConceptMap was last reviewed by the publisher -->
 <effectivePeriod><!-- I 0..1 Period 
     When the ConceptMap is expected to be used --></effectivePeriod>
 <topic><!-- I 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc   --></topic>
 <author><!-- I 0..* ContactDetail Who authored the ConceptMap --></author>
 <editor><!-- I 0..* ContactDetail Who edited the ConceptMap --></editor>
 <reviewer><!-- I 0..* ContactDetail Who reviewed the ConceptMap --></reviewer>
 <endorser><!-- I 0..* ContactDetail Who endorsed the ConceptMap --></endorser>
 <relatedArtifact><!-- I 0..* RelatedArtifact 
     Additional documentation, citations, etc --></relatedArtifact>
 <property> I 0..* BackboneElement  <!-- I 0..* Additional properties of the mapping -->
  <modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
  <code value="[code]"/><!-- I 1..1 
      Identifies the property on the mappings, and when referred to in the $translate operation -->
  <uri value="[uri]"/><!-- I 0..1 Formal identifier for the property -->
  <description value="[string]"/><!-- I 0..1 Why the property is defined, and/or what it conveys -->
  <type value="[code]"/><!-- I 1..1 Coding | string | integer | boolean | dateTime | decimal | code   -->
  <system value="[canonical]"/><!-- I 0..1 The CodeSystem from which code values come -->
 </property>
 <additionalAttribute> I 0..* BackboneElement  <!-- I 0..* Definition of an additional attribute to act as a data source or target -->
  <modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
  <code value="[code]"/><!-- I 1..1 Identifies this additional attribute through this resource -->
  <uri value="[uri]"/><!-- I 0..1 
      Formal identifier for the data element referred to in this attribte -->
  <description value="[string]"/><!-- I 0..1 
      Why the additional attribute is defined, and/or what the data element it refers to is -->
  <type value="[code]"/><!-- I 1..1 code | Coding | string | boolean | Quantity   -->
 </additionalAttribute>
 <sourceScope[x]><!-- I 0..1 uri|canonical 
     The source value set that contains the concepts that are being mapped --></sourceScope[x]>
 <targetScope[x]><!-- I 0..1 uri|canonical 
     The target value set which provides context for the mappings --></targetScope[x]>
 <group> I 0..* BackboneElement  <!-- I 0..* Same source and target systems -->
  <modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
  <source value="[canonical]"/><!-- I 0..1 Source system where concepts to be mapped are defined -->
  <target value="[canonical]"/><!-- I 0..1 Target system that the concepts are to be mapped to -->
  <element> I 1..* BackboneElement  <!-- I 1..* Mappings for a concept from the source set -->
   <modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
   <code value="[code]"/><!-- I 0..1 Identifies element being mapped -->
   <display value="[string]"/><!-- I 0..1 Display for the code -->
   <valueSet value="[canonical]"/><!-- I 0..1 Identifies the set of concepts being mapped -->
   <noMap value="[boolean]"/><!-- I 0..1 No mapping to a target concept for this source concept -->
   <target> I 0..* BackboneElement  <!-- I 0..* Concept in target system for element -->
    <modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
    <code value="[code]"/><!-- I 0..1 Code that identifies the target element -->
    <display value="[string]"/><!-- I 0..1 Display for the code -->
    <valueSet value="[canonical]"/><!-- I 0..1 Identifies the set of target concepts -->
    <relationship value="[code]"/><!-- I 1..1 related-to | equivalent | source-is-narrower-than-target | source-is-broader-than-target | not-related-to   -->
    <comment value="[string]"/><!-- I 0..1 Description of status/issues in mapping -->
    <property> I 0..* BackboneElement  <!-- I 0..* Property value for the source -> target mapping -->
     <modifierExtension><!-- I 0..* 
       Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
     <code value="[code]"/><!-- I 1..1 Reference to ConceptMap.property.code -->
     <value[x]><!-- I 1..1 Coding|string|
       integer|boolean|dateTime|decimal|code 
         Value of the property for this concept --></value[x]>
    </property>
    <dependsOn> I 0..* BackboneElement  <!-- I 0..* Other properties required for this mapping -->
     <modifierExtension><!-- I 0..* 
       Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
     <attribute value="[code]"/><!-- I 1..1 
         A reference to a mapping attribute defined in ConceptMap.additionalAttribute -->
     <value[x]><!-- I 0..1 code|Coding|
       string|boolean|Quantity 
         Value of the referenced data element --></value[x]>
     <valueSet value="[canonical]"/><!-- I 0..1 
         The mapping depends on a data element with a value from this value set -->
    </dependsOn>
    <product><!-- See http://hl7.org/fhir/StructureDefinition/ConceptMap#ConceptMap.group.element.target.dependsOn  Other data elements that this mapping also produces --></product>
   </target>
  </element>
  <unmapped> I 0..1 BackboneElement  <!-- I 0..1 What to do when there is no mapping target for the source concept and ConceptMap.group.element.noMap is not true -->
   <modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
   <mode value="[code]"/><!-- I 1..1 use-source-code | fixed | other-map   -->
   <code value="[code]"/><!-- I 0..1 Fixed code when mode = fixed -->
   <display value="[string]"/><!-- I 0..1 Display for the code -->
   <valueSet value="[canonical]"/><!-- I 0..1 Fixed code set when mode = fixed -->
   <relationship value="[code]"/><!-- I 0..1 related-to | equivalent | source-is-narrower-than-target | source-is-broader-than-target | not-related-to   -->
   <otherMap value="[canonical]"/><!-- I 0..1 
       canonical reference to an additional ConceptMap to use for mapping if the source concept is unmapped -->
  </unmapped>
 </group>
</ConceptMap>

{ // ShareableConceptMap
  // from Element: extension
    "meta" : { Meta }, // IMetadata about the resource
    "implicitRules" : "<uri>", // IA set of rules under which this content was created
    "language" : "<code>", // ILanguage of the resource content
    "text" : { Narrative }, // IText summary of the resource, for human interpretation
    "contained" : [{ Resource }], //Contained, inline Resources
    "extension" : [ //  sliced by value:url  in the specified order, Open 
      { // narrative | semi-structured | structured | executable // I
        // from Element: extension
      }
    ],
    "modifierExtension" : [{ Extension }], // IExtensions that cannot be ignored
    "url" : "<uri>", // I R! Canonical identifier for this concept map, represented as a URI (globally unique)
    "identifier" : [{ Identifier }], // IAdditional identifier for the concept map
    "version" : "<string>", // I R! Business version of the concept map
  // value[x]: How to compare versions. One of these 2:
    "versionAlgorithmString" : "<string>", // IHow to compare versions
    "versionAlgorithmCoding" : { Coding }, // IHow to compare versions
    "name" : "<string>", // IName for this concept map (computer friendly)
    "title" : "<string>", // I R! Name for this concept map (human friendly)
    "status" : "<code>", // I R! draft | active | retired | unknown
    "experimental" : <boolean>, // I R! For testing purposes, not real usage
    "date" : "<dateTime>", // IDate last changed
    "publisher" : "<string>", // IName of the publisher/steward (organization or individual)
    "contact" : [{ ContactDetail }], // IContact details for the publisher
    "description" : "<markdown>", // I R! Natural language description of the concept map
    "useContext" : [{ UsageContext }], // IThe context that the content is intended to support
    "jurisdiction" : [{ CodeableConcept }], // IIntended jurisdiction for concept map (if applicable)
    "purpose" : "<markdown>", // IWhy this concept map is defined
    "copyright" : "<markdown>", // IUse and/or publishing restrictions
    "copyrightLabel" : "<string>", // ICopyright holder and year(s)
    "approvalDate" : "<date>", // IWhen the ConceptMap was approved by publisher
    "lastReviewDate" : "<date>", // IWhen the ConceptMap was last reviewed by the publisher
    "effectivePeriod" : { Period }, // IWhen the ConceptMap is expected to be used
    "topic" : [{ CodeableConcept }], // IE.g. Education, Treatment, Assessment, etc
    "author" : [{ ContactDetail }], // IWho authored the ConceptMap
    "editor" : [{ ContactDetail }], // IWho edited the ConceptMap
    "reviewer" : [{ ContactDetail }], // IWho reviewed the ConceptMap
    "endorser" : [{ ContactDetail }], // IWho endorsed the ConceptMap
    "relatedArtifact" : [{ RelatedArtifact }], // IAdditional documentation, citations, etc
    "property" : [{ BackboneElement }], // IAdditional properties of the mapping
    "additionalAttribute" : [{ BackboneElement }], // IDefinition of an additional attribute to act as a data source or target
  // value[x]: The source value set that contains the concepts that are being mapped. One of these 2:
    "sourceScopeUri" : "<uri>", // IThe source value set that contains the concepts that are being mapped
    "sourceScopeCanonical" : "<canonical>", // IThe source value set that contains the concepts that are being mapped
  // value[x]: The target value set which provides context for the mappings. One of these 2:
    "targetScopeUri" : "<uri>", // IThe target value set which provides context for the mappings
    "targetScopeCanonical" : "<canonical>", // IThe target value set which provides context for the mappings
    "group" : [{ BackboneElement }], // ISame source and target systems
  }

This structure is derived from ConceptMap.

Summary

Mandatory: 5 elements
Must-Support: 10 elements

Extensions

This structure refers to these extensions:

Differential View

This indicates the differences between this profile and the base ConceptMap structure.

Name iconFlags iconCard. iconType iconDescription & Constraints icondoco icon
.. ConceptMap 1..1 ConceptMap A map from one set of concepts to one or more other concepts
... Slices for extension Content/Rules for all slices
.... knowledgeRepresentationLevel S 0..* code narrative | semi-structured | structured | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeRepresentationLevel
Binding: Knowledge Representation Level (required)
... url S 1..1 uri Canonical identifier for this concept map, represented as a URI (globally unique)
... version S 1..1 string Business version of the concept map
... versionAlgorithm[x] S 0..1 string, Coding How to compare versions
... name S 0..1 string Name for this concept map (computer friendly)
... title S 1..1 string Name for this concept map (human friendly)
... status S 1..1 code draft | active | retired | unknown
... experimental S 1..1 boolean For testing purposes, not real usage
... publisher S 0..1 string Name of the publisher/steward (organization or individual)
... description S 1..1 markdown Natural language description of the concept map

doco Documentation for this format icon

Snapshot View

This provides the consolidated view (aka snapshot) of the profile after applying the changes in this profile to the base ConceptMap structure.

Name iconFlags iconCard. iconType iconDescription & Constraints icondoco icon
.. ConceptMap C icon 1..1 ConceptMap A map from one set of concepts to one or more other concepts
cnl-0: Name should be usable as an identifier for the module by machine processing applications such as code generation
... 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
... language 0..1 code Language of the resource content
Binding: All Languages (required): IETF language tag for a human language

Additional BindingsPurpose
Common Languages Starter Set
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... knowledgeRepresentationLevel S 0..* code narrative | semi-structured | structured | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeRepresentationLevel
Binding: Knowledge Representation Level (required)
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... url SΣC icon 1..1 uri Canonical identifier for this concept map, represented as a URI (globally unique)
cnl-1: URL should not contain | or # - these characters make processing canonical references problematic
... identifier Σ 0..* Identifier Additional identifier for the concept map
... version SΣ 1..1 string Business version of the concept map
... versionAlgorithm[x] SΣ 0..1 How to compare versions
Binding: Version Algorithm (extensible)
.... versionAlgorithmString string
.... versionAlgorithmCoding Coding
... name SΣC icon 0..1 string Name for this concept map (computer friendly)
... title SΣ 1..1 string Name for this concept map (human friendly)
... status ?!SΣC icon 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... experimental SΣ 1..1 boolean For testing purposes, not real usage
... date Σ 0..1 dateTime Date last changed
... publisher SΣ 0..1 string Name of the publisher/steward (organization or individual)
... contact Σ 0..* ContactDetail Contact details for the publisher
... description S 1..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
... copyrightLabel 0..1 string Copyright holder and year(s)
... approvalDate 0..1 date When the ConceptMap was approved by publisher
... lastReviewDate 0..1 date When the ConceptMap was last reviewed by the publisher
... effectivePeriod Σ 0..1 Period When the ConceptMap is expected to be used
... topic 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc
Binding: Definition Topic (example)
... author 0..* ContactDetail Who authored the ConceptMap
... editor 0..* ContactDetail Who edited the ConceptMap
... reviewer 0..* ContactDetail Who reviewed the ConceptMap
... endorser 0..* ContactDetail Who endorsed the ConceptMap
... relatedArtifact 0..* RelatedArtifact Additional documentation, citations, etc
... property ΣC icon 0..* BackboneElement Additional properties of the mapping
cmd-11: If the property type is code, a system SHALL be specified
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... code Σ 1..1 code Identifies the property on the mappings, and when referred to in the $translate operation
.... uri Σ 0..1 uri Formal identifier for the property
.... description Σ 0..1 string Why the property is defined, and/or what it conveys
.... type ΣC icon 1..1 code Coding | string | integer | boolean | dateTime | decimal | code
Binding: ConceptMap Property Type (required): The type of a property value.

.... system ΣC icon 0..1 canonical(CodeSystem) The CodeSystem from which code values come
... additionalAttribute Σ 0..* BackboneElement Definition of an additional attribute to act as a data source or target
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... code Σ 1..1 code Identifies this additional attribute through this resource
.... uri Σ 0..1 uri Formal identifier for the data element referred to in this attribte
.... description Σ 0..1 string Why the additional attribute is defined, and/or what the data element it refers to is
.... type Σ 1..1 code code | Coding | string | boolean | Quantity
Binding: ConceptMap Attribute Type (required): The type of a mapping attribute value.

... sourceScope[x] Σ 0..1 The source value set that contains the concepts that are being mapped
.... sourceScopeUri uri
.... sourceScopeCanonical canonical(ValueSet)
... targetScope[x] Σ 0..1 The target value set which provides context for the mappings
.... targetScopeUri uri
.... targetScopeCanonical 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
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... source 0..1 canonical(CodeSystem) Source system where concepts to be mapped are defined
.... target 0..1 canonical(CodeSystem) Target system that the concepts are to be mapped to
.... element C icon 1..* BackboneElement Mappings for a concept from the source set
cmd-4: If noMap is present, target SHALL NOT be present
cmd-5: Either code or valueSet SHALL be present but not both.
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... code C icon 0..1 code Identifies element being mapped
..... display 0..1 string Display for the code
..... valueSet C icon 0..1 canonical(ValueSet) Identifies the set of concepts being mapped
..... noMap C icon 0..1 boolean No mapping to a target concept for this source concept
..... target C icon 0..* BackboneElement Concept in target system for element
cmd-1: If the map is source-is-broader-than-target or not-related-to, there SHALL be some comments, unless the status is 'draft'
cmd-7: Either code or valueSet SHALL be present but not both.
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... code C icon 0..1 code Code that identifies the target element
...... display 0..1 string Display for the code
...... valueSet C icon 0..1 canonical(ValueSet) Identifies the set of target concepts
...... relationship ?!C icon 1..1 code related-to | equivalent | source-is-narrower-than-target | source-is-broader-than-target | not-related-to
Binding: ConceptMapRelationship (required): The relationship between concepts.

...... comment C icon 0..1 string Description of status/issues in mapping
...... property 0..* BackboneElement Property value for the source -> target mapping
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... code 1..1 code Reference to ConceptMap.property.code
....... value[x] 1..1 Value of the property for this concept
........ valueCoding Coding
........ valueString string
........ valueInteger integer
........ valueBoolean boolean
........ valueDateTime dateTime
........ valueDecimal decimal
........ valueCode code
...... dependsOn C icon 0..* BackboneElement Other properties required for this mapping
cmd-6: One of value[x] or valueSet must exist, but not both.
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... attribute 1..1 code A reference to a mapping attribute defined in ConceptMap.additionalAttribute
....... value[x] C icon 0..1 Value of the referenced data element
........ valueCode code
........ valueCoding Coding
........ valueString string
........ valueBoolean boolean
........ valueQuantity Quantity
....... valueSet C icon 0..1 canonical(ValueSet) The mapping depends on a data element with a value from this value set
...... product 0..* See dependsOn (ConceptMap) Other data elements that this mapping also produces
.... unmapped C icon 0..1 BackboneElement What to do when there is no mapping target for the source concept and ConceptMap.group.element.noMap is not true
cmd-2: If the mode is 'fixed', either a code or valueSet must be provided, but not both.
cmd-3: If the mode is 'other-map', a url for the other map must be provided
cmd-8: If the mode is not 'fixed', code, display and valueSet are not allowed
cmd-9: If the mode is not 'other-map', relationship must be provided
cmd-10: If the mode is not 'other-map', otherMap is not allowed
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... mode C icon 1..1 code use-source-code | fixed | other-map
Binding: Concept Map Group Unmapped Mode (required): Defines which action to take if there is no match in the group.

..... code C icon 0..1 code Fixed code when mode = fixed
..... display C icon 0..1 string Display for the code
..... valueSet C icon 0..1 canonical(ValueSet) Fixed code set when mode = fixed
..... relationship ?!C icon 0..1 code related-to | equivalent | source-is-narrower-than-target | source-is-broader-than-target | not-related-to
Binding: ConceptMapRelationship (required): The default relationship value to apply between the source and target concepts when no concept mapping is specified.

..... otherMap C icon 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 icon

XML Template

<!-- ShareableConceptMap -->doco

<ConceptMap xmlns="http://hl7.org/fhir"
>
  <!-- from Element: extension -->
 <id value="[id]"/><!-- 0..1 Logical id of this artifact -->
 <meta><!-- I 0..1 Meta Metadata about the resource --></meta>
 <implicitRules value="[uri]"/><!-- I 0..1 A set of rules under which this content was created -->
 <language value="[code]"/><!-- I 0..1 Language of the resource content   -->
 <text><!-- I 0..1 Narrative 
     Text summary of the resource, for human interpretation --></text>
 <contained><!-- 0..* Resource Contained, inline Resources --></contained>
 <modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored  --></modifierExtension>
 <url value="[uri]"/><!-- I 1..1 Canonical identifier for this concept map, represented as a URI (globally unique) -->
 <identifier><!-- I 0..* Identifier 
     Additional identifier for the concept map --></identifier>
 <version value="[string]"/><!-- I 1..1 Business version of the concept map -->
 <versionAlgorithm[x]><!-- I 0..1 string|Coding How to compare versions   --></versionAlgorithm[x]>
 <name value="[string]"/><!-- I 0..1 Name for this concept map (computer friendly) -->
 <title value="[string]"/><!-- I 1..1 Name for this concept map (human friendly) -->
 <status value="[code]"/><!-- I 1..1 draft | active | retired | unknown   -->
 <experimental value="[boolean]"/><!-- I 1..1 For testing purposes, not real usage -->
 <date value="[dateTime]"/><!-- I 0..1 Date last changed -->
 <publisher value="[string]"/><!-- I 0..1 Name of the publisher/steward (organization or individual) -->
 <contact><!-- I 0..* ContactDetail Contact details for the publisher --></contact>
 <description value="[markdown]"/><!-- I 1..1 Natural language description of the concept map -->
 <useContext><!-- I 0..* UsageContext 
     The context that the content is intended to support --></useContext>
 <jurisdiction><!-- I 0..* CodeableConcept Intended jurisdiction for concept map (if applicable)   --></jurisdiction>
 <purpose value="[markdown]"/><!-- I 0..1 Why this concept map is defined -->
 <copyright value="[markdown]"/><!-- I 0..1 Use and/or publishing restrictions -->
 <copyrightLabel value="[string]"/><!-- I 0..1 Copyright holder and year(s) -->
 <approvalDate value="[date]"/><!-- I 0..1 When the ConceptMap was approved by publisher -->
 <lastReviewDate value="[date]"/><!-- I 0..1 When the ConceptMap was last reviewed by the publisher -->
 <effectivePeriod><!-- I 0..1 Period 
     When the ConceptMap is expected to be used --></effectivePeriod>
 <topic><!-- I 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc   --></topic>
 <author><!-- I 0..* ContactDetail Who authored the ConceptMap --></author>
 <editor><!-- I 0..* ContactDetail Who edited the ConceptMap --></editor>
 <reviewer><!-- I 0..* ContactDetail Who reviewed the ConceptMap --></reviewer>
 <endorser><!-- I 0..* ContactDetail Who endorsed the ConceptMap --></endorser>
 <relatedArtifact><!-- I 0..* RelatedArtifact 
     Additional documentation, citations, etc --></relatedArtifact>
 <property> I 0..* BackboneElement  <!-- I 0..* Additional properties of the mapping -->
  <modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
  <code value="[code]"/><!-- I 1..1 
      Identifies the property on the mappings, and when referred to in the $translate operation -->
  <uri value="[uri]"/><!-- I 0..1 Formal identifier for the property -->
  <description value="[string]"/><!-- I 0..1 Why the property is defined, and/or what it conveys -->
  <type value="[code]"/><!-- I 1..1 Coding | string | integer | boolean | dateTime | decimal | code   -->
  <system value="[canonical]"/><!-- I 0..1 The CodeSystem from which code values come -->
 </property>
 <additionalAttribute> I 0..* BackboneElement  <!-- I 0..* Definition of an additional attribute to act as a data source or target -->
  <modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
  <code value="[code]"/><!-- I 1..1 Identifies this additional attribute through this resource -->
  <uri value="[uri]"/><!-- I 0..1 
      Formal identifier for the data element referred to in this attribte -->
  <description value="[string]"/><!-- I 0..1 
      Why the additional attribute is defined, and/or what the data element it refers to is -->
  <type value="[code]"/><!-- I 1..1 code | Coding | string | boolean | Quantity   -->
 </additionalAttribute>
 <sourceScope[x]><!-- I 0..1 uri|canonical 
     The source value set that contains the concepts that are being mapped --></sourceScope[x]>
 <targetScope[x]><!-- I 0..1 uri|canonical 
     The target value set which provides context for the mappings --></targetScope[x]>
 <group> I 0..* BackboneElement  <!-- I 0..* Same source and target systems -->
  <modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
  <source value="[canonical]"/><!-- I 0..1 Source system where concepts to be mapped are defined -->
  <target value="[canonical]"/><!-- I 0..1 Target system that the concepts are to be mapped to -->
  <element> I 1..* BackboneElement  <!-- I 1..* Mappings for a concept from the source set -->
   <modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
   <code value="[code]"/><!-- I 0..1 Identifies element being mapped -->
   <display value="[string]"/><!-- I 0..1 Display for the code -->
   <valueSet value="[canonical]"/><!-- I 0..1 Identifies the set of concepts being mapped -->
   <noMap value="[boolean]"/><!-- I 0..1 No mapping to a target concept for this source concept -->
   <target> I 0..* BackboneElement  <!-- I 0..* Concept in target system for element -->
    <modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
    <code value="[code]"/><!-- I 0..1 Code that identifies the target element -->
    <display value="[string]"/><!-- I 0..1 Display for the code -->
    <valueSet value="[canonical]"/><!-- I 0..1 Identifies the set of target concepts -->
    <relationship value="[code]"/><!-- I 1..1 related-to | equivalent | source-is-narrower-than-target | source-is-broader-than-target | not-related-to   -->
    <comment value="[string]"/><!-- I 0..1 Description of status/issues in mapping -->
    <property> I 0..* BackboneElement  <!-- I 0..* Property value for the source -> target mapping -->
     <modifierExtension><!-- I 0..* 
       Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
     <code value="[code]"/><!-- I 1..1 Reference to ConceptMap.property.code -->
     <value[x]><!-- I 1..1 Coding|string|
       integer|boolean|dateTime|decimal|code 
         Value of the property for this concept --></value[x]>
    </property>
    <dependsOn> I 0..* BackboneElement  <!-- I 0..* Other properties required for this mapping -->
     <modifierExtension><!-- I 0..* 
       Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
     <attribute value="[code]"/><!-- I 1..1 
         A reference to a mapping attribute defined in ConceptMap.additionalAttribute -->
     <value[x]><!-- I 0..1 code|Coding|
       string|boolean|Quantity 
         Value of the referenced data element --></value[x]>
     <valueSet value="[canonical]"/><!-- I 0..1 
         The mapping depends on a data element with a value from this value set -->
    </dependsOn>
    <product><!-- See http://hl7.org/fhir/StructureDefinition/ConceptMap#ConceptMap.group.element.target.dependsOn  Other data elements that this mapping also produces --></product>
   </target>
  </element>
  <unmapped> I 0..1 BackboneElement  <!-- I 0..1 What to do when there is no mapping target for the source concept and ConceptMap.group.element.noMap is not true -->
   <modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
   <mode value="[code]"/><!-- I 1..1 use-source-code | fixed | other-map   -->
   <code value="[code]"/><!-- I 0..1 Fixed code when mode = fixed -->
   <display value="[string]"/><!-- I 0..1 Display for the code -->
   <valueSet value="[canonical]"/><!-- I 0..1 Fixed code set when mode = fixed -->
   <relationship value="[code]"/><!-- I 0..1 related-to | equivalent | source-is-narrower-than-target | source-is-broader-than-target | not-related-to   -->
   <otherMap value="[canonical]"/><!-- I 0..1 
       canonical reference to an additional ConceptMap to use for mapping if the source concept is unmapped -->
  </unmapped>
 </group>
</ConceptMap>

JSON Template

{ // ShareableConceptMap
  // from Element: extension
    "meta" : { Meta }, // IMetadata about the resource
    "implicitRules" : "<uri>", // IA set of rules under which this content was created
    "language" : "<code>", // ILanguage of the resource content
    "text" : { Narrative }, // IText summary of the resource, for human interpretation
    "contained" : [{ Resource }], //Contained, inline Resources
    "extension" : [ //  sliced by value:url  in the specified order, Open 
      { // narrative | semi-structured | structured | executable // I
        // from Element: extension
      }
    ],
    "modifierExtension" : [{ Extension }], // IExtensions that cannot be ignored
    "url" : "<uri>", // I R! Canonical identifier for this concept map, represented as a URI (globally unique)
    "identifier" : [{ Identifier }], // IAdditional identifier for the concept map
    "version" : "<string>", // I R! Business version of the concept map
  // value[x]: How to compare versions. One of these 2:
    "versionAlgorithmString" : "<string>", // IHow to compare versions
    "versionAlgorithmCoding" : { Coding }, // IHow to compare versions
    "name" : "<string>", // IName for this concept map (computer friendly)
    "title" : "<string>", // I R! Name for this concept map (human friendly)
    "status" : "<code>", // I R! draft | active | retired | unknown
    "experimental" : <boolean>, // I R! For testing purposes, not real usage
    "date" : "<dateTime>", // IDate last changed
    "publisher" : "<string>", // IName of the publisher/steward (organization or individual)
    "contact" : [{ ContactDetail }], // IContact details for the publisher
    "description" : "<markdown>", // I R! Natural language description of the concept map
    "useContext" : [{ UsageContext }], // IThe context that the content is intended to support
    "jurisdiction" : [{ CodeableConcept }], // IIntended jurisdiction for concept map (if applicable)
    "purpose" : "<markdown>", // IWhy this concept map is defined
    "copyright" : "<markdown>", // IUse and/or publishing restrictions
    "copyrightLabel" : "<string>", // ICopyright holder and year(s)
    "approvalDate" : "<date>", // IWhen the ConceptMap was approved by publisher
    "lastReviewDate" : "<date>", // IWhen the ConceptMap was last reviewed by the publisher
    "effectivePeriod" : { Period }, // IWhen the ConceptMap is expected to be used
    "topic" : [{ CodeableConcept }], // IE.g. Education, Treatment, Assessment, etc
    "author" : [{ ContactDetail }], // IWho authored the ConceptMap
    "editor" : [{ ContactDetail }], // IWho edited the ConceptMap
    "reviewer" : [{ ContactDetail }], // IWho reviewed the ConceptMap
    "endorser" : [{ ContactDetail }], // IWho endorsed the ConceptMap
    "relatedArtifact" : [{ RelatedArtifact }], // IAdditional documentation, citations, etc
    "property" : [{ BackboneElement }], // IAdditional properties of the mapping
    "additionalAttribute" : [{ BackboneElement }], // IDefinition of an additional attribute to act as a data source or target
  // value[x]: The source value set that contains the concepts that are being mapped. One of these 2:
    "sourceScopeUri" : "<uri>", // IThe source value set that contains the concepts that are being mapped
    "sourceScopeCanonical" : "<canonical>", // IThe source value set that contains the concepts that are being mapped
  // value[x]: The target value set which provides context for the mappings. One of these 2:
    "targetScopeUri" : "<uri>", // IThe target value set which provides context for the mappings
    "targetScopeCanonical" : "<canonical>", // IThe target value set which provides context for the mappings
    "group" : [{ BackboneElement }], // ISame source and target systems
  }

 

Alternate definitions: Master Definition (XML, JSON), Schematron

4.10.17.2.2 Terminology Bindings

Path Name Conformance ValueSet
ConceptMap.language All Languages required All Languages
ConceptMap.versionAlgorithm[x] Version Algorithm extensible Version Algorithm
ConceptMap.status PublicationStatus required PublicationStatus
ConceptMap.jurisdiction Jurisdiction ValueSet extensible Jurisdiction ValueSet
ConceptMap.topic Definition Topic example Definition Topic
ConceptMap.property.type ConceptMap Property Type required ConceptMap Property Type
ConceptMap.additionalAttribute.type ConceptMap Attribute Type required ConceptMap Attribute Type
ConceptMap.group.element.target.relationship ConceptMapRelationship required ConceptMapRelationship
ConceptMap.group.unmapped.mode Concept Map Group Unmapped Mode required Concept Map Group Unmapped Mode
ConceptMap.group.unmapped.relationship ConceptMapRelationship required ConceptMapRelationship
. .