Page Status: updated 2023-04-19

ConceptMap

Page index

Introduction

The ConceptMap resource, shown in the profile NLLConceptMap, defines how a code, or set of codes, relates to another code, or set of codes. Some code systems include codes that are equivalent, or related to codes in another code system. The intention of a concept map is to show these relations.

The concept maps exposed in the National Medication List is primarily intended for client systems to facilitate user interfaces and help the user to select a relevant code, e.g. given which medical product has been selected, or to translate between code systems e.g. EDQM and Snomed CT.

Overview

idS Σ0..1string
metaΣ0..1Meta
implicitRulesΣ ?!0..1uri
language0..1codeBinding
text0..1Narrative
contained0..*Resource
extensionI0..*Extension
modifierExtension?! I0..*Extension
urlS Σ0..1uri
identifierΣ0..1Identifier
versionS Σ0..1string
nameS Σ I0..1string
titleS Σ0..1string
statusS Σ ?!1..1codeBinding
experimentalΣ0..1boolean
dateS Σ0..1dateTime
publisherS Σ0..1string
contactΣ0..*ContactDetail
descriptionS0..1markdown
useContextΣ0..*UsageContext
jurisdictionΣ0..*CodeableConceptBinding
purpose0..1markdown
copyright0..1markdown
sourceCanonicalcanonical(ValueSet)
targetCanonicalcanonical(ValueSet)
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
sourceS0..1uri
sourceVersionS0..1string
targetS0..1uri
targetVersionS0..1string
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
codeS0..1code
display0..1string
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
codeS0..1code
display0..1string
equivalenceS ?!1..1codeBinding
commentI0..1string
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
property1..1uri
system0..1canonical(CodeSystem)
value1..1string
display0..1string
product0..*see (dependsOn)
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
mode1..1codeBinding
code0..1code
display0..1string
url0..1canonical(ConceptMap)

Details

Description of all elements can be found here, Element descriptions.

Mapping of FHIR element names to the National Medication List names can be found here, Element language mappings.

Supported operations

HTTP methods

Operation Supported Comment
Search (GET, POST) yes See below for supported search options.
Insert (POST) no
Update (PUT) no
Delete (DEL) no
Operation (GET, POST) yes See below for supported extended operations.

When interacting with this resource a set of HTTP-headers must be included in the request, see HTTP Header and Authorization.

Query operations

Supported Queries

The following query alternatives are available for this resource.

  1. GET ../ConceptMap
  2. GET ../ConceptMap/[id]

Compartment searches

Compartments are not supported by this resource.

Include & reverse includes

Include and revinclude are not supported by this resource.

For generic information about how to search in FHIR look here.

Search parameters

The table below shows all supported search parameters.

Parameter Description Comment
ConceptMap A search without parameters returnes all concept maps
../ConceptMap
ConceptMap/[id] A read based on the logical ID of a concept map
../ConceptMap/nll-form-to-ucum-unit

Other operations

$translate

Invocations

GET ../ConceptMap/$translate?system=[system]&code=[code]&source=[source]&target=[target]
GET ../ConceptMap/[id]/$translate?system=[system]&code=[code]

This operation does NOT change content.
This operation translates a code from one value set to another.
This is a standard operation in FHIR, see $translate for more information.

Parameters (In)

Parameter Description Comment
system The system of the code that is to be translated
..?system=http://electronichealth.se/fhir/CodeSystem/mpa-form
code The code that is to be translated
..&code=PSOIIN
source The value set the code comes from
..&source=http://electronichealth.se/fhir/ValueSet/nll-mpa-form
target The value set in which a translation is sought
..&target=http://electronichealth.se/fhir/ValueSet/nll-ucum-unit

Parameters (Out)

Parameter Description Comment
result True if the concept could be translated successfully
true
match A concept in the target value set with an equivalence
match.equivalence A code indicating the equivalence of the translation
equivalent
match.concept The translation outcome as a Coding, eg
"system": "http://snomed.info/sct", "code": "258994006"