Snapshot 3: Connectathon 32 Base

This page is part of the FHIR Specification (v5.0.0-snapshot3: R5 Snapshot #3, to support Connectathon 32). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

4.10.19.7 StructureDefinition: PublishableConceptMap

Vocabulary icon Work Group Maturity Level: 0Trial Use Use Context: Any

The canonical URL for this profile is: 

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

Defines and enforces the minimum expectations for publication and distribution of a concept map, typically as part of an artifact repository or implementation guide publication

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

4.10.19.7.1 Formal Views of Profile Content

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

This structure is derived from ShareableConceptMap.

Summary

Mandatory: 1 element
Must-Support: 9 elements

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

Name iconFlags iconCard. iconType iconDescription & Constraints icondoco icon
.. ConceptMap 1..1ShareableConceptMapA map from one set of concepts to one or more other concepts
... identifier S0..*IdentifierAdditional identifier for the concept map
... date S1..1dateTimeDate last changed
... contact S0..*ContactDetailContact details for the publisher
... jurisdiction S0..*CodeableConceptIntended jurisdiction for concept map (if applicable)
... purpose S0..1markdownWhy this concept map is defined
... copyright S0..1markdownUse and/or publishing restrictions
... approvalDate 0..1dateWhen the ConceptMap was approved by publisher
... lastReviewDate 0..1dateWhen the ConceptMap was last reviewed
... effectivePeriod S0..1PeriodWhen the ConceptMap is expected to be used
... topic S0..*CodeableConceptE.g. Education, Treatment, Assessment, etc.
... author 0..*ContactDetailWho authored the ConceptMap
... editor 0..*ContactDetailWho edited the ConceptMap
... reviewer 0..*ContactDetailWho reviewed the ConceptMap
... endorser 0..*ContactDetailWho endorsed the ConceptMap
... relatedArtifact 0..*RelatedArtifactAdditional documentation, citations, etc.

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 ShareableConceptMap structure.

Name iconFlags iconCard. iconType iconDescription & Constraints icondoco icon
.. ConceptMap C icon1..1ShareableConceptMapA map from one set of concepts to one or more other concepts
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (preferred): IETF language tag

Additional BindingsPurpose
All LanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... knowledgeRepresentationLevel S0..*codenarrative | semi-structured | structured | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeRepresentationLevel
Binding: Knowledge Representation Level (required)
... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
... url SΣC icon1..1uriCanonical identifier for this concept map, represented as a URI (globally unique)
... identifier SΣ0..*IdentifierAdditional identifier for the concept map
... version SΣ1..1stringBusiness version of the concept map
... name SΣC icon0..1stringName for this concept map (computer friendly)
... title SΣ1..1stringName for this concept map (human friendly)
... status ?!SΣ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... experimental SΣ1..1booleanFor testing purposes, not real usage
... date SΣ1..1dateTimeDate last changed
... publisher SΣ0..1stringName of the publisher/steward (organization or individual)
... contact SΣ0..*ContactDetailContact details for the publisher
... description S1..1markdownNatural language description of the concept map
... useContext SΣ0..*UsageContextThe context that the content is intended to support
... jurisdiction SΣ0..*CodeableConceptIntended jurisdiction for concept map (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.


... purpose S0..1markdownWhy this concept map is defined
... copyright S0..1markdownUse and/or publishing restrictions
... approvalDate 0..1dateWhen the ConceptMap was approved by publisher
... lastReviewDate 0..1dateWhen the ConceptMap was last reviewed
... effectivePeriod SΣ0..1PeriodWhen the ConceptMap is expected to be used
... topic S0..*CodeableConceptE.g. Education, Treatment, Assessment, etc.
Binding: DefinitionTopic (example)
... author 0..*ContactDetailWho authored the ConceptMap
... editor 0..*ContactDetailWho edited the ConceptMap
... reviewer 0..*ContactDetailWho reviewed the ConceptMap
... endorser 0..*ContactDetailWho endorsed the ConceptMap
... relatedArtifact 0..*RelatedArtifactAdditional documentation, citations, etc.
... sourceScope[x] Σ0..1The source value set that contains the concepts that are being mapped
.... sourceScopeUriuri
.... sourceScopeCanonicalcanonical(ValueSet)
... targetScope[x] Σ0..1The target value set which provides context for the mappings
.... targetScopeUriuri
.... targetScopeCanonicalcanonical(ValueSet)
... group 0..*BackboneElementSame source and target systems
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... source 0..1canonical(CodeSystem)Source system where concepts to be mapped are defined
.... target 0..1canonical(CodeSystem)Target system that the concepts are to be mapped to
.... element C icon1..*BackboneElementMappings for a concept from the source set
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code 0..1codeIdentifies element being mapped
..... display 0..1stringDisplay for the code
..... valueSet 0..1canonical(ValueSet)Identifies elements being mapped
..... noMap 0..1booleanNo mapping to a target concept for this source concept
..... target C icon0..*BackboneElementConcept in target system for element
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... code 0..1codeCode that identifies the target element
...... display 0..1stringDisplay for the code
...... valueSet 0..1canonical(ValueSet)Identifies the set of target elements
...... relationship ?!1..1coderelated-to | equivalent | source-is-narrower-than-target | source-is-broader-than-target | not-related-to
Binding: ConceptMapRelationship (required): The relationship between concepts.

...... comment C icon0..1stringDescription of status/issues in mapping
...... dependsOn C icon0..*BackboneElementOther properties required for this mapping
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... property 1..1uriA reference to a property that may be required to refine the mapping
....... value[x] 0..1Value of the referenced property
........ valueCodecode
........ valueCodingCoding
........ valueStringstring
........ valueIntegerinteger
........ valueBooleanboolean
........ valueDateTimedateTime
........ valueDecimaldecimal
........ valueUriuri
........ valueIdid
....... valueSet 0..1canonical(ValueSet)The mapping depends on a property with a value from this value set
...... product 0..*See dependsOn (ConceptMap)Other properties that this mapping also produces
.... unmapped C icon0..1BackboneElementWhat to do when there is no mapping target for the source concept
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... mode 1..1codeuse-source-code | fixed | other-map
Binding: ConceptMapGroupUnmappedMode (required): Defines which action to take if there is no match in the group.

..... code 0..1codeFixed code when mode = fixed
..... display 0..1stringDisplay for the code
..... valueSet 0..1canonical(ValueSet)Fixed code set when mode = fixed
..... relationship ?!0..1coderelated-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 0..1canonical(ConceptMap)canonical reference to an additional ConceptMap to use for mapping if the source concept is unmapped

doco Documentation for this format icon
<!-- PublishableConceptMap -->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 -->
 <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 1..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 -->
 <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 -->
 <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>
 <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 elements 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 elements -->
    <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 -->
    <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>
     <property value="[uri]"/><!-- I 1..1 
         A reference to a property that may be required to refine the mapping -->
     <value[x]><!-- I 0..1 code|Coding|
       string|integer|boolean|dateTime|decimal|uri|id 
         Value of the referenced property --></value[x]>
     <valueSet value="[canonical]"/><!-- I 0..1 
         The mapping depends on a property with a value from this value set -->
    </dependsOn>
    <product><!-- See http://hl7.org/fhir/StructureDefinition/ConceptMap#ConceptMap.group.element.target.dependsOn  Other properties 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 -->
   <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>

{ // PublishableConceptMap
  // 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
    "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>", // I R! Date 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
    "approvalDate" : "<date>", // IWhen the ConceptMap was approved by publisher
    "lastReviewDate" : "<date>", // IWhen the ConceptMap was last reviewed
    "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.
  // 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 ShareableConceptMap.

Summary

Mandatory: 1 element
Must-Support: 9 elements

Differential View

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

Name iconFlags iconCard. iconType iconDescription & Constraints icondoco icon
.. ConceptMap 1..1ShareableConceptMapA map from one set of concepts to one or more other concepts
... identifier S0..*IdentifierAdditional identifier for the concept map
... date S1..1dateTimeDate last changed
... contact S0..*ContactDetailContact details for the publisher
... jurisdiction S0..*CodeableConceptIntended jurisdiction for concept map (if applicable)
... purpose S0..1markdownWhy this concept map is defined
... copyright S0..1markdownUse and/or publishing restrictions
... approvalDate 0..1dateWhen the ConceptMap was approved by publisher
... lastReviewDate 0..1dateWhen the ConceptMap was last reviewed
... effectivePeriod S0..1PeriodWhen the ConceptMap is expected to be used
... topic S0..*CodeableConceptE.g. Education, Treatment, Assessment, etc.
... author 0..*ContactDetailWho authored the ConceptMap
... editor 0..*ContactDetailWho edited the ConceptMap
... reviewer 0..*ContactDetailWho reviewed the ConceptMap
... endorser 0..*ContactDetailWho endorsed the ConceptMap
... relatedArtifact 0..*RelatedArtifactAdditional documentation, citations, etc.

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 ShareableConceptMap structure.

Name iconFlags iconCard. iconType iconDescription & Constraints icondoco icon
.. ConceptMap C icon1..1ShareableConceptMapA map from one set of concepts to one or more other concepts
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (preferred): IETF language tag

Additional BindingsPurpose
All LanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... knowledgeRepresentationLevel S0..*codenarrative | semi-structured | structured | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeRepresentationLevel
Binding: Knowledge Representation Level (required)
... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
... url SΣC icon1..1uriCanonical identifier for this concept map, represented as a URI (globally unique)
... identifier SΣ0..*IdentifierAdditional identifier for the concept map
... version SΣ1..1stringBusiness version of the concept map
... name SΣC icon0..1stringName for this concept map (computer friendly)
... title SΣ1..1stringName for this concept map (human friendly)
... status ?!SΣ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... experimental SΣ1..1booleanFor testing purposes, not real usage
... date SΣ1..1dateTimeDate last changed
... publisher SΣ0..1stringName of the publisher/steward (organization or individual)
... contact SΣ0..*ContactDetailContact details for the publisher
... description S1..1markdownNatural language description of the concept map
... useContext SΣ0..*UsageContextThe context that the content is intended to support
... jurisdiction SΣ0..*CodeableConceptIntended jurisdiction for concept map (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.


... purpose S0..1markdownWhy this concept map is defined
... copyright S0..1markdownUse and/or publishing restrictions
... approvalDate 0..1dateWhen the ConceptMap was approved by publisher
... lastReviewDate 0..1dateWhen the ConceptMap was last reviewed
... effectivePeriod SΣ0..1PeriodWhen the ConceptMap is expected to be used
... topic S0..*CodeableConceptE.g. Education, Treatment, Assessment, etc.
Binding: DefinitionTopic (example)
... author 0..*ContactDetailWho authored the ConceptMap
... editor 0..*ContactDetailWho edited the ConceptMap
... reviewer 0..*ContactDetailWho reviewed the ConceptMap
... endorser 0..*ContactDetailWho endorsed the ConceptMap
... relatedArtifact 0..*RelatedArtifactAdditional documentation, citations, etc.
... sourceScope[x] Σ0..1The source value set that contains the concepts that are being mapped
.... sourceScopeUriuri
.... sourceScopeCanonicalcanonical(ValueSet)
... targetScope[x] Σ0..1The target value set which provides context for the mappings
.... targetScopeUriuri
.... targetScopeCanonicalcanonical(ValueSet)
... group 0..*BackboneElementSame source and target systems
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... source 0..1canonical(CodeSystem)Source system where concepts to be mapped are defined
.... target 0..1canonical(CodeSystem)Target system that the concepts are to be mapped to
.... element C icon1..*BackboneElementMappings for a concept from the source set
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code 0..1codeIdentifies element being mapped
..... display 0..1stringDisplay for the code
..... valueSet 0..1canonical(ValueSet)Identifies elements being mapped
..... noMap 0..1booleanNo mapping to a target concept for this source concept
..... target C icon0..*BackboneElementConcept in target system for element
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... code 0..1codeCode that identifies the target element
...... display 0..1stringDisplay for the code
...... valueSet 0..1canonical(ValueSet)Identifies the set of target elements
...... relationship ?!1..1coderelated-to | equivalent | source-is-narrower-than-target | source-is-broader-than-target | not-related-to
Binding: ConceptMapRelationship (required): The relationship between concepts.

...... comment C icon0..1stringDescription of status/issues in mapping
...... dependsOn C icon0..*BackboneElementOther properties required for this mapping
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... property 1..1uriA reference to a property that may be required to refine the mapping
....... value[x] 0..1Value of the referenced property
........ valueCodecode
........ valueCodingCoding
........ valueStringstring
........ valueIntegerinteger
........ valueBooleanboolean
........ valueDateTimedateTime
........ valueDecimaldecimal
........ valueUriuri
........ valueIdid
....... valueSet 0..1canonical(ValueSet)The mapping depends on a property with a value from this value set
...... product 0..*See dependsOn (ConceptMap)Other properties that this mapping also produces
.... unmapped C icon0..1BackboneElementWhat to do when there is no mapping target for the source concept
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... mode 1..1codeuse-source-code | fixed | other-map
Binding: ConceptMapGroupUnmappedMode (required): Defines which action to take if there is no match in the group.

..... code 0..1codeFixed code when mode = fixed
..... display 0..1stringDisplay for the code
..... valueSet 0..1canonical(ValueSet)Fixed code set when mode = fixed
..... relationship ?!0..1coderelated-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 0..1canonical(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

<!-- PublishableConceptMap -->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 -->
 <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 1..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 -->
 <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 -->
 <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>
 <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 elements 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 elements -->
    <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 -->
    <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>
     <property value="[uri]"/><!-- I 1..1 
         A reference to a property that may be required to refine the mapping -->
     <value[x]><!-- I 0..1 code|Coding|
       string|integer|boolean|dateTime|decimal|uri|id 
         Value of the referenced property --></value[x]>
     <valueSet value="[canonical]"/><!-- I 0..1 
         The mapping depends on a property with a value from this value set -->
    </dependsOn>
    <product><!-- See http://hl7.org/fhir/StructureDefinition/ConceptMap#ConceptMap.group.element.target.dependsOn  Other properties 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 -->
   <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

{ // PublishableConceptMap
  // 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
    "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>", // I R! Date 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
    "approvalDate" : "<date>", // IWhen the ConceptMap was approved by publisher
    "lastReviewDate" : "<date>", // IWhen the ConceptMap was last reviewed
    "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.
  // 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.19.7.2 Terminology Bindings

PathNameConformanceValueSet
ConceptMap.languageCommon LanguagespreferredCommon Languages
ConceptMap.statusPublicationStatusrequiredPublicationStatus
ConceptMap.jurisdictionJurisdiction ValueSetextensibleJurisdiction ValueSet
ConceptMap.topicDefinitionTopicexampleDefinitionTopic
ConceptMap.group.element.target.relationshipConceptMapRelationshiprequiredConceptMapRelationship
ConceptMap.group.unmapped.modeConceptMapGroupUnmappedModerequiredConceptMapGroupUnmappedMode
ConceptMap.group.unmapped.relationshipConceptMapRelationshiprequiredConceptMapRelationship
.