Operation-conceptmap-translate.json

Operation Definition

{
  "resourceType": "OperationDefinition",
  "id": "ConceptMap-translate",
  "text": {
    "status": "generated",
    "div": "<div>!-- Snipped for Brevity --></div>"
  },
  "url": "http://hl7.org/fhir/OperationDefinition/ConceptMap-translate",
  "name": "Concept Translation",
  "publisher": "HL7 (FHIR Project)",
  "contact": [
    {
      "telecom": [
        {
          "system": "url",
          "value": "http://hl7.org/fhir"
        },
        {
          "system": "email",
          "value": "fhir@lists.hl7.org"
        }
      ]
    }
  ],
  "description": "Translate a code from one value set to another, based on the existing value set and concept maps resources, and/or other additional knowledge available to the server. || One (and only one) of the in parameters (code, coding, codeableConcept) must be provided, to identify the code that is to be translated.  || The outcome is an operationOutcome with hints, warnings, or errors, or the translated code in an extension",
  "status": "draft",
  "date": "2015-03-27T00:13:00+11:00",
  "kind": "operation",
  "code": "translate",
  "system": false,
  "type": [
    "ConceptMap"
  ],
  "instance": true,
  "parameter": [
    {
      "name": "code",
      "use": "in",
      "min": 0,
      "max": "1",
      "documentation": "The code that is to be translated. If a code is provided, a system must be provided",
      "type": "code"
    },
    {
      "name": "system",
      "use": "in",
      "min": 0,
      "max": "1",
      "documentation": "The system for the code that is to be translated",
      "type": "uri"
    },
    {
      "name": "version",
      "use": "in",
      "min": 0,
      "max": "1",
      "documentation": "The version of the system, if one was provided in the source data",
      "type": "string"
    },
    {
      "name": "valueSet",
      "use": "in",
      "min": 0,
      "max": "1",
      "documentation": "Identifies the value set used when the concept (system/code pair) was chosen. May be a logical id, or an absolute or relative location",
      "type": "uri"
    },
    {
      "name": "coding",
      "use": "in",
      "min": 0,
      "max": "1",
      "documentation": "A coding to translate",
      "type": "Coding"
    },
    {
      "name": "codeableConcept",
      "use": "in",
      "min": 0,
      "max": "1",
      "documentation": "A full codeableConcept to validate. The server can translate any of the coding values as it chooses",
      "type": "CodeableConcept"
    },
    {
      "name": "target",
      "use": "in",
      "min": 1,
      "max": "1",
      "documentation": "Identifies the value set in which a translation is sought. May be a logical id, or an absolute or relative location",
      "type": "uri"
    },
    {
      "name": "result",
      "use": "out",
      "min": 1,
      "max": "1",
      "documentation": "True if the concept could be translated",
      "type": "boolean"
    },
    {
      "name": "message",
      "use": "out",
      "min": 0,
      "max": "1",
      "documentation": "Error details, if result = false. If this is provided when result = true, the message carries hints and wanrings",
      "type": "string"
    },
    {
      "name": "equivalence",
      "use": "out",
      "min": 0,
      "max": "1",
      "documentation": "A code indicating the equivalence of the translation, using values from [ConceptMapEquivalence]{concept-equivalence.html}",
      "type": "code"
    },
    {
      "name": "outcome",
      "use": "out",
      "min": 0,
      "max": "1",
      "documentation": "The translation outcome",
      "type": "Coding"
    }
  ]
}