R4 Draft for Comment

This page is part of the FHIR Specification (v3.2.0: R4 Ballot 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

Vocabulary Work GroupMaturity Level: 3 Normative Compartments: Not linked to any defined compartments

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 URI that is used to identify this concept map when it is referenced in a specification, model, design or an instance. This SHOULD be globally unique, and SHOULD be a literal address at which this concept map is (or will be) published.

Control0..1
Typeuri
Requirements

Allows the concept map to be referenced by a single globally unique identifier.

Summarytrue
Comments

Can be a urn:uuid: or a urn:oid:, but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.

The URL SHOULD include the major version of the concept map. For more information see Technical and Business Versions.

ConceptMap.identifier
Definition

A 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
Requirements

Allows externally provided and/or usable business identifiers to be easily associated with the module.

Summarytrue
Comments

Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, e.g., to identify this concept map outside of FHIR, where it is not possible to use the logical URI.

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 concept map author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.

NoteThis is a business versionId, not a resource version id (see discussion)
Control0..1
Typestring
Summarytrue
Comments

There may be different concept map instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the concept map with the format [url]|[version].

ConceptMap.name
Definition

A natural language name identifying the concept map. This name should be usable as an identifier for the module by machine processing applications such as code generation.

Control0..1
Typestring
Requirements

Support human navigation and code generation.

Summarytrue
Comments

The name is not expected to be globally unique. The name should be a simple alpha-numeric type name to ensure that it is computable friendly.

ConceptMap.title
Definition

A short, descriptive, user-friendly title for the concept map.

Control0..1
Typestring
Summarytrue
Comments

This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.

ConceptMap.status
Definition

The status of this concept map. Enables tracking the life-cycle of the content.

Control1..1
Terminology BindingPublicationStatus (Required)
Typecode
Is Modifiertrue
Summarytrue
Comments

Allows filtering of concept maps that are appropriate for use vs. not.
This is labeled as "Is Modifier" because applications should not use a retired concept map without due consideration.

ConceptMap.experimental
Definition

A boolean value to indicate that this concept map is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.

Control0..1
Typeboolean
Is Modifiertrue
Requirements

Enables experimental content to be developed following the same lifecycle that would be used for a production-level concept map.

Summarytrue
Comments

Allows filtering of concept map that are appropriate for use vs. not. This is labeled as "Is Modifier" because applications should not use an experimental concept map in production.

ConceptMap.date
Definition

The date (and optionally time) when the concept map was published. The date must change if and when the business version changes 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
Alternate NamesRevision Date
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 or be found by consulting Provenances associated with past versions of the resource.

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. The publisher (or steward) of the concept map is the organization or individual primarily responsible for the maintenance and upkeep of the concept map. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the concept map. This item SHOULD be populated unless the information is available from context.

ConceptMap.contact
Definition

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

Control0..*
TypeContactDetail
Summarytrue
Comments

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

ConceptMap.description
Definition

A free text natural language description of the concept map from a consumer's perspective.

Control0..1
Typemarkdown
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
Standards StatusThis element has a standards status of "Trial Use" which is different to the status of the whole resource
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 for appropriate concept map instances.

Control0..*
TypeUsageContext
Requirements

Assist in searching for appropriate content.

Summarytrue
Comments

When multiple useContexts are specified, there is no expectation whether all or any of the contexts apply.

ConceptMap.jurisdiction
Definition

A legal or geographic region in which the concept map is intended to be used.

Control0..*
Terminology BindingJurisdiction ValueSet (Extensible)
TypeCodeableConcept
Summarytrue
Comments

It may be possible for the concept map to be used in jurisdictions other than those for which it was originally designed or intended.

ConceptMap.purpose
Definition

Explaination of why this concept map is needed and why it has been designed as it has.

Control0..1
Typemarkdown
Comments

This element does not describe the usage of the concept map Instead it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this concept map.

ConceptMap.copyright
Definition

A copyright statement relating to the concept map and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the concept map.

Control0..1
Typemarkdown
Requirements

Consumers must be able to determine any legal restrictions on the use of the concept map and/or its content.

Alternate NamesLicense; Restrictions
Comments

null 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.

Control0..1
Typeuri|Reference(ValueSet)
[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. If there is no source or target value set, the is no specified context for the map.

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.

Control0..1
Typeuri|Reference(ValueSet)
[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. If there is no source or target value set, the is no specified context for the map.

ConceptMap.group
Definition

A group of mappings that all have the same source and target system.

Control0..*
ConceptMap.group.source
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.group.sourceVersion
Definition

The specific version of the code system, as determined by the code system authority.

Control0..1
Typestring
Comments

The specification of a particular code system version may be required for code systems which lack concept permanence.

ConceptMap.group.target
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

Target may be omitted if all the targget element equivalence values are 'unmatched'.

ConceptMap.group.targetVersion
Definition

The specific version of the code system, as determined by the code system authority.

Control0..1
Typestring
Comments

The specification of a particular code system version may be required for code systems which lack concept permanence.

ConceptMap.group.element
Definition

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

Control1..*
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.group.element.code
Definition

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

Control0..1
Typecode
ConceptMap.group.element.display
Definition

The display for the code. The display is only provided to help editors when editing the concept map.

Control0..1
Typestring
Comments

The display is ignored when processing the map.

ConceptMap.group.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 (expression : comment.exists() or equivalence.empty() or ((equivalence != 'narrower') and (equivalence != 'inexact')), xpath: exists(f:comment) or not(exists(f:equivalence)) or ((f:equivalence/@value != 'narrower') and (f:equivalence/@value != 'inexact')))
ConceptMap.group.element.target.code
Definition

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

Control0..1
Typecode
ConceptMap.group.element.target.display
Definition

The display for the code. The display is only provided to help editors when editing the concept map.

Control0..1
Typestring
Comments

The display is ignored when processing the map.

ConceptMap.group.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).

Control0..1
Terminology BindingConceptMapEquivalence (Required)
Typecode
Is Modifiertrue
Default Valueequivalent
Comments

This element is labeled as a modifier because it may indicate that a target does not apply.

ConceptMap.group.element.target.comment
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 (expression : comment.exists() or equivalence.empty() or ((equivalence != 'narrower') and (equivalence != 'inexact')), xpath: exists(f:comment) or not(exists(f:equivalence)) or ((f:equivalence/@value != 'narrower') and (f:equivalence/@value != 'inexact')))
ConceptMap.group.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.group.element.target.dependsOn.property
Definition

A reference to an element that holds a coded value that corresponds to a code system property. The idea is that the information model carries an element somwhere that is labeled to correspond with a code system property.

Control1..1
Typeuri
ConceptMap.group.element.target.dependsOn.system
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).

Control0..1
Typeuri
Meaning if MissingThe code is in the source (dependsOn) or target (product) system
ConceptMap.group.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.group.element.target.dependsOn.display
Definition

The display for the code. The display is only provided to help editors when editing the concept map.

Control0..1
Typestring
Comments

The display is ignored when processing the map.

ConceptMap.group.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.group.element.target.dependsOn
ConceptMap.group.unmapped
Definition

What to do when there is no match in the mappings in the group.

Control0..1
Comments

This only applies if the source code is in the system defined for the group.

InvariantsDefined on this element
cmd-2: If the mode is 'fixed', a code must be provided (expression : (mode = 'fixed') implies code.exists(), xpath: (f:mode/@value != 'fixed') or exists(f:code))
cmd-3: If the mode is 'other-map', a code must be provided (expression : (mode = 'other-map') implies url.exists(), xpath: (f:mode/@value != 'other-map') or exists(f:url))
ConceptMap.group.unmapped.mode
Definition

Defines which action to take if there is no match in the group. One of 3 actions is possible: use the unmapped code (this is useful when doing a mapping between versions, and only a few codes have changed), use a fixed code (a default code), or alternatively, a reference to a different concept map can be provided (by canonical URL).

Control1..1
Terminology BindingConceptMapGroupUnmappedMode (Required)
Typecode
ConceptMap.group.unmapped.code
Definition

The fixed code to use when the mode = 'fixed' - all unmapped codes are mapped to a single fixed code.

Control0..1
Typecode
ConceptMap.group.unmapped.display
Definition

The display for the code. The display is only provided to help editors when editing the concept map.

Control0..1
Typestring
Comments

The display is ignored when processing the map.

ConceptMap.group.unmapped.url
Definition

The canonical URL of the map to use if this map contains no mapping.

Control0..1
Typeuri