ConceptMap - FHIR Resource (r4)
This ConceptMap Resource uses the FHIR API standard for access and structure.
Validate an ConceptMap FHIR Resource (r4)
ConceptMap Attributes
AttributeField is listTypeDescription
Description: Canonical identifier for this concept map, represented as a URI (globally unique)
FHIR Version: r4
Attribute Type : uri
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"url": "http://hl7.org/fhir/ConceptMap/101"Learn more about the (ConceptMap) url FHIR attribute
Description: Additional identifier for the concept map
FHIR Version: r4
Attribute Type : Identifier
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"identifier": {
"system": "urn:ietf:rfc:3986",
"value": "urn:uuid:53cd62ee-033e-414c-9f58-3ca97b5ffc3b"
}Learn more about the (ConceptMap) identifier FHIR attribute
Description: Business version of the concept map
FHIR Version: r4
Attribute Type : string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"version": "4.0.1"Learn more about the (ConceptMap) version FHIR attribute
Description: C? Name for this concept map (computer friendly)
FHIR Version: r4
Attribute Type : string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"name": "FHIR-v3-Address-Use"Learn more about the (ConceptMap) name FHIR attribute
Description: Name for this concept map (human friendly)
FHIR Version: r4
Attribute Type : string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"title": "FHIR/v3 Address Use Mapping"Learn more about the (ConceptMap) title FHIR attribute
Description: draft | active | retired | unknown
FHIR Version: r4
Attribute Type : code
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"status": "draft"Learn more about the (ConceptMap) status FHIR attribute
Description: For testing purposes, not real usage
FHIR Version: r4
Attribute Type : boolean
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"experimental": trueLearn more about the (ConceptMap) experimental FHIR attribute
Description: Date last changed
FHIR Version: r4
Attribute Type : dateTime
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"date": "2012-06-13"Learn more about the (ConceptMap) date FHIR attribute
Description: Name of the publisher (organization or individual)
FHIR Version: r4
Attribute Type : string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"publisher": "HL7, Inc"Learn more about the (ConceptMap) publisher FHIR attribute
Description: Contact details for the publisher
FHIR Version: r4
Attribute Type : ContactDetail
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"contact": [
{
"name": "FHIR project team (example)",
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
}
]
}
]Learn more about the (ConceptMap) contact FHIR attribute
Description: Natural language description of the concept map
FHIR Version: r4
Attribute Type : markdown
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"description": "A mapping between the FHIR and HL7 v3 AddressUse Code systems"Learn more about the (ConceptMap) description FHIR attribute
Description: The context that the content is intended to support
FHIR Version: r4
Attribute Type : UsageContext
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"useContext": [
{
"code": {
"system": "http://terminology.hl7.org/CodeSystem/usage-context-type",
"code": "venue"
},
"valueCodeableConcept": {
"text": "for CCDA Usage"
}
}
]Learn more about the (ConceptMap) useContext FHIR attribute
Description: Intended jurisdiction for concept map (if applicable)
FHIR Version: r4
Attribute Type : CodeableConcept
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"jurisdiction": [
{
"coding": [
{
"system": "urn:iso:std:iso:3166",
"code": "US"
}
]
}
]Learn more about the (ConceptMap) jurisdiction FHIR attribute
Description: Why this concept map is defined
FHIR Version: r4
Attribute Type : markdown
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"purpose": "To help implementers map from HL7 v3/CDA to FHIR"Learn more about the (ConceptMap) purpose FHIR attribute
Description: Use and/or publishing restrictions
FHIR Version: r4
Attribute Type : markdown
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"copyright": "Creative Commons 0"Learn more about the (ConceptMap) copyright FHIR attribute
Description:
FHIR Version: r4
Attribute Type : uri|canonical(ValueSet)
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"source[x]": Learn more about the (ConceptMap) source[x] FHIR attribute
Description:
FHIR Version: r4
Attribute Type : uri|canonical(ValueSet)
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"target[x]": Learn more about the (ConceptMap) target[x] FHIR attribute
Description: Same source and target systems
FHIR Version: r4
Attribute Type : Data Type
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"group": [
{
"source": "http://hl7.org/fhir/address-use",
"target": "http://terminology.hl7.org/CodeSystem/v3-AddressUse",
"element": [
{
"code": "home",
"display": "home",
"target": [
{
"code": "H",
"display": "home",
"equivalence": "equivalent"
}
]
},
{
"code": "work",
"display": "work",
"target": [
{
"code": "WP",
"display": "work place",
"equivalence": "equivalent"
}
]
},
{
"code": "temp",
"display": "temp",
"target": [
{
"code": "TMP",
"display": "temporary address",
"equivalence": "equivalent"
}
]
},
{
"code": "old",
"display": "old",
"target": [
{
"code": "BAD",
"display": "bad address",
"equivalence": "disjoint",
"comment": "In the HL7 v3 AD, old is handled by the usablePeriod element, but you have to provide a time, there's no simple equivalent of flagging an address as old"
}
]
}
],
"unmapped": {
"mode": "fixed",
"code": "temp",
"display": "temp"
}
}
]Learn more about the (ConceptMap) group FHIR attribute
ConceptMap Example
{
"resourceType": "ConceptMap",
"id": "101",
"text": {
"status": "generated",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n <h2>FHIR-v3-Address-Use (http://hl7.org/fhir/ConceptMap/101)</h2>\n <p>Mapping from \n <a href=\"valueset-address-use.html\">http://hl7.org/fhir/ValueSet/address-use</a> to \n <a href=\"v3/AddressUse/vs.html\">http://terminology.hl7.org/ValueSet/v3-AddressUse</a>\n </p>\n <p>DRAFT (not intended for production usage). Published on 13/06/2012 by HL7, Inc (FHIR project team (example): \n <a href=\"http://hl7.org/fhir\">http://hl7.org/fhir</a>). Creative Commons 0\n </p>\n <div>\n <p>A mapping between the FHIR and HL7 v3 AddressUse Code systems</p>\n\n </div>\n <br/>\n <table class=\"grid\">\n <tr>\n <td>\n <b>Source Code</b>\n </td>\n <td>\n <b>Equivalence</b>\n </td>\n <td>\n <b>Destination Code</b>\n </td>\n <td>\n <b>Comment</b>\n </td>\n </tr>\n <tr>\n <td>home</td>\n <td>equivalent</td>\n <td>H (home address)</td>\n <td/>\n </tr>\n <tr>\n <td>work</td>\n <td>equivalent</td>\n <td>WP (work place)</td>\n <td/>\n </tr>\n <tr>\n <td>temp (Temporary)</td>\n <td>equivalent</td>\n <td>TMP (temporary address)</td>\n <td/>\n </tr>\n <tr>\n <td>old (Old / Incorrect)</td>\n <td>disjoint</td>\n <td>BAD (bad address)</td>\n <td>In the HL7 v3 AD, old is handled by the usablePeriod element, but you have to provide a time, there's no simple equivalent of flagging an address as old</td>\n </tr>\n </table>\n </div>"
},
"url": "http://hl7.org/fhir/ConceptMap/101",
"identifier": {
"system": "urn:ietf:rfc:3986",
"value": "urn:uuid:53cd62ee-033e-414c-9f58-3ca97b5ffc3b"
},
"version": "4.0.1",
"name": "FHIR-v3-Address-Use",
"title": "FHIR/v3 Address Use Mapping",
"status": "draft",
"experimental": true,
"date": "2012-06-13",
"publisher": "HL7, Inc",
"contact": [
{
"name": "FHIR project team (example)",
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
}
]
}
],
"description": "A mapping between the FHIR and HL7 v3 AddressUse Code systems",
"useContext": [
{
"code": {
"system": "http://terminology.hl7.org/CodeSystem/usage-context-type",
"code": "venue"
},
"valueCodeableConcept": {
"text": "for CCDA Usage"
}
}
],
"jurisdiction": [
{
"coding": [
{
"system": "urn:iso:std:iso:3166",
"code": "US"
}
]
}
],
"purpose": "To help implementers map from HL7 v3/CDA to FHIR",
"copyright": "Creative Commons 0",
"sourceUri": "http://hl7.org/fhir/ValueSet/address-use",
"targetUri": "http://terminology.hl7.org/ValueSet/v3-AddressUse",
"group": [
{
"source": "http://hl7.org/fhir/address-use",
"target": "http://terminology.hl7.org/CodeSystem/v3-AddressUse",
"element": [
{
"code": "home",
"display": "home",
"target": [
{
"code": "H",
"display": "home",
"equivalence": "equivalent"
}
]
},
{
"code": "work",
"display": "work",
"target": [
{
"code": "WP",
"display": "work place",
"equivalence": "equivalent"
}
]
},
{
"code": "temp",
"display": "temp",
"target": [
{
"code": "TMP",
"display": "temporary address",
"equivalence": "equivalent"
}
]
},
{
"code": "old",
"display": "old",
"target": [
{
"code": "BAD",
"display": "bad address",
"equivalence": "disjoint",
"comment": "In the HL7 v3 AD, old is handled by the usablePeriod element, but you have to provide a time, there's no simple equivalent of flagging an address as old"
}
]
}
],
"unmapped": {
"mode": "fixed",
"code": "temp",
"display": "temp"
}
}
]
}ConceptMap Structure
{
"resourceType" : "ConceptMap",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"url" : "<uri>", // Canonical identifier for this concept map, represented as a URI (globally unique)
"identifier" : { Identifier }, // Additional identifier for the concept map
"version" : "<string>", // Business version of the concept map
"name" : "<string>", // C? Name for this concept map (computer friendly)
"title" : "<string>", // Name for this concept map (human friendly)
"status" : "<code>", // R! draft | active | retired | unknown
"experimental" : <boolean>, // For testing purposes, not real usage
"date" : "<dateTime>", // Date last changed
"publisher" : "<string>", // Name of the publisher (organization or individual)
"contact" : [{ ContactDetail }], // Contact details for the publisher
"description" : "<markdown>", // Natural language description of the concept map
"useContext" : [{ UsageContext }], // The context that the content is intended to support
"jurisdiction" : [{ CodeableConcept }], // Intended jurisdiction for concept map (if applicable)
"purpose" : "<markdown>", // Why this concept map is defined
"copyright" : "<markdown>", // Use and/or publishing restrictions
// source[x]: The source value set that contains the concepts that are being mapped. One of these 2:
"sourceUri" : "<uri>",
"sourceCanonical" : { canonical(ValueSet) },
// target[x]: The target value set which provides context for the mappings. One of these 2:
"targetUri" : "<uri>",
"targetCanonical" : { canonical(ValueSet) },
"group" : [{ // Same source and target systems
"source" : "<uri>", // Source system where concepts to be mapped are defined
"sourceVersion" : "<string>", // Specific version of the code system
"target" : "<uri>", // Target system that the concepts are to be mapped to
"targetVersion" : "<string>", // Specific version of the code system
"element" : [{ // R! Mappings for a concept from the source set
"code" : "<code>", // Identifies element being mapped
"display" : "<string>", // Display for the code
"target" : [{ // Concept in target system for element
"code" : "<code>", // Code that identifies the target element
"display" : "<string>", // Display for the code
"equivalence" : "<code>", // R! relatedto | equivalent | equal | wider | subsumes | narrower | specializes | inexact | unmatched | disjoint
"comment" : "<string>", // C? Description of status/issues in mapping
"dependsOn" : [{ // Other elements required for this mapping (from context)
"property" : "<uri>", // R! Reference to property mapping depends on
"system" : { canonical(CodeSystem) }, // Code System (if necessary)
"value" : "<string>", // R! Value of the referenced element
"display" : "<string>" // Display for the code (if value is a code)
}],
"product" : [{ Content as for ConceptMap.group.element.target.dependsOn }] // Other concepts that this mapping also produces
}]
}],
"unmapped" : { // What to do when there is no mapping for the source concept
"mode" : "<code>", // R! provided | fixed | other-map
"code" : "<code>", // Fixed code when mode = fixed
"display" : "<string>", // Display for the code
"url" : { canonical(ConceptMap) } // canonical reference to an additional ConceptMap to use for mapping if the source concept is unmapped
}
}]
}
ConceptMap Search Parameters
The following search parameters can be used to query ConceptMap resources. Just submit them like so:
https://api.1up.health/fhir/r4/ConceptMap?query-param=queryvalue| Search Parameter | Field Type | Resource Fields Searched |
|---|---|---|
context | text | useContext.value |
context-quantity | quantity | useContext.value |
context-type | text | useContext.code |
context-type-quantity | composite | useContext |
context-type-value | composite | useContext |
date | date | date |
dependson | uri | group.element.target.dependsOn.property |
description | text | description |
identifier | text | identifier |
jurisdiction | text | jurisdiction |
name | text | name |
other | reference | group.unmapped.url |
product | uri | group.element.target.product.property |
publisher | text | publisher |
source | reference | source |
source-code | text | group.element.code |
source-system | uri | group.source |
source-uri | reference | source |
status | text | status |
target | reference | target |
target-code | text | group.element.target.code |
target-system | uri | group.target |
target-uri | reference | target |
title | text | title |
url | uri | url |
version | text | version |
