Operation-valueset-batch.json

Operation Definition

{
  "resourceType": "OperationDefinition",
  "id": "ValueSet-batch",
  "text": {
    "status": "generated",
    "div": "<div>!-- Snipped for Brevity --></div>"
  },
  "url": "http://hl7.org/fhir/OperationDefinition/ValueSet-batch",
  "name": "Batch Mode Validation",
  "publisher": "HL7 (FHIR Project)",
  "contact": [
    {
      "telecom": [
        {
          "system": "url",
          "value": "http://hl7.org/fhir"
        },
        {
          "system": "email",
          "value": "fhir@lists.hl7.org"
        }
      ]
    }
  ],
  "description": "Validate a set of concepts against value sets in a single oeration\n\nTypically, this would be called when a validating a resource or document that contains many codes, to reduce network latency events",
  "status": "draft",
  "date": "2015-03-27T00:13:00+11:00",
  "kind": "operation",
  "code": "batch",
  "system": false,
  "type": [
    "ValueSet"
  ],
  "instance": false,
  "parameter": [
    {
      "name": "item",
      "use": "in",
      "min": 0,
      "max": "*",
      "documentation": "An item to be validated",
      "part": [
        {
          "name": "concept",
          "min": 1,
          "max": "1",
          "documentation": "A codeable concept to be validated. If the source is a coding, or a code/system pair, wrap it in a CodeableConcept",
          "type": "CodeableConcept"
        },
        {
          "name": "uri",
          "min": 1,
          "max": "1",
          "documentation": "The value set to validate the concept against. This is a logical value set identifier (i.e. ValueSet.identifier). The server must know the value set (e.g. it is defined explicitly in the server's valuesets, or it is defined implicitly by some code system known to the server",
          "type": "uri"
        }
      ]
    },
    {
      "name": "date",
      "use": "in",
      "min": 0,
      "max": "1",
      "documentation": "The date for which the validation should be checked. Normally, this is the current conditions (which is the default values) but under some circumstances, systems need to validate that a correct code was used at some point in the past. A typical example of this would be where code selection is constrained to the set of codes that were available when the patient was treated, not when the record is being edited. Note that which date is appropriate is a matter for implementation policy.",
      "type": "dateTime"
    },
    {
      "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 details supplied are valid",
          "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": "display",
          "min": 0,
          "max": "1",
          "documentation": "A valid display for the concept if the system wishes to display this to a user",
          "type": "string"
        }
      ]
    }
  ]
}