Canonical Resource Management Infrastructure Implementation Guide
1.0.0-snapshot - Snapshot International flag

This page is part of the Canonical Resource Management Infrastructure Implementation Guide (v1.0.0-snapshot: STU1 Draft) based on FHIR (HL7® FHIR® Standard) R4. The current version which supersedes this version is 1.0.0. For a full list of available versions, see the Directory of published versions

Resource Profile: CRMI Publishable ConceptMap

Official URL: http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-publishableconceptmap Version: 1.0.0-snapshot
Standards status: Trial-use Maturity Level: 1 Computable Name: CRMIPublishableConceptMap
Other Identifiers: OID:2.16.840.1.113883.4.642.40.38.42.33

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:

Formal Views of Profile Content

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

This structure is derived from ConceptMap

NameFlagsCard.TypeDescription & Constraintsdoco
.. ConceptMap 1..1 ConceptMap A map from one set of concepts to one or more other concepts
... copyrightLabel S 0..1 string Copyright holder and year(s)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
... approvalDate S 0..1 date When the artifact was approved by publisher
URL: http://hl7.org/fhir/StructureDefinition/artifact-approvalDate
... lastReviewDate S 0..1 date When the artifact was approved by publisher
URL: http://hl7.org/fhir/StructureDefinition/artifact-lastReviewDate
... topic S 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc.
URL: http://hl7.org/fhir/StructureDefinition/artifact-topic
Binding: DefinitionTopic (example): Topics associated with the artifact


... author S 0..* ContactDetail Who authored the {{title}}
URL: http://hl7.org/fhir/StructureDefinition/artifact-author
... editor S 0..* ContactDetail Who edited the {{title}}
URL: http://hl7.org/fhir/StructureDefinition/artifact-editor
... reviewer S 0..* ContactDetail Who reviewed the {{title}}
URL: http://hl7.org/fhir/StructureDefinition/artifact-reviewer
... endorser S 0..* ContactDetail Who endorsed the {{title}}
URL: http://hl7.org/fhir/StructureDefinition/artifact-endorser
... relatedArtifact S 0..* RelatedArtifact Additional documentation, citations, etc.
URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact
... identifier S 0..1 Identifier Additional identifier for the concept map
... date S 1..1 dateTime Date last changed
... contact S 0..* ContactDetail Contact details for the publisher
... useContext S 0..* UsageContext The context that the content is intended to support
... 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

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. ConceptMap C 1..1 ConceptMap A map from one set of concepts to one or more other concepts
cmd-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
... copyrightLabel S 0..1 string Copyright holder and year(s)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
... approvalDate S 0..1 date When the artifact was approved by publisher
URL: http://hl7.org/fhir/StructureDefinition/artifact-approvalDate
... effectivePeriod S 0..1 Period When the artifact is expected to be used
URL: http://hl7.org/fhir/StructureDefinition/artifact-effectivePeriod
... topic S 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc.
URL: http://hl7.org/fhir/StructureDefinition/artifact-topic
Binding: DefinitionTopic (example): Topics associated with the artifact


... author S 0..* ContactDetail Who authored the {{title}}
URL: http://hl7.org/fhir/StructureDefinition/artifact-author
... editor S 0..* ContactDetail Who edited the {{title}}
URL: http://hl7.org/fhir/StructureDefinition/artifact-editor
... reviewer S 0..* ContactDetail Who reviewed the {{title}}
URL: http://hl7.org/fhir/StructureDefinition/artifact-reviewer
... endorser S 0..* ContactDetail Who endorsed the {{title}}
URL: http://hl7.org/fhir/StructureDefinition/artifact-endorser
... relatedArtifact S 0..* RelatedArtifact Additional documentation, citations, etc.
URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier SΣ 0..1 Identifier Additional identifier for the concept map
... status ?!Σ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... date SΣ 1..1 dateTime Date last changed
... contact SΣ 0..* ContactDetail Contact details for the publisher
... 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: Jurisdiction ValueSet (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

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.jurisdictionextensibleJurisdiction ValueSet
http://hl7.org/fhir/ValueSet/jurisdiction
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}')
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()
NameFlagsCard.TypeDescription & Constraintsdoco
.. ConceptMap C 1..1 ConceptMap A map from one set of concepts to one or more other concepts
cmd-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: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguages Max Binding
... 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
... copyrightLabel S 0..1 string Copyright holder and year(s)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
... approvalDate S 0..1 date When the artifact was approved by publisher
URL: http://hl7.org/fhir/StructureDefinition/artifact-approvalDate
... lastReviewDate S 0..1 date When the artifact was approved by publisher
URL: http://hl7.org/fhir/StructureDefinition/artifact-lastReviewDate
... effectivePeriod S 0..1 Period When the artifact is expected to be used
URL: http://hl7.org/fhir/StructureDefinition/artifact-effectivePeriod
... topic S 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc.
URL: http://hl7.org/fhir/StructureDefinition/artifact-topic
Binding: DefinitionTopic (example): Topics associated with the artifact


... author S 0..* ContactDetail Who authored the {{title}}
URL: http://hl7.org/fhir/StructureDefinition/artifact-author
... editor S 0..* ContactDetail Who edited the {{title}}
URL: http://hl7.org/fhir/StructureDefinition/artifact-editor
... reviewer S 0..* ContactDetail Who reviewed the {{title}}
URL: http://hl7.org/fhir/StructureDefinition/artifact-reviewer
... endorser S 0..* ContactDetail Who endorsed the {{title}}
URL: http://hl7.org/fhir/StructureDefinition/artifact-endorser
... relatedArtifact S 0..* RelatedArtifact Additional documentation, citations, etc.
URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact
... 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 SΣ 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 ?!Σ 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 SΣ 1..1 dateTime Date last changed
... publisher Σ 0..1 string Name of the publisher (organization or individual)
... contact SΣ 0..* ContactDetail Contact details for the publisher
... description 0..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: Jurisdiction ValueSet (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
... source[x] Σ 0..1 The source value set that contains the concepts that are being mapped
.... sourceUri uri
.... sourceCanonical canonical(ValueSet)
... target[x] Σ 0..1 The target value set which provides context for the mappings
.... targetUri uri
.... targetCanonical canonical(ValueSet)
... group 0..* BackboneElement Same source and target systems
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... 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 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
cmd-1: If the map is narrower or inexact, there SHALL be some comments
...... 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 ?! 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 1..1 uri Reference to property mapping depends on
....... system 0..1 canonical(CodeSystem) Code System (if necessary)
....... value 1..1 string Value of the referenced element
....... display 0..1 string Display for the code (if value is a code)
...... product 0..* See dependsOn (ConceptMap) Other concepts that this mapping also produces
.... unmapped C 0..1 BackboneElement What to do when there is no mapping for the source concept
cmd-2: If the mode is 'fixed', a code must be provided
cmd-3: If the mode is 'other-map', a url must be provided
..... 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
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
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()

Differential View

This structure is derived from ConceptMap

NameFlagsCard.TypeDescription & Constraintsdoco
.. ConceptMap 1..1 ConceptMap A map from one set of concepts to one or more other concepts
... copyrightLabel S 0..1 string Copyright holder and year(s)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
... approvalDate S 0..1 date When the artifact was approved by publisher
URL: http://hl7.org/fhir/StructureDefinition/artifact-approvalDate
... lastReviewDate S 0..1 date When the artifact was approved by publisher
URL: http://hl7.org/fhir/StructureDefinition/artifact-lastReviewDate
... topic S 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc.
URL: http://hl7.org/fhir/StructureDefinition/artifact-topic
Binding: DefinitionTopic (example): Topics associated with the artifact


... author S 0..* ContactDetail Who authored the {{title}}
URL: http://hl7.org/fhir/StructureDefinition/artifact-author
... editor S 0..* ContactDetail Who edited the {{title}}
URL: http://hl7.org/fhir/StructureDefinition/artifact-editor
... reviewer S 0..* ContactDetail Who reviewed the {{title}}
URL: http://hl7.org/fhir/StructureDefinition/artifact-reviewer
... endorser S 0..* ContactDetail Who endorsed the {{title}}
URL: http://hl7.org/fhir/StructureDefinition/artifact-endorser
... relatedArtifact S 0..* RelatedArtifact Additional documentation, citations, etc.
URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact
... identifier S 0..1 Identifier Additional identifier for the concept map
... date S 1..1 dateTime Date last changed
... contact S 0..* ContactDetail Contact details for the publisher
... useContext S 0..* UsageContext The context that the content is intended to support
... 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

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ConceptMap C 1..1 ConceptMap A map from one set of concepts to one or more other concepts
cmd-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
... copyrightLabel S 0..1 string Copyright holder and year(s)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
... approvalDate S 0..1 date When the artifact was approved by publisher
URL: http://hl7.org/fhir/StructureDefinition/artifact-approvalDate
... effectivePeriod S 0..1 Period When the artifact is expected to be used
URL: http://hl7.org/fhir/StructureDefinition/artifact-effectivePeriod
... topic S 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc.
URL: http://hl7.org/fhir/StructureDefinition/artifact-topic
Binding: DefinitionTopic (example): Topics associated with the artifact


... author S 0..* ContactDetail Who authored the {{title}}
URL: http://hl7.org/fhir/StructureDefinition/artifact-author
... editor S 0..* ContactDetail Who edited the {{title}}
URL: http://hl7.org/fhir/StructureDefinition/artifact-editor
... reviewer S 0..* ContactDetail Who reviewed the {{title}}
URL: http://hl7.org/fhir/StructureDefinition/artifact-reviewer
... endorser S 0..* ContactDetail Who endorsed the {{title}}
URL: http://hl7.org/fhir/StructureDefinition/artifact-endorser
... relatedArtifact S 0..* RelatedArtifact Additional documentation, citations, etc.
URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier SΣ 0..1 Identifier Additional identifier for the concept map
... status ?!Σ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... date SΣ 1..1 dateTime Date last changed
... contact SΣ 0..* ContactDetail Contact details for the publisher
... 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: Jurisdiction ValueSet (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

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.jurisdictionextensibleJurisdiction ValueSet
http://hl7.org/fhir/ValueSet/jurisdiction
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}')
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()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ConceptMap C 1..1 ConceptMap A map from one set of concepts to one or more other concepts
cmd-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: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguages Max Binding
... 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
... copyrightLabel S 0..1 string Copyright holder and year(s)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
... approvalDate S 0..1 date When the artifact was approved by publisher
URL: http://hl7.org/fhir/StructureDefinition/artifact-approvalDate
... lastReviewDate S 0..1 date When the artifact was approved by publisher
URL: http://hl7.org/fhir/StructureDefinition/artifact-lastReviewDate
... effectivePeriod S 0..1 Period When the artifact is expected to be used
URL: http://hl7.org/fhir/StructureDefinition/artifact-effectivePeriod
... topic S 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc.
URL: http://hl7.org/fhir/StructureDefinition/artifact-topic
Binding: DefinitionTopic (example): Topics associated with the artifact


... author S 0..* ContactDetail Who authored the {{title}}
URL: http://hl7.org/fhir/StructureDefinition/artifact-author
... editor S 0..* ContactDetail Who edited the {{title}}
URL: http://hl7.org/fhir/StructureDefinition/artifact-editor
... reviewer S 0..* ContactDetail Who reviewed the {{title}}
URL: http://hl7.org/fhir/StructureDefinition/artifact-reviewer
... endorser S 0..* ContactDetail Who endorsed the {{title}}
URL: http://hl7.org/fhir/StructureDefinition/artifact-endorser
... relatedArtifact S 0..* RelatedArtifact Additional documentation, citations, etc.
URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact
... 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 SΣ 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 ?!Σ 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 SΣ 1..1 dateTime Date last changed
... publisher Σ 0..1 string Name of the publisher (organization or individual)
... contact SΣ 0..* ContactDetail Contact details for the publisher
... description 0..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: Jurisdiction ValueSet (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
... source[x] Σ 0..1 The source value set that contains the concepts that are being mapped
.... sourceUri uri
.... sourceCanonical canonical(ValueSet)
... target[x] Σ 0..1 The target value set which provides context for the mappings
.... targetUri uri
.... targetCanonical canonical(ValueSet)
... group 0..* BackboneElement Same source and target systems
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... 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 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
cmd-1: If the map is narrower or inexact, there SHALL be some comments
...... 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 ?! 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 1..1 uri Reference to property mapping depends on
....... system 0..1 canonical(CodeSystem) Code System (if necessary)
....... value 1..1 string Value of the referenced element
....... display 0..1 string Display for the code (if value is a code)
...... product 0..* See dependsOn (ConceptMap) Other concepts that this mapping also produces
.... unmapped C 0..1 BackboneElement What to do when there is no mapping for the source concept
cmd-2: If the mode is 'fixed', a code must be provided
cmd-3: If the mode is 'other-map', a url must be provided
..... 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
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
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()

 

Other representations of profile: CSV, Excel, Schematron