HL7 Terminology (THO)
6.1.0 - Continuous Process Integration (ci build) International flag

HL7 Terminology (THO) - Local Development build (v6.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: Publishable ConceptMap

Official URL: http://terminology.hl7.org/StructureDefinition/publishableconceptmap Version: 1.0.0
Standards status: Trial-use Maturity Level: 1 Responsible: HL7 International / Terminology Infrastructure Computable Name: 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

Usage:

  • This Resource Profile is not used by any profiles in this Implementation Guide

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. ConceptMap C 1..1 ShareableConceptMap 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
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... contained 0..* Resource Contained, inline Resources
... 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: KnowledgeRepresentationLevel (required)
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... url SΣC 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
ele-1: All FHIR elements must have a @value or children
... identifier SΣ 0..* Identifier Additional identifier for the concept map
ele-1: All FHIR elements must have a @value or children
... version SΣ 1..1 string Business version of the concept map
ele-1: All FHIR elements must have a @value or children
... versionAlgorithm[x] SΣ 0..1 How to compare versions
Binding: VersionAlgorithm (extensible)
ele-1: All FHIR elements must have a @value or children
.... versionAlgorithmString string
.... versionAlgorithmCoding Coding
... name SΣC 0..1 string Name for this concept map (computer friendly)
ele-1: All FHIR elements must have a @value or children
... title SΣ 1..1 string Name for this concept map (human friendly)
ele-1: All FHIR elements must have a @value or children
... status ?!SΣC 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.


ele-1: All FHIR elements must have a @value or children
... experimental SΣ 1..1 boolean For testing purposes, not real usage
ele-1: All FHIR elements must have a @value or children
... date SΣ 1..1 dateTime Date last changed
ele-1: All FHIR elements must have a @value or children
... publisher SΣ 0..1 string Name of the publisher/steward (organization or individual)
ele-1: All FHIR elements must have a @value or children
... contact SΣ 0..* ContactDetail Contact details for the publisher
ele-1: All FHIR elements must have a @value or children
... description S 1..1 markdown Natural language description of the concept map
ele-1: All FHIR elements must have a @value or children
... useContext SΣ 0..* UsageContext The context that the content is intended to support
ele-1: All FHIR elements must have a @value or children
... jurisdiction SΣ 0..* CodeableConcept Intended jurisdiction for concept map (if applicable)
Binding: JurisdictionValueSet (extensible): Countries and regions within which this artifact is targeted for use.


ele-1: All FHIR elements must have a @value or children
... purpose S 0..1 markdown Why this concept map is defined
ele-1: All FHIR elements must have a @value or children
... copyright S 0..1 markdown Use and/or publishing restrictions
ele-1: All FHIR elements must have a @value or children
... copyrightLabel S 0..1 string Copyright holder and year(s)
ele-1: All FHIR elements must have a @value or children
... approvalDate 0..1 date When the ConceptMap was approved by publisher
ele-1: All FHIR elements must have a @value or children
... lastReviewDate 0..1 date When the ConceptMap was last reviewed by the publisher
ele-1: All FHIR elements must have a @value or children
... effectivePeriod SΣ 0..1 Period When the ConceptMap is expected to be used
ele-1: All FHIR elements must have a @value or children
... topic S 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc
Binding: DefinitionTopic (example)
ele-1: All FHIR elements must have a @value or children
... author 0..* ContactDetail Who authored the ConceptMap
ele-1: All FHIR elements must have a @value or children
... editor 0..* ContactDetail Who edited the ConceptMap
ele-1: All FHIR elements must have a @value or children
... reviewer 0..* ContactDetail Who reviewed the ConceptMap
ele-1: All FHIR elements must have a @value or children
... endorser 0..* ContactDetail Who endorsed the ConceptMap
ele-1: All FHIR elements must have a @value or children
... relatedArtifact 0..* RelatedArtifact Additional documentation, citations, etc
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
ConceptMap.versionAlgorithm[x]extensibleVersionAlgorithm
http://hl7.org/fhir/ValueSet/version-algorithm
from the FHIR Standard
ConceptMap.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|5.0.0
from the FHIR Standard
ConceptMap.jurisdictionextensibleJurisdictionValueSet
http://hl7.org/fhir/ValueSet/jurisdiction
from the FHIR Standard
ConceptMap.topicexampleDefinitionTopic
http://hl7.org/fhir/ValueSet/definition-topic
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
cnl-0warningConceptMapName should be usable as an identifier for the module by machine processing applications such as code generation
: name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$')
cnl-1warningConceptMap.urlURL should not contain | or # - these characters make processing canonical references problematic
: exists() implies matches('^[^|# ]+$')
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 ShareableConceptMap

NameFlagsCard.TypeDescription & Constraintsdoco
.. ConceptMap 1..1 ShareableConceptMap A map from one set of concepts to one or more other concepts
... identifier S 0..* Identifier Additional identifier for the concept map
... date S 1..1 dateTime Date last changed
... contact S 0..* ContactDetail Contact details for the publisher
... jurisdiction S 0..* CodeableConcept Intended jurisdiction for concept map (if applicable)
... purpose S 0..1 markdown Why this concept map is defined
... copyright S 0..1 markdown Use and/or publishing restrictions
... copyrightLabel S 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 S 0..1 Period When the ConceptMap is expected to be used
... topic S 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc
... 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

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. ConceptMap C 1..1 ShareableConceptMap 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: AllLanguages (required): IETF language tag for a human language

Additional BindingsPurpose
CommonLanguages 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: KnowledgeRepresentationLevel (required)
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... url SΣC 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 SΣ 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: VersionAlgorithm (extensible)
.... versionAlgorithmString string
.... versionAlgorithmCoding Coding
... name SΣC 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 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 SΣ 1..1 dateTime Date last changed
... publisher SΣ 0..1 string Name of the publisher/steward (organization or individual)
... contact SΣ 0..* ContactDetail Contact details for the publisher
... description S 1..1 markdown Natural language description of the concept map
... useContext SΣ 0..* UsageContext The context that the content is intended to support
... jurisdiction SΣ 0..* CodeableConcept Intended jurisdiction for concept map (if applicable)
Binding: JurisdictionValueSet (extensible): Countries and regions within which this artifact is targeted for use.


... purpose S 0..1 markdown Why this concept map is defined
... copyright S 0..1 markdown Use and/or publishing restrictions
... copyrightLabel S 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 SΣ 0..1 Period When the ConceptMap is expected to be used
... topic S 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc
Binding: DefinitionTopic (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 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 1..1 code Coding | string | integer | boolean | dateTime | decimal | code
Binding: ConceptMapPropertyType (required): The type of a property value.

.... system ΣC 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: ConceptMapAttributeType (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 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 0..1 code Identifies element being mapped
..... display 0..1 string Display for the code
..... valueSet C 0..1 canonical(ValueSet) Identifies the set of concepts being mapped
..... noMap C 0..1 boolean No mapping to a target concept for this source concept
..... target C 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 0..1 code Code that identifies the target element
...... display 0..1 string Display for the code
...... valueSet C 0..1 canonical(ValueSet) Identifies the set of target concepts
...... relationship ?!C 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 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 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 0..1 Value of the referenced data element
........ valueCode code
........ valueCoding Coding
........ valueString string
........ valueBoolean boolean
........ valueQuantity Quantity
....... valueSet C 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 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 1..1 code use-source-code | fixed | other-map
Binding: ConceptMapGroupUnmappedMode (required): Defines which action to take if there is no match in the group.

..... code C 0..1 code Fixed code when mode = fixed
..... display C 0..1 string Display for the code
..... valueSet C 0..1 canonical(ValueSet) Fixed code set when mode = fixed
..... relationship ?!C 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 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.languagerequiredAllLanguages (a valid code from Tags for the Identification of Languages)
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
from the FHIR Standard
ConceptMap.versionAlgorithm[x]extensibleVersionAlgorithm
http://hl7.org/fhir/ValueSet/version-algorithm
from the FHIR Standard
ConceptMap.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|5.0.0
from the FHIR Standard
ConceptMap.jurisdictionextensibleJurisdictionValueSet
http://hl7.org/fhir/ValueSet/jurisdiction
from the FHIR Standard
ConceptMap.topicexampleDefinitionTopic
http://hl7.org/fhir/ValueSet/definition-topic
from the FHIR Standard
ConceptMap.property.typerequiredConceptMapPropertyType
http://hl7.org/fhir/ValueSet/conceptmap-property-type|5.0.0
from the FHIR Standard
ConceptMap.additionalAttribute.typerequiredConceptMapAttributeType
http://hl7.org/fhir/ValueSet/conceptmap-attribute-type|5.0.0
from the FHIR Standard
ConceptMap.group.element.target.relationshiprequiredConceptMapRelationship
http://hl7.org/fhir/ValueSet/concept-map-relationship|5.0.0
from the FHIR Standard
ConceptMap.group.unmapped.moderequiredConceptMapGroupUnmappedMode
http://hl7.org/fhir/ValueSet/conceptmap-unmapped-mode|5.0.0
from the FHIR Standard
ConceptMap.group.unmapped.relationshiprequiredConceptMapRelationship
http://hl7.org/fhir/ValueSet/concept-map-relationship|5.0.0
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
cmd-1errorConceptMap.group.element.targetIf the map is source-is-broader-than-target or not-related-to, there SHALL be some comments, unless the status is 'draft'
: comment.exists() or (%resource.status = 'draft') or relationship.empty() or ((relationship != 'source-is-broader-than-target') and (relationship != 'not-related-to'))
cmd-2errorConceptMap.group.unmappedIf the mode is 'fixed', either a code or valueSet must be provided, but not both.
: (mode = 'fixed') implies ((code.exists() and valueSet.empty()) or (code.empty() and valueSet.exists()))
cmd-3errorConceptMap.group.unmappedIf the mode is 'other-map', a url for the other map must be provided
: (mode = 'other-map') implies otherMap.exists()
cmd-4errorConceptMap.group.elementIf noMap is present, target SHALL NOT be present
: (noMap.exists() and noMap=true) implies target.empty()
cmd-5errorConceptMap.group.elementEither code or valueSet SHALL be present but not both.
: (code.exists() and valueSet.empty()) or (code.empty() and valueSet.exists())
cmd-6errorConceptMap.group.element.target.dependsOnOne of value[x] or valueSet must exist, but not both.
: (value.exists() and valueSet.empty()) or (value.empty() and valueSet.exists())
cmd-7errorConceptMap.group.element.targetEither code or valueSet SHALL be present but not both.
: (code.exists() and valueSet.empty()) or (code.empty() and valueSet.exists())
cmd-8errorConceptMap.group.unmappedIf the mode is not 'fixed', code, display and valueSet are not allowed
: (mode != 'fixed') implies (code.empty() and display.empty() and valueSet.empty())
cmd-9errorConceptMap.group.unmappedIf the mode is not 'other-map', relationship must be provided
: (mode != 'other-map') implies relationship.exists()
cmd-10errorConceptMap.group.unmappedIf the mode is not 'other-map', otherMap is not allowed
: (mode != 'other-map') implies otherMap.empty()
cmd-11errorConceptMap.propertyIf the property type is code, a system SHALL be specified
: type = 'code' implies system.exists()
cnl-0warningConceptMapName should be usable as an identifier for the module by machine processing applications such as code generation
: name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$')
cnl-1warningConceptMap.urlURL should not contain | or # - these characters make processing canonical references problematic
: exists() implies matches('^[^|# ]+$')
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 ShareableConceptMap

Summary

Mandatory: 1 element
Must-Support: 10 elements

Maturity: 1

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ConceptMap C 1..1 ShareableConceptMap 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
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... contained 0..* Resource Contained, inline Resources
... 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: KnowledgeRepresentationLevel (required)
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... url SΣC 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
ele-1: All FHIR elements must have a @value or children
... identifier SΣ 0..* Identifier Additional identifier for the concept map
ele-1: All FHIR elements must have a @value or children
... version SΣ 1..1 string Business version of the concept map
ele-1: All FHIR elements must have a @value or children
... versionAlgorithm[x] SΣ 0..1 How to compare versions
Binding: VersionAlgorithm (extensible)
ele-1: All FHIR elements must have a @value or children
.... versionAlgorithmString string
.... versionAlgorithmCoding Coding
... name SΣC 0..1 string Name for this concept map (computer friendly)
ele-1: All FHIR elements must have a @value or children
... title SΣ 1..1 string Name for this concept map (human friendly)
ele-1: All FHIR elements must have a @value or children
... status ?!SΣC 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.


ele-1: All FHIR elements must have a @value or children
... experimental SΣ 1..1 boolean For testing purposes, not real usage
ele-1: All FHIR elements must have a @value or children
... date SΣ 1..1 dateTime Date last changed
ele-1: All FHIR elements must have a @value or children
... publisher SΣ 0..1 string Name of the publisher/steward (organization or individual)
ele-1: All FHIR elements must have a @value or children
... contact SΣ 0..* ContactDetail Contact details for the publisher
ele-1: All FHIR elements must have a @value or children
... description S 1..1 markdown Natural language description of the concept map
ele-1: All FHIR elements must have a @value or children
... useContext SΣ 0..* UsageContext The context that the content is intended to support
ele-1: All FHIR elements must have a @value or children
... jurisdiction SΣ 0..* CodeableConcept Intended jurisdiction for concept map (if applicable)
Binding: JurisdictionValueSet (extensible): Countries and regions within which this artifact is targeted for use.


ele-1: All FHIR elements must have a @value or children
... purpose S 0..1 markdown Why this concept map is defined
ele-1: All FHIR elements must have a @value or children
... copyright S 0..1 markdown Use and/or publishing restrictions
ele-1: All FHIR elements must have a @value or children
... copyrightLabel S 0..1 string Copyright holder and year(s)
ele-1: All FHIR elements must have a @value or children
... approvalDate 0..1 date When the ConceptMap was approved by publisher
ele-1: All FHIR elements must have a @value or children
... lastReviewDate 0..1 date When the ConceptMap was last reviewed by the publisher
ele-1: All FHIR elements must have a @value or children
... effectivePeriod SΣ 0..1 Period When the ConceptMap is expected to be used
ele-1: All FHIR elements must have a @value or children
... topic S 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc
Binding: DefinitionTopic (example)
ele-1: All FHIR elements must have a @value or children
... author 0..* ContactDetail Who authored the ConceptMap
ele-1: All FHIR elements must have a @value or children
... editor 0..* ContactDetail Who edited the ConceptMap
ele-1: All FHIR elements must have a @value or children
... reviewer 0..* ContactDetail Who reviewed the ConceptMap
ele-1: All FHIR elements must have a @value or children
... endorser 0..* ContactDetail Who endorsed the ConceptMap
ele-1: All FHIR elements must have a @value or children
... relatedArtifact 0..* RelatedArtifact Additional documentation, citations, etc
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
ConceptMap.versionAlgorithm[x]extensibleVersionAlgorithm
http://hl7.org/fhir/ValueSet/version-algorithm
from the FHIR Standard
ConceptMap.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|5.0.0
from the FHIR Standard
ConceptMap.jurisdictionextensibleJurisdictionValueSet
http://hl7.org/fhir/ValueSet/jurisdiction
from the FHIR Standard
ConceptMap.topicexampleDefinitionTopic
http://hl7.org/fhir/ValueSet/definition-topic
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
cnl-0warningConceptMapName should be usable as an identifier for the module by machine processing applications such as code generation
: name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$')
cnl-1warningConceptMap.urlURL should not contain | or # - these characters make processing canonical references problematic
: exists() implies matches('^[^|# ]+$')
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 ShareableConceptMap

NameFlagsCard.TypeDescription & Constraintsdoco
.. ConceptMap 1..1 ShareableConceptMap A map from one set of concepts to one or more other concepts
... identifier S 0..* Identifier Additional identifier for the concept map
... date S 1..1 dateTime Date last changed
... contact S 0..* ContactDetail Contact details for the publisher
... jurisdiction S 0..* CodeableConcept Intended jurisdiction for concept map (if applicable)
... purpose S 0..1 markdown Why this concept map is defined
... copyright S 0..1 markdown Use and/or publishing restrictions
... copyrightLabel S 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 S 0..1 Period When the ConceptMap is expected to be used
... topic S 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc
... 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

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ConceptMap C 1..1 ShareableConceptMap 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: AllLanguages (required): IETF language tag for a human language

Additional BindingsPurpose
CommonLanguages 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: KnowledgeRepresentationLevel (required)
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... url SΣC 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 SΣ 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: VersionAlgorithm (extensible)
.... versionAlgorithmString string
.... versionAlgorithmCoding Coding
... name SΣC 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 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 SΣ 1..1 dateTime Date last changed
... publisher SΣ 0..1 string Name of the publisher/steward (organization or individual)
... contact SΣ 0..* ContactDetail Contact details for the publisher
... description S 1..1 markdown Natural language description of the concept map
... useContext SΣ 0..* UsageContext The context that the content is intended to support
... jurisdiction SΣ 0..* CodeableConcept Intended jurisdiction for concept map (if applicable)
Binding: JurisdictionValueSet (extensible): Countries and regions within which this artifact is targeted for use.


... purpose S 0..1 markdown Why this concept map is defined
... copyright S 0..1 markdown Use and/or publishing restrictions
... copyrightLabel S 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 SΣ 0..1 Period When the ConceptMap is expected to be used
... topic S 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc
Binding: DefinitionTopic (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 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 1..1 code Coding | string | integer | boolean | dateTime | decimal | code
Binding: ConceptMapPropertyType (required): The type of a property value.

.... system ΣC 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: ConceptMapAttributeType (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 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 0..1 code Identifies element being mapped
..... display 0..1 string Display for the code
..... valueSet C 0..1 canonical(ValueSet) Identifies the set of concepts being mapped
..... noMap C 0..1 boolean No mapping to a target concept for this source concept
..... target C 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 0..1 code Code that identifies the target element
...... display 0..1 string Display for the code
...... valueSet C 0..1 canonical(ValueSet) Identifies the set of target concepts
...... relationship ?!C 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 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 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 0..1 Value of the referenced data element
........ valueCode code
........ valueCoding Coding
........ valueString string
........ valueBoolean boolean
........ valueQuantity Quantity
....... valueSet C 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 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 1..1 code use-source-code | fixed | other-map
Binding: ConceptMapGroupUnmappedMode (required): Defines which action to take if there is no match in the group.

..... code C 0..1 code Fixed code when mode = fixed
..... display C 0..1 string Display for the code
..... valueSet C 0..1 canonical(ValueSet) Fixed code set when mode = fixed
..... relationship ?!C 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 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.languagerequiredAllLanguages (a valid code from Tags for the Identification of Languages)
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
from the FHIR Standard
ConceptMap.versionAlgorithm[x]extensibleVersionAlgorithm
http://hl7.org/fhir/ValueSet/version-algorithm
from the FHIR Standard
ConceptMap.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|5.0.0
from the FHIR Standard
ConceptMap.jurisdictionextensibleJurisdictionValueSet
http://hl7.org/fhir/ValueSet/jurisdiction
from the FHIR Standard
ConceptMap.topicexampleDefinitionTopic
http://hl7.org/fhir/ValueSet/definition-topic
from the FHIR Standard
ConceptMap.property.typerequiredConceptMapPropertyType
http://hl7.org/fhir/ValueSet/conceptmap-property-type|5.0.0
from the FHIR Standard
ConceptMap.additionalAttribute.typerequiredConceptMapAttributeType
http://hl7.org/fhir/ValueSet/conceptmap-attribute-type|5.0.0
from the FHIR Standard
ConceptMap.group.element.target.relationshiprequiredConceptMapRelationship
http://hl7.org/fhir/ValueSet/concept-map-relationship|5.0.0
from the FHIR Standard
ConceptMap.group.unmapped.moderequiredConceptMapGroupUnmappedMode
http://hl7.org/fhir/ValueSet/conceptmap-unmapped-mode|5.0.0
from the FHIR Standard
ConceptMap.group.unmapped.relationshiprequiredConceptMapRelationship
http://hl7.org/fhir/ValueSet/concept-map-relationship|5.0.0
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
cmd-1errorConceptMap.group.element.targetIf the map is source-is-broader-than-target or not-related-to, there SHALL be some comments, unless the status is 'draft'
: comment.exists() or (%resource.status = 'draft') or relationship.empty() or ((relationship != 'source-is-broader-than-target') and (relationship != 'not-related-to'))
cmd-2errorConceptMap.group.unmappedIf the mode is 'fixed', either a code or valueSet must be provided, but not both.
: (mode = 'fixed') implies ((code.exists() and valueSet.empty()) or (code.empty() and valueSet.exists()))
cmd-3errorConceptMap.group.unmappedIf the mode is 'other-map', a url for the other map must be provided
: (mode = 'other-map') implies otherMap.exists()
cmd-4errorConceptMap.group.elementIf noMap is present, target SHALL NOT be present
: (noMap.exists() and noMap=true) implies target.empty()
cmd-5errorConceptMap.group.elementEither code or valueSet SHALL be present but not both.
: (code.exists() and valueSet.empty()) or (code.empty() and valueSet.exists())
cmd-6errorConceptMap.group.element.target.dependsOnOne of value[x] or valueSet must exist, but not both.
: (value.exists() and valueSet.empty()) or (value.empty() and valueSet.exists())
cmd-7errorConceptMap.group.element.targetEither code or valueSet SHALL be present but not both.
: (code.exists() and valueSet.empty()) or (code.empty() and valueSet.exists())
cmd-8errorConceptMap.group.unmappedIf the mode is not 'fixed', code, display and valueSet are not allowed
: (mode != 'fixed') implies (code.empty() and display.empty() and valueSet.empty())
cmd-9errorConceptMap.group.unmappedIf the mode is not 'other-map', relationship must be provided
: (mode != 'other-map') implies relationship.exists()
cmd-10errorConceptMap.group.unmappedIf the mode is not 'other-map', otherMap is not allowed
: (mode != 'other-map') implies otherMap.empty()
cmd-11errorConceptMap.propertyIf the property type is code, a system SHALL be specified
: type = 'code' implies system.exists()
cnl-0warningConceptMapName should be usable as an identifier for the module by machine processing applications such as code generation
: name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$')
cnl-1warningConceptMap.urlURL should not contain | or # - these characters make processing canonical references problematic
: exists() implies matches('^[^|# ]+$')
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 ShareableConceptMap

Summary

Mandatory: 1 element
Must-Support: 10 elements

Maturity: 1

 

Other representations of profile: CSV, Excel, Schematron