Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

To get translations for at ValueSet, use $expand as follows:

  1. Call $expand on the ValueSet

    1. GET <base-url>/fhir/ValueSet/$expand?url=<ValueSet url>&property=designation

  2. Determine best translation:

    1. Choose designation with “da” (for Danish) if available, otherwise

    2. Choose display (as best alternative - this will be in whatever language the concept is defined with)

      1. In the example below, this is the case for code assessment

Info

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"                     }                 ]             }

...

For supported operations on concept lookups and decomposition, please see the supported operations on CodeSystem at httphttps://www.hl7.org/fhir/STU3R4/codesystem-operations.html . Designations targeted consumers/citizens will eg. contain the following data in the designation:

...

To get values forQuantity.codeandQuantity.system use the ConceptMap conceptmap-obs-code-to-ucum as follows:

  1. Call $translate on the given code and system:

    1. GET <base-url>/fhir/ConceptMap/$translate?system=<system>&code=<code>

  2. On match found, the values to use in Quantity.codeandQuantity.systemare the matching concept’s code and system, respectively, where the source ConceptMap is “http://ehealth.sundhed.dk/ConceptMap/conceptmap-obs-code-to-ucum” (see example response below):

Info

Example request and response on $translate on 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 conceptmap-ucum-to-printsymbol as follows:

  1. Call $translate on the given system and code determined in the response above:

    1. GET <base-url>/fhir/ConceptMap/$translate?target=http://ehealth.sundhed.dk/vs/ehealth-ucum-printsymbol-supplement&code=<code>&system=<system>

  2. On match found, extract the matching concept (see example response below).

  3. Call $lookupon the matching (CodeSystem) system and code:

    1. GET <base-url>/fhir/CodeSystem/$lookup?system=http://ehealth.sundhed.dk/cs/ehealth-ucum-printsymbol-supplement&code=<code>

  4. On match found, the value to use in Quantity.unitis the matching concept’s designation.valuewhere the designation.language=da(see example response below). If there is no such designation, the printable value in Quantity.unit shall be left empty.

Note

The $lookup does not return designation on eHealth Infrastructure Release 4 and other releases prior to Release 5.

...

To determine whether to use integer or decimal, use the ConceptMap conceptmap-obs-code-to-value-type as follows:

  1. Call $translate on the given code and system:

    1. GET <base-url>/fhir/ConceptMap/$translate?system=<system>&code=<code>&target=http://hl7.org/fhir/ValueSet/data-types

  2. On match found, indication of whether to use integer or decimal are the matching concept’s code and system, respectively, where the source ConceptMap is “http://ehealth.sundhed.dk/ConceptMap/conceptmap-obs-code-to-value-type” (see example response below).

  3. The codes integer and decimal in system http://hl7.org/fhir/data-types signify that the observed value or reference range shall be given as integer and decimal, respectively.

Info

Example request and response on $translate on conceptmap-obs-code-to-value-type

Request:

GET <base-url>/fhir/ConceptMap/$translate?system=urn:oid:1.2.208.176.2.1&code=NPU03804&target=http://hl7.org/fhir/ValueSet/data-types

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://hl7.org/fhir/data-types",
                        "code": "decimal",
                        "display": "decimal"
                    }
                },
                {
                    "name": "source",
                    "valueUri": "http://ehealth.sundhed.dk/ConceptMap/conceptmap-obs-code-to-value-type"
                }
            ]
        }
    ]
}

...