Operation-codesystem-lookup.json

Operation Definition

{
  "resourceType": "OperationDefinition",
  "id": "CodeSystem-lookup",
  "text": {
    "status": "generated",
    "div": "<div>!-- Snipped for Brevity --></div>"
  },
  "url": "http://hl7.org/fhir/OperationDefinition/CodeSystem-lookup",
  "name": "Concept Look Up",
  "status": "draft",
  "kind": "operation",
  "date": "2016-08-11T17:02:54+10:00",
  "publisher": "HL7 (FHIR Project)",
  "contact": [
    {
      "telecom": [
        {
          "system": "other",
          "value": "http://hl7.org/fhir"
        },
        {
          "system": "email",
          "value": "fhir@lists.hl7.org"
        }
      ]
    }
  ],
  "description": "Given a code/system, or a Coding, get additional details about the concept",
  "code": "lookup",
  "comment": "Note that the $lookup operation is more than just a code system search  - the server finds the concept, and gathers the return information from the value set and the underlying code system definitions.",
  "system": false,
  "type": [
    "CodeSystem"
  ],
  "instance": false,
  "parameter": [
    {
      "name": "code",
      "use": "in",
      "min": 0,
      "max": "1",
      "documentation": "The code that is to be validated. 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 validated",
      "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": "coding",
      "use": "in",
      "min": 0,
      "max": "1",
      "documentation": "A coding to look up",
      "type": "Coding"
    },
    {
      "name": "date",
      "use": "in",
      "min": 0,
      "max": "1",
      "documentation": "The date for which the information should be returned. Normally, this is the current conditions (which is the default value) but under some circumstances, systems need to acccess this information as it would have been 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": "property",
      "use": "in",
      "min": 0,
      "max": "*",
      "documentation": "A property that the client wishes to be returned in the output. If no properties are specified, the server chooses what to return. The following properties are defined for all code systems: system, version, display, definition, designation, parent, child, and lang.X where X is a language code in a designation. These properties refer to the directly return parameters documented for the operation",
      "type": "code"
    },
    {
      "name": "name",
      "use": "out",
      "min": 1,
      "max": "1",
      "documentation": "A display name for the code system",
      "type": "string"
    },
    {
      "name": "version",
      "use": "out",
      "min": 0,
      "max": "1",
      "documentation": "The version that these details are based on",
      "type": "string"
    },
    {
      "name": "display",
      "use": "out",
      "min": 1,
      "max": "1",
      "documentation": "The preferred display for this concept",
      "type": "string"
    },
    {
      "name": "property",
      "use": "out",
      "min": 0,
      "max": "*",
      "part": [
        {
          "name": "code",
          "use": "out",
          "min": 0,
          "max": "1",
          "type": "code"
        },
        {
          "name": "value",
          "use": "out",
          "min": 1,
          "max": "1",
          "type": "string"
        },
        {
          "name": "description",
          "use": "out",
          "min": 0,
          "max": "1",
          "documentation": "Human Readable representation of the propery value",
          "type": "string"
        }
      ]
    },
    {
      "name": "designation",
      "use": "out",
      "min": 0,
      "max": "*",
      "documentation": "Additional representations for this concept",
      "part": [
        {
          "name": "language",
          "use": "out",
          "min": 0,
          "max": "1",
          "documentation": "The language this designation is defined for",
          "type": "code"
        },
        {
          "name": "use",
          "use": "out",
          "min": 0,
          "max": "1",
          "documentation": "A code that details how this designation would be used",
          "type": "Coding"
        },
        {
          "name": "value",
          "use": "out",
          "min": 1,
          "max": "1",
          "documentation": "The text value for this designation",
          "type": "string"
        }
      ]
    }
  ]
}