This page is part of the FHIR Specification (v5.0.0-draft-final: Final QA Preview for R5 - see ballot notes). 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
Terminology Infrastructure Work Group | Maturity Level: 1 | Trial Use | Security Category: Anonymous | Compartments: Not linked to any defined compartments |
Detailed Descriptions for the elements in the ConceptMap resource.
ConceptMap | |||||||||||||||||||||||||
Element Id | ConceptMap | ||||||||||||||||||||||||
Definition | A statement of relationships from one set of concepts to one or more other concepts - either concepts in code systems, or data element/data element concepts, or classes in class models. | ||||||||||||||||||||||||
Short Display | A map from one set of concepts to one or more other concepts | ||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||
Type | MetadataResource | ||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
ConceptMap.url | |||||||||||||||||||||||||
Element Id | 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; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this concept map is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the concept map is stored on different servers. | ||||||||||||||||||||||||
Short Display | Canonical identifier for this concept map, represented as a URI (globally unique) | ||||||||||||||||||||||||
Cardinality | 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. Multiple instances may share the same URL if they have a distinct version. The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in Technical and Business Versions. In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the meta.source element to indicate where the current master source of the resource can be found. | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
ConceptMap.identifier | |||||||||||||||||||||||||
Element Id | 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. | ||||||||||||||||||||||||
Short Display | Additional identifier for the concept map | ||||||||||||||||||||||||
Note | This is a business identifier, not a resource identifier (see discussion) | ||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||
Type | Identifier | ||||||||||||||||||||||||
Requirements | Allows externally provided and/or usable 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 (instance identifier) data type, and can then identify this concept map outside of FHIR, where it is not possible to use the logical URI. | ||||||||||||||||||||||||
ConceptMap.version | |||||||||||||||||||||||||
Element Id | 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. | ||||||||||||||||||||||||
Short Display | Business version of the concept map | ||||||||||||||||||||||||
Note | This is a business versionId, not a resource version id (see discussion) | ||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||
Type | string | ||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||
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]. The version SHOULD NOT contain a '#' - see Business Version. | ||||||||||||||||||||||||
ConceptMap.versionAlgorithm[x] | |||||||||||||||||||||||||
Element Id | ConceptMap.versionAlgorithm[x] | ||||||||||||||||||||||||
Definition | Indicates the mechanism used to compare versions to determine which ConceptMap is more current. | ||||||||||||||||||||||||
Short Display | How to compare versions | ||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||
Terminology Binding | Version Algorithm (Extensible) | ||||||||||||||||||||||||
Type | string|Coding | ||||||||||||||||||||||||
[x] Note | See Choice of Datatypes for further information about how to use [x] | ||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||
Comments | If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined. | ||||||||||||||||||||||||
ConceptMap.name | |||||||||||||||||||||||||
Element Id | 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. | ||||||||||||||||||||||||
Short Display | Name for this concept map (computer friendly) | ||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||
Type | string | ||||||||||||||||||||||||
Requirements | Support human navigation and code generation. | ||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||
Comments | The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly. | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
ConceptMap.title | |||||||||||||||||||||||||
Element Id | ConceptMap.title | ||||||||||||||||||||||||
Definition | A short, descriptive, user-friendly title for the concept map. | ||||||||||||||||||||||||
Short Display | Name for this concept map (human friendly) | ||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||
Type | string | ||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||
Comments | This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc. | ||||||||||||||||||||||||
ConceptMap.status | |||||||||||||||||||||||||
Element Id | ConceptMap.status | ||||||||||||||||||||||||
Definition | The status of this concept map. Enables tracking the life-cycle of the content. | ||||||||||||||||||||||||
Short Display | draft | active | retired | unknown | ||||||||||||||||||||||||
Cardinality | 1..1 | ||||||||||||||||||||||||
Terminology Binding | PublicationStatus (Required) | ||||||||||||||||||||||||
Type | code | ||||||||||||||||||||||||
Is Modifier | true (Reason: This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration) | ||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||
Comments | Allows filtering of concept maps that are appropriate for use versus not. | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
ConceptMap.experimental | |||||||||||||||||||||||||
Element Id | 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. | ||||||||||||||||||||||||
Short Display | For testing purposes, not real usage | ||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||
Type | boolean | ||||||||||||||||||||||||
Meaning if Missing | If absent, this resource is treated as though it is not experimental. | ||||||||||||||||||||||||
Requirements | Enables experimental content to be developed following the same lifecycle that would be used for a production-level concept map. | ||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||
Comments | Allows filtering of concept maps that are appropriate for use versus not. | ||||||||||||||||||||||||
ConceptMap.date | |||||||||||||||||||||||||
Element Id | ConceptMap.date | ||||||||||||||||||||||||
Definition | The date (and optionally time) when the concept map was last significantly changed. The date must change 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. | ||||||||||||||||||||||||
Short Display | Date last changed | ||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||
Type | dateTime | ||||||||||||||||||||||||
Alternate Names | Revision Date | ||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||
Comments | The date is often not tracked until the resource is published, but may be present on draft content. 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 | |||||||||||||||||||||||||
Element Id | ConceptMap.publisher | ||||||||||||||||||||||||
Definition | The name of the organization or individual responsible for the release and ongoing maintenance of the concept map. | ||||||||||||||||||||||||
Short Display | Name of the publisher/steward (organization or individual) | ||||||||||||||||||||||||
Cardinality | 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 | |||||||||||||||||||||||||
Element Id | ConceptMap.contact | ||||||||||||||||||||||||
Definition | Contact details to assist a user in finding and communicating with the publisher. | ||||||||||||||||||||||||
Short Display | Contact details for the publisher | ||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||
Type | ContactDetail | ||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||
Comments | May be a web site, an email address, a telephone number, etc. | ||||||||||||||||||||||||
ConceptMap.description | |||||||||||||||||||||||||
Element Id | ConceptMap.description | ||||||||||||||||||||||||
Definition | A free text natural language description of the concept map from a consumer's perspective. | ||||||||||||||||||||||||
Short Display | Natural language description of the concept map | ||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||
Type | markdown | ||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||
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 | |||||||||||||||||||||||||
Element Id | ConceptMap.useContext | ||||||||||||||||||||||||
Definition | The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate concept map instances. | ||||||||||||||||||||||||
Short Display | The context that the content is intended to support | ||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||
Type | UsageContext | ||||||||||||||||||||||||
Requirements | Assist in searching for appropriate content. | ||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||
Comments | When multiple useContexts are specified, there is no expectation that all or any of the contexts apply. | ||||||||||||||||||||||||
ConceptMap.jurisdiction | |||||||||||||||||||||||||
Element Id | ConceptMap.jurisdiction | ||||||||||||||||||||||||
Definition | A legal or geographic region in which the concept map is intended to be used. | ||||||||||||||||||||||||
Short Display | Intended jurisdiction for concept map (if applicable) | ||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||
Terminology Binding | Jurisdiction ValueSet (Extensible) | ||||||||||||||||||||||||
Type | CodeableConcept | ||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||
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 | |||||||||||||||||||||||||
Element Id | ConceptMap.purpose | ||||||||||||||||||||||||
Definition | Explanation of why this concept map is needed and why it has been designed as it has. | ||||||||||||||||||||||||
Short Display | Why this concept map is defined | ||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||
Type | markdown | ||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||
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 | |||||||||||||||||||||||||
Element Id | 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. | ||||||||||||||||||||||||
Short Display | Use and/or publishing restrictions | ||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||
Type | markdown | ||||||||||||||||||||||||
Requirements | Consumers must be able to determine any legal restrictions on the use of the concept map and/or its content. | ||||||||||||||||||||||||
Alternate Names | License; Restrictions | ||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||
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.copyrightLabel | |||||||||||||||||||||||||
Element Id | ConceptMap.copyrightLabel | ||||||||||||||||||||||||
Definition | A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved'). | ||||||||||||||||||||||||
Short Display | Copyright holder and year(s) | ||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||
Type | string | ||||||||||||||||||||||||
Requirements | Defines the content expected to be rendered in all representations of the artifact. | ||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||
Comments | The (c) symbol should NOT be included in this string. It will be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element. | ||||||||||||||||||||||||
ConceptMap.approvalDate | |||||||||||||||||||||||||
Element Id | ConceptMap.approvalDate | ||||||||||||||||||||||||
Definition | The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage. | ||||||||||||||||||||||||
Short Display | When the ConceptMap was approved by publisher | ||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||
Type | date | ||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||
Comments | The 'date' element may be more recent than the approval date because of minor changes or editorial corrections. | ||||||||||||||||||||||||
ConceptMap.lastReviewDate | |||||||||||||||||||||||||
Element Id | ConceptMap.lastReviewDate | ||||||||||||||||||||||||
Definition | The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date. | ||||||||||||||||||||||||
Short Display | When the ConceptMap was last reviewed by the publisher | ||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||
Type | date | ||||||||||||||||||||||||
Requirements | Gives a sense of how "current" the content is. Resources that have not been reviewed in a long time may have a risk of being less appropriate/relevant. | ||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||
Comments | If specified, this date follows the original approval date. | ||||||||||||||||||||||||
ConceptMap.effectivePeriod | |||||||||||||||||||||||||
Element Id | ConceptMap.effectivePeriod | ||||||||||||||||||||||||
Definition | The period during which the ConceptMap content was or is planned to be in active use. | ||||||||||||||||||||||||
Short Display | When the ConceptMap is expected to be used | ||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||
Type | Period | ||||||||||||||||||||||||
Requirements | Allows establishing a transition before a resource comes into effect and also allows for a sunsetting process when new versions of the ConceptMap are or are expected to be used instead. | ||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||
Comments | The effective period for a ConceptMap determines when the content is applicable for usage and is independent of publication and review dates. For example, a measure intended to be used for the year 2016 might be published in 2015. | ||||||||||||||||||||||||
ConceptMap.topic | |||||||||||||||||||||||||
Element Id | ConceptMap.topic | ||||||||||||||||||||||||
Definition | Descriptions related to the content of the ConceptMap. Topics provide a high-level categorization as well as keywords for the ConceptMap that can be useful for filtering and searching. | ||||||||||||||||||||||||
Short Display | E.g. Education, Treatment, Assessment, etc | ||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||
Terminology Binding | Definition Topic (Example) | ||||||||||||||||||||||||
Type | CodeableConcept | ||||||||||||||||||||||||
Requirements | Repositories must be able to determine how to categorize the ConceptMap so that it can be found by topical and keyword searches. | ||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||
Comments | This element provides topical categorization and keywords for the ConceptMap, as opposed to the more structured context-of-use information provided in the useContext element | ||||||||||||||||||||||||
ConceptMap.author | |||||||||||||||||||||||||
Element Id | ConceptMap.author | ||||||||||||||||||||||||
Definition | An individiual or organization primarily involved in the creation and maintenance of the ConceptMap. | ||||||||||||||||||||||||
Short Display | Who authored the ConceptMap | ||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||
Type | ContactDetail | ||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||
ConceptMap.editor | |||||||||||||||||||||||||
Element Id | ConceptMap.editor | ||||||||||||||||||||||||
Definition | An individual or organization primarily responsible for internal coherence of the ConceptMap. | ||||||||||||||||||||||||
Short Display | Who edited the ConceptMap | ||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||
Type | ContactDetail | ||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||
ConceptMap.reviewer | |||||||||||||||||||||||||
Element Id | ConceptMap.reviewer | ||||||||||||||||||||||||
Definition | An individual or organization asserted by the publisher to be primarily responsible for review of some aspect of the ConceptMap. | ||||||||||||||||||||||||
Short Display | Who reviewed the ConceptMap | ||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||
Type | ContactDetail | ||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||
ConceptMap.endorser | |||||||||||||||||||||||||
Element Id | ConceptMap.endorser | ||||||||||||||||||||||||
Definition | An individual or organization asserted by the publisher to be responsible for officially endorsing the ConceptMap for use in some setting. | ||||||||||||||||||||||||
Short Display | Who endorsed the ConceptMap | ||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||
Type | ContactDetail | ||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||
ConceptMap.relatedArtifact | |||||||||||||||||||||||||
Element Id | ConceptMap.relatedArtifact | ||||||||||||||||||||||||
Definition | Related artifacts such as additional documentation, justification, dependencies, bibliographic references, and predecessor and successor artifacts. | ||||||||||||||||||||||||
Short Display | Additional documentation, citations, etc | ||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||
Type | RelatedArtifact | ||||||||||||||||||||||||
Requirements | A ConceptMap must be able to provide enough information for consumers of the content (and/or interventions or results produced by the content) to be able to determine and understand the justification for and evidence in support of the content. | ||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||
Comments | Each related artifact is either an attachment, or a reference to another resource, but not both. | ||||||||||||||||||||||||
ConceptMap.property | |||||||||||||||||||||||||
Element Id | ConceptMap.property | ||||||||||||||||||||||||
Definition | A property defines a slot through which additional information can be provided about a map from source -> target. | ||||||||||||||||||||||||
Short Display | Additional properties of the mapping | ||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||
Comments | Properties may be used to supply for example, mapping priority, provenance, presentation hints, flag as experimental, and additional documentation. Multiple occurrences of ConceptMap.group.element.target.property may occur for a ConceptMap.property where ConceptMap.group.element.target.property.code is the same and the values in ConceptMap.group.element.target.property.value differ. | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
ConceptMap.property.code | |||||||||||||||||||||||||
Element Id | ConceptMap.property.code | ||||||||||||||||||||||||
Definition | A code that is used to identify the property. The code is used internally (in ConceptMap.group.element.target.property.code) and also in the $translate operation. | ||||||||||||||||||||||||
Short Display | Identifies the property on the mappings, and when referred to in the $translate operation | ||||||||||||||||||||||||
Cardinality | 1..1 | ||||||||||||||||||||||||
Type | code | ||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||
ConceptMap.property.uri | |||||||||||||||||||||||||
Element Id | ConceptMap.property.uri | ||||||||||||||||||||||||
Definition | Reference to the formal meaning of the property. | ||||||||||||||||||||||||
Short Display | Formal identifier for the property | ||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||
Type | uri | ||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||
ConceptMap.property.description | |||||||||||||||||||||||||
Element Id | ConceptMap.property.description | ||||||||||||||||||||||||
Definition | A description of the property - why it is defined, and how its value might be used. | ||||||||||||||||||||||||
Short Display | Why the property is defined, and/or what it conveys | ||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||
Type | string | ||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||
ConceptMap.property.type | |||||||||||||||||||||||||
Element Id | ConceptMap.property.type | ||||||||||||||||||||||||
Definition | The type of the property value. | ||||||||||||||||||||||||
Short Display | Coding | string | integer | boolean | dateTime | decimal | code | ||||||||||||||||||||||||
Cardinality | 1..1 | ||||||||||||||||||||||||
Terminology Binding | ConceptMap Property Type (Required) | ||||||||||||||||||||||||
Type | code | ||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
ConceptMap.property.system | |||||||||||||||||||||||||
Element Id | ConceptMap.property.system | ||||||||||||||||||||||||
Definition | The CodeSystem that defines the codes from which values of type | ||||||||||||||||||||||||
Short Display | The CodeSystem from which code values come | ||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||
Type | canonical(CodeSystem) | ||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
ConceptMap.additionalAttribute | |||||||||||||||||||||||||
Element Id | ConceptMap.additionalAttribute | ||||||||||||||||||||||||
Definition | An additionalAttribute defines an additional data element found in the source or target data model where the data will come from or be mapped to. Some mappings are based on data in addition to the source data element, where codes in multiple fields are combined to a single field (or vice versa). | ||||||||||||||||||||||||
Short Display | Definition of an additional attribute to act as a data source or target | ||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||
Comments | Additional attributes are used to define additional data elements where mapping data can be found. For an example, see [Specimen Type v2 -> SNOMED CT Mapping(conceptmap-example-specimen-type.html) | ||||||||||||||||||||||||
ConceptMap.additionalAttribute.code | |||||||||||||||||||||||||
Element Id | ConceptMap.additionalAttribute.code | ||||||||||||||||||||||||
Definition | A code that is used to identify this additional data attribute. The code is used internally in ConceptMap.group.element.target.dependsOn.attribute and ConceptMap.group.element.target.product.attribute. | ||||||||||||||||||||||||
Short Display | Identifies this additional attribute through this resource | ||||||||||||||||||||||||
Cardinality | 1..1 | ||||||||||||||||||||||||
Type | code | ||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||
ConceptMap.additionalAttribute.uri | |||||||||||||||||||||||||
Element Id | ConceptMap.additionalAttribute.uri | ||||||||||||||||||||||||
Definition | Reference to the formal definition of the source/target data element. For elements defined by the FHIR specification, or using a FHIR logical model, the correct format is {canonical-url}#{element-id}. | ||||||||||||||||||||||||
Short Display | Formal identifier for the data element referred to in this attribte | ||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||
Type | uri | ||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||
ConceptMap.additionalAttribute.description | |||||||||||||||||||||||||
Element Id | ConceptMap.additionalAttribute.description | ||||||||||||||||||||||||
Definition | A description of the additional attribute and/or the data element it refers to - why it is defined, and how the value might be used in mappings, and a discussion of issues associated with the use of the data element. | ||||||||||||||||||||||||
Short Display | Why the additional attribute is defined, and/or what the data element it refers to is | ||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||
Type | string | ||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||
ConceptMap.additionalAttribute.type | |||||||||||||||||||||||||
Element Id | ConceptMap.additionalAttribute.type | ||||||||||||||||||||||||
Definition | The type of the source data contained in this concept map for this data element. | ||||||||||||||||||||||||
Short Display | code | Coding | string | boolean | Quantity | ||||||||||||||||||||||||
Cardinality | 1..1 | ||||||||||||||||||||||||
Terminology Binding | ConceptMap Attribute Type (Required) | ||||||||||||||||||||||||
Type | code | ||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||
Comments | When the source or target is not content defined by FHIR, some additional application logic might be required to map from the FHIR Datatype to the externally defined content | ||||||||||||||||||||||||
ConceptMap.sourceScope[x] | |||||||||||||||||||||||||
Element Id | ConceptMap.sourceScope[x] | ||||||||||||||||||||||||
Definition | Identifier for the source value set that contains the concepts that are being mapped and provides context for the mappings. Limits the scope of the map to source codes (ConceptMap.group.element code or valueSet) that are members of this value set. | ||||||||||||||||||||||||
Short Display | The source value set that contains the concepts that are being mapped | ||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||
Type | uri|canonical(ValueSet) | ||||||||||||||||||||||||
[x] Note | See Choice of Datatypes 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 sourceScope or targetScope value set, there is no specified context for the map (not recommended). The sourceScope value set may select codes from either an explicit (standard or local) or implicit code system. | ||||||||||||||||||||||||
ConceptMap.targetScope[x] | |||||||||||||||||||||||||
Element Id | ConceptMap.targetScope[x] | ||||||||||||||||||||||||
Definition | Identifier for the target value set that provides important context about how the mapping choices are made. Limits the scope of the map to target codes (ConceptMap.group.element.target code or valueSet) that are members of this value set. | ||||||||||||||||||||||||
Short Display | The target value set which provides context for the mappings | ||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||
Type | uri|canonical(ValueSet) | ||||||||||||||||||||||||
[x] Note | See Choice of Datatypes 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 sourceScope or targetScope value set, there is no specified context for the map (not recommended). The targetScope value set may select codes from either an explicit (standard or local) or implicit code system. | ||||||||||||||||||||||||
ConceptMap.group | |||||||||||||||||||||||||
Element Id | ConceptMap.group | ||||||||||||||||||||||||
Definition | A group of mappings that all have the same source and target system. | ||||||||||||||||||||||||
Short Display | Same source and target systems | ||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||
ConceptMap.group.source | |||||||||||||||||||||||||
Element Id | ConceptMap.group.source | ||||||||||||||||||||||||
Definition | An absolute URI that identifies the source system where the concepts to be mapped are defined. | ||||||||||||||||||||||||
Short Display | Source system where concepts to be mapped are defined | ||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||
Type | canonical(CodeSystem) | ||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||
Comments | This is not needed if the source value set is specified and it contains concepts from only a single system. | ||||||||||||||||||||||||
ConceptMap.group.target | |||||||||||||||||||||||||
Element Id | ConceptMap.group.target | ||||||||||||||||||||||||
Definition | An absolute URI that identifies the target system that the concepts will be mapped to. | ||||||||||||||||||||||||
Short Display | Target system that the concepts are to be mapped to | ||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||
Type | canonical(CodeSystem) | ||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||
Comments | This is not needed if the target value set is specified and it contains concepts from only a single system. The group target may also be omitted if all of the target element relationship values are 'not-related-to'. | ||||||||||||||||||||||||
ConceptMap.group.element | |||||||||||||||||||||||||
Element Id | ConceptMap.group.element | ||||||||||||||||||||||||
Definition | Mappings for an individual concept in the source to one or more concepts in the target. | ||||||||||||||||||||||||
Short Display | Mappings for a concept from the source set | ||||||||||||||||||||||||
Cardinality | 1..* | ||||||||||||||||||||||||
Alternate Names | code; concept; item | ||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||
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. | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
ConceptMap.group.element.code | |||||||||||||||||||||||||
Element Id | ConceptMap.group.element.code | ||||||||||||||||||||||||
Definition | Identity (code or path) or the element/item being mapped. | ||||||||||||||||||||||||
Short Display | Identifies element being mapped | ||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||
Type | code | ||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
ConceptMap.group.element.display | |||||||||||||||||||||||||
Element Id | ConceptMap.group.element.display | ||||||||||||||||||||||||
Definition | The display for the code. The display is only provided to help editors when editing the concept map. | ||||||||||||||||||||||||
Short Display | Display for the code | ||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||
Type | string | ||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||
Comments | The display is ignored when processing the map. | ||||||||||||||||||||||||
ConceptMap.group.element.valueSet | |||||||||||||||||||||||||
Element Id | ConceptMap.group.element.valueSet | ||||||||||||||||||||||||
Definition | The set of codes being mapped. | ||||||||||||||||||||||||
Short Display | Identifies elements being mapped | ||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||
Type | canonical(ValueSet) | ||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
ConceptMap.group.element.noMap | |||||||||||||||||||||||||
Element Id | ConceptMap.group.element.noMap | ||||||||||||||||||||||||
Definition | If noMap = true this indicates that no mapping to a target concept exists for this source concept. | ||||||||||||||||||||||||
Short Display | No mapping to a target concept for this source concept | ||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||
Type | boolean | ||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
ConceptMap.group.element.target | |||||||||||||||||||||||||
Element Id | ConceptMap.group.element.target | ||||||||||||||||||||||||
Definition | A concept from the target value set that this concept maps to. | ||||||||||||||||||||||||
Short Display | Concept in target system for element | ||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||
Comments | Ideally there would only be one map, with an 'equivalent' mapping. But multiple maps are allowed for several narrower (i.e. source-is-broader-than-target) options, or to assert that other concepts are not related. | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
ConceptMap.group.element.target.code | |||||||||||||||||||||||||
Element Id | ConceptMap.group.element.target.code | ||||||||||||||||||||||||
Definition | Identity (code or path) or the element/item that the map refers to. | ||||||||||||||||||||||||
Short Display | Code that identifies the target element | ||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||
Type | code | ||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
ConceptMap.group.element.target.display | |||||||||||||||||||||||||
Element Id | ConceptMap.group.element.target.display | ||||||||||||||||||||||||
Definition | The display for the code. The display is only provided to help editors when editing the concept map. | ||||||||||||||||||||||||
Short Display | Display for the code | ||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||
Type | string | ||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||
Comments | The display is ignored when processing the map. | ||||||||||||||||||||||||
ConceptMap.group.element.target.valueSet | |||||||||||||||||||||||||
Element Id | ConceptMap.group.element.target.valueSet | ||||||||||||||||||||||||
Definition | The set of codes that the map refers to. | ||||||||||||||||||||||||
Short Display | Identifies the set of target elements | ||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||
Type | canonical(ValueSet) | ||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
ConceptMap.group.element.target.relationship | |||||||||||||||||||||||||
Element Id | ConceptMap.group.element.target.relationship | ||||||||||||||||||||||||
Definition | The relationship between the source and target concepts. The relationship is read from source to target (e.g. source-is-narrower-than-target). | ||||||||||||||||||||||||
Short Display | related-to | equivalent | source-is-narrower-than-target | source-is-broader-than-target | not-related-to | ||||||||||||||||||||||||
Cardinality | 1..1 | ||||||||||||||||||||||||
Terminology Binding | ConceptMapRelationship (Required) | ||||||||||||||||||||||||
Type | code | ||||||||||||||||||||||||
Is Modifier | true (Reason: The 'not-related-to' relationship means that there is no mapping from the source to the target, and the mapping cannot be interpreted without knowing this value as it could mean the elements are equivalent, totally mismatched or anything in between) | ||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||
Comments | This element is labeled as a modifier because it may indicate that there is no mapping. | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
ConceptMap.group.element.target.comment | |||||||||||||||||||||||||
Element Id | ConceptMap.group.element.target.comment | ||||||||||||||||||||||||
Definition | A description of status/issues in mapping that conveys additional information not represented in the structured data. | ||||||||||||||||||||||||
Short Display | Description of status/issues in mapping | ||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||
Type | string | ||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
ConceptMap.group.element.target.property | |||||||||||||||||||||||||
Element Id | ConceptMap.group.element.target.property | ||||||||||||||||||||||||
Definition | A property value for this source -> target mapping. | ||||||||||||||||||||||||
Short Display | Property value for the source -> target mapping | ||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||
ConceptMap.group.element.target.property.code | |||||||||||||||||||||||||
Element Id | ConceptMap.group.element.target.property.code | ||||||||||||||||||||||||
Definition | A reference to a mapping property defined in ConceptMap.property. | ||||||||||||||||||||||||
Short Display | Reference to ConceptMap.property.code | ||||||||||||||||||||||||
Cardinality | 1..1 | ||||||||||||||||||||||||
Type | code | ||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||
ConceptMap.group.element.target.property.value[x] | |||||||||||||||||||||||||
Element Id | ConceptMap.group.element.target.property.value[x] | ||||||||||||||||||||||||
Definition | The value of this property. | ||||||||||||||||||||||||
Short Display | Value of the property for this concept | ||||||||||||||||||||||||
Cardinality | 1..1 | ||||||||||||||||||||||||
Type | Coding|string|integer|boolean|dateTime|decimal|code | ||||||||||||||||||||||||
[x] Note | See Choice of Datatypes for further information about how to use [x] | ||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||
ConceptMap.group.element.target.dependsOn | |||||||||||||||||||||||||
Element Id | ConceptMap.group.element.target.dependsOn | ||||||||||||||||||||||||
Definition | A set of additional dependencies for this mapping to hold. This mapping is only applicable if the specified data attribute can be resolved, and it has the specified value. | ||||||||||||||||||||||||
Short Display | Other properties required for this mapping | ||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
ConceptMap.group.element.target.dependsOn.attribute | |||||||||||||||||||||||||
Element Id | ConceptMap.group.element.target.dependsOn.attribute | ||||||||||||||||||||||||
Definition | A reference to the additional attribute that holds a value the map depends on. | ||||||||||||||||||||||||
Short Display | A reference to a mapping attribute defined in ConceptMap.additionalAttribute | ||||||||||||||||||||||||
Cardinality | 1..1 | ||||||||||||||||||||||||
Type | code | ||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||
ConceptMap.group.element.target.dependsOn.value[x] | |||||||||||||||||||||||||
Element Id | ConceptMap.group.element.target.dependsOn.value[x] | ||||||||||||||||||||||||
Definition | Data element value that the map depends on / produces. | ||||||||||||||||||||||||
Short Display | Value of the referenced data element | ||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||
Type | code|Coding|string|boolean|Quantity | ||||||||||||||||||||||||
[x] Note | See Choice of Datatypes for further information about how to use [x] | ||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||
Comments | If the data type is a code, then the code system is the code system specified in .group.source or .group.target | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
ConceptMap.group.element.target.dependsOn.valueSet | |||||||||||||||||||||||||
Element Id | ConceptMap.group.element.target.dependsOn.valueSet | ||||||||||||||||||||||||
Definition | This mapping applies if the data element value is a code from this value set. | ||||||||||||||||||||||||
Short Display | The mapping depends on a data element with a value from this value set | ||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||
Type | canonical(ValueSet) | ||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
ConceptMap.group.element.target.product | |||||||||||||||||||||||||
Element Id | ConceptMap.group.element.target.product | ||||||||||||||||||||||||
Definition | Product is the output of a ConceptMap that provides additional values that go in other attributes / data elemnts of the target data. | ||||||||||||||||||||||||
Short Display | Other data elements that this mapping also produces | ||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||
Type | See ConceptMap.group.element.target.dependsOn | ||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||
ConceptMap.group.unmapped | |||||||||||||||||||||||||
Element Id | ConceptMap.group.unmapped | ||||||||||||||||||||||||
Definition | What to do when there is no mapping to a target concept from the source concept. This provides the "default" to be applied when there is no target concept mapping specified. The 'unmapped' element is ignored if a code is specified to have relationship = not-related-to. | ||||||||||||||||||||||||
Short Display | What to do when there is no mapping target for the source concept | ||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||
Comments | This only applies if the source code has a system value that matches the system defined for the group. | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
ConceptMap.group.unmapped.mode | |||||||||||||||||||||||||
Element Id | ConceptMap.group.unmapped.mode | ||||||||||||||||||||||||
Definition | Defines which action to take if there is no match for the source concept in the target system designated for the group. One of 3 actions are possible: use the unmapped source 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). | ||||||||||||||||||||||||
Short Display | use-source-code | fixed | other-map | ||||||||||||||||||||||||
Cardinality | 1..1 | ||||||||||||||||||||||||
Terminology Binding | Concept Map Group Unmapped Mode (Required) | ||||||||||||||||||||||||
Type | code | ||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
ConceptMap.group.unmapped.code | |||||||||||||||||||||||||
Element Id | ConceptMap.group.unmapped.code | ||||||||||||||||||||||||
Definition | The fixed code to use when the mode = 'fixed' - all unmapped codes are mapped to a single fixed code. | ||||||||||||||||||||||||
Short Display | Fixed code when mode = fixed | ||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||
Type | code | ||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
ConceptMap.group.unmapped.display | |||||||||||||||||||||||||
Element Id | ConceptMap.group.unmapped.display | ||||||||||||||||||||||||
Definition | The display for the code. The display is only provided to help editors when editing the concept map. | ||||||||||||||||||||||||
Short Display | Display for the code | ||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||
Type | string | ||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||
Comments | The display is ignored when processing the map. | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
ConceptMap.group.unmapped.valueSet | |||||||||||||||||||||||||
Element Id | ConceptMap.group.unmapped.valueSet | ||||||||||||||||||||||||
Definition | The set of fixed codes to use when the mode = 'fixed' - all unmapped codes are mapped to each of the fixed codes. | ||||||||||||||||||||||||
Short Display | Fixed code set when mode = fixed | ||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||
Type | canonical(ValueSet) | ||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
ConceptMap.group.unmapped.relationship | |||||||||||||||||||||||||
Element Id | ConceptMap.group.unmapped.relationship | ||||||||||||||||||||||||
Definition | The default relationship value to apply between the source and target concepts when the source code is unmapped and the mode is 'fixed' or 'use-source-code'. | ||||||||||||||||||||||||
Short Display | related-to | equivalent | source-is-narrower-than-target | source-is-broader-than-target | not-related-to | ||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||
Terminology Binding | ConceptMapRelationship (Required) | ||||||||||||||||||||||||
Type | code | ||||||||||||||||||||||||
Is Modifier | true (Reason: The 'not-related-to' relationship means that there is no mapping from the source to the target, and the mapping cannot be interpreted without knowing this value as it could mean the elements are equivalent, totally mismatched or anything in between) | ||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||
Comments | This element is labeled as a modifier because it may indicate that there is no mapping. | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
ConceptMap.group.unmapped.otherMap | |||||||||||||||||||||||||
Element Id | ConceptMap.group.unmapped.otherMap | ||||||||||||||||||||||||
Definition | The canonical reference to an additional ConceptMap resource instance to use for mapping if this ConceptMap resource contains no matching mapping for the source concept. | ||||||||||||||||||||||||
Short Display | canonical reference to an additional ConceptMap to use for mapping if the source concept is unmapped | ||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||
Type | canonical(ConceptMap) | ||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||
Invariants |
|