Content Repository Management Infrastructure Implementation Guide
3.0.0-ballot - STU 3 Ballot International flag

Content Repository Management Infrastructure Implementation Guide, published by HL7 International / Clinical Decision Support. This guide is not an authorized publication; it is the continuous build for version 3.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/crmi-ig/ and changes regularly. See the Directory of published versions

Resource Profile: Publishable ConceptMap

Official URL: http://hl7.org/fhir/StructureDefinition/publishableconceptmap Version: 4.0.2
Standards status: Trial-use Maturity Level: 1 Responsible: HL7 International / Terminology Infrastructure Computable Name: PublishableConceptMap
Other Identifiers: OID:2.16.840.1.113883.4.642.5.1114

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. For production (active and not experimental) concept maps, additional requirements apply to identify the source and target code system versions, publisher, effective period, and licensing information (see Terminology Transformations)

​Original Source: hl7.org

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description Differentials, Snapshots, and other representations.

NameFlagsCard.TypeDescription & Constraints    Filter: doco
ConceptMap C 1..1 ConceptMap A map from one set of concepts to one or more other concepts
Constraints: cmd-0, pub-1, pcm-1, pcm-2
ConceptMap.meta This element is included in summaries. 0..1 Meta Metadata about the resource
ConceptMap.meta.Slices for extension Content/Rules for all slices
ConceptMap.meta.Slices for extension.extension:packageSource This element must be supported. 0..1 (Complex) What package the artifact is defined in
URL: http://hl7.org/fhir/StructureDefinition/package-source
ConceptMap.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
ConceptMap.Slices for extension Content/Rules for all slices
ConceptMap.Slices for extension.extension:knowledgeCapability This element must be supported. C 0..* code shareable | computable | publishable | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability
Binding: KnowledgeCapability (required)
ConceptMap.Slices for extension.extension:copyrightLabel This element must be supported. 0..1 string Copyright holder and year(s)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
ConceptMap.Slices for extension.extension:approvalDate This element must be supported. 0..1 date When resource approved by publisher
URL: http://hl7.org/fhir/StructureDefinition/resource-approvalDate
ConceptMap.Slices for extension.extension:lastReviewDate This element must be supported. 0..1 date Last review date for the resource
URL: http://hl7.org/fhir/StructureDefinition/resource-lastReviewDate
ConceptMap.Slices for extension.extension:effectivePeriod This element must be supported. 0..1 Period The effective date range for the resource
URL: http://hl7.org/fhir/StructureDefinition/resource-effectivePeriod
ConceptMap.Slices for extension.extension:topic This element must be supported. 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc.
URL: http://hl7.org/fhir/StructureDefinition/artifact-topic
Binding: DefinitionTopic (example): Topics associated with the artifact
ConceptMap.Slices for extension.extension:author This element must be supported. 0..* ContactDetail Who authored the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-author
ConceptMap.Slices for extension.extension:editor This element must be supported. 0..* ContactDetail Who edited the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-editor
ConceptMap.Slices for extension.extension:reviewer This element must be supported. 0..* ContactDetail Who reviewed the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-reviewer
ConceptMap.Slices for extension.extension:endorser This element must be supported. 0..* ContactDetail Who endorsed the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-endorser
ConceptMap.Slices for extension.extension:relatedArtifact This element must be supported. 0..* (Complex) Additional documentation, citations, etc.
URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact
ConceptMap.Slices for extension.extension:relatedArtifact.extension 0..0 Extension
Slice: Unordered, Open by value:url
ConceptMap.Slices for extension.extension:relatedArtifact.url 1..1 uri "http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact"
ConceptMap.Slices for extension.extension:relatedArtifact.value[x] 1..1 RelatedArtifact Value of extension
ConceptMap.Slices for extension.extension:relatedArtifact.value[x].Slices for extension Content/Rules for all slices
ConceptMap.Slices for extension.extension:relatedArtifact.value[x].Slices for extension.extension:publicationDate 0..1 date Publication date of referenced artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationDate
ConceptMap.Slices for extension.extension:relatedArtifact.value[x].Slices for extension.extension:publicationStatus 0..1 code Publication status of referenced artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationStatus
Binding: PublicationStatus (required): The lifecycle status of a reference artifact
ConceptMap.Slices for extension.extension:relatedArtifact.value[x].type This element is included in summaries. 1..1 code documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of
Binding: RelatedArtifactType (required): The type of relationship to the related artifact.
ConceptMap.Slices for extension.extension:artifactComment 0..* (Complex) Additional documentation, review, or usage guidance
URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment
ConceptMap.Slices for extension.extension:authoritativeSource This element must be supported. 0..1 uri Original definitions
URL: http://hl7.org/fhir/StructureDefinition/artifact-authoritativeSource
ConceptMap.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
ConceptMap.identifier This element must be supported. This element is included in summaries. 0..1 Identifier Additional identifier for the concept map
ConceptMap.status This element is a modifier element. This element is included in summaries. 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
ConceptMap.date This element must be supported. This element is included in summaries. 1..1 dateTime Date last changed
ConceptMap.publisher This element must be supported. This element is included in summaries. C 0..1 string Name of the publisher (organization or individual)
ConceptMap.contact This element must be supported. This element is included in summaries. 0..* ContactDetail Contact details for the publisher
ConceptMap.useContext This element must be supported. This element is included in summaries. 0..* UsageContext The context that the content is intended to support
ConceptMap.jurisdiction This element must be supported. This element is included in summaries. 0..* CodeableConcept Intended jurisdiction for concept map (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.
ConceptMap.purpose This element must be supported. 0..1 markdown Why this concept map is defined
ConceptMap.copyright This element must be supported. C 0..1 markdown Use and/or publishing restrictions
ConceptMap.group 0..* BackboneElement Same source and target systems
ConceptMap.group.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
ConceptMap.group.source This element must be supported. C 0..1 uri Source system where concepts to be mapped are defined
ConceptMap.group.sourceVersion This element must be supported. C 0..1 string Specific version of the code system
ConceptMap.group.target This element must be supported. C 0..1 uri Target system that the concepts are to be mapped to
ConceptMap.group.targetVersion This element must be supported. C 0..1 string Specific version of the code system
ConceptMap.group.element 1..* BackboneElement Mappings for a concept from the source set
ConceptMap.group.element.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
ConceptMap.group.element.target C 0..* BackboneElement Concept in target system for element
Constraints: cmd-1
ConceptMap.group.element.target.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
ConceptMap.group.element.target.equivalence This element is a modifier element. This element must be supported. 1..1 code relatedto | equivalent | equal | wider | subsumes | narrower | specializes | inexact | unmatched | disjoint
Binding: ConceptMapEquivalence (required): The degree of equivalence between concepts.
ConceptMap.group.element.target.comment This element must be supported. C 0..1 string Description of status/issues in mapping
ConceptMap.group.element.target.dependsOn This element must be supported. 0..* BackboneElement Other elements required for this mapping (from context)
ConceptMap.group.element.target.dependsOn.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
ConceptMap.group.element.target.dependsOn.property 1..1 uri Reference to property mapping depends on
ConceptMap.group.element.target.dependsOn.value 1..1 string Value of the referenced element
ConceptMap.group.element.target.product This element must be supported. 0..* See dependsOn (ConceptMap) Other concepts that this mapping also produces

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ConceptMap.extension:relatedArtifact.​value[x].type Base required RelatedArtifactType 📍4.0.1 FHIR Std.
ConceptMap.status Base required PublicationStatus 📍4.0.1 FHIR Std.
ConceptMap.jurisdiction Base extensible Jurisdiction 📍4.0.1 FHIR Std.
ConceptMap.group.element.​target.equivalence Base required ConceptMapEquivalence 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
cmd-0 warning ConceptMap Name 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-1 error ConceptMap.group.element.target If the map is narrower or inexact, there SHALL be some comments comment.exists() or equivalence.empty() or ((equivalence != 'narrower') and (equivalence != 'inexact'))
dom-2 error ConceptMap If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error ConceptMap If 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-4 error ConceptMap If 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-5 error ConceptMap If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice ConceptMap A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
pcm-1 warning ConceptMap A production (active and not experimental) concept map SHOULD specify version, publisher, copyright, and an effective period (status = 'active' and experimental.where($this = true).empty()) implies (version.exists() and publisher.exists() and copyright.exists() and extension('http://hl7.org/fhir/StructureDefinition/resource-effectivePeriod').exists())
pcm-2 warning ConceptMap A production (active and not experimental) concept map SHOULD specify the source and target code systems and versions for each group (status = 'active' and experimental.where($this = true).empty()) implies group.all(source.exists() and sourceVersion.exists() and target.exists() and targetVersion.exists())
pub-1 error ConceptMap If knowledge capabilities are stated, they SHALL include publishable extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').exists() implies extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').where(value = 'publishable').exists()

This structure is derived from ConceptMap

NameFlagsCard.TypeDescription & Constraints    Filter: doco
ConceptMap C 1..1 ConceptMap A map from one set of concepts to one or more other concepts
Constraints: pub-1, pcm-1, pcm-2
ConceptMap.meta
ConceptMap.meta.Slices for extension Content/Rules for all slices
ConceptMap.meta.Slices for extension.extension:packageSource This element must be supported. 0..1 (Complex) What package the artifact is defined in
URL: http://hl7.org/fhir/StructureDefinition/package-source
ConceptMap.Slices for extension Content/Rules for all slices
ConceptMap.Slices for extension.extension:knowledgeCapability This element must be supported. C 0..* code shareable | computable | publishable | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability
Binding: KnowledgeCapability (required)
ConceptMap.Slices for extension.extension:copyrightLabel This element must be supported. 0..1 string Copyright holder and year(s)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
ConceptMap.Slices for extension.extension:approvalDate This element must be supported. 0..1 date When resource approved by publisher
URL: http://hl7.org/fhir/StructureDefinition/resource-approvalDate
ConceptMap.Slices for extension.extension:lastReviewDate This element must be supported. 0..1 date Last review date for the resource
URL: http://hl7.org/fhir/StructureDefinition/resource-lastReviewDate
ConceptMap.Slices for extension.extension:effectivePeriod This element must be supported. 0..1 Period The effective date range for the resource
URL: http://hl7.org/fhir/StructureDefinition/resource-effectivePeriod
ConceptMap.Slices for extension.extension:topic This element must be supported. 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc.
URL: http://hl7.org/fhir/StructureDefinition/artifact-topic
Binding: DefinitionTopic (example): Topics associated with the artifact
ConceptMap.Slices for extension.extension:author This element must be supported. 0..* ContactDetail Who authored the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-author
ConceptMap.Slices for extension.extension:editor This element must be supported. 0..* ContactDetail Who edited the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-editor
ConceptMap.Slices for extension.extension:reviewer This element must be supported. 0..* ContactDetail Who reviewed the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-reviewer
ConceptMap.Slices for extension.extension:endorser This element must be supported. 0..* ContactDetail Who endorsed the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-endorser
ConceptMap.Slices for extension.extension:relatedArtifact This element must be supported. 0..* (Complex) Additional documentation, citations, etc.
URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact
ConceptMap.Slices for extension.extension:relatedArtifact.value[x]
ConceptMap.Slices for extension.extension:relatedArtifact.value[x].Slices for extension Content/Rules for all slices
ConceptMap.Slices for extension.extension:relatedArtifact.value[x].Slices for extension.extension:publicationDate 0..1 date Publication date of referenced artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationDate
ConceptMap.Slices for extension.extension:relatedArtifact.value[x].Slices for extension.extension:publicationStatus 0..1 code Publication status of referenced artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationStatus
Binding: PublicationStatus (required): The lifecycle status of a reference artifact
ConceptMap.Slices for extension.extension:artifactComment 0..* (Complex) Additional documentation, review, or usage guidance
URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment
ConceptMap.Slices for extension.extension:authoritativeSource This element must be supported. 0..1 uri Original definitions
URL: http://hl7.org/fhir/StructureDefinition/artifact-authoritativeSource
ConceptMap.identifier This element must be supported. 0..1 Identifier Additional identifier for the concept map
ConceptMap.publisher This element must be supported. C 0..1 string Name of the publisher (organization or individual)
ConceptMap.contact This element must be supported. 0..* ContactDetail Contact details for the publisher
ConceptMap.useContext This element must be supported. 0..* UsageContext The context that the content is intended to support
ConceptMap.jurisdiction This element must be supported. 0..* CodeableConcept Intended jurisdiction for concept map (if applicable)
ConceptMap.purpose This element must be supported. 0..1 markdown Why this concept map is defined
ConceptMap.copyright This element must be supported. C 0..1 markdown Use and/or publishing restrictions
ConceptMap.group
ConceptMap.group.source This element must be supported. C 0..1 uri Source system where concepts to be mapped are defined
ConceptMap.group.sourceVersion This element must be supported. C 0..1 string Specific version of the code system
ConceptMap.group.target This element must be supported. C 0..1 uri Target system that the concepts are to be mapped to
ConceptMap.group.targetVersion This element must be supported. C 0..1 string Specific version of the code system
ConceptMap.group.element
ConceptMap.group.element.target
ConceptMap.group.element.target.equivalence This element must be supported. 1..1 code relatedto | equivalent | equal | wider | subsumes | narrower | specializes | inexact | unmatched | disjoint
ConceptMap.group.element.target.comment This element must be supported. 0..1 string Description of status/issues in mapping
ConceptMap.group.element.target.dependsOn This element must be supported. 0..* BackboneElement Other elements required for this mapping (from context)
ConceptMap.group.element.target.product This element must be supported. 0..* Other concepts that this mapping also produces

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
pcm-1 warning ConceptMap A production (active and not experimental) concept map SHOULD specify version, publisher, copyright, and an effective period (status = 'active' and experimental.where($this = true).empty()) implies (version.exists() and publisher.exists() and copyright.exists() and extension('http://hl7.org/fhir/StructureDefinition/resource-effectivePeriod').exists())
pcm-2 warning ConceptMap A production (active and not experimental) concept map SHOULD specify the source and target code systems and versions for each group (status = 'active' and experimental.where($this = true).empty()) implies group.all(source.exists() and sourceVersion.exists() and target.exists() and targetVersion.exists())
pub-1 error ConceptMap If knowledge capabilities are stated, they SHALL include publishable extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').exists() implies extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').where(value = 'publishable').exists()
NameFlagsCard.TypeDescription & Constraints    Filter: doco
ConceptMap C 1..1 ConceptMap A map from one set of concepts to one or more other concepts
Constraints: cmd-0, pub-1, pcm-1, pcm-2
ConceptMap.id This element is included in summaries. 0..1 id Logical id of this artifact
ConceptMap.meta This element is included in summaries. 0..1 Meta Metadata about the resource
ConceptMap.meta.id 0..1 string Unique id for inter-element referencing
ConceptMap.meta.Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
ConceptMap.meta.Slices for extension.extension:packageSource This element must be supported. 0..1 (Complex) What package the artifact is defined in
URL: http://hl7.org/fhir/StructureDefinition/package-source
ConceptMap.meta.versionId This element is included in summaries. 0..1 id Version specific identifier
ConceptMap.meta.lastUpdated This element is included in summaries. 0..1 instant When the resource version last changed
ConceptMap.meta.source This element is included in summaries. 0..1 uri Identifies where the resource comes from
ConceptMap.meta.profile This element is included in summaries. 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
ConceptMap.meta.security This element is included in summaries. 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
ConceptMap.meta.tag This element is included in summaries. 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
ConceptMap.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
ConceptMap.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
ConceptMap.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
ConceptMap.contained 0..* Resource Contained, inline Resources
ConceptMap.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
ConceptMap.Slices for extension.extension:knowledgeCapability This element must be supported. C 0..* code shareable | computable | publishable | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability
Binding: KnowledgeCapability (required)
ConceptMap.Slices for extension.extension:copyrightLabel This element must be supported. 0..1 string Copyright holder and year(s)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
ConceptMap.Slices for extension.extension:approvalDate This element must be supported. 0..1 date When resource approved by publisher
URL: http://hl7.org/fhir/StructureDefinition/resource-approvalDate
ConceptMap.Slices for extension.extension:lastReviewDate This element must be supported. 0..1 date Last review date for the resource
URL: http://hl7.org/fhir/StructureDefinition/resource-lastReviewDate
ConceptMap.Slices for extension.extension:effectivePeriod This element must be supported. 0..1 Period The effective date range for the resource
URL: http://hl7.org/fhir/StructureDefinition/resource-effectivePeriod
ConceptMap.Slices for extension.extension:topic This element must be supported. 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc.
URL: http://hl7.org/fhir/StructureDefinition/artifact-topic
Binding: DefinitionTopic (example): Topics associated with the artifact
ConceptMap.Slices for extension.extension:author This element must be supported. 0..* ContactDetail Who authored the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-author
ConceptMap.Slices for extension.extension:editor This element must be supported. 0..* ContactDetail Who edited the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-editor
ConceptMap.Slices for extension.extension:reviewer This element must be supported. 0..* ContactDetail Who reviewed the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-reviewer
ConceptMap.Slices for extension.extension:endorser This element must be supported. 0..* ContactDetail Who endorsed the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-endorser
ConceptMap.Slices for extension.extension:relatedArtifact This element must be supported. 0..* (Complex) Additional documentation, citations, etc.
URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact
ConceptMap.Slices for extension.extension:relatedArtifact.id 0..1 string Unique id for inter-element referencing
ConceptMap.Slices for extension.extension:relatedArtifact.extension 0..0 Extension
Slice: Unordered, Open by value:url
ConceptMap.Slices for extension.extension:relatedArtifact.url 1..1 uri "http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact"
ConceptMap.Slices for extension.extension:relatedArtifact.value[x] 1..1 RelatedArtifact Value of extension
ConceptMap.Slices for extension.extension:relatedArtifact.value[x].id 0..1 string Unique id for inter-element referencing
ConceptMap.Slices for extension.extension:relatedArtifact.value[x].Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
ConceptMap.Slices for extension.extension:relatedArtifact.value[x].Slices for extension Content/Rules for all slices
ConceptMap.Slices for extension.extension:relatedArtifact.value[x].Slices for extension.extension:publicationDate 0..1 date Publication date of referenced artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationDate
ConceptMap.Slices for extension.extension:relatedArtifact.value[x].Slices for extension.extension:publicationStatus 0..1 code Publication status of referenced artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationStatus
Binding: PublicationStatus (required): The lifecycle status of a reference artifact
ConceptMap.Slices for extension.extension:relatedArtifact.value[x].type This element is included in summaries. 1..1 code documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of
Binding: RelatedArtifactType (required): The type of relationship to the related artifact.
ConceptMap.Slices for extension.extension:relatedArtifact.value[x].label This element is included in summaries. 0..1 string Short label
ConceptMap.Slices for extension.extension:relatedArtifact.value[x].display This element is included in summaries. 0..1 string Brief description of the related artifact
ConceptMap.Slices for extension.extension:relatedArtifact.value[x].citation This element is included in summaries. 0..1 markdown Bibliographic citation for the artifact
ConceptMap.Slices for extension.extension:relatedArtifact.value[x].url This element is included in summaries. 0..1 url Where the artifact can be accessed
ConceptMap.Slices for extension.extension:relatedArtifact.value[x].document This element is included in summaries. 0..1 Attachment What document is being referenced
ConceptMap.Slices for extension.extension:relatedArtifact.value[x].resource This element is included in summaries. 0..1 canonical(Resource) What resource is being referenced
ConceptMap.Slices for extension.extension:artifactComment 0..* (Complex) Additional documentation, review, or usage guidance
URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment
ConceptMap.Slices for extension.extension:authoritativeSource This element must be supported. 0..1 uri Original definitions
URL: http://hl7.org/fhir/StructureDefinition/artifact-authoritativeSource
ConceptMap.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
ConceptMap.url This element is included in summaries. 0..1 uri Canonical identifier for this concept map, represented as a URI (globally unique)
ConceptMap.identifier This element must be supported. This element is included in summaries. 0..1 Identifier Additional identifier for the concept map
ConceptMap.version This element is included in summaries. 0..1 string Business version of the concept map
ConceptMap.name This element is included in summaries. C 0..1 string Name for this concept map (computer friendly)
ConceptMap.title This element is included in summaries. 0..1 string Name for this concept map (human friendly)
ConceptMap.status This element is a modifier element. This element is included in summaries. 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
ConceptMap.experimental This element is included in summaries. 0..1 boolean For testing purposes, not real usage
ConceptMap.date This element must be supported. This element is included in summaries. 1..1 dateTime Date last changed
ConceptMap.publisher This element must be supported. This element is included in summaries. C 0..1 string Name of the publisher (organization or individual)
ConceptMap.contact This element must be supported. This element is included in summaries. 0..* ContactDetail Contact details for the publisher
ConceptMap.description 0..1 markdown Natural language description of the concept map
ConceptMap.useContext This element must be supported. This element is included in summaries. 0..* UsageContext The context that the content is intended to support
ConceptMap.jurisdiction This element must be supported. This element is included in summaries. 0..* CodeableConcept Intended jurisdiction for concept map (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.
ConceptMap.purpose This element must be supported. 0..1 markdown Why this concept map is defined
ConceptMap.copyright This element must be supported. C 0..1 markdown Use and/or publishing restrictions
ConceptMap.source[x] This element is included in summaries. 0..1 The source value set that contains the concepts that are being mapped
ConceptMap.source[x].sourceUri uri
ConceptMap.source[x].sourceCanonical canonical(ValueSet)
ConceptMap.target[x] This element is included in summaries. 0..1 The target value set which provides context for the mappings
ConceptMap.target[x].targetUri uri
ConceptMap.target[x].targetCanonical canonical(ValueSet)
ConceptMap.group 0..* BackboneElement Same source and target systems
ConceptMap.group.id 0..1 string Unique id for inter-element referencing
ConceptMap.group.extension 0..* Extension Additional content defined by implementations
ConceptMap.group.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
ConceptMap.group.source This element must be supported. C 0..1 uri Source system where concepts to be mapped are defined
ConceptMap.group.sourceVersion This element must be supported. C 0..1 string Specific version of the code system
ConceptMap.group.target This element must be supported. C 0..1 uri Target system that the concepts are to be mapped to
ConceptMap.group.targetVersion This element must be supported. C 0..1 string Specific version of the code system
ConceptMap.group.element 1..* BackboneElement Mappings for a concept from the source set
ConceptMap.group.element.id 0..1 string Unique id for inter-element referencing
ConceptMap.group.element.extension 0..* Extension Additional content defined by implementations
ConceptMap.group.element.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
ConceptMap.group.element.code 0..1 code Identifies element being mapped
ConceptMap.group.element.display 0..1 string Display for the code
ConceptMap.group.element.target C 0..* BackboneElement Concept in target system for element
Constraints: cmd-1
ConceptMap.group.element.target.id 0..1 string Unique id for inter-element referencing
ConceptMap.group.element.target.extension 0..* Extension Additional content defined by implementations
ConceptMap.group.element.target.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
ConceptMap.group.element.target.code 0..1 code Code that identifies the target element
ConceptMap.group.element.target.display 0..1 string Display for the code
ConceptMap.group.element.target.equivalence This element is a modifier element. This element must be supported. 1..1 code relatedto | equivalent | equal | wider | subsumes | narrower | specializes | inexact | unmatched | disjoint
Binding: ConceptMapEquivalence (required): The degree of equivalence between concepts.
ConceptMap.group.element.target.comment This element must be supported. C 0..1 string Description of status/issues in mapping
ConceptMap.group.element.target.dependsOn This element must be supported. 0..* BackboneElement Other elements required for this mapping (from context)
ConceptMap.group.element.target.dependsOn.id 0..1 string Unique id for inter-element referencing
ConceptMap.group.element.target.dependsOn.extension 0..* Extension Additional content defined by implementations
ConceptMap.group.element.target.dependsOn.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
ConceptMap.group.element.target.dependsOn.property 1..1 uri Reference to property mapping depends on
ConceptMap.group.element.target.dependsOn.system 0..1 canonical(CodeSystem) Code System (if necessary)
ConceptMap.group.element.target.dependsOn.value 1..1 string Value of the referenced element
ConceptMap.group.element.target.dependsOn.display 0..1 string Display for the code (if value is a code)
ConceptMap.group.element.target.product This element must be supported. 0..* See dependsOn (ConceptMap) Other concepts that this mapping also produces
ConceptMap.group.unmapped C 0..1 BackboneElement What to do when there is no mapping for the source concept
Constraints: cmd-2, cmd-3
ConceptMap.group.unmapped.id 0..1 string Unique id for inter-element referencing
ConceptMap.group.unmapped.extension 0..* Extension Additional content defined by implementations
ConceptMap.group.unmapped.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
ConceptMap.group.unmapped.mode 1..1 code provided | fixed | other-map
Binding: ConceptMapGroupUnmappedMode (required): Defines which action to take if there is no match in the group.
ConceptMap.group.unmapped.code 0..1 code Fixed code when mode = fixed
ConceptMap.group.unmapped.display 0..1 string Display for the code
ConceptMap.group.unmapped.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

Path Status Usage ValueSet Version Source
ConceptMap.meta.security Base extensible SecurityLabels 📍4.0.1 FHIR Std.
ConceptMap.meta.tag Base example Common Tags 📍4.0.1 FHIR Std.
ConceptMap.language Base preferred Common Languages 📍4.0.1 FHIR Std.
ConceptMap.extension:relatedArtifact.​value[x].type Base required RelatedArtifactType 📍4.0.1 FHIR Std.
ConceptMap.status Base required PublicationStatus 📍4.0.1 FHIR Std.
ConceptMap.jurisdiction Base extensible Jurisdiction 📍4.0.1 FHIR Std.
ConceptMap.group.element.​target.equivalence Base required ConceptMapEquivalence 📍4.0.1 FHIR Std.
ConceptMap.group.unmapped.​mode Base required ConceptMapGroupUnmappedMode 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
cmd-0 warning ConceptMap Name 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-1 error ConceptMap.group.element.target If the map is narrower or inexact, there SHALL be some comments comment.exists() or equivalence.empty() or ((equivalence != 'narrower') and (equivalence != 'inexact'))
cmd-2 error ConceptMap.group.unmapped If the mode is 'fixed', a code must be provided (mode = 'fixed') implies code.exists()
cmd-3 error ConceptMap.group.unmapped If the mode is 'other-map', a url must be provided (mode = 'other-map') implies url.exists()
dom-2 error ConceptMap If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error ConceptMap If 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-4 error ConceptMap If 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-5 error ConceptMap If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice ConceptMap A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
pcm-1 warning ConceptMap A production (active and not experimental) concept map SHOULD specify version, publisher, copyright, and an effective period (status = 'active' and experimental.where($this = true).empty()) implies (version.exists() and publisher.exists() and copyright.exists() and extension('http://hl7.org/fhir/StructureDefinition/resource-effectivePeriod').exists())
pcm-2 warning ConceptMap A production (active and not experimental) concept map SHOULD specify the source and target code systems and versions for each group (status = 'active' and experimental.where($this = true).empty()) implies group.all(source.exists() and sourceVersion.exists() and target.exists() and targetVersion.exists())
pub-1 error ConceptMap If knowledge capabilities are stated, they SHALL include publishable extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').exists() implies extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').where(value = 'publishable').exists()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
ConceptMap C 1..1 ConceptMap A map from one set of concepts to one or more other concepts
Constraints: cmd-0, pub-1, pcm-1, pcm-2
ConceptMap.meta This element is included in summaries. 0..1 Meta Metadata about the resource
ConceptMap.meta.Slices for extension Content/Rules for all slices
ConceptMap.meta.Slices for extension.extension:packageSource This element must be supported. 0..1 (Complex) What package the artifact is defined in
URL: http://hl7.org/fhir/StructureDefinition/package-source
ConceptMap.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
ConceptMap.Slices for extension Content/Rules for all slices
ConceptMap.Slices for extension.extension:knowledgeCapability This element must be supported. C 0..* code shareable | computable | publishable | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability
Binding: KnowledgeCapability (required)
ConceptMap.Slices for extension.extension:copyrightLabel This element must be supported. 0..1 string Copyright holder and year(s)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
ConceptMap.Slices for extension.extension:approvalDate This element must be supported. 0..1 date When resource approved by publisher
URL: http://hl7.org/fhir/StructureDefinition/resource-approvalDate
ConceptMap.Slices for extension.extension:lastReviewDate This element must be supported. 0..1 date Last review date for the resource
URL: http://hl7.org/fhir/StructureDefinition/resource-lastReviewDate
ConceptMap.Slices for extension.extension:effectivePeriod This element must be supported. 0..1 Period The effective date range for the resource
URL: http://hl7.org/fhir/StructureDefinition/resource-effectivePeriod
ConceptMap.Slices for extension.extension:topic This element must be supported. 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc.
URL: http://hl7.org/fhir/StructureDefinition/artifact-topic
Binding: DefinitionTopic (example): Topics associated with the artifact
ConceptMap.Slices for extension.extension:author This element must be supported. 0..* ContactDetail Who authored the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-author
ConceptMap.Slices for extension.extension:editor This element must be supported. 0..* ContactDetail Who edited the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-editor
ConceptMap.Slices for extension.extension:reviewer This element must be supported. 0..* ContactDetail Who reviewed the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-reviewer
ConceptMap.Slices for extension.extension:endorser This element must be supported. 0..* ContactDetail Who endorsed the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-endorser
ConceptMap.Slices for extension.extension:relatedArtifact This element must be supported. 0..* (Complex) Additional documentation, citations, etc.
URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact
ConceptMap.Slices for extension.extension:relatedArtifact.extension 0..0 Extension
Slice: Unordered, Open by value:url
ConceptMap.Slices for extension.extension:relatedArtifact.url 1..1 uri "http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact"
ConceptMap.Slices for extension.extension:relatedArtifact.value[x] 1..1 RelatedArtifact Value of extension
ConceptMap.Slices for extension.extension:relatedArtifact.value[x].Slices for extension Content/Rules for all slices
ConceptMap.Slices for extension.extension:relatedArtifact.value[x].Slices for extension.extension:publicationDate 0..1 date Publication date of referenced artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationDate
ConceptMap.Slices for extension.extension:relatedArtifact.value[x].Slices for extension.extension:publicationStatus 0..1 code Publication status of referenced artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationStatus
Binding: PublicationStatus (required): The lifecycle status of a reference artifact
ConceptMap.Slices for extension.extension:relatedArtifact.value[x].type This element is included in summaries. 1..1 code documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of
Binding: RelatedArtifactType (required): The type of relationship to the related artifact.
ConceptMap.Slices for extension.extension:artifactComment 0..* (Complex) Additional documentation, review, or usage guidance
URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment
ConceptMap.Slices for extension.extension:authoritativeSource This element must be supported. 0..1 uri Original definitions
URL: http://hl7.org/fhir/StructureDefinition/artifact-authoritativeSource
ConceptMap.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
ConceptMap.identifier This element must be supported. This element is included in summaries. 0..1 Identifier Additional identifier for the concept map
ConceptMap.status This element is a modifier element. This element is included in summaries. 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
ConceptMap.date This element must be supported. This element is included in summaries. 1..1 dateTime Date last changed
ConceptMap.publisher This element must be supported. This element is included in summaries. C 0..1 string Name of the publisher (organization or individual)
ConceptMap.contact This element must be supported. This element is included in summaries. 0..* ContactDetail Contact details for the publisher
ConceptMap.useContext This element must be supported. This element is included in summaries. 0..* UsageContext The context that the content is intended to support
ConceptMap.jurisdiction This element must be supported. This element is included in summaries. 0..* CodeableConcept Intended jurisdiction for concept map (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.
ConceptMap.purpose This element must be supported. 0..1 markdown Why this concept map is defined
ConceptMap.copyright This element must be supported. C 0..1 markdown Use and/or publishing restrictions
ConceptMap.group 0..* BackboneElement Same source and target systems
ConceptMap.group.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
ConceptMap.group.source This element must be supported. C 0..1 uri Source system where concepts to be mapped are defined
ConceptMap.group.sourceVersion This element must be supported. C 0..1 string Specific version of the code system
ConceptMap.group.target This element must be supported. C 0..1 uri Target system that the concepts are to be mapped to
ConceptMap.group.targetVersion This element must be supported. C 0..1 string Specific version of the code system
ConceptMap.group.element 1..* BackboneElement Mappings for a concept from the source set
ConceptMap.group.element.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
ConceptMap.group.element.target C 0..* BackboneElement Concept in target system for element
Constraints: cmd-1
ConceptMap.group.element.target.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
ConceptMap.group.element.target.equivalence This element is a modifier element. This element must be supported. 1..1 code relatedto | equivalent | equal | wider | subsumes | narrower | specializes | inexact | unmatched | disjoint
Binding: ConceptMapEquivalence (required): The degree of equivalence between concepts.
ConceptMap.group.element.target.comment This element must be supported. C 0..1 string Description of status/issues in mapping
ConceptMap.group.element.target.dependsOn This element must be supported. 0..* BackboneElement Other elements required for this mapping (from context)
ConceptMap.group.element.target.dependsOn.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
ConceptMap.group.element.target.dependsOn.property 1..1 uri Reference to property mapping depends on
ConceptMap.group.element.target.dependsOn.value 1..1 string Value of the referenced element
ConceptMap.group.element.target.product This element must be supported. 0..* See dependsOn (ConceptMap) Other concepts that this mapping also produces

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ConceptMap.extension:relatedArtifact.​value[x].type Base required RelatedArtifactType 📍4.0.1 FHIR Std.
ConceptMap.status Base required PublicationStatus 📍4.0.1 FHIR Std.
ConceptMap.jurisdiction Base extensible Jurisdiction 📍4.0.1 FHIR Std.
ConceptMap.group.element.​target.equivalence Base required ConceptMapEquivalence 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
cmd-0 warning ConceptMap Name 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-1 error ConceptMap.group.element.target If the map is narrower or inexact, there SHALL be some comments comment.exists() or equivalence.empty() or ((equivalence != 'narrower') and (equivalence != 'inexact'))
dom-2 error ConceptMap If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error ConceptMap If 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-4 error ConceptMap If 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-5 error ConceptMap If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice ConceptMap A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
pcm-1 warning ConceptMap A production (active and not experimental) concept map SHOULD specify version, publisher, copyright, and an effective period (status = 'active' and experimental.where($this = true).empty()) implies (version.exists() and publisher.exists() and copyright.exists() and extension('http://hl7.org/fhir/StructureDefinition/resource-effectivePeriod').exists())
pcm-2 warning ConceptMap A production (active and not experimental) concept map SHOULD specify the source and target code systems and versions for each group (status = 'active' and experimental.where($this = true).empty()) implies group.all(source.exists() and sourceVersion.exists() and target.exists() and targetVersion.exists())
pub-1 error ConceptMap If knowledge capabilities are stated, they SHALL include publishable extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').exists() implies extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').where(value = 'publishable').exists()

Differential View

This structure is derived from ConceptMap

NameFlagsCard.TypeDescription & Constraints    Filter: doco
ConceptMap C 1..1 ConceptMap A map from one set of concepts to one or more other concepts
Constraints: pub-1, pcm-1, pcm-2
ConceptMap.meta
ConceptMap.meta.Slices for extension Content/Rules for all slices
ConceptMap.meta.Slices for extension.extension:packageSource This element must be supported. 0..1 (Complex) What package the artifact is defined in
URL: http://hl7.org/fhir/StructureDefinition/package-source
ConceptMap.Slices for extension Content/Rules for all slices
ConceptMap.Slices for extension.extension:knowledgeCapability This element must be supported. C 0..* code shareable | computable | publishable | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability
Binding: KnowledgeCapability (required)
ConceptMap.Slices for extension.extension:copyrightLabel This element must be supported. 0..1 string Copyright holder and year(s)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
ConceptMap.Slices for extension.extension:approvalDate This element must be supported. 0..1 date When resource approved by publisher
URL: http://hl7.org/fhir/StructureDefinition/resource-approvalDate
ConceptMap.Slices for extension.extension:lastReviewDate This element must be supported. 0..1 date Last review date for the resource
URL: http://hl7.org/fhir/StructureDefinition/resource-lastReviewDate
ConceptMap.Slices for extension.extension:effectivePeriod This element must be supported. 0..1 Period The effective date range for the resource
URL: http://hl7.org/fhir/StructureDefinition/resource-effectivePeriod
ConceptMap.Slices for extension.extension:topic This element must be supported. 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc.
URL: http://hl7.org/fhir/StructureDefinition/artifact-topic
Binding: DefinitionTopic (example): Topics associated with the artifact
ConceptMap.Slices for extension.extension:author This element must be supported. 0..* ContactDetail Who authored the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-author
ConceptMap.Slices for extension.extension:editor This element must be supported. 0..* ContactDetail Who edited the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-editor
ConceptMap.Slices for extension.extension:reviewer This element must be supported. 0..* ContactDetail Who reviewed the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-reviewer
ConceptMap.Slices for extension.extension:endorser This element must be supported. 0..* ContactDetail Who endorsed the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-endorser
ConceptMap.Slices for extension.extension:relatedArtifact This element must be supported. 0..* (Complex) Additional documentation, citations, etc.
URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact
ConceptMap.Slices for extension.extension:relatedArtifact.value[x]
ConceptMap.Slices for extension.extension:relatedArtifact.value[x].Slices for extension Content/Rules for all slices
ConceptMap.Slices for extension.extension:relatedArtifact.value[x].Slices for extension.extension:publicationDate 0..1 date Publication date of referenced artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationDate
ConceptMap.Slices for extension.extension:relatedArtifact.value[x].Slices for extension.extension:publicationStatus 0..1 code Publication status of referenced artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationStatus
Binding: PublicationStatus (required): The lifecycle status of a reference artifact
ConceptMap.Slices for extension.extension:artifactComment 0..* (Complex) Additional documentation, review, or usage guidance
URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment
ConceptMap.Slices for extension.extension:authoritativeSource This element must be supported. 0..1 uri Original definitions
URL: http://hl7.org/fhir/StructureDefinition/artifact-authoritativeSource
ConceptMap.identifier This element must be supported. 0..1 Identifier Additional identifier for the concept map
ConceptMap.date This element must be supported. 1..1 dateTime Date last changed
ConceptMap.publisher This element must be supported. C 0..1 string Name of the publisher (organization or individual)
ConceptMap.contact This element must be supported. 0..* ContactDetail Contact details for the publisher
ConceptMap.useContext This element must be supported. 0..* UsageContext The context that the content is intended to support
ConceptMap.jurisdiction This element must be supported. 0..* CodeableConcept Intended jurisdiction for concept map (if applicable)
ConceptMap.purpose This element must be supported. 0..1 markdown Why this concept map is defined
ConceptMap.copyright This element must be supported. C 0..1 markdown Use and/or publishing restrictions
ConceptMap.group
ConceptMap.group.source This element must be supported. C 0..1 uri Source system where concepts to be mapped are defined
ConceptMap.group.sourceVersion This element must be supported. C 0..1 string Specific version of the code system
ConceptMap.group.target This element must be supported. C 0..1 uri Target system that the concepts are to be mapped to
ConceptMap.group.targetVersion This element must be supported. C 0..1 string Specific version of the code system
ConceptMap.group.element
ConceptMap.group.element.target
ConceptMap.group.element.target.equivalence This element must be supported. 1..1 code relatedto | equivalent | equal | wider | subsumes | narrower | specializes | inexact | unmatched | disjoint
ConceptMap.group.element.target.comment This element must be supported. 0..1 string Description of status/issues in mapping
ConceptMap.group.element.target.dependsOn This element must be supported. 0..* BackboneElement Other elements required for this mapping (from context)
ConceptMap.group.element.target.product This element must be supported. 0..* Other concepts that this mapping also produces

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
pcm-1 warning ConceptMap A production (active and not experimental) concept map SHOULD specify version, publisher, copyright, and an effective period (status = 'active' and experimental.where($this = true).empty()) implies (version.exists() and publisher.exists() and copyright.exists() and extension('http://hl7.org/fhir/StructureDefinition/resource-effectivePeriod').exists())
pcm-2 warning ConceptMap A production (active and not experimental) concept map SHOULD specify the source and target code systems and versions for each group (status = 'active' and experimental.where($this = true).empty()) implies group.all(source.exists() and sourceVersion.exists() and target.exists() and targetVersion.exists())
pub-1 error ConceptMap If knowledge capabilities are stated, they SHALL include publishable extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').exists() implies extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').where(value = 'publishable').exists()

Snapshot ViewView

NameFlagsCard.TypeDescription & Constraints    Filter: doco
ConceptMap C 1..1 ConceptMap A map from one set of concepts to one or more other concepts
Constraints: cmd-0, pub-1, pcm-1, pcm-2
ConceptMap.id This element is included in summaries. 0..1 id Logical id of this artifact
ConceptMap.meta This element is included in summaries. 0..1 Meta Metadata about the resource
ConceptMap.meta.id 0..1 string Unique id for inter-element referencing
ConceptMap.meta.Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
ConceptMap.meta.Slices for extension.extension:packageSource This element must be supported. 0..1 (Complex) What package the artifact is defined in
URL: http://hl7.org/fhir/StructureDefinition/package-source
ConceptMap.meta.versionId This element is included in summaries. 0..1 id Version specific identifier
ConceptMap.meta.lastUpdated This element is included in summaries. 0..1 instant When the resource version last changed
ConceptMap.meta.source This element is included in summaries. 0..1 uri Identifies where the resource comes from
ConceptMap.meta.profile This element is included in summaries. 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
ConceptMap.meta.security This element is included in summaries. 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
ConceptMap.meta.tag This element is included in summaries. 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
ConceptMap.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
ConceptMap.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
ConceptMap.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
ConceptMap.contained 0..* Resource Contained, inline Resources
ConceptMap.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
ConceptMap.Slices for extension.extension:knowledgeCapability This element must be supported. C 0..* code shareable | computable | publishable | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability
Binding: KnowledgeCapability (required)
ConceptMap.Slices for extension.extension:copyrightLabel This element must be supported. 0..1 string Copyright holder and year(s)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
ConceptMap.Slices for extension.extension:approvalDate This element must be supported. 0..1 date When resource approved by publisher
URL: http://hl7.org/fhir/StructureDefinition/resource-approvalDate
ConceptMap.Slices for extension.extension:lastReviewDate This element must be supported. 0..1 date Last review date for the resource
URL: http://hl7.org/fhir/StructureDefinition/resource-lastReviewDate
ConceptMap.Slices for extension.extension:effectivePeriod This element must be supported. 0..1 Period The effective date range for the resource
URL: http://hl7.org/fhir/StructureDefinition/resource-effectivePeriod
ConceptMap.Slices for extension.extension:topic This element must be supported. 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc.
URL: http://hl7.org/fhir/StructureDefinition/artifact-topic
Binding: DefinitionTopic (example): Topics associated with the artifact
ConceptMap.Slices for extension.extension:author This element must be supported. 0..* ContactDetail Who authored the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-author
ConceptMap.Slices for extension.extension:editor This element must be supported. 0..* ContactDetail Who edited the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-editor
ConceptMap.Slices for extension.extension:reviewer This element must be supported. 0..* ContactDetail Who reviewed the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-reviewer
ConceptMap.Slices for extension.extension:endorser This element must be supported. 0..* ContactDetail Who endorsed the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-endorser
ConceptMap.Slices for extension.extension:relatedArtifact This element must be supported. 0..* (Complex) Additional documentation, citations, etc.
URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact
ConceptMap.Slices for extension.extension:relatedArtifact.id 0..1 string Unique id for inter-element referencing
ConceptMap.Slices for extension.extension:relatedArtifact.extension 0..0 Extension
Slice: Unordered, Open by value:url
ConceptMap.Slices for extension.extension:relatedArtifact.url 1..1 uri "http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact"
ConceptMap.Slices for extension.extension:relatedArtifact.value[x] 1..1 RelatedArtifact Value of extension
ConceptMap.Slices for extension.extension:relatedArtifact.value[x].id 0..1 string Unique id for inter-element referencing
ConceptMap.Slices for extension.extension:relatedArtifact.value[x].Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
ConceptMap.Slices for extension.extension:relatedArtifact.value[x].Slices for extension Content/Rules for all slices
ConceptMap.Slices for extension.extension:relatedArtifact.value[x].Slices for extension.extension:publicationDate 0..1 date Publication date of referenced artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationDate
ConceptMap.Slices for extension.extension:relatedArtifact.value[x].Slices for extension.extension:publicationStatus 0..1 code Publication status of referenced artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationStatus
Binding: PublicationStatus (required): The lifecycle status of a reference artifact
ConceptMap.Slices for extension.extension:relatedArtifact.value[x].type This element is included in summaries. 1..1 code documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of
Binding: RelatedArtifactType (required): The type of relationship to the related artifact.
ConceptMap.Slices for extension.extension:relatedArtifact.value[x].label This element is included in summaries. 0..1 string Short label
ConceptMap.Slices for extension.extension:relatedArtifact.value[x].display This element is included in summaries. 0..1 string Brief description of the related artifact
ConceptMap.Slices for extension.extension:relatedArtifact.value[x].citation This element is included in summaries. 0..1 markdown Bibliographic citation for the artifact
ConceptMap.Slices for extension.extension:relatedArtifact.value[x].url This element is included in summaries. 0..1 url Where the artifact can be accessed
ConceptMap.Slices for extension.extension:relatedArtifact.value[x].document This element is included in summaries. 0..1 Attachment What document is being referenced
ConceptMap.Slices for extension.extension:relatedArtifact.value[x].resource This element is included in summaries. 0..1 canonical(Resource) What resource is being referenced
ConceptMap.Slices for extension.extension:artifactComment 0..* (Complex) Additional documentation, review, or usage guidance
URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment
ConceptMap.Slices for extension.extension:authoritativeSource This element must be supported. 0..1 uri Original definitions
URL: http://hl7.org/fhir/StructureDefinition/artifact-authoritativeSource
ConceptMap.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
ConceptMap.url This element is included in summaries. 0..1 uri Canonical identifier for this concept map, represented as a URI (globally unique)
ConceptMap.identifier This element must be supported. This element is included in summaries. 0..1 Identifier Additional identifier for the concept map
ConceptMap.version This element is included in summaries. 0..1 string Business version of the concept map
ConceptMap.name This element is included in summaries. C 0..1 string Name for this concept map (computer friendly)
ConceptMap.title This element is included in summaries. 0..1 string Name for this concept map (human friendly)
ConceptMap.status This element is a modifier element. This element is included in summaries. 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
ConceptMap.experimental This element is included in summaries. 0..1 boolean For testing purposes, not real usage
ConceptMap.date This element must be supported. This element is included in summaries. 1..1 dateTime Date last changed
ConceptMap.publisher This element must be supported. This element is included in summaries. C 0..1 string Name of the publisher (organization or individual)
ConceptMap.contact This element must be supported. This element is included in summaries. 0..* ContactDetail Contact details for the publisher
ConceptMap.description 0..1 markdown Natural language description of the concept map
ConceptMap.useContext This element must be supported. This element is included in summaries. 0..* UsageContext The context that the content is intended to support
ConceptMap.jurisdiction This element must be supported. This element is included in summaries. 0..* CodeableConcept Intended jurisdiction for concept map (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.
ConceptMap.purpose This element must be supported. 0..1 markdown Why this concept map is defined
ConceptMap.copyright This element must be supported. C 0..1 markdown Use and/or publishing restrictions
ConceptMap.source[x] This element is included in summaries. 0..1 The source value set that contains the concepts that are being mapped
ConceptMap.source[x].sourceUri uri
ConceptMap.source[x].sourceCanonical canonical(ValueSet)
ConceptMap.target[x] This element is included in summaries. 0..1 The target value set which provides context for the mappings
ConceptMap.target[x].targetUri uri
ConceptMap.target[x].targetCanonical canonical(ValueSet)
ConceptMap.group 0..* BackboneElement Same source and target systems
ConceptMap.group.id 0..1 string Unique id for inter-element referencing
ConceptMap.group.extension 0..* Extension Additional content defined by implementations
ConceptMap.group.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
ConceptMap.group.source This element must be supported. C 0..1 uri Source system where concepts to be mapped are defined
ConceptMap.group.sourceVersion This element must be supported. C 0..1 string Specific version of the code system
ConceptMap.group.target This element must be supported. C 0..1 uri Target system that the concepts are to be mapped to
ConceptMap.group.targetVersion This element must be supported. C 0..1 string Specific version of the code system
ConceptMap.group.element 1..* BackboneElement Mappings for a concept from the source set
ConceptMap.group.element.id 0..1 string Unique id for inter-element referencing
ConceptMap.group.element.extension 0..* Extension Additional content defined by implementations
ConceptMap.group.element.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
ConceptMap.group.element.code 0..1 code Identifies element being mapped
ConceptMap.group.element.display 0..1 string Display for the code
ConceptMap.group.element.target C 0..* BackboneElement Concept in target system for element
Constraints: cmd-1
ConceptMap.group.element.target.id 0..1 string Unique id for inter-element referencing
ConceptMap.group.element.target.extension 0..* Extension Additional content defined by implementations
ConceptMap.group.element.target.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
ConceptMap.group.element.target.code 0..1 code Code that identifies the target element
ConceptMap.group.element.target.display 0..1 string Display for the code
ConceptMap.group.element.target.equivalence This element is a modifier element. This element must be supported. 1..1 code relatedto | equivalent | equal | wider | subsumes | narrower | specializes | inexact | unmatched | disjoint
Binding: ConceptMapEquivalence (required): The degree of equivalence between concepts.
ConceptMap.group.element.target.comment This element must be supported. C 0..1 string Description of status/issues in mapping
ConceptMap.group.element.target.dependsOn This element must be supported. 0..* BackboneElement Other elements required for this mapping (from context)
ConceptMap.group.element.target.dependsOn.id 0..1 string Unique id for inter-element referencing
ConceptMap.group.element.target.dependsOn.extension 0..* Extension Additional content defined by implementations
ConceptMap.group.element.target.dependsOn.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
ConceptMap.group.element.target.dependsOn.property 1..1 uri Reference to property mapping depends on
ConceptMap.group.element.target.dependsOn.system 0..1 canonical(CodeSystem) Code System (if necessary)
ConceptMap.group.element.target.dependsOn.value 1..1 string Value of the referenced element
ConceptMap.group.element.target.dependsOn.display 0..1 string Display for the code (if value is a code)
ConceptMap.group.element.target.product This element must be supported. 0..* See dependsOn (ConceptMap) Other concepts that this mapping also produces
ConceptMap.group.unmapped C 0..1 BackboneElement What to do when there is no mapping for the source concept
Constraints: cmd-2, cmd-3
ConceptMap.group.unmapped.id 0..1 string Unique id for inter-element referencing
ConceptMap.group.unmapped.extension 0..* Extension Additional content defined by implementations
ConceptMap.group.unmapped.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
ConceptMap.group.unmapped.mode 1..1 code provided | fixed | other-map
Binding: ConceptMapGroupUnmappedMode (required): Defines which action to take if there is no match in the group.
ConceptMap.group.unmapped.code 0..1 code Fixed code when mode = fixed
ConceptMap.group.unmapped.display 0..1 string Display for the code
ConceptMap.group.unmapped.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

Path Status Usage ValueSet Version Source
ConceptMap.meta.security Base extensible SecurityLabels 📍4.0.1 FHIR Std.
ConceptMap.meta.tag Base example Common Tags 📍4.0.1 FHIR Std.
ConceptMap.language Base preferred Common Languages 📍4.0.1 FHIR Std.
ConceptMap.extension:relatedArtifact.​value[x].type Base required RelatedArtifactType 📍4.0.1 FHIR Std.
ConceptMap.status Base required PublicationStatus 📍4.0.1 FHIR Std.
ConceptMap.jurisdiction Base extensible Jurisdiction 📍4.0.1 FHIR Std.
ConceptMap.group.element.​target.equivalence Base required ConceptMapEquivalence 📍4.0.1 FHIR Std.
ConceptMap.group.unmapped.​mode Base required ConceptMapGroupUnmappedMode 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
cmd-0 warning ConceptMap Name 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-1 error ConceptMap.group.element.target If the map is narrower or inexact, there SHALL be some comments comment.exists() or equivalence.empty() or ((equivalence != 'narrower') and (equivalence != 'inexact'))
cmd-2 error ConceptMap.group.unmapped If the mode is 'fixed', a code must be provided (mode = 'fixed') implies code.exists()
cmd-3 error ConceptMap.group.unmapped If the mode is 'other-map', a url must be provided (mode = 'other-map') implies url.exists()
dom-2 error ConceptMap If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error ConceptMap If 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-4 error ConceptMap If 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-5 error ConceptMap If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice ConceptMap A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
pcm-1 warning ConceptMap A production (active and not experimental) concept map SHOULD specify version, publisher, copyright, and an effective period (status = 'active' and experimental.where($this = true).empty()) implies (version.exists() and publisher.exists() and copyright.exists() and extension('http://hl7.org/fhir/StructureDefinition/resource-effectivePeriod').exists())
pcm-2 warning ConceptMap A production (active and not experimental) concept map SHOULD specify the source and target code systems and versions for each group (status = 'active' and experimental.where($this = true).empty()) implies group.all(source.exists() and sourceVersion.exists() and target.exists() and targetVersion.exists())
pub-1 error ConceptMap If knowledge capabilities are stated, they SHALL include publishable extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').exists() implies extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').where(value = 'publishable').exists()

 

Other representations of profile: CSV, Excel, Schematron