Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ConceptMap | TU | DomainResource | A map from one set of concepts to one or more other concepts + Warning: Name should be usable as an identifier for the module by machine processing applications such as code generation Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension Interfaces Implemented: MetadataResource | |
url | ΣC | 0..1 | uri | Canonical identifier for this concept map, represented as a URI (globally unique) + Warning: URL should not contain | or # - these characters make processing canonical references problematic |
identifier | Σ | 0..* | Identifier | Additional identifier for the concept map |
version | Σ | 0..1 | string | Business version of the concept map |
versionAlgorithm[x] | Σ | 0..1 | How to compare versions Binding: Version Algorithm (Extensible) | |
versionAlgorithmString | string | |||
versionAlgorithmCoding | Coding | |||
name | ΣC | 0..1 | string | Name for this concept map (computer friendly) |
title | ΣT | 0..1 | string | Name for this concept map (human friendly) |
status | ?!ΣC | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (Required) |
experimental | Σ | 0..1 | boolean | For testing purposes, not real usage |
date | Σ | 0..1 | dateTime | Date last changed |
publisher | ΣT | 0..1 | string | Name of the publisher/steward (organization or individual) |
contact | Σ | 0..* | ContactDetail | Contact details for the publisher |
description | T | 0..1 | markdown | Natural language description of the concept map |
useContext | Σ | 0..* | UsageContext | The context that the content is intended to support |
jurisdiction | ΣXD | 0..* | CodeableConcept | Intended jurisdiction for concept map (if applicable) Binding: Jurisdiction ValueSet (Extensible) |
purpose | T | 0..1 | markdown | Why this concept map is defined |
copyright | T | 0..1 | markdown | Use and/or publishing restrictions |
copyrightLabel | T | 0..1 | string | Copyright holder and year(s) |
approvalDate | 0..1 | date | When the ConceptMap was approved by publisher | |
lastReviewDate | 0..1 | date | When the ConceptMap was last reviewed by the publisher | |
effectivePeriod | Σ | 0..1 | Period | When the ConceptMap is expected to be used |
topic | XD | 0..* | CodeableConcept | E.g. Education, Treatment, Assessment, etc Binding: Definition Topic (Example) |
author | 0..* | ContactDetail | Who authored the ConceptMap | |
editor | 0..* | ContactDetail | Who edited the ConceptMap | |
reviewer | 0..* | ContactDetail | Who reviewed the ConceptMap | |
endorser | 0..* | ContactDetail | Who endorsed the ConceptMap | |
relatedArtifact | 0..* | RelatedArtifact | Additional documentation, citations, etc | |
property | ΣC | 0..* | BackboneElement | Additional properties of the mapping + Rule: If the property type is code, a system SHALL be specified |
code | Σ | 1..1 | code | Identifies the property on the mappings, and when referred to in the $translate operation |
uri | Σ | 0..1 | uri | Formal identifier for the property |
description | Σ | 0..1 | string | Why the property is defined, and/or what it conveys |
type | ΣC | 1..1 | code | Coding | string | integer | boolean | dateTime | decimal | code Binding: ConceptMap Property Type (Required) |
system | ΣC | 0..1 | canonical(CodeSystem) | The CodeSystem from which code values come |
additionalAttribute | Σ | 0..* | BackboneElement | Definition of an additional attribute to act as a data source or target |
code | Σ | 1..1 | code | Identifies this additional attribute through this resource |
uri | Σ | 0..1 | uri | Formal identifier for the data element referred to in this attribte |
description | Σ | 0..1 | string | Why the additional attribute is defined, and/or what the data element it refers to is |
type | Σ | 1..1 | code | code | Coding | string | boolean | Quantity Binding: ConceptMap Attribute Type (Required) |
sourceScope[x] | Σ | 0..1 | The source value set that contains the concepts that are being mapped | |
sourceScopeUri | uri | |||
sourceScopeCanonical | canonical(ValueSet) | |||
targetScope[x] | Σ | 0..1 | The target value set which provides context for the mappings | |
targetScopeUri | uri | |||
targetScopeCanonical | canonical(ValueSet) | |||
group | 0..* | BackboneElement | Same source and target systems | |
source | 0..1 | canonical(CodeSystem) | Source system where concepts to be mapped are defined | |
target | 0..1 | canonical(CodeSystem) | Target system that the concepts are to be mapped to | |
element | C | 1..* | BackboneElement | Mappings for a concept from the source set + Rule: If noMap is present, target SHALL NOT be present + Rule: Either code or valueSet SHALL be present but not both. |
code | C | 0..1 | code | Identifies element being mapped |
display | 0..1 | string | Display for the code | |
valueSet | C | 0..1 | canonical(ValueSet) | Identifies the set of concepts being mapped |
noMap | C | 0..1 | boolean | No mapping to a target concept for this source concept |
target | C | 0..* | BackboneElement | Concept in target system for element + Rule: If the map is source-is-broader-than-target or not-related-to, there SHALL be some comments, unless the status is 'draft' + Rule: Either code or valueSet SHALL be present but not both. |
code | C | 0..1 | code | Code that identifies the target element |
display | 0..1 | string | Display for the code | |
valueSet | C | 0..1 | canonical(ValueSet) | Identifies the set of target concepts |
relationship | ?!C | 1..1 | code | related-to | equivalent | source-is-narrower-than-target | source-is-broader-than-target | not-related-to Binding: ConceptMapRelationship (Required) |
comment | C | 0..1 | string | Description of status/issues in mapping |
property | 0..* | BackboneElement | Property value for the source -> target mapping | |
code | 1..1 | code | Reference to ConceptMap.property.code | |
value[x] | 1..1 | Value of the property for this concept | ||
valueCoding | Coding | |||
valueString | string | |||
valueInteger | integer | |||
valueBoolean | boolean | |||
valueDateTime | dateTime | |||
valueDecimal | decimal | |||
valueCode | code | |||
dependsOn | C | 0..* | BackboneElement | Other properties required for this mapping + Rule: One of value[x] or valueSet must exist, but not both. |
attribute | 1..1 | code | A reference to a mapping attribute defined in ConceptMap.additionalAttribute | |
value[x] | C | 0..1 | Value of the referenced data element | |
valueCode | code | |||
valueCoding | Coding | |||
valueString | string | |||
valueBoolean | boolean | |||
valueQuantity | Quantity | |||
valueSet | C | 0..1 | canonical(ValueSet) | The mapping depends on a data element with a value from this value set |
product | 0..* | see dependsOn | Other data elements that this mapping also produces | |
unmapped | C | 0..1 | BackboneElement | What to do when there is no mapping target for the source concept and ConceptMap.group.element.noMap is not true + Rule: If the mode is 'fixed', either a code or valueSet must be provided, but not both. + Rule: If the mode is 'other-map', a url for the other map must be provided + Rule: If the mode is not 'fixed', code, display and valueSet are not allowed + Rule: If the mode is not 'other-map', relationship must be provided + Rule: If the mode is not 'other-map', otherMap is not allowed |
mode | C | 1..1 | code | use-source-code | fixed | other-map Binding: Concept Map Group Unmapped Mode (Required) |
code | C | 0..1 | code | Fixed code when mode = fixed |
display | C | 0..1 | string | Display for the code |
valueSet | C | 0..1 | canonical(ValueSet) | Fixed code set when mode = fixed |
relationship | ?!C | 0..1 | code | related-to | equivalent | source-is-narrower-than-target | source-is-broader-than-target | not-related-to Binding: ConceptMapRelationship (Required) |
otherMap | C | 0..1 | canonical(ConceptMap) | canonical reference to an additional ConceptMap to use for mapping if the source concept is unmapped |
Documentation for this format |