DSTU2

This page is part of the FHIR Specification (v1.0.2: DSTU 2). 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.23.7 Resource ConceptMap - Detailed Descriptions

Detailed Descriptions for the elements in the ConceptMap resource.

ConceptMap
Definition

A statement of relationships from one set of concepts to one or more other concepts - either code systems or data elements, or classes in class models.

Control1..1
ConceptMap.url
Definition

An absolute URL that is used to identify this concept map when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this concept map is (or will be) published.

Control0..1
Typeuri
Summarytrue
ConceptMap.identifier
Definition

Formal identifier that is used to identify this concept map when it is represented in other formats, or referenced in a specification, model, design or an instance.

NoteThis is a business identifer, not a resource identifier (see discussion)
Control0..1
TypeIdentifier
Summarytrue
Comments

Typically, this is used for values that can go in a v3 II data type.

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.

NoteThis is a business versionId, not a resource identifier (see discussion)
Control0..1
Typestring
Summarytrue
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.

Control0..1
Typestring
Requirements

Support human navigation.

Summarytrue
Comments

Not expected to be unique.

ConceptMap.status
Definition

The status of the concept map.

Control1..1
BindingConformanceResourceStatus: The lifecycle status of a Value Set or Concept Map. (Required)
Typecode
Is Modifiertrue
Requirements

Identify when/if the concept map should be used.

Summarytrue
Comments

Allows filtering of ConceptMap resources 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.

Control0..1
Typeboolean
Summarytrue
Comments

Allows filtering of ConceptMap resources that are appropriate for use.

ConceptMap.publisher
Definition

The name of the individual or organization that published the concept map.

Control0..1
Typestring
Requirements

Helps establish the "authority/credibility" of the concept map. May also allow for contact.

Summarytrue
Comments

Usually an organization, but may be an individual. This item SHOULD be populated unless the information is available from context.

ConceptMap.contact
Definition

Contacts to assist a user in finding and communicating with the publisher.

Control0..*
Summarytrue
Comments

May be a web site, an email address, a telephone number, etc.

ConceptMap.contact.name
Definition

The name of an individual to contact regarding the concept map.

Control0..1
Typestring
Summarytrue
Comments

If there is no named individual, the telecom is for the organization as a whole.

ConceptMap.contact.telecom
Definition

Contact details for individual (if a name was provided) or the publisher.

Control0..*
TypeContactPoint
Summarytrue
ConceptMap.date
Definition

The date this version of the concept map was published. The date must change when the business version changes, if it does, and it must change if the status code changes. In addition, it should change when the substantive content of the concept map changes.

Control0..1
TypedateTime
Requirements

Need to know when a concept map was first legal for use or became withdrawn or replaced.

Summarytrue
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. Additional specific dates may be added as extensions.

ConceptMap.description
Definition

A free text natural language description of the use of the concept map - reason for definition, conditions of use, etc.

Control0..1
Typestring
Requirements

Human understandability.

Summarytrue
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.useContext
Definition

The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching of concept map instances.

Control0..*
BindingContext of Use ValueSet: Indicates the countries, regions, disciplines and other aspects of use within which this artifact is targeted for use. (Extensible)
TypeCodeableConcept
Requirements

Assist in searching for appropriate concept map instances.

Summarytrue
ConceptMap.requirements
Definition

Explains why this concept map is needed and why it has been constrained as it has.

Control0..1
Typestring
Comments

This element does not describe the usage of the concept map (that is done in comments), rather it's for traceability of ''why'' the element is either needed or ''why'' the constraints exist as they do. This may be used to point to source materials or specifications that drove the structure of this data element.

ConceptMap.copyright
Definition

A copyright statement relating to the concept map and/or its contents.

Control0..1
Typestring
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.source[x]
Definition

The source value set that specifies the concepts that are being mapped.

Control1..1
Typeuri|Reference(ValueSet | StructureDefinition)
[x] NoteSee Choice of Data Types for further information about how to use [x]
Summarytrue
Comments

Should be a version specific reference. URIs SHOULD be absolute.

ConceptMap.target[x]
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.

Control1..1
Typeuri|Reference(ValueSet | StructureDefinition)
[x] NoteSee Choice of Data Types for further information about how to use [x]
Summarytrue
Comments

Should be a version specific reference. URIs SHOULD be absolute.

ConceptMap.element
Definition

Mappings for an individual concept in the source to one or more concepts in the target.

Control0..*
Alternate Namescode; concept; item
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 multiple times with different comments or dependencies.

ConceptMap.element.codeSystem
Definition

An absolute URI that identifies the Code System (if the source is a value set that crosses more than one code system).

Control0..1
Typeuri
ConceptMap.element.code
Definition

Identity (code or path) or the element/item being mapped.

Control0..1
Typecode
ConceptMap.element.target
Definition

A concept from the target value set that this concept maps to.

Control0..*
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.

InvariantsDefined on this element
cmd-1: If the map is narrower or inexact, there SHALL be some comments (xpath: exists(f:comments) or ((f:equivalence/@value != 'narrower') and (f:equivalence/@value != 'inexact')))
ConceptMap.element.target.codeSystem
Definition

An absolute URI that identifies the code system of the target code (if the target is a value set that cross code systems).

Control0..1
Typeuri
Comments

Should be a version specific reference.

ConceptMap.element.target.code
Definition

Identity (code or path) or the element/item that the map refers to.

Control0..1
Typecode
ConceptMap.element.target.equivalence
Definition

The equivalence between the source and target concepts (counting for the dependencies and products). The equivalence is read from target to source (e.g. the target is 'wider' than the source).

Control1..1
BindingConceptMapEquivalence: The degree of equivalence between concepts. (Required)
Typecode
Is Modifiertrue
ConceptMap.element.target.comments
Definition

A description of status/issues in mapping that conveys additional information not represented in the structured data.

Control0..1
Typestring
InvariantsAffect this element
cmd-1: If the map is narrower or inexact, there SHALL be some comments (xpath: exists(f:comments) or ((f:equivalence/@value != 'narrower') and (f:equivalence/@value != 'inexact')))
ConceptMap.element.target.dependsOn
Definition

A set of additional dependencies for this mapping to hold. This mapping is only applicable if the specified element can be resolved, and it has the specified value.

Control0..*
ConceptMap.element.target.dependsOn.element
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. HL7 v2) or a general reference to a kind of data field, or a reference to a value set with an appropriately narrow definition.

Control1..1
Typeuri
ConceptMap.element.target.dependsOn.codeSystem
Definition

An absolute URI that identifies the code system of the dependency code (if the source/dependency is a value set that crosses code systems).

Control1..1
Typeuri
ConceptMap.element.target.dependsOn.code
Definition

Identity (code or path) or the element/item/ValueSet that the map depends on / refers to.

Control1..1
Typestring
ConceptMap.element.target.product
Definition

A set of additional outcomes from this mapping to other elements. To properly execute this mapping, the specified element 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.

Control0..*
TypeSee ConceptMap.element.target.dependsOn