Implementation Guide
25.0.0 - R4 APIs

Publish Box goes here

Resource Profile: AthenaConceptMap

Official URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition-athena-conceptmap-profile.html Version: 25.0.0
Active as of 2022-03-01 Computable Name: AthenaConceptMap

Defines constraints and extensions on the Binary resource as supported by Athena Products.

This ConceptMap profile is part of the set of resource profiles supported by the API Server used with the athenaPractice and athenaFlow products. It further describes read and search capabilities of these products. Note: The create and update operations are NOT supported for this resource.

Overview

A statement of relationships from one set of concepts to one or more other concepts - either code systems or data elements, or classes in class models.

Scope and Usage

This profile is used to define the content that will be returned by the API Server in response to requests to access ConceptMap resources. All elements listed in the differential profile view are Supported, which means that the API Server is capable of supplying these fields from the product database when they have been populated via the product or its APIs.

Source

The ConceptMap resource provides information about mappings used by the API Server to translate between athenaPractice and athenaFlow specific codes to standard codes used by HL7 FHIR Resources. The content is derived from an external file created during system installation.

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 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
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... url Σ 0..1 uri Canonical identifier for this concept map, represented as a URI (globally unique)
... version Σ 0..1 string Business version of the concept map
... name ΣC 0..1 string Name for this concept map (computer friendly)
... status ?!SΣ 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
... purpose 0..1 markdown Why this concept map is defined
... copyright 0..1 markdown Use and/or publishing restrictions
... source[x] Σ 0..1 uri The source value set that contains the concepts that are being mapped
... target[x] Σ 0..1 uri The target value set which provides context for the mappings
... group 0..* BackboneElement Same source and target systems
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... source 0..1 uri Source system where concepts to be mapped are defined
.... target 0..1 uri Target system that the concepts are to be mapped to
.... element S 1..* BackboneElement Mappings for a concept from the source set
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... code 0..1 code Identifies element being mapped
..... target C 0..* BackboneElement Concept in target system for element
Constraints: cmd-1
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... code 0..1 code Code that identifies the target element
...... equivalence ?!S 1..1 code relatedto | equivalent | equal | wider | subsumes | narrower | specializes | inexact | unmatched | disjoint
Binding: ConceptMapEquivalence (required): The degree of equivalence between concepts.
...... comment C 0..1 string Description of status/issues in mapping
...... dependsOn 0..* BackboneElement Other elements required for this mapping (from context)
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... property S 1..1 uri Reference to property mapping depends on
....... system 0..1 canonical(CodeSystem) Code System (if necessary)
....... value S 1..1 string Value of the referenced element
...... product 0..* See dependsOn (ConceptMap) Other concepts that this mapping also produces

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
ConceptMap.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|4.0.1
From the FHIR Standard
ConceptMap.group.element.target.equivalencerequiredConceptMapEquivalence
http://hl7.org/fhir/ValueSet/concept-map-equivalence|4.0.1
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
cmd-0warningConceptMapName should be usable as an identifier for the module by machine processing applications such as code generation
: name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
cmd-1errorConceptMap.group.element.targetIf the map is narrower or inexact, there SHALL be some comments
: comment.exists() or equivalence.empty() or ((equivalence != 'narrower') and (equivalence != 'inexact'))
dom-2errorConceptMapIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorConceptMapIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorConceptMapIf 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-5errorConceptMapIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceConceptMapA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust 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 A map from one set of concepts to one or more other concepts
... 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
... status S 1..1 code draft | active | retired | unknown
... 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
... purpose 0..1 markdown Why this concept map is defined
... copyright 0..1 markdown Use and/or publishing restrictions
... source[x] 0..1 uri The source value set that contains the concepts that are being mapped
... target[x] 0..1 uri The target value set which provides context for the mappings
... group 0..* BackboneElement Same source and target systems
.... source 0..1 uri Source system where concepts to be mapped are defined
.... target 0..1 uri Target system that the concepts are to be mapped to
.... element S 1..* BackboneElement Mappings for a concept from the source set
..... code 0..1 code Identifies element being mapped
..... target 0..* BackboneElement Concept in target system for element
...... code 0..1 code Code that identifies the target element
...... equivalence S 1..1 code relatedto | equivalent | equal | wider | subsumes | narrower | specializes | inexact | unmatched | disjoint
...... comment 0..1 string Description of status/issues in mapping
...... dependsOn 0..* BackboneElement Other elements required for this mapping (from context)
....... property S 1..1 uri Reference to property mapping depends on
....... system 0..1 canonical(CodeSystem) Code System (if necessary)
....... value S 1..1 string Value of the referenced element
...... product 0..* See dependsOn (ConceptMap) Other concepts that this mapping also produces

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ConceptMap C 0..* ConceptMap 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
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... 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 ΣC 0..1 string Name for this concept map (computer friendly)
... title Σ 0..1 string Name for this concept map (human friendly)
... status ?!SΣ 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 uri The source value set that contains the concepts that are being mapped
... target[x] Σ 0..1 uri The target value set which provides context for the mappings
... 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 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 S 1..* BackboneElement Mappings for a concept from the source set
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... code 0..1 code Identifies element being mapped
..... display 0..1 string Display for the code
..... target C 0..* BackboneElement Concept in target system for element
Constraints: cmd-1
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... code 0..1 code Code that identifies the target element
...... display 0..1 string Display for the code
...... equivalence ?!S 1..1 code relatedto | equivalent | equal | wider | subsumes | narrower | specializes | inexact | unmatched | disjoint
Binding: ConceptMapEquivalence (required): The degree of equivalence between concepts.
...... comment C 0..1 string Description of status/issues in mapping
...... dependsOn 0..* BackboneElement Other elements required for this mapping (from context)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... property S 1..1 uri Reference to property mapping depends on
....... system 0..1 canonical(CodeSystem) Code System (if necessary)
....... value S 1..1 string Value of the referenced element
....... display 0..1 string Display for the code (if value is a code)
...... product 0..* See dependsOn (ConceptMap) Other concepts that this mapping also produces
.... unmapped C 0..1 BackboneElement What to do when there is no mapping for the source concept
Constraints: cmd-2, cmd-3
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... 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

PathConformanceValueSetURI
ConceptMap.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
ConceptMap.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|4.0.1
From the FHIR Standard
ConceptMap.jurisdictionextensibleJurisdiction ValueSet
http://hl7.org/fhir/ValueSet/jurisdiction
From the FHIR Standard
ConceptMap.group.element.target.equivalencerequiredConceptMapEquivalence
http://hl7.org/fhir/ValueSet/concept-map-equivalence|4.0.1
From the FHIR Standard
ConceptMap.group.unmapped.moderequiredConceptMapGroupUnmappedMode
http://hl7.org/fhir/ValueSet/conceptmap-unmapped-mode|4.0.1
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
cmd-0warningConceptMapName should be usable as an identifier for the module by machine processing applications such as code generation
: name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
cmd-1errorConceptMap.group.element.targetIf the map is narrower or inexact, there SHALL be some comments
: comment.exists() or equivalence.empty() or ((equivalence != 'narrower') and (equivalence != 'inexact'))
cmd-2errorConceptMap.group.unmappedIf the mode is 'fixed', a code must be provided
: (mode = 'fixed') implies code.exists()
cmd-3errorConceptMap.group.unmappedIf the mode is 'other-map', a url must be provided
: (mode = 'other-map') implies url.exists()
dom-2errorConceptMapIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorConceptMapIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorConceptMapIf 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-5errorConceptMapIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceConceptMapA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from ConceptMap

Summary

Mandatory: 1 element(4 nested mandatory elements)
Must-Support: 5 elements

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ConceptMap C 0..* ConceptMap 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
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... url Σ 0..1 uri Canonical identifier for this concept map, represented as a URI (globally unique)
... version Σ 0..1 string Business version of the concept map
... name ΣC 0..1 string Name for this concept map (computer friendly)
... status ?!SΣ 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
... purpose 0..1 markdown Why this concept map is defined
... copyright 0..1 markdown Use and/or publishing restrictions
... source[x] Σ 0..1 uri The source value set that contains the concepts that are being mapped
... target[x] Σ 0..1 uri The target value set which provides context for the mappings
... group 0..* BackboneElement Same source and target systems
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... source 0..1 uri Source system where concepts to be mapped are defined
.... target 0..1 uri Target system that the concepts are to be mapped to
.... element S 1..* BackboneElement Mappings for a concept from the source set
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... code 0..1 code Identifies element being mapped
..... target C 0..* BackboneElement Concept in target system for element
Constraints: cmd-1
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... code 0..1 code Code that identifies the target element
...... equivalence ?!S 1..1 code relatedto | equivalent | equal | wider | subsumes | narrower | specializes | inexact | unmatched | disjoint
Binding: ConceptMapEquivalence (required): The degree of equivalence between concepts.
...... comment C 0..1 string Description of status/issues in mapping
...... dependsOn 0..* BackboneElement Other elements required for this mapping (from context)
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... property S 1..1 uri Reference to property mapping depends on
....... system 0..1 canonical(CodeSystem) Code System (if necessary)
....... value S 1..1 string Value of the referenced element
...... product 0..* See dependsOn (ConceptMap) Other concepts that this mapping also produces

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
ConceptMap.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|4.0.1
From the FHIR Standard
ConceptMap.group.element.target.equivalencerequiredConceptMapEquivalence
http://hl7.org/fhir/ValueSet/concept-map-equivalence|4.0.1
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
cmd-0warningConceptMapName should be usable as an identifier for the module by machine processing applications such as code generation
: name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
cmd-1errorConceptMap.group.element.targetIf the map is narrower or inexact, there SHALL be some comments
: comment.exists() or equivalence.empty() or ((equivalence != 'narrower') and (equivalence != 'inexact'))
dom-2errorConceptMapIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorConceptMapIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorConceptMapIf 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-5errorConceptMapIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceConceptMapA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust 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 A map from one set of concepts to one or more other concepts
... 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
... status S 1..1 code draft | active | retired | unknown
... 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
... purpose 0..1 markdown Why this concept map is defined
... copyright 0..1 markdown Use and/or publishing restrictions
... source[x] 0..1 uri The source value set that contains the concepts that are being mapped
... target[x] 0..1 uri The target value set which provides context for the mappings
... group 0..* BackboneElement Same source and target systems
.... source 0..1 uri Source system where concepts to be mapped are defined
.... target 0..1 uri Target system that the concepts are to be mapped to
.... element S 1..* BackboneElement Mappings for a concept from the source set
..... code 0..1 code Identifies element being mapped
..... target 0..* BackboneElement Concept in target system for element
...... code 0..1 code Code that identifies the target element
...... equivalence S 1..1 code relatedto | equivalent | equal | wider | subsumes | narrower | specializes | inexact | unmatched | disjoint
...... comment 0..1 string Description of status/issues in mapping
...... dependsOn 0..* BackboneElement Other elements required for this mapping (from context)
....... property S 1..1 uri Reference to property mapping depends on
....... system 0..1 canonical(CodeSystem) Code System (if necessary)
....... value S 1..1 string Value of the referenced element
...... product 0..* See dependsOn (ConceptMap) Other concepts that this mapping also produces

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ConceptMap C 0..* ConceptMap 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
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... 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 ΣC 0..1 string Name for this concept map (computer friendly)
... title Σ 0..1 string Name for this concept map (human friendly)
... status ?!SΣ 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 uri The source value set that contains the concepts that are being mapped
... target[x] Σ 0..1 uri The target value set which provides context for the mappings
... 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 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 S 1..* BackboneElement Mappings for a concept from the source set
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... code 0..1 code Identifies element being mapped
..... display 0..1 string Display for the code
..... target C 0..* BackboneElement Concept in target system for element
Constraints: cmd-1
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... code 0..1 code Code that identifies the target element
...... display 0..1 string Display for the code
...... equivalence ?!S 1..1 code relatedto | equivalent | equal | wider | subsumes | narrower | specializes | inexact | unmatched | disjoint
Binding: ConceptMapEquivalence (required): The degree of equivalence between concepts.
...... comment C 0..1 string Description of status/issues in mapping
...... dependsOn 0..* BackboneElement Other elements required for this mapping (from context)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... property S 1..1 uri Reference to property mapping depends on
....... system 0..1 canonical(CodeSystem) Code System (if necessary)
....... value S 1..1 string Value of the referenced element
....... display 0..1 string Display for the code (if value is a code)
...... product 0..* See dependsOn (ConceptMap) Other concepts that this mapping also produces
.... unmapped C 0..1 BackboneElement What to do when there is no mapping for the source concept
Constraints: cmd-2, cmd-3
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... 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

PathConformanceValueSetURI
ConceptMap.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
ConceptMap.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|4.0.1
From the FHIR Standard
ConceptMap.jurisdictionextensibleJurisdiction ValueSet
http://hl7.org/fhir/ValueSet/jurisdiction
From the FHIR Standard
ConceptMap.group.element.target.equivalencerequiredConceptMapEquivalence
http://hl7.org/fhir/ValueSet/concept-map-equivalence|4.0.1
From the FHIR Standard
ConceptMap.group.unmapped.moderequiredConceptMapGroupUnmappedMode
http://hl7.org/fhir/ValueSet/conceptmap-unmapped-mode|4.0.1
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
cmd-0warningConceptMapName should be usable as an identifier for the module by machine processing applications such as code generation
: name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
cmd-1errorConceptMap.group.element.targetIf the map is narrower or inexact, there SHALL be some comments
: comment.exists() or equivalence.empty() or ((equivalence != 'narrower') and (equivalence != 'inexact'))
cmd-2errorConceptMap.group.unmappedIf the mode is 'fixed', a code must be provided
: (mode = 'fixed') implies code.exists()
cmd-3errorConceptMap.group.unmappedIf the mode is 'other-map', a url must be provided
: (mode = 'other-map') implies url.exists()
dom-2errorConceptMapIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorConceptMapIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorConceptMapIf 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-5errorConceptMapIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceConceptMapA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from ConceptMap

Summary

Mandatory: 1 element(4 nested mandatory elements)
Must-Support: 5 elements

 

Other representations of profile: CSV, Excel, Schematron

Notes:

Supported Interactions

The Interactions supported by this resource are listed below.

Search Parameters

Search parameters are executed as specified in the HL7 FHIR RESTful API implementation definition. To search for Organization resources, an application shall perform an HTTP GET, specifying the query parameters associated with the resource.

ConceptMap resources can be enumerated by retrieving the fhir/List resource with an id of ConceptMap

GET [base]/fhir/R4/List/ConceptMap?{_format=[json|xml]&_summary=[true|text|data]}

Where:

Name Description
[base] Specifies the base URL of the FHIR Server, e.g., https://cpsapisandbox.virenceaz.com:9443/demoAPIServer
[_format] Specifies the format of the output and may be xml or json. When present, the _format value overrides the value of the Accept header in the request.
[_summary] Filters the output to include only narrative elements (_summary=text), summary elements (_summary=true) or to omit the generated narrative (_summary=data). Note: If the generated html narrative for the resource is not going to be used by the call, using _summary=data provides improved API response times, especially when returning larger result sets.

HTTP Response Codes

The following HTTP response codes are returned by this API call:

200 OK The query was performed and any results found are contained within the body of the HTTP response. Note: The search API will return 200 OK when the query itself is successful, regardless of whether or not any matching results were found.
401 Unauthorized Authorization is required for this request, and either the Authorization header is missing or the supplied user credentials in the Authorization header are not valid or have expired. The body of the HTTP response will contain an OperationOutcome resource that indicates that Authorization is required.
500 Server Error The server may return other error codes to indicate other error conditions. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error.

Other Operations

The following additional operation is available.
$translate

Translate a code from one value set to another, based on the existing value set and concept maps resources.

See $translate OperationDefinition for more detail.