Interactions with the Terminology Service
Description for how to interact with the terminology service.
Extracting Translations from ValueSet and CodeSystem
How to determine, say, Danish translations used in ValueSet? The ValueSet as a resource is likely not to contain a proper, displayable value in Danish as the ValueSet can be defined as include of other ValueSet and/or include of entire or partial CodeSystem, and as the display values in the ValueSet are for technical help primarily. Translations, if available, reside in the CodeSystem.
To get translations for at ValueSet, use $expand
as follows:
Call
$expand
on the ValueSetGET <base-url>/fhir/ValueSet/$expand?url=<ValueSet url>&property=designation
Determine best translation:
Choose designation with “da” (for Danish) if available, otherwise
Choose display (as best alternative - this will be in whatever language the concept is defined with)
In the example below, this is the case for code assessment
Example request and response on $expand on topic-type
Request:
GET <base-url>/fhir/ValueSet/$expand?url=http://ehealth.sundhed.dk/vs/topic-type
Response:
{ "resourceType": "ValueSet", "status": "active",
…
{ "system": "http://hl7.org/fhir/definition-topic", "code": "assessment", "display": "Assessment" }, …
{ "system": "http://ehealth.sundhed.dk/cs/topic-type", "code": "self-treatment", "display": "Self-treatment", "designation": [ { "language": "da", "value": "Selvbehandling" } ] }
…
CodeSystems and designations
For supported operations on concept lookups and decomposition, please see the supported operations on CodeSystem at https://www.hl7.org/fhir/R4/codesystem-operations.html . Designations targeted consumers/citizens will eg. contain the following data in the designation:
<designation>
<language value="da"></language>
<use>
<system value="http://terminology.hl7.org/CodeSystem/hl7TermMaintInfra"</system>>
<code value="consumer"></code>
</use>
<value value="Højde"></value>
</designation>
Determining the proper code, system and unit for Quantity
Given an observation code
and corresponding system
from the ValueSet "http://ehealth.sundhed.dk/vs/observation-codes"
(see https://docs.ehealth.sundhed.dk/latest-released/ig/ValueSet-ehealth-observation-codes.html), how does one then determine how to specify an observed quantity or reference range? The following describes how to obtain values to set in Quantity.code
, .system
and .unit
.
To get values forQuantity.code
and Quantity.system
use the ConceptMap "http://ehealth.sundhed.dk/ConceptMap/conceptmap-obs-code-to-ucum"
(See https://docs.ehealth.sundhed.dk/latest-released/ig/ConceptMap-conceptmap-obs-code-to-ucum.html) as follows:
Call
$translate
on the givencode
andsystem
:GET <base-url>/fhir/ConceptMap/$translate?system=<system>&code=<code>
On match found, the values to use in
Quantity.code
andQuantity.system
are the matching concept’scode
andsystem
, respectively, where the source ConceptMap is"http://ehealth.sundhed.dk/ConceptMap/conceptmap-obs-code-to-ucum"
(see example response below):
Example request and response on $translate on "http://ehealth.sundhed.dk/ConceptMap/conceptmap-obs-code-to-ucum"
Request:
GET <base-url>/fhir/ConceptMap/$translate?system=urn:oid:1.2.208.176.2.1&code=NPU03804
Response:
{ "resourceType": "Parameters", "parameter": [ { "name": "result", "valueBoolean": true }, { "name": "message", "valueString": "Matches found!" }, { "name": "match", "part": [ { "name": "equivalence", "valueCode": "specializes" }, { "name": "concept", "valueCoding": { "system": "http://unitsofmeasure.org", "code": "kg", "display": "kilogram" } }, { "name": "source", "valueUri": "http://ehealth.sundhed.dk/ConceptMap/conceptmap-obs-code-to-ucum" } ] } ] }
To get the corresponding and printable value for Quantity.unit
, use the ConceptMap "http://ehealth.sundhed.dk/ConceptMap/conceptmap-ucum-to-printsymbol"
(see https://docs.ehealth.sundhed.dk/latest-released/ig/ConceptMap-conceptmap-ucum-to-printsymbol.html) as follows:
Call
$translate
on the givensystem
andcode
determined in the response above:GET <base-url>/fhir/ConceptMap/$translate?target=http://ehealth.sundhed.dk/vs/ehealth-ucum-printsymbol-supplement&code=<code>&system=<system>
On match found, extract the matching concept (see example response below).
Call
$lookup
on the matching (CodeSystem)system
andcode
:GET <base-url>/fhir/CodeSystem/$lookup?system=http://ehealth.sundhed.dk/cs/ehealth-ucum-printsymbol-supplement&code=<code>
On match found, the value to use in
Quantity.unit
is the matching concept’sdesignation.value
where thedesignation.language=da
(see example response below). If there is no such designation, the printable value inQuantity.unit
shall be left empty.
The $lookup does not return designation on eHealth Infrastructure Release 4 and other releases prior to Release 5.
Determining whether to provide measurement as integer or decimal
Given an observation code
and corresponding system
from the ValueSet "http://ehealth.sundhed.dk/vs/observation-codes"
(see https://docs.ehealth.sundhed.dk/latest-released/ig/ValueSet-ehealth-observation-codes.html), how does one determine whether an observed quantity or reference range shall be stated as an integer or decimal? While a particular device might produce a decimal with a given precision for a measure, it is up to the client/solution to convert to the form expected by the infrastructure. Whether integer or decimal, the value is set inQuantity.value
.
To determine whether to use integer or decimal, use the ConceptMap "http://ehealth.sundhed.dk/ConceptMap/conceptmap-obs-code-to-value-type"
(see https://docs.ehealth.sundhed.dk/latest-released/ig/ConceptMap-conceptmap-obs-code-to-value-type.html) as follows:
Call
$translate
on the givencode
andsystem
:GET <base-url>/fhir/ConceptMap/$translate?system=<system>&code=<code>&target=http://hl7.org/fhir/ValueSet/data-types
On match found, indication of whether to use integer or decimal are the matching concept’s
code
andsystem
, respectively, where the source ConceptMap is"http://ehealth.sundhed.dk/ConceptMap/conceptmap-obs-code-to-value-type"
(see example response below).The codes
integer
anddecimal
insystem http://hl7.org/fhir/data-types
signify that the observed value or reference range shall be given as integer and decimal, respectively.