ConceptMap - FHIR v0.0.82

This page is part of the FHIR Specification (v0.0.82: DSTU 1). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3 R2

6.15.8 Resource ConceptMap - Formal Definitions

Formal definitions for the elements in the ConceptMap resource.

ConceptMap
Definition	A statement of relationships from one set of concepts to one or more other concept systems.
Control	1..1
ConceptMap.identifier
Definition	The identifier that is used to identify this concept map when it is referenced in a specification, model, design or an instance (should be globally unique OID, UUID, or URI).
Control	0..1
Type	string
Summary	true
ConceptMap.version
Definition	The identifier that is used to identify this version of the concept map when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the profile author manually and the value should be a timestamp.
Control	0..1
Type	string
Summary	true
Comments	There may be multiple resource versions of the concept map that have this same identifier.
ConceptMap.name
Definition	A free text natural language name describing the concept map.
Control	1..1
Type	string
Requirements	Support human navigation.
Summary	true
Comments	Not expected to be unique.
ConceptMap.publisher
Definition	The name of the individual or organization that published the concept map.
Control	0..1
Type	string
Requirements	Helps establish the "authority/credibility" of the conept map. May also allow for contact.
Summary	true
Comments	Usually an organization, but may be an individual. This item SHOULD be populated unless the information is available from context.
ConceptMap.telecom
Definition	Contacts of the publisher to assist a user in finding and communicating with the publisher.
Control	0..*
Type	Contact
Summary	true
Comments	May be a web site, an email address, a telephone number (tel:), etc.
ConceptMap.description
Definition	A free text natural language description of the use of the concept map - reason for definition, conditions of use, etc.
Control	0..1
Type	string
Requirements	Human understandability.
Summary	true
Comments	The description is not intended to describe the semantics of the concept map. The description should capture its intended use, which is needed for ensuring integrity for its use in models across future changes.
ConceptMap.copyright
Definition	A copyright statement relating to the concept map and/or its contents.
Control	0..1
Type	string
Comments	Frequently, the copyright differs between the concept map, and codes that are included. The copyright statement should clearly differentiate between these when required.
ConceptMap.status
Definition	The status of the concept map.
Control	1..1
Binding	ValueSetStatus: The lifecycle status of a Value Set or Concept Map (see http://hl7.org/fhir/valueset-status for values)
Type	code
Is Modifier	true
Requirements	Identify when/if the concept map should be used.
Summary	true
Comments	Allows filtering of ConceptMaps that are appropriate for use.
ConceptMap.experimental
Definition	This ConceptMap was authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.
Control	0..1
Type	boolean
Summary	true
Comments	Allows filtering of ConceptMaps that are appropriate for use.
ConceptMap.date
Definition	The date that the concept map status was last changed.
Control	0..1
Type	dateTime
Requirements	Need to know when a concept map was first legal for use or became withdrawn or replaced.
Summary	true
Comments	Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the concept map.
ConceptMap.source
Definition	The source value set that specifies the concepts that are being mapped.
Control	1..1
Type	Resource(ValueSet)
Summary	true
Comments	Should be a version specific reference.
ConceptMap.target
Definition	The target value set provides context to the mappings. Note that the mapping is made between concepts, not between value sets, but the value set provides important context about how the concept mapping choices are made.
Control	1..1
Type	Resource(ValueSet)
Summary	true
ConceptMap.concept
Definition	Mappings for a concept from the source valueset.
Control	0..*
Comments	Generally, the ideal is that there would only be one mapping for each concept in the source value set, but a given concept may be mapped mutliple times with different comments or dependencies.
ConceptMap.concept.system
Definition	System that defines the concept being mapped.
Control	1..1
Type	uri
ConceptMap.concept.code
Definition	Identifies concept being mapped.
Control	0..1
Type	code
ConceptMap.concept.dependsOn
Definition	A set of additional dependencies for this mapping to hold. This mapping is only applicable if the specified concept can be resolved, and it has the specified value.
Control	0..*
ConceptMap.concept.dependsOn.concept
Definition	A reference to a specific concept that holds a coded value. This can be an element in a FHIR resource, or a specific reference to a data element in a different specification (e.g. v2) or a general reference to a kind of data field, or a reference to a value set with an appropriately narrow definition.
Control	1..1
Type	uri
ConceptMap.concept.dependsOn.system
Definition	System for a concept in the referenced concept.
Control	1..1
Type	uri
ConceptMap.concept.dependsOn.code
Definition	Code for a concept in the referenced concept.
Control	1..1
Type	code
ConceptMap.concept.map
Definition	A concept from the target value set that this concept maps to.
Control	0..*
Comments	Ideally there would only be one map, with equal or equivalent mapping. But multiple maps are allowed for several narrower options, or to assert that other concepts are unmatched.
Invariants	Defined on this element Inv-1: If the map is narrower, there SHALL be some comments (xpath: exists(f:comments) or ((f:equivalence/@value != 'narrower') and (f:equivalence/@value != 'inexact'))) Inv-2: If a code is provided, a system SHALL be provided (xpath: exists(f:system) or not(exists(f:code)))
ConceptMap.concept.map.system
Definition	System of the target.
Control	0..1
Type	uri
Comments	Should be a version specific reference.
Invariants	Affect this element Inv-2: If a code is provided, a system SHALL be provided (xpath: exists(f:system) or not(exists(f:code)))
ConceptMap.concept.map.code
Definition	Code that identifies the target concept.
Control	0..1
Type	code
ConceptMap.concept.map.equivalence
Definition	equal \| equivalent \| wider \| subsumes \| narrower \| specialises \| inexact \| unmatched \| disjoint.
Control	1..1
Binding	ConceptMapEquivalence: The degree of equivalence between concepts (see http://hl7.org/fhir/concept-equivalence for values)
Type	code
Is Modifier	true
ConceptMap.concept.map.comments
Definition	Description of status/issues in mapping.
Control	0..1
Type	string
Invariants	Affect this element Inv-1: If the map is narrower, there SHALL be some comments (xpath: exists(f:comments) or ((f:equivalence/@value != 'narrower') and (f:equivalence/@value != 'inexact')))
ConceptMap.concept.map.product
Definition	A set of additional outcomes from this mapping to other value sets. To properly execute this mapping, the specified value set must be mapped to some data element or source that is in context. The mapping may still be useful without a place for the additional data elements, but the equivalence cannot be relied on.
Control	0..*
Type	See ConceptMap.concept.dependsOn