Canonical Resource Management Infrastructure Implementation Guide
2.0.0 - STU 2 International flag

Canonical Resource 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 2.0.0 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: CRMI Publishable ConceptMap

Official URL: http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-publishableconceptmap Version: 2.0.0
Standards status: Trial-use Maturity Level: 1 Responsible: HL7 International / Terminology Infrastructure 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

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: Filtersdoco
.. ConceptMap C 1..1 ConceptMap A map from one set of concepts to one or more other concepts
Constraints: cmd-0, pub-1
... meta Σ 0..1 Meta Metadata about the resource
.... Slices for extension Content/Rules for all slices
..... extension:packageSource S 0..1 (Complex) What package the artifact is defined in
URL: http://hl7.org/fhir/StructureDefinition/package-source
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension Content/Rules for all slices
.... extension:knowledgeCapability SC 0..* code shareable | computable | publishable | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability
Binding: KnowledgeCapability (required)
.... extension:copyrightLabel S 0..1 string Copyright holder and year(s)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
.... extension:approvalDate S 0..1 date When resource approved by publisher
URL: http://hl7.org/fhir/StructureDefinition/resource-approvalDate
.... extension:lastReviewDate S 0..1 date Last review date for the resource
URL: http://hl7.org/fhir/StructureDefinition/resource-lastReviewDate
.... extension:effectivePeriod S 0..1 Period The effective date range for the resource
URL: http://hl7.org/fhir/StructureDefinition/resource-effectivePeriod
.... extension: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
.... extension:author S 0..* ContactDetail Who authored the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-author
.... extension:editor S 0..* ContactDetail Who edited the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-editor
.... extension:reviewer S 0..* ContactDetail Who reviewed the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-reviewer
.... extension:endorser S 0..* ContactDetail Who endorsed the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-endorser
.... extension:relatedArtifact S 0..* (Complex) Additional documentation, citations, etc.
URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact"
..... value[x] 1..1 RelatedArtifact Value of extension
...... Slices for extension Content/Rules for all slices
....... extension:publicationDate 0..1 date Publication date of referenced artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationDate
....... 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
...... type Σ 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.
.... extension:artifactComment 0..* (Complex) Additional documentation, review, or usage guidance
URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment
.... extension:authoritativeSource S 0..1 uri Original definitions
URL: http://hl7.org/fhir/StructureDefinition/artifact-authoritativeSource
... 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

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.

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}')
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()
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: Filtersdoco
.. ConceptMap C 1..1 ConceptMap A map from one set of concepts to one or more other concepts
Constraints: pub-1
... meta
.... Slices for extension Content/Rules for all slices
..... extension:packageSource S 0..1 (Complex) What package the artifact is defined in
URL: http://hl7.org/fhir/StructureDefinition/package-source
... Slices for extension Content/Rules for all slices
.... extension:knowledgeCapability SC 0..* code shareable | computable | publishable | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability
Binding: KnowledgeCapability (required)
.... extension:copyrightLabel S 0..1 string Copyright holder and year(s)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
.... extension:approvalDate S 0..1 date When resource approved by publisher
URL: http://hl7.org/fhir/StructureDefinition/resource-approvalDate
.... extension:lastReviewDate S 0..1 date Last review date for the resource
URL: http://hl7.org/fhir/StructureDefinition/resource-lastReviewDate
.... extension:effectivePeriod S 0..1 Period The effective date range for the resource
URL: http://hl7.org/fhir/StructureDefinition/resource-effectivePeriod
.... extension: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
.... extension:author S 0..* ContactDetail Who authored the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-author
.... extension:editor S 0..* ContactDetail Who edited the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-editor
.... extension:reviewer S 0..* ContactDetail Who reviewed the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-reviewer
.... extension:endorser S 0..* ContactDetail Who endorsed the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-endorser
.... extension:relatedArtifact S 0..* (Complex) Additional documentation, citations, etc.
URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact
..... value[x]
...... Slices for extension Content/Rules for all slices
....... extension:publicationDate 0..1 date Publication date of referenced artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationDate
....... 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
.... extension:artifactComment 0..* (Complex) Additional documentation, review, or usage guidance
URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment
.... extension:authoritativeSource S 0..1 uri Original definitions
URL: http://hl7.org/fhir/StructureDefinition/artifact-authoritativeSource
... identifier S 0..1 Identifier Additional identifier for the concept map
... 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

Constraints

Id Grade Path(s) Description Expression
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: Filtersdoco
.. ConceptMap C 1..1 ConceptMap A map from one set of concepts to one or more other concepts
Constraints: cmd-0, pub-1
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... extension:packageSource S 0..1 (Complex) What package the artifact is defined in
URL: http://hl7.org/fhir/StructureDefinition/package-source
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile Σ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
.... tag Σ 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".
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:knowledgeCapability SC 0..* code shareable | computable | publishable | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability
Binding: KnowledgeCapability (required)
.... extension:copyrightLabel S 0..1 string Copyright holder and year(s)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
.... extension:approvalDate S 0..1 date When resource approved by publisher
URL: http://hl7.org/fhir/StructureDefinition/resource-approvalDate
.... extension:lastReviewDate S 0..1 date Last review date for the resource
URL: http://hl7.org/fhir/StructureDefinition/resource-lastReviewDate
.... extension:effectivePeriod S 0..1 Period The effective date range for the resource
URL: http://hl7.org/fhir/StructureDefinition/resource-effectivePeriod
.... extension: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
.... extension:author S 0..* ContactDetail Who authored the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-author
.... extension:editor S 0..* ContactDetail Who edited the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-editor
.... extension:reviewer S 0..* ContactDetail Who reviewed the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-reviewer
.... extension:endorser S 0..* ContactDetail Who endorsed the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-endorser
.... extension:relatedArtifact S 0..* (Complex) Additional documentation, citations, etc.
URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact"
..... value[x] 1..1 RelatedArtifact Value of extension
...... id 0..1 string Unique id for inter-element referencing
...... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... extension:publicationDate 0..1 date Publication date of referenced artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationDate
....... 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
...... type Σ 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.
...... label Σ 0..1 string Short label
...... display Σ 0..1 string Brief description of the related artifact
...... citation Σ 0..1 markdown Bibliographic citation for the artifact
...... url Σ 0..1 url Where the artifact can be accessed
...... document Σ 0..1 Attachment What document is being referenced
...... resource Σ 0..1 canonical(Resource) What resource is being referenced
.... extension:artifactComment 0..* (Complex) Additional documentation, review, or usage guidance
URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment
.... extension:authoritativeSource S 0..1 uri Original definitions
URL: http://hl7.org/fhir/StructureDefinition/artifact-authoritativeSource
... 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
Constraints: cmd-1
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... code 0..1 code Code that identifies the target element
...... display 0..1 string Display for the code
...... equivalence ?! 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
Constraints: cmd-2, cmd-3
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... mode 1..1 code provided | fixed | other-map
Binding: ConceptMapGroupUnmappedMode (required): Defines which action to take if there is no match in the group.
..... code 0..1 code Fixed code when mode = fixed
..... display 0..1 string Display for the code
..... url 0..1 canonical(ConceptMap) canonical reference to an additional ConceptMap to use for mapping if the source concept is unmapped

doco Documentation for this format

Terminology Bindings

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()
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: Filtersdoco
.. ConceptMap C 1..1 ConceptMap A map from one set of concepts to one or more other concepts
Constraints: cmd-0, pub-1
... meta Σ 0..1 Meta Metadata about the resource
.... Slices for extension Content/Rules for all slices
..... extension:packageSource S 0..1 (Complex) What package the artifact is defined in
URL: http://hl7.org/fhir/StructureDefinition/package-source
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension Content/Rules for all slices
.... extension:knowledgeCapability SC 0..* code shareable | computable | publishable | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability
Binding: KnowledgeCapability (required)
.... extension:copyrightLabel S 0..1 string Copyright holder and year(s)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
.... extension:approvalDate S 0..1 date When resource approved by publisher
URL: http://hl7.org/fhir/StructureDefinition/resource-approvalDate
.... extension:lastReviewDate S 0..1 date Last review date for the resource
URL: http://hl7.org/fhir/StructureDefinition/resource-lastReviewDate
.... extension:effectivePeriod S 0..1 Period The effective date range for the resource
URL: http://hl7.org/fhir/StructureDefinition/resource-effectivePeriod
.... extension: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
.... extension:author S 0..* ContactDetail Who authored the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-author
.... extension:editor S 0..* ContactDetail Who edited the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-editor
.... extension:reviewer S 0..* ContactDetail Who reviewed the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-reviewer
.... extension:endorser S 0..* ContactDetail Who endorsed the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-endorser
.... extension:relatedArtifact S 0..* (Complex) Additional documentation, citations, etc.
URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact"
..... value[x] 1..1 RelatedArtifact Value of extension
...... Slices for extension Content/Rules for all slices
....... extension:publicationDate 0..1 date Publication date of referenced artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationDate
....... 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
...... type Σ 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.
.... extension:artifactComment 0..* (Complex) Additional documentation, review, or usage guidance
URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment
.... extension:authoritativeSource S 0..1 uri Original definitions
URL: http://hl7.org/fhir/StructureDefinition/artifact-authoritativeSource
... 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

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.

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}')
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()
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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ConceptMap C 1..1 ConceptMap A map from one set of concepts to one or more other concepts
Constraints: pub-1
... meta
.... Slices for extension Content/Rules for all slices
..... extension:packageSource S 0..1 (Complex) What package the artifact is defined in
URL: http://hl7.org/fhir/StructureDefinition/package-source
... Slices for extension Content/Rules for all slices
.... extension:knowledgeCapability SC 0..* code shareable | computable | publishable | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability
Binding: KnowledgeCapability (required)
.... extension:copyrightLabel S 0..1 string Copyright holder and year(s)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
.... extension:approvalDate S 0..1 date When resource approved by publisher
URL: http://hl7.org/fhir/StructureDefinition/resource-approvalDate
.... extension:lastReviewDate S 0..1 date Last review date for the resource
URL: http://hl7.org/fhir/StructureDefinition/resource-lastReviewDate
.... extension:effectivePeriod S 0..1 Period The effective date range for the resource
URL: http://hl7.org/fhir/StructureDefinition/resource-effectivePeriod
.... extension: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
.... extension:author S 0..* ContactDetail Who authored the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-author
.... extension:editor S 0..* ContactDetail Who edited the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-editor
.... extension:reviewer S 0..* ContactDetail Who reviewed the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-reviewer
.... extension:endorser S 0..* ContactDetail Who endorsed the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-endorser
.... extension:relatedArtifact S 0..* (Complex) Additional documentation, citations, etc.
URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact
..... value[x]
...... Slices for extension Content/Rules for all slices
....... extension:publicationDate 0..1 date Publication date of referenced artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationDate
....... 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
.... extension:artifactComment 0..* (Complex) Additional documentation, review, or usage guidance
URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment
.... extension:authoritativeSource S 0..1 uri Original definitions
URL: http://hl7.org/fhir/StructureDefinition/artifact-authoritativeSource
... identifier S 0..1 Identifier Additional identifier for the concept map
... 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

Constraints

Id Grade Path(s) Description Expression
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: Filtersdoco
.. ConceptMap C 1..1 ConceptMap A map from one set of concepts to one or more other concepts
Constraints: cmd-0, pub-1
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... extension:packageSource S 0..1 (Complex) What package the artifact is defined in
URL: http://hl7.org/fhir/StructureDefinition/package-source
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile Σ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
.... tag Σ 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".
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:knowledgeCapability SC 0..* code shareable | computable | publishable | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability
Binding: KnowledgeCapability (required)
.... extension:copyrightLabel S 0..1 string Copyright holder and year(s)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
.... extension:approvalDate S 0..1 date When resource approved by publisher
URL: http://hl7.org/fhir/StructureDefinition/resource-approvalDate
.... extension:lastReviewDate S 0..1 date Last review date for the resource
URL: http://hl7.org/fhir/StructureDefinition/resource-lastReviewDate
.... extension:effectivePeriod S 0..1 Period The effective date range for the resource
URL: http://hl7.org/fhir/StructureDefinition/resource-effectivePeriod
.... extension: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
.... extension:author S 0..* ContactDetail Who authored the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-author
.... extension:editor S 0..* ContactDetail Who edited the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-editor
.... extension:reviewer S 0..* ContactDetail Who reviewed the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-reviewer
.... extension:endorser S 0..* ContactDetail Who endorsed the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-endorser
.... extension:relatedArtifact S 0..* (Complex) Additional documentation, citations, etc.
URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact"
..... value[x] 1..1 RelatedArtifact Value of extension
...... id 0..1 string Unique id for inter-element referencing
...... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... extension:publicationDate 0..1 date Publication date of referenced artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationDate
....... 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
...... type Σ 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.
...... label Σ 0..1 string Short label
...... display Σ 0..1 string Brief description of the related artifact
...... citation Σ 0..1 markdown Bibliographic citation for the artifact
...... url Σ 0..1 url Where the artifact can be accessed
...... document Σ 0..1 Attachment What document is being referenced
...... resource Σ 0..1 canonical(Resource) What resource is being referenced
.... extension:artifactComment 0..* (Complex) Additional documentation, review, or usage guidance
URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment
.... extension:authoritativeSource S 0..1 uri Original definitions
URL: http://hl7.org/fhir/StructureDefinition/artifact-authoritativeSource
... 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
Constraints: cmd-1
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... code 0..1 code Code that identifies the target element
...... display 0..1 string Display for the code
...... equivalence ?! 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
Constraints: cmd-2, cmd-3
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... mode 1..1 code provided | fixed | other-map
Binding: ConceptMapGroupUnmappedMode (required): Defines which action to take if there is no match in the group.
..... code 0..1 code Fixed code when mode = fixed
..... display 0..1 string Display for the code
..... url 0..1 canonical(ConceptMap) canonical reference to an additional ConceptMap to use for mapping if the source concept is unmapped

doco Documentation for this format

Terminology Bindings

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()
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