STU3 Candidate

This page is part of the FHIR Specification (v1.8.0: STU 3 Draft). 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

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.

Control 1..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. The URL SHOULD include the major version of the concept map. For more information see Technical and Business Versions .

Control 0..1
Type uri
Requirements

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

Summary true
Comments

Can be a urn:uuid: or a urn:oid:, but real http: addresses are preferred.

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.

Note This is a business identifer, not a resource identifier (see discussion )
Control 0..1
Type Identifier
Requirements

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

Summary true
Comments

Typically, this is used for identifiers that can go in an HL7 v3 II data type - e.g. to identify this concept map outside of FHIR, where the logical URL is not possible to use.

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 are orderable.

Note This is a business versionId, not a resource version id (see discussion )
Control 0..1
Type string
Summary true
Comments

There may be multiple different instances of a concept map that have the same identifier but different versions.

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.

Control 0..1
Type string
Requirements

Support human navigation & code generation.

Summary true
Comments

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

ConceptMap.title
Definition

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

Control 0..1
Type string
Summary true
ConceptMap.status
Definition

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

Control 1..1
Terminology Binding PublicationStatus ( Required )
Type code
Is Modifier true
Summary true
Comments

Allows filtering of concept map that are appropriate for use vs. not.

ConceptMap.experimental
Definition

A flag 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.

Control 0..1
Type boolean
Is Modifier true
Requirements

Enables experimental content to be developed following the same life-cycle as a production-level concept map would.

Summary true
Comments

Allows filtering of concept map that are appropriate for use vs. not.

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 concept map. May also allow for contact.

Summary true
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.

Control 0..*
Type ContactDetail
Summary true
Comments

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

ConceptMap.date
Definition

The date (and optionally time) when 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.

Control 0..1
Type dateTime
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. Additional specific dates may be added as extensions.

ConceptMap.description
Definition

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

Control 0..1
Type markdown
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 code system definitions.

Control 0..*
Type UsageContext
Requirements

Assist in searching for appropriate content.

Summary true
Comments

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

ConceptMap.jurisdiction
Definition

A jurisdiction in which the concept map is intended to be used.

Control 0..*
Terminology Binding Jurisdiction ValueSet ( Extensible )
Type CodeableConcept
Summary true
ConceptMap.purpose
Definition

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

Control 0..1
Type markdown
Comments

This element does not describe the usage of the concept map (See, e.g, the comments element, or relatedArtifacts), rather it's for 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.

Control 0..1
Type markdown
Requirements

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

Alternate Names License; 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.

Control 0..1
Type uri | Reference ( ValueSet )
[x] Note See Choice of Data Types for further information about how to use [x]
Summary true
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.

Control 0..1
Type uri | Reference ( ValueSet )
[x] Note See Choice of Data Types for further information about how to use [x]
Summary true
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.

Control 0..*
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).

Control 1..1
Type uri
ConceptMap.group.sourceVersion
Definition

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

Control 0..1
Type string
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).

Control 0..1
Type uri
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.

Control 0..1
Type string
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.

Control 1..*
Alternate Names code; 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.

Control 0..1
Type code
ConceptMap.group.element.target
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
cmd-1 : If the map is narrower or inexact, there SHALL be some comments ( expression : comments.exists() or equivalence.empty() or ((equivalence != 'narrower') and (equivalence != 'inexact')), xpath: exists(f:comments) 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.

Control 0..1
Type code
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).

Control 0..1
Terminology Binding ConceptMapEquivalence ( Required )
Type code
Is Modifier true
Default Value equivalent
ConceptMap.group.element.target.comments
Definition

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

Control 0..1
Type string
Invariants Affect this element
cmd-1 : If the map is narrower or inexact, there SHALL be some comments ( expression : comments.exists() or equivalence.empty() or ((equivalence != 'narrower') and (equivalence != 'inexact')), xpath: exists(f:comments) 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.

Control 0..*
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 labelled to correspond with a code system property.

Control 1..1
Type uri
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).

Control 0..1
Type uri
Meaning if Missing The 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.

Control 1..1
Type string
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.

Control 0..*
Type See ConceptMap.group.element.target.dependsOn