Operation Definition

{
  "resourceType" : "OperationDefinition",
  "id" : "CodeSystem-lookup",
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: OperationDefinition CodeSystem-lookup</b></p><a name=\"CodeSystem-lookup\"> </a><a name=\"hcCodeSystem-lookup\"> </a><a name=\"CodeSystem-lookup-en-US\"> </a><p>URL: [base]/CodeSystem/$lookup</p><p>URL: [base]/CodeSystem/[id]/$lookup</p><h3>Parameters</h3><table class=\"grid\"><tr><td><b>Use</b></td><td><b>Name</b></td><td><b>Scope</b></td><td><b>Cardinality</b></td><td><b>Type</b></td><td><b>Binding</b></td><td><b>Documentation</b></td></tr><tr><td>IN</td><td>code</td><td/><td>0..1</td><td><a href=\"datatypes.html#code\">code</a></td><td/><td><div><p>The code that is to be located. If a code is provided, a system must be provided</p>\n</div></td></tr><tr><td>IN</td><td>system</td><td>type</td><td>0..1</td><td><a href=\"datatypes.html#uri\">uri</a></td><td/><td><div><p>The system for the code that is to be located</p>\n</div></td></tr><tr><td>IN</td><td>version</td><td>type</td><td>0..1</td><td><a href=\"datatypes.html#string\">string</a></td><td/><td><div><p>The version of the system, if one was provided in the source data</p>\n</div></td></tr><tr><td>IN</td><td>coding</td><td/><td>0..1</td><td><a href=\"datatypes.html#Coding\">Coding</a></td><td/><td><div><p>A coding to look up</p>\n</div></td></tr><tr><td>IN</td><td>date</td><td/><td>0..1</td><td><a href=\"datatypes.html#dateTime\">dateTime</a></td><td/><td><div><p>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.</p>\n</div></td></tr><tr><td>IN</td><td>displayLanguage</td><td/><td>0..1</td><td><a href=\"datatypes.html#code\">code</a></td><td/><td><div><p>The requested language for display (see CodeSystem.concept.designation.language)</p>\n</div></td></tr><tr><td>IN</td><td>property</td><td/><td>0..*</td><td><a href=\"datatypes.html#code\">code</a></td><td/><td><div><p>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: name, version (code system info) and code information: display, designation, and lang.X where X is a designation language code. These properties are returned explicitly in named out parameters with matching names, or in designations. In addition, any property codes defined by <a href=\"codesystem.html#defined-props\">this specification</a> or by the CodeSystem (<a href=\"codesystem-definitions.html#CodeSystem.property\">CodeSystem.property.code</a>) are allowed, and these are returned in the out parameter <code>property</code></p>\n</div></td></tr><tr><td>IN</td><td>useSupplement</td><td/><td>0..*</td><td><a href=\"datatypes.html#canonical\">canonical</a></td><td/><td><div><p>Supplements to take into account when performing the $lookup operation. The supplements must be for the same CodeSystem. By default, supplements for the code system are not automatically included except where they provide additional designations that may be indicated by, for example, the displayLanguage parameter</p>\n</div></td></tr><tr><td>OUT</td><td>name</td><td/><td>1..1</td><td><a href=\"datatypes.html#string\">string</a></td><td/><td><div><p>A display name for the code system</p>\n</div></td></tr><tr><td>OUT</td><td>version</td><td/><td>0..1</td><td><a href=\"datatypes.html#string\">string</a></td><td/><td><div><p>The version that these details are based on</p>\n</div></td></tr><tr><td>OUT</td><td>display</td><td/><td>1..1</td><td><a href=\"datatypes.html#string\">string</a></td><td/><td><div><p>The preferred display for this concept</p>\n</div></td></tr><tr><td>OUT</td><td>definition</td><td/><td>0..1</td><td><a href=\"datatypes.html#string\">string</a></td><td/><td><div><p>A statement of the meaning of the concept from the code system</p>\n</div></td></tr><tr><td>OUT</td><td>designation</td><td/><td>0..*</td><td></td><td/><td><div><p>Additional representations for this concept</p>\n</div></td></tr><tr><td>OUT</td><td>designation.language</td><td/><td>0..1</td><td><a href=\"datatypes.html#code\">code</a></td><td/><td><div><p>The language this designation is defined for</p>\n</div></td></tr><tr><td>OUT</td><td>designation.use</td><td/><td>0..1</td><td><a href=\"datatypes.html#Coding\">Coding</a></td><td/><td><div><p>A code that details how this designation would be used</p>\n</div></td></tr><tr><td>OUT</td><td>designation.additionalUse</td><td/><td>0..*</td><td><a href=\"datatypes.html#Coding\">Coding</a></td><td/><td><div><p>Additional codes that detail how this designation would be used (if there is more than one)</p>\n</div></td></tr><tr><td>OUT</td><td>designation.value</td><td/><td>1..1</td><td><a href=\"datatypes.html#string\">string</a></td><td/><td><div><p>The text value for this designation</p>\n</div></td></tr><tr><td>OUT</td><td>property</td><td/><td>0..*</td><td></td><td/><td><div><p>One or more properties that contain additional information about the code, including status. For complex terminologies (e.g. SNOMED CT, LOINC, medications), these properties serve to decompose the code</p>\n</div></td></tr><tr><td>OUT</td><td>property.code</td><td/><td>1..1</td><td><a href=\"datatypes.html#code\">code</a></td><td/><td><div><p>Identifies the property returned</p>\n</div></td></tr><tr><td>OUT</td><td>property.value</td><td/><td>0..1</td><td><a href=\"datatypes.html#Coding\">Coding</a> | <a href=\"datatypes.html#boolean\">boolean</a> | <a href=\"datatypes.html#code\">code</a> | <a href=\"datatypes.html#dateTime\">dateTime</a> | <a href=\"datatypes.html#decimal\">decimal</a> | <a href=\"datatypes.html#integer\">integer</a> | <a href=\"datatypes.html#string\">string</a></td><td/><td><div><p>The value of the property returned</p>\n</div></td></tr><tr><td>OUT</td><td>property.description</td><td/><td>0..1</td><td><a href=\"datatypes.html#string\">string</a></td><td/><td><div><p>Human Readable representation of the property value (e.g. display for a code)</p>\n</div></td></tr><tr><td>OUT</td><td>property.source</td><td/><td>0..1</td><td><a href=\"datatypes.html#canonical\">canonical</a></td><td/><td><div><p>If information from a supplement is included as a property (e.g. any additional property or property value), then this parameter must assert the url of the supplement.</p>\n</div></td></tr><tr><td>OUT</td><td>property.subproperty</td><td/><td>0..*</td><td></td><td/><td><div><p>Nested Properties (mainly used for SNOMED CT decomposition, for relationship Groups)</p>\n</div></td></tr><tr><td>OUT</td><td>property.subproperty.code</td><td/><td>1..1</td><td><a href=\"datatypes.html#code\">code</a></td><td/><td><div><p>Identifies the sub-property returned</p>\n</div></td></tr><tr><td>OUT</td><td>property.subproperty.value</td><td/><td>1..1</td><td><a href=\"datatypes.html#Coding\">Coding</a> | <a href=\"datatypes.html#boolean\">boolean</a> | <a href=\"datatypes.html#code\">code</a> | <a href=\"datatypes.html#dateTime\">dateTime</a> | <a href=\"datatypes.html#decimal\">decimal</a> | <a href=\"datatypes.html#integer\">integer</a> | <a href=\"datatypes.html#string\">string</a></td><td/><td><div><p>The value of the sub-property returned</p>\n</div></td></tr><tr><td>OUT</td><td>property.subproperty.description</td><td/><td>0..1</td><td><a href=\"datatypes.html#string\">string</a></td><td/><td><div><p>Human Readable representation of the sub-property value (e.g. display for a code)</p>\n</div></td></tr><tr><td>OUT</td><td>property.subproperty.source</td><td/><td>0..1</td><td><a href=\"datatypes.html#canonical\">canonical</a></td><td/><td><div><p>If information from a supplement is included as a subproperty (e.g. any additional subproperty or subproperty value), then this parameter must assert the url of the supplement.</p>\n</div></td></tr></table><div><p>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 underlying code system definitions.</p>\n</div></div>"
  },
  "extension" : [{
    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
    "valueInteger" : 5
  },
  {
    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
    "valueCode" : "normative"
  },
  {
    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
    "valueCode" : "vocab"
  }],
  "url" : "http://hl7.org/fhir/OperationDefinition/CodeSystem-lookup",
  "version" : "6.0.0-ballot2",
  "name" : "Lookup",
  "title" : "Concept Look Up & Decomposition",
  "status" : "active",
  "kind" : "operation",
  "experimental" : false,
  "date" : "2024-11-25T19:23:15+00:00",
  "publisher" : "HL7 International / Terminology Infrastructure",
  "contact" : [{
    "telecom" : [{
      "system" : "url",
      "value" : "http://hl7.org/fhir"
    },
    {
      "system" : "email",
      "value" : "fhir@lists.hl7.org"
    }]
  },
  {
    "telecom" : [{
      "system" : "url",
      "value" : "http://www.hl7.org/Special/committees/Vocab"
    }]
  }],
  "description" : "Given a code/system, or a Coding, get additional details about the concept, including definition, status, designations, and properties. One of the products of this operation is a full decomposition of a code from a structured terminology.\n\nWhen invoking this operation, a client SHALL provide both a system and a code, either using the system+code parameters, or in the coding parameter. Other parameters are optional",
  "jurisdiction" : [{
    "coding" : [{
      "system" : "http://unstats.un.org/unsd/methods/m49/m49.htm",
      "code" : "001",
      "display" : "World"
    }]
  }],
  "affectsState" : false,
  "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 underlying code system definitions.",
  "resource" : ["CodeSystem"],
  "system" : false,
  "type" : true,
  "instance" : true,
  "parameter" : [{
    "name" : "code",
    "use" : "in",
    "min" : 0,
    "max" : "1",
    "documentation" : "The code that is to be located. If a code is provided, a system must be provided",
    "type" : "code"
  },
  {
    "name" : "system",
    "use" : "in",
    "scope" : ["type"],
    "min" : 0,
    "max" : "1",
    "documentation" : "The system for the code that is to be located",
    "type" : "uri"
  },
  {
    "name" : "version",
    "use" : "in",
    "scope" : ["type"],
    "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" : "displayLanguage",
    "use" : "in",
    "min" : 0,
    "max" : "1",
    "documentation" : "The requested language for display (see CodeSystem.concept.designation.language)",
    "type" : "code"
  },
  {
    "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: name, version (code system info) and code information: display, designation, and lang.X where X is a designation language code. These properties are returned explicitly in named out parameters with matching names, or in designations. In addition, any property codes defined by [this specification](codesystem.html#defined-props) or by the CodeSystem ([CodeSystem.property.code](codesystem-definitions.html#CodeSystem.property)) are allowed, and these are returned in the out parameter ```property```",
    "type" : "code"
  },
  {
    "name" : "useSupplement",
    "use" : "in",
    "min" : 0,
    "max" : "*",
    "documentation" : "Supplements to take into account when performing the $lookup operation. The supplements must be for the same CodeSystem. By default, supplements for the code system are not automatically included except where they provide additional designations that may be indicated by, for example, the displayLanguage parameter",
    "type" : "canonical"
  },
  {
    "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" : "definition",
    "use" : "out",
    "min" : 0,
    "max" : "1",
    "documentation" : "A statement of the meaning of the concept from the code system",
    "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" : "additionalUse",
      "use" : "out",
      "min" : 0,
      "max" : "*",
      "documentation" : "Additional codes that detail how this designation would be used (if there is more than one)",
      "type" : "Coding"
    },
    {
      "name" : "value",
      "use" : "out",
      "min" : 1,
      "max" : "1",
      "documentation" : "The text value for this designation",
      "type" : "string"
    }]
  },
  {
    "name" : "property",
    "use" : "out",
    "min" : 0,
    "max" : "*",
    "documentation" : "One or more properties that contain additional information about the code, including status. For complex terminologies (e.g. SNOMED CT, LOINC, medications), these properties serve to decompose the code",
    "part" : [{
      "name" : "code",
      "use" : "out",
      "min" : 1,
      "max" : "1",
      "documentation" : "Identifies the property returned",
      "type" : "code"
    },
    {
      "extension" : [{
        "url" : "http://hl7.org/fhir/StructureDefinition/operationdefinition-allowed-type",
        "valueUri" : "Coding"
      },
      {
        "url" : "http://hl7.org/fhir/StructureDefinition/operationdefinition-allowed-type",
        "valueUri" : "boolean"
      },
      {
        "url" : "http://hl7.org/fhir/StructureDefinition/operationdefinition-allowed-type",
        "valueUri" : "code"
      },
      {
        "url" : "http://hl7.org/fhir/StructureDefinition/operationdefinition-allowed-type",
        "valueUri" : "dateTime"
      },
      {
        "url" : "http://hl7.org/fhir/StructureDefinition/operationdefinition-allowed-type",
        "valueUri" : "decimal"
      },
      {
        "url" : "http://hl7.org/fhir/StructureDefinition/operationdefinition-allowed-type",
        "valueUri" : "integer"
      },
      {
        "url" : "http://hl7.org/fhir/StructureDefinition/operationdefinition-allowed-type",
        "valueUri" : "string"
      }],
      "name" : "value",
      "use" : "out",
      "min" : 0,
      "max" : "1",
      "documentation" : "The value of the property returned",
      "type" : "Element"
    },
    {
      "name" : "description",
      "use" : "out",
      "min" : 0,
      "max" : "1",
      "documentation" : "Human Readable representation of the property value (e.g. display for a code)",
      "type" : "string"
    },
    {
      "name" : "source",
      "use" : "out",
      "min" : 0,
      "max" : "1",
      "documentation" : "If information from a supplement is included as a property (e.g. any additional property or property value), then this parameter must assert the url of the supplement.",
      "type" : "canonical"
    },
    {
      "name" : "subproperty",
      "use" : "out",
      "min" : 0,
      "max" : "*",
      "documentation" : "Nested Properties (mainly used for SNOMED CT decomposition, for relationship Groups)",
      "part" : [{
        "name" : "code",
        "use" : "out",
        "min" : 1,
        "max" : "1",
        "documentation" : "Identifies the sub-property returned",
        "type" : "code"
      },
      {
        "extension" : [{
          "url" : "http://hl7.org/fhir/StructureDefinition/operationdefinition-allowed-type",
          "valueUri" : "Coding"
        },
        {
          "url" : "http://hl7.org/fhir/StructureDefinition/operationdefinition-allowed-type",
          "valueUri" : "boolean"
        },
        {
          "url" : "http://hl7.org/fhir/StructureDefinition/operationdefinition-allowed-type",
          "valueUri" : "code"
        },
        {
          "url" : "http://hl7.org/fhir/StructureDefinition/operationdefinition-allowed-type",
          "valueUri" : "dateTime"
        },
        {
          "url" : "http://hl7.org/fhir/StructureDefinition/operationdefinition-allowed-type",
          "valueUri" : "decimal"
        },
        {
          "url" : "http://hl7.org/fhir/StructureDefinition/operationdefinition-allowed-type",
          "valueUri" : "integer"
        },
        {
          "url" : "http://hl7.org/fhir/StructureDefinition/operationdefinition-allowed-type",
          "valueUri" : "string"
        }],
        "name" : "value",
        "use" : "out",
        "min" : 1,
        "max" : "1",
        "documentation" : "The value of the sub-property returned",
        "type" : "Element"
      },
      {
        "name" : "description",
        "use" : "out",
        "min" : 0,
        "max" : "1",
        "documentation" : "Human Readable representation of the sub-property value (e.g. display for a code)",
        "type" : "string"
      },
      {
        "name" : "source",
        "use" : "out",
        "min" : 0,
        "max" : "1",
        "documentation" : "If information from a supplement is included as a subproperty (e.g. any additional subproperty or subproperty value), then this parameter must assert the url of the supplement.",
        "type" : "canonical"
      }]
    }]
  }]
}