Skip to content

Operation $translate on ConceptMap

This operation translates a code from one value set to another, based on the existing value set and concept maps resources.

Endpoints

[fhir_base]/ConceptMap/$translate

[fhir_base]/ConceptMap/[id]/$translate

Query parameters

Query parameter Type Status Description
url uri implemented A canonical URL for a concept map.
conceptMap ConceptMap not implemented The concept map is provided directly as part of the request.
conceptMapVersion string not implemented The identifier that is used to identify a specific version of the concept map to be used for the translation.
code code implemented The code that is to be translated. If a code is provided, a system must be provided
system uri implemented The system for the code that is to be translated
version string not implemented The version of the system, if one was provided in the source data
source uri implemented Identifies the value set used when the concept (system/code pair) was chosen. May be a logical id, or an absolute or relative location.
coding Coding implemented A coding to translate
codeableConcept CodeableConcept implemented A full codeableConcept to validate.
target uri implemented Identifies the value set in which a translation is sought.
targetsystem uri implemented identifies a target code system in which a mapping is sought.
dependency - not implemented Another element that may help produce the correct mapping

Example

Example - $translate

GET https://demo.kodjin.com/terminology/ConceptMap/icd10-to-icd9/$translate?system=http://hl7.org/fhir/sid/icd-10-cm&targetSystem=http://terminology.hl7.org/CodeSystem/icd9&code=A00.0

    {
    "parameter": [
        {
            "name": "result",
            "valueBoolean": true
        },
        {
            "name": "match",
            "part": [
                {
                    "name": "equivalence",
                    "valueCode": "equivalent"
                },
                {
                    "name": "concept",
                    "valueCoding": {
                        "system": "http://terminology.hl7.org/CodeSystem/icd9",
                        "code": "001.0",
                        "display": "Cholera due to Vibrio cholerae"
                    }
                },
                {
                    "name": "source",
                    "valueUri": "http://edenlab.com.ua/fhir/ConceptMap/icd10-to-icd9"
                }
            ]
        }
    ],
    "resourceType": "Parameters"
    }

Example - $translate via POST

GET https://demo.kodjin.com/terminology/ConceptMap/$translate

    {
        "resourceType": "Parameters",
        "parameter": [
            {
                "name": "url",
                "valueUri": "http://hl7.org/fhir/ConceptMap/101"
            },
            {
                "name": "coding",
                "valueCoding": {
                    "code": "home",
                    "system": "http://hl7.org/fhir/address-use"
                }
            },
            {
                "name": "targetSystem",
                "valueUri": "http://terminology.hl7.org/CodeSystem/v3-AddressUse"
            }
        ]
    }

Try operation $translate with our Kodjin FHIR Server Postman Collection