Operation-conceptmap-batch.json

Operation Definition

{
  "resourceType": "OperationDefinition",
  "id": "ConceptMap-batch",
  "text": {
    "status": "generated",
    "div": "<div>!-- Snipped for Brevity --></div>"
  },
  "url": "http://hl7.org/fhir/OperationDefinition/ConceptMap-batch",
  "name": "Batch Mode Translation",
  "publisher": "HL7 (FHIR Project)",
  "contact": [
    {
      "telecom": [
        {
          "system": "url",
          "value": "http://hl7.org/fhir"
        },
        {
          "system": "email",
          "value": "fhir@lists.hl7.org"
        }
      ]
    }
  ],
  "description": "Translate a set of concepts 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",
  "status": "draft",
  "date": "2015-03-27T00:13:00+11:00",
  "kind": "operation",
  "code": "batch",
  "system": false,
  "type": [
    "ConceptMap"
  ],
  "instance": false,
  "parameter": [
    {
      "name": "item",
      "use": "in",
      "min": 0,
      "max": "*",
      "documentation": "An item to be translated",
      "part": [
        {
          "name": "concept",
          "min": 1,
          "max": "1",
          "documentation": "A codeable concept to be translated. If the source is a coding, or a code/system pair, wrap it in a CodeableConcept",
          "type": "CodeableConcept"
        },
        {
          "name": "target",
          "min": 1,
          "max": "*",
          "documentation": "Identifies the value set in which a translation is sought. May be a logical id, or an absolute or relative location. If more than one is provided, multiple translations are requested for the concept",
          "type": "uri"
        },
        {
          "name": "map",
          "min": 0,
          "max": "1",
          "documentation": "A specific concept map to use for the translation. If none is provided, the server chooses which concept map to use",
          "type": "Reference(ConceptMap)"
        }
      ]
    },
    {
      "name": "item",
      "use": "out",
      "min": 0,
      "max": "*",
      "documentation": "The outcome of validating an item. There must be an entry for every item in the same order",
      "part": [
        {
          "name": "result",
          "min": 1,
          "max": "1",
          "documentation": "True if the concept could be translated",
          "type": "boolean"
        },
        {
          "name": "message",
          "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",
          "min": 0,
          "max": "1",
          "documentation": "A code indicating the equivalence of the translation, using values from [ConceptMapEquivalence]{concept-equivalence.html}. TODO: what about multiple translations?",
          "type": "code"
        },
        {
          "name": "outcome",
          "min": 0,
          "max": "1",
          "documentation": "The translation outcome - a CodeableConcept to allow for multiple translations",
          "type": "CodeableConcept"
        }
      ]
    }
  ]
}