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
| Official URL: http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-publishableconceptmap | Version: 3.0.0-ballot | ||||
| 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. 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)
Usages:
You can also check for usages in the FHIR IG Statistics
Description Differentials, Snapshots, and other representations.
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() |
|---|---|---|---|---|
![]() |
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 |
![]() ![]() |
0..1 | Meta | Metadata about the resource | |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
0..1 | (Complex) | What package the artifact is defined in URL: http://hl7.org/fhir/StructureDefinition/package-source | |
![]() ![]() |
0..1 | uri | A set of rules under which this content was created | |
![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() |
C | 0..* | code | shareable | computable | publishable | executable URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability Binding: KnowledgeCapability (required) |
![]() ![]() ![]() |
0..1 | string | Copyright holder and year(s) URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel | |
![]() ![]() ![]() |
0..1 | date | When resource approved by publisher URL: http://hl7.org/fhir/StructureDefinition/resource-approvalDate | |
![]() ![]() ![]() |
0..1 | date | Last review date for the resource URL: http://hl7.org/fhir/StructureDefinition/resource-lastReviewDate | |
![]() ![]() ![]() |
0..1 | Period | The effective date range for the resource URL: http://hl7.org/fhir/StructureDefinition/resource-effectivePeriod | |
![]() ![]() ![]() |
0..* | CodeableConcept | E.g. Education, Treatment, Assessment, etc. URL: http://hl7.org/fhir/StructureDefinition/artifact-topic Binding: DefinitionTopic (example): Topics associated with the artifact | |
![]() ![]() ![]() |
0..* | ContactDetail | Who authored the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-author | |
![]() ![]() ![]() |
0..* | ContactDetail | Who edited the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-editor | |
![]() ![]() ![]() |
0..* | ContactDetail | Who reviewed the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-reviewer | |
![]() ![]() ![]() |
0..* | ContactDetail | Who endorsed the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-endorser | |
![]() ![]() ![]() |
0..* | (Complex) | Additional documentation, citations, etc. URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact | |
![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||
![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact" | |
![]() ![]() ![]() ![]() |
1..1 | RelatedArtifact | Value of extension | |
![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | date | Publication date of referenced artifact URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationDate | |
![]() ![]() ![]() ![]() ![]() ![]() |
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 | |
![]() ![]() ![]() ![]() ![]() |
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. | |
![]() ![]() ![]() |
0..* | (Complex) | Additional documentation, review, or usage guidance URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment | |
![]() ![]() ![]() |
0..1 | uri | Original definitions URL: http://hl7.org/fhir/StructureDefinition/artifact-authoritativeSource | |
![]() ![]() |
0..* | Extension | Extensions that cannot be ignored | |
![]() ![]() |
0..1 | Identifier | Additional identifier for the concept map | |
![]() ![]() |
1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. | |
![]() ![]() |
1..1 | dateTime | Date last changed | |
![]() ![]() |
C | 0..1 | string | Name of the publisher (organization or individual) |
![]() ![]() |
0..* | ContactDetail | Contact details for the publisher | |
![]() ![]() |
0..* | UsageContext | The context that the content is intended to support | |
![]() ![]() |
0..* | CodeableConcept | Intended jurisdiction for concept map (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use. | |
![]() ![]() |
0..1 | markdown | Why this concept map is defined | |
![]() ![]() |
C | 0..1 | markdown | Use and/or publishing restrictions |
![]() ![]() |
0..* | BackboneElement | Same source and target systems | |
![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
![]() ![]() ![]() |
C | 0..1 | uri | Source system where concepts to be mapped are defined |
![]() ![]() ![]() |
C | 0..1 | string | Specific version of the code system |
![]() ![]() ![]() |
C | 0..1 | uri | Target system that the concepts are to be mapped to |
![]() ![]() ![]() |
C | 0..1 | string | Specific version of the code system |
![]() ![]() ![]() |
1..* | BackboneElement | Mappings for a concept from the source set | |
![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
![]() ![]() ![]() ![]() |
C | 0..* | BackboneElement | Concept in target system for element Constraints: cmd-1 |
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
![]() ![]() ![]() ![]() ![]() |
1..1 | code | relatedto | equivalent | equal | wider | subsumes | narrower | specializes | inexact | unmatched | disjoint Binding: ConceptMapEquivalence (required): The degree of equivalence between concepts. | |
![]() ![]() ![]() ![]() ![]() |
C | 0..1 | string | Description of status/issues in mapping |
![]() ![]() ![]() ![]() ![]() |
0..* | BackboneElement | Other elements required for this mapping (from context) | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Reference to property mapping depends on | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | string | Value of the referenced element | |
![]() ![]() ![]() ![]() ![]() |
0..* | See dependsOn (ConceptMap) | Other concepts that this mapping also produces | |
Documentation for this format | ||||
| 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. |
| 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
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() |
|---|---|---|---|---|
![]() |
C | 1..1 | ConceptMap | A map from one set of concepts to one or more other concepts Constraints: pub-1, pcm-1, pcm-2 |
![]() ![]() |
||||
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
0..1 | (Complex) | What package the artifact is defined in URL: http://hl7.org/fhir/StructureDefinition/package-source | |
![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() |
C | 0..* | code | shareable | computable | publishable | executable URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability Binding: KnowledgeCapability (required) |
![]() ![]() ![]() |
0..1 | string | Copyright holder and year(s) URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel | |
![]() ![]() ![]() |
0..1 | date | When resource approved by publisher URL: http://hl7.org/fhir/StructureDefinition/resource-approvalDate | |
![]() ![]() ![]() |
0..1 | date | Last review date for the resource URL: http://hl7.org/fhir/StructureDefinition/resource-lastReviewDate | |
![]() ![]() ![]() |
0..1 | Period | The effective date range for the resource URL: http://hl7.org/fhir/StructureDefinition/resource-effectivePeriod | |
![]() ![]() ![]() |
0..* | CodeableConcept | E.g. Education, Treatment, Assessment, etc. URL: http://hl7.org/fhir/StructureDefinition/artifact-topic Binding: DefinitionTopic (example): Topics associated with the artifact | |
![]() ![]() ![]() |
0..* | ContactDetail | Who authored the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-author | |
![]() ![]() ![]() |
0..* | ContactDetail | Who edited the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-editor | |
![]() ![]() ![]() |
0..* | ContactDetail | Who reviewed the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-reviewer | |
![]() ![]() ![]() |
0..* | ContactDetail | Who endorsed the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-endorser | |
![]() ![]() ![]() |
0..* | (Complex) | Additional documentation, citations, etc. URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact | |
![]() ![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | date | Publication date of referenced artifact URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationDate | |
![]() ![]() ![]() ![]() ![]() ![]() |
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 | |
![]() ![]() ![]() |
0..* | (Complex) | Additional documentation, review, or usage guidance URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment | |
![]() ![]() ![]() |
0..1 | uri | Original definitions URL: http://hl7.org/fhir/StructureDefinition/artifact-authoritativeSource | |
![]() ![]() |
0..1 | Identifier | Additional identifier for the concept map | |
![]() ![]() |
1..1 | dateTime | Date last changed | |
![]() ![]() |
C | 0..1 | string | Name of the publisher (organization or individual) |
![]() ![]() |
0..* | ContactDetail | Contact details for the publisher | |
![]() ![]() |
0..* | UsageContext | The context that the content is intended to support | |
![]() ![]() |
0..* | CodeableConcept | Intended jurisdiction for concept map (if applicable) | |
![]() ![]() |
0..1 | markdown | Why this concept map is defined | |
![]() ![]() |
C | 0..1 | markdown | Use and/or publishing restrictions |
![]() ![]() |
||||
![]() ![]() ![]() |
C | 0..1 | uri | Source system where concepts to be mapped are defined |
![]() ![]() ![]() |
C | 0..1 | string | Specific version of the code system |
![]() ![]() ![]() |
C | 0..1 | uri | Target system that the concepts are to be mapped to |
![]() ![]() ![]() |
C | 0..1 | string | Specific version of the code system |
![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() ![]() |
1..1 | code | relatedto | equivalent | equal | wider | subsumes | narrower | specializes | inexact | unmatched | disjoint | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Description of status/issues in mapping | |
![]() ![]() ![]() ![]() ![]() |
0..* | BackboneElement | Other elements required for this mapping (from context) | |
![]() ![]() ![]() ![]() ![]() |
0..* | Other concepts that this mapping also produces | ||
Documentation for this format | ||||
| 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()
|
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
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 | ||||
![]() ![]() |
0..1 | id | Logical id of this artifact | |||||
![]() ![]() |
0..1 | Meta | Metadata about the resource | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
0..1 | (Complex) | What package the artifact is defined in URL: http://hl7.org/fhir/StructureDefinition/package-source | |||||
![]() ![]() ![]() |
0..1 | id | Version specific identifier | |||||
![]() ![]() ![]() |
0..1 | instant | When the resource version last changed | |||||
![]() ![]() ![]() |
0..1 | uri | Identifies where the resource comes from | |||||
![]() ![]() ![]() |
0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | |||||
![]() ![]() ![]() |
0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | |||||
![]() ![]() ![]() |
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". | |||||
![]() ![]() |
0..1 | uri | A set of rules under which this content was created | |||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() |
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 | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
C | 0..* | code | shareable | computable | publishable | executable URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability Binding: KnowledgeCapability (required) | ||||
![]() ![]() ![]() |
0..1 | string | Copyright holder and year(s) URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel | |||||
![]() ![]() ![]() |
0..1 | date | When resource approved by publisher URL: http://hl7.org/fhir/StructureDefinition/resource-approvalDate | |||||
![]() ![]() ![]() |
0..1 | date | Last review date for the resource URL: http://hl7.org/fhir/StructureDefinition/resource-lastReviewDate | |||||
![]() ![]() ![]() |
0..1 | Period | The effective date range for the resource URL: http://hl7.org/fhir/StructureDefinition/resource-effectivePeriod | |||||
![]() ![]() ![]() |
0..* | CodeableConcept | E.g. Education, Treatment, Assessment, etc. URL: http://hl7.org/fhir/StructureDefinition/artifact-topic Binding: DefinitionTopic (example): Topics associated with the artifact | |||||
![]() ![]() ![]() |
0..* | ContactDetail | Who authored the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-author | |||||
![]() ![]() ![]() |
0..* | ContactDetail | Who edited the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-editor | |||||
![]() ![]() ![]() |
0..* | ContactDetail | Who reviewed the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-reviewer | |||||
![]() ![]() ![]() |
0..* | ContactDetail | Who endorsed the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-endorser | |||||
![]() ![]() ![]() |
0..* | (Complex) | Additional documentation, citations, etc. URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||
![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact" | |||||
![]() ![]() ![]() ![]() |
1..1 | RelatedArtifact | Value of extension | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | date | Publication date of referenced artifact URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationDate | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
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 | |||||
![]() ![]() ![]() ![]() ![]() |
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. | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Short label | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Brief description of the related artifact | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | markdown | Bibliographic citation for the artifact | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | url | Where the artifact can be accessed | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Attachment | What document is being referenced | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | canonical(Resource) | What resource is being referenced | |||||
![]() ![]() ![]() |
0..* | (Complex) | Additional documentation, review, or usage guidance URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment | |||||
![]() ![]() ![]() |
0..1 | uri | Original definitions URL: http://hl7.org/fhir/StructureDefinition/artifact-authoritativeSource | |||||
![]() ![]() |
0..* | Extension | Extensions that cannot be ignored | |||||
![]() ![]() |
0..1 | uri | Canonical identifier for this concept map, represented as a URI (globally unique) | |||||
![]() ![]() |
0..1 | Identifier | Additional identifier for the concept map | |||||
![]() ![]() |
0..1 | string | Business version of the concept map | |||||
![]() ![]() |
C | 0..1 | string | Name for this concept map (computer friendly) | ||||
![]() ![]() |
0..1 | string | Name for this concept map (human friendly) | |||||
![]() ![]() |
1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. | |||||
![]() ![]() |
0..1 | boolean | For testing purposes, not real usage | |||||
![]() ![]() |
1..1 | dateTime | Date last changed | |||||
![]() ![]() |
C | 0..1 | string | Name of the publisher (organization or individual) | ||||
![]() ![]() |
0..* | ContactDetail | Contact details for the publisher | |||||
![]() ![]() |
0..1 | markdown | Natural language description of the concept map | |||||
![]() ![]() |
0..* | UsageContext | The context that the content is intended to support | |||||
![]() ![]() |
0..* | CodeableConcept | Intended jurisdiction for concept map (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use. | |||||
![]() ![]() |
0..1 | markdown | Why this concept map is defined | |||||
![]() ![]() |
C | 0..1 | markdown | Use and/or publishing restrictions | ||||
![]() ![]() |
0..1 | The source value set that contains the concepts that are being mapped | ||||||
![]() ![]() ![]() |
uri | |||||||
![]() ![]() ![]() |
canonical(ValueSet) | |||||||
![]() ![]() |
0..1 | The target value set which provides context for the mappings | ||||||
![]() ![]() ![]() |
uri | |||||||
![]() ![]() ![]() |
canonical(ValueSet) | |||||||
![]() ![]() |
0..* | BackboneElement | Same source and target systems | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() |
C | 0..1 | uri | Source system where concepts to be mapped are defined | ||||
![]() ![]() ![]() |
C | 0..1 | string | Specific version of the code system | ||||
![]() ![]() ![]() |
C | 0..1 | uri | Target system that the concepts are to be mapped to | ||||
![]() ![]() ![]() |
C | 0..1 | string | Specific version of the code system | ||||
![]() ![]() ![]() |
1..* | BackboneElement | Mappings for a concept from the source set | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() ![]() |
0..1 | code | Identifies element being mapped | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Display for the code | |||||
![]() ![]() ![]() ![]() |
C | 0..* | BackboneElement | Concept in target system for element Constraints: cmd-1 | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | code | Code that identifies the target element | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Display for the code | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | code | relatedto | equivalent | equal | wider | subsumes | narrower | specializes | inexact | unmatched | disjoint Binding: ConceptMapEquivalence (required): The degree of equivalence between concepts. | |||||
![]() ![]() ![]() ![]() ![]() |
C | 0..1 | string | Description of status/issues in mapping | ||||
![]() ![]() ![]() ![]() ![]() |
0..* | BackboneElement | Other elements required for this mapping (from context) | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Reference to property mapping depends on | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | canonical(CodeSystem) | Code System (if necessary) | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | string | Value of the referenced element | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Display for the code (if value is a code) | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | See dependsOn (ConceptMap) | Other concepts that this mapping also produces | |||||
![]() ![]() ![]() |
C | 0..1 | BackboneElement | What to do when there is no mapping for the source concept Constraints: cmd-2, cmd-3 | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() ![]() |
1..1 | code | provided | fixed | other-map Binding: ConceptMapGroupUnmappedMode (required): Defines which action to take if there is no match in the group. | |||||
![]() ![]() ![]() ![]() |
0..1 | code | Fixed code when mode = fixed | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Display for the code | |||||
![]() ![]() ![]() ![]() |
0..1 | canonical(ConceptMap) | canonical reference to an additional ConceptMap to use for mapping if the source concept is unmapped | |||||
Documentation for this format | ||||||||
| 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. |
| 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()
|
This structure is derived from ConceptMap
Summary
Mandatory: 1 element
Must-Support: 29 elements
Extensions
This structure refers to these extensions:
Maturity: 1
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() |
|---|---|---|---|---|
![]() |
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 |
![]() ![]() |
0..1 | Meta | Metadata about the resource | |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
0..1 | (Complex) | What package the artifact is defined in URL: http://hl7.org/fhir/StructureDefinition/package-source | |
![]() ![]() |
0..1 | uri | A set of rules under which this content was created | |
![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() |
C | 0..* | code | shareable | computable | publishable | executable URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability Binding: KnowledgeCapability (required) |
![]() ![]() ![]() |
0..1 | string | Copyright holder and year(s) URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel | |
![]() ![]() ![]() |
0..1 | date | When resource approved by publisher URL: http://hl7.org/fhir/StructureDefinition/resource-approvalDate | |
![]() ![]() ![]() |
0..1 | date | Last review date for the resource URL: http://hl7.org/fhir/StructureDefinition/resource-lastReviewDate | |
![]() ![]() ![]() |
0..1 | Period | The effective date range for the resource URL: http://hl7.org/fhir/StructureDefinition/resource-effectivePeriod | |
![]() ![]() ![]() |
0..* | CodeableConcept | E.g. Education, Treatment, Assessment, etc. URL: http://hl7.org/fhir/StructureDefinition/artifact-topic Binding: DefinitionTopic (example): Topics associated with the artifact | |
![]() ![]() ![]() |
0..* | ContactDetail | Who authored the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-author | |
![]() ![]() ![]() |
0..* | ContactDetail | Who edited the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-editor | |
![]() ![]() ![]() |
0..* | ContactDetail | Who reviewed the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-reviewer | |
![]() ![]() ![]() |
0..* | ContactDetail | Who endorsed the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-endorser | |
![]() ![]() ![]() |
0..* | (Complex) | Additional documentation, citations, etc. URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact | |
![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||
![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact" | |
![]() ![]() ![]() ![]() |
1..1 | RelatedArtifact | Value of extension | |
![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | date | Publication date of referenced artifact URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationDate | |
![]() ![]() ![]() ![]() ![]() ![]() |
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 | |
![]() ![]() ![]() ![]() ![]() |
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. | |
![]() ![]() ![]() |
0..* | (Complex) | Additional documentation, review, or usage guidance URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment | |
![]() ![]() ![]() |
0..1 | uri | Original definitions URL: http://hl7.org/fhir/StructureDefinition/artifact-authoritativeSource | |
![]() ![]() |
0..* | Extension | Extensions that cannot be ignored | |
![]() ![]() |
0..1 | Identifier | Additional identifier for the concept map | |
![]() ![]() |
1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. | |
![]() ![]() |
1..1 | dateTime | Date last changed | |
![]() ![]() |
C | 0..1 | string | Name of the publisher (organization or individual) |
![]() ![]() |
0..* | ContactDetail | Contact details for the publisher | |
![]() ![]() |
0..* | UsageContext | The context that the content is intended to support | |
![]() ![]() |
0..* | CodeableConcept | Intended jurisdiction for concept map (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use. | |
![]() ![]() |
0..1 | markdown | Why this concept map is defined | |
![]() ![]() |
C | 0..1 | markdown | Use and/or publishing restrictions |
![]() ![]() |
0..* | BackboneElement | Same source and target systems | |
![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
![]() ![]() ![]() |
C | 0..1 | uri | Source system where concepts to be mapped are defined |
![]() ![]() ![]() |
C | 0..1 | string | Specific version of the code system |
![]() ![]() ![]() |
C | 0..1 | uri | Target system that the concepts are to be mapped to |
![]() ![]() ![]() |
C | 0..1 | string | Specific version of the code system |
![]() ![]() ![]() |
1..* | BackboneElement | Mappings for a concept from the source set | |
![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
![]() ![]() ![]() ![]() |
C | 0..* | BackboneElement | Concept in target system for element Constraints: cmd-1 |
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
![]() ![]() ![]() ![]() ![]() |
1..1 | code | relatedto | equivalent | equal | wider | subsumes | narrower | specializes | inexact | unmatched | disjoint Binding: ConceptMapEquivalence (required): The degree of equivalence between concepts. | |
![]() ![]() ![]() ![]() ![]() |
C | 0..1 | string | Description of status/issues in mapping |
![]() ![]() ![]() ![]() ![]() |
0..* | BackboneElement | Other elements required for this mapping (from context) | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Reference to property mapping depends on | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | string | Value of the referenced element | |
![]() ![]() ![]() ![]() ![]() |
0..* | See dependsOn (ConceptMap) | Other concepts that this mapping also produces | |
Documentation for this format | ||||
| 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. |
| 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
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() |
|---|---|---|---|---|
![]() |
C | 1..1 | ConceptMap | A map from one set of concepts to one or more other concepts Constraints: pub-1, pcm-1, pcm-2 |
![]() ![]() |
||||
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
0..1 | (Complex) | What package the artifact is defined in URL: http://hl7.org/fhir/StructureDefinition/package-source | |
![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() |
C | 0..* | code | shareable | computable | publishable | executable URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability Binding: KnowledgeCapability (required) |
![]() ![]() ![]() |
0..1 | string | Copyright holder and year(s) URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel | |
![]() ![]() ![]() |
0..1 | date | When resource approved by publisher URL: http://hl7.org/fhir/StructureDefinition/resource-approvalDate | |
![]() ![]() ![]() |
0..1 | date | Last review date for the resource URL: http://hl7.org/fhir/StructureDefinition/resource-lastReviewDate | |
![]() ![]() ![]() |
0..1 | Period | The effective date range for the resource URL: http://hl7.org/fhir/StructureDefinition/resource-effectivePeriod | |
![]() ![]() ![]() |
0..* | CodeableConcept | E.g. Education, Treatment, Assessment, etc. URL: http://hl7.org/fhir/StructureDefinition/artifact-topic Binding: DefinitionTopic (example): Topics associated with the artifact | |
![]() ![]() ![]() |
0..* | ContactDetail | Who authored the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-author | |
![]() ![]() ![]() |
0..* | ContactDetail | Who edited the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-editor | |
![]() ![]() ![]() |
0..* | ContactDetail | Who reviewed the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-reviewer | |
![]() ![]() ![]() |
0..* | ContactDetail | Who endorsed the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-endorser | |
![]() ![]() ![]() |
0..* | (Complex) | Additional documentation, citations, etc. URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact | |
![]() ![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | date | Publication date of referenced artifact URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationDate | |
![]() ![]() ![]() ![]() ![]() ![]() |
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 | |
![]() ![]() ![]() |
0..* | (Complex) | Additional documentation, review, or usage guidance URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment | |
![]() ![]() ![]() |
0..1 | uri | Original definitions URL: http://hl7.org/fhir/StructureDefinition/artifact-authoritativeSource | |
![]() ![]() |
0..1 | Identifier | Additional identifier for the concept map | |
![]() ![]() |
1..1 | dateTime | Date last changed | |
![]() ![]() |
C | 0..1 | string | Name of the publisher (organization or individual) |
![]() ![]() |
0..* | ContactDetail | Contact details for the publisher | |
![]() ![]() |
0..* | UsageContext | The context that the content is intended to support | |
![]() ![]() |
0..* | CodeableConcept | Intended jurisdiction for concept map (if applicable) | |
![]() ![]() |
0..1 | markdown | Why this concept map is defined | |
![]() ![]() |
C | 0..1 | markdown | Use and/or publishing restrictions |
![]() ![]() |
||||
![]() ![]() ![]() |
C | 0..1 | uri | Source system where concepts to be mapped are defined |
![]() ![]() ![]() |
C | 0..1 | string | Specific version of the code system |
![]() ![]() ![]() |
C | 0..1 | uri | Target system that the concepts are to be mapped to |
![]() ![]() ![]() |
C | 0..1 | string | Specific version of the code system |
![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() ![]() |
1..1 | code | relatedto | equivalent | equal | wider | subsumes | narrower | specializes | inexact | unmatched | disjoint | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Description of status/issues in mapping | |
![]() ![]() ![]() ![]() ![]() |
0..* | BackboneElement | Other elements required for this mapping (from context) | |
![]() ![]() ![]() ![]() ![]() |
0..* | Other concepts that this mapping also produces | ||
Documentation for this format | ||||
| 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
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
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 | ||||
![]() ![]() |
0..1 | id | Logical id of this artifact | |||||
![]() ![]() |
0..1 | Meta | Metadata about the resource | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
0..1 | (Complex) | What package the artifact is defined in URL: http://hl7.org/fhir/StructureDefinition/package-source | |||||
![]() ![]() ![]() |
0..1 | id | Version specific identifier | |||||
![]() ![]() ![]() |
0..1 | instant | When the resource version last changed | |||||
![]() ![]() ![]() |
0..1 | uri | Identifies where the resource comes from | |||||
![]() ![]() ![]() |
0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | |||||
![]() ![]() ![]() |
0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | |||||
![]() ![]() ![]() |
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". | |||||
![]() ![]() |
0..1 | uri | A set of rules under which this content was created | |||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() |
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 | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
C | 0..* | code | shareable | computable | publishable | executable URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability Binding: KnowledgeCapability (required) | ||||
![]() ![]() ![]() |
0..1 | string | Copyright holder and year(s) URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel | |||||
![]() ![]() ![]() |
0..1 | date | When resource approved by publisher URL: http://hl7.org/fhir/StructureDefinition/resource-approvalDate | |||||
![]() ![]() ![]() |
0..1 | date | Last review date for the resource URL: http://hl7.org/fhir/StructureDefinition/resource-lastReviewDate | |||||
![]() ![]() ![]() |
0..1 | Period | The effective date range for the resource URL: http://hl7.org/fhir/StructureDefinition/resource-effectivePeriod | |||||
![]() ![]() ![]() |
0..* | CodeableConcept | E.g. Education, Treatment, Assessment, etc. URL: http://hl7.org/fhir/StructureDefinition/artifact-topic Binding: DefinitionTopic (example): Topics associated with the artifact | |||||
![]() ![]() ![]() |
0..* | ContactDetail | Who authored the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-author | |||||
![]() ![]() ![]() |
0..* | ContactDetail | Who edited the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-editor | |||||
![]() ![]() ![]() |
0..* | ContactDetail | Who reviewed the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-reviewer | |||||
![]() ![]() ![]() |
0..* | ContactDetail | Who endorsed the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-endorser | |||||
![]() ![]() ![]() |
0..* | (Complex) | Additional documentation, citations, etc. URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||
![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact" | |||||
![]() ![]() ![]() ![]() |
1..1 | RelatedArtifact | Value of extension | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | date | Publication date of referenced artifact URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationDate | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
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 | |||||
![]() ![]() ![]() ![]() ![]() |
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. | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Short label | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Brief description of the related artifact | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | markdown | Bibliographic citation for the artifact | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | url | Where the artifact can be accessed | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Attachment | What document is being referenced | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | canonical(Resource) | What resource is being referenced | |||||
![]() ![]() ![]() |
0..* | (Complex) | Additional documentation, review, or usage guidance URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment | |||||
![]() ![]() ![]() |
0..1 | uri | Original definitions URL: http://hl7.org/fhir/StructureDefinition/artifact-authoritativeSource | |||||
![]() ![]() |
0..* | Extension | Extensions that cannot be ignored | |||||
![]() ![]() |
0..1 | uri | Canonical identifier for this concept map, represented as a URI (globally unique) | |||||
![]() ![]() |
0..1 | Identifier | Additional identifier for the concept map | |||||
![]() ![]() |
0..1 | string | Business version of the concept map | |||||
![]() ![]() |
C | 0..1 | string | Name for this concept map (computer friendly) | ||||
![]() ![]() |
0..1 | string | Name for this concept map (human friendly) | |||||
![]() ![]() |
1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. | |||||
![]() ![]() |
0..1 | boolean | For testing purposes, not real usage | |||||
![]() ![]() |
1..1 | dateTime | Date last changed | |||||
![]() ![]() |
C | 0..1 | string | Name of the publisher (organization or individual) | ||||
![]() ![]() |
0..* | ContactDetail | Contact details for the publisher | |||||
![]() ![]() |
0..1 | markdown | Natural language description of the concept map | |||||
![]() ![]() |
0..* | UsageContext | The context that the content is intended to support | |||||
![]() ![]() |
0..* | CodeableConcept | Intended jurisdiction for concept map (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use. | |||||
![]() ![]() |
0..1 | markdown | Why this concept map is defined | |||||
![]() ![]() |
C | 0..1 | markdown | Use and/or publishing restrictions | ||||
![]() ![]() |
0..1 | The source value set that contains the concepts that are being mapped | ||||||
![]() ![]() ![]() |
uri | |||||||
![]() ![]() ![]() |
canonical(ValueSet) | |||||||
![]() ![]() |
0..1 | The target value set which provides context for the mappings | ||||||
![]() ![]() ![]() |
uri | |||||||
![]() ![]() ![]() |
canonical(ValueSet) | |||||||
![]() ![]() |
0..* | BackboneElement | Same source and target systems | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() |
C | 0..1 | uri | Source system where concepts to be mapped are defined | ||||
![]() ![]() ![]() |
C | 0..1 | string | Specific version of the code system | ||||
![]() ![]() ![]() |
C | 0..1 | uri | Target system that the concepts are to be mapped to | ||||
![]() ![]() ![]() |
C | 0..1 | string | Specific version of the code system | ||||
![]() ![]() ![]() |
1..* | BackboneElement | Mappings for a concept from the source set | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() ![]() |
0..1 | code | Identifies element being mapped | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Display for the code | |||||
![]() ![]() ![]() ![]() |
C | 0..* | BackboneElement | Concept in target system for element Constraints: cmd-1 | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | code | Code that identifies the target element | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Display for the code | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | code | relatedto | equivalent | equal | wider | subsumes | narrower | specializes | inexact | unmatched | disjoint Binding: ConceptMapEquivalence (required): The degree of equivalence between concepts. | |||||
![]() ![]() ![]() ![]() ![]() |
C | 0..1 | string | Description of status/issues in mapping | ||||
![]() ![]() ![]() ![]() ![]() |
0..* | BackboneElement | Other elements required for this mapping (from context) | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Reference to property mapping depends on | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | canonical(CodeSystem) | Code System (if necessary) | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | string | Value of the referenced element | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Display for the code (if value is a code) | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | See dependsOn (ConceptMap) | Other concepts that this mapping also produces | |||||
![]() ![]() ![]() |
C | 0..1 | BackboneElement | What to do when there is no mapping for the source concept Constraints: cmd-2, cmd-3 | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() ![]() |
1..1 | code | provided | fixed | other-map Binding: ConceptMapGroupUnmappedMode (required): Defines which action to take if there is no match in the group. | |||||
![]() ![]() ![]() ![]() |
0..1 | code | Fixed code when mode = fixed | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Display for the code | |||||
![]() ![]() ![]() ![]() |
0..1 | canonical(ConceptMap) | canonical reference to an additional ConceptMap to use for mapping if the source concept is unmapped | |||||
Documentation for this format | ||||||||
| 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. |
| 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()
|
This structure is derived from ConceptMap
Summary
Mandatory: 1 element
Must-Support: 29 elements
Extensions
This structure refers to these extensions:
Maturity: 1
Other representations of profile: CSV, Excel, Schematron