工作组: Vocabulary  成熟度: NNormative (from v4.0.0) Compartments: N/A

通过一对code/system或一个Coding类型的输入参数,获取相关概念的其他详细信息,包括定义、状态、名称和属性。 此操作的产出之一是从结构化术语中完全分解后的code编码信息。

调用此操作时,客户端必须提供code和system输入参数,可以使用code+system或在Coding类型。其他更多输入参数是可选的。

此操作的官方定义URL如下:

 http://hl7.org/fhir/OperationDefinition/CodeSystem-lookup

正式定义 (作为 OperationDefinition).

URL: [基地址]/CodeSystem/$lookup

这是一个幂等的操作。

输入参数:
参数名基数类型文档
code0..1code

The code that is to be located. If a code is provided, a system must be provided

system0..1uri

The system for the code that is to be located

version0..1string

The version of the system, if one was provided in the source data

coding0..1Coding

A coding to look up

date0..1dateTime

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.

displayLanguage0..1code

The requested language for display (see $expand.displayLanguage)

property0..*code

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: url, name, version (code system info) and code information: display, definition, designation, parent and child, and for designations, lang.X where X is a designation language code. Some of the properties are returned explicit in named parameters (when the names match), and the rest (except for lang.X) in the property parameter group

输出参数:
参数名基数类型文档
name1..1string

A display name for the code system

version0..1string

The version that these details are based on

display1..1string

The preferred display for this concept

designation0..*

Additional representations for this concept

designation.language0..1code

The language this designation is defined for

designation.use0..1Coding

A code that details how this designation would be used

designation.value1..1string

The text value for this designation

property0..*

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

property.code1..1code

Identifies the property returned

property.value0..1code | Coding | string | integer | boolean | dateTime | decimal

The value of the property returned

property.description0..1string

Human Readable representation of the property value (e.g. display for a code)

property.subproperty0..*

Nested Properties (mainly used for SNOMED CT decomposition, for relationship Groups)

property.subproperty.code1..1code

Identifies the sub-property returned

property.subproperty.value1..1code | Coding | string | integer | boolean | dateTime | decimal

The value of the sub-property returned

property.subproperty.description0..1string

Human Readable representation of the property value (e.g. display for a code)

注意,$lookup操作不仅仅是搜索编码系统,服务器会去查找对应的概念,并从编码系统定义的底层收集信息后再返回。

请求: 用 code+system 查找

GET [base]/CodeSystem/$lookup?system=http://loinc.org&code=1963-8

请求: 用 Coding 查找

POST [base]/CodeSystem/$lookup
[other headers]

<Parameters xmlns="http://hl7.org/fhir">
  <parameter>
    <name value="coding"/>
  <valueCoding>
    <system value="http://loinc.org"/>
    <code value="1963-8"/>
  </valueCoding>
  </parameter>
</Parameters>

响应: 当请求能被处理时


HTTP/1.1 200 OK
[other headers]

{
  "resourceType" : "Parameters",
  "parameter" : [
    {
    "name" : "name",
    "valueString" : "LOINC"
  },
  {
    "name" : "version",
    "valueString" : "2.48"
  },
  {
    "name" : "display",
    "valueString" : "Bicarbonate [Moles/volume] in Serum"
  },
  {
    "name" : "abstract",
    "valueString" : "false"
  },
  {
      "name" : "designation",
    "part" : [
    {
      "name" : "value",
      "valueString" : "Bicarbonate [Moles/volume] in Serum"
    }
    ]
  }
  ]
}

响应: 出错,如:请求一个未知的code


HTTP/1.1 400 Bad Request
[other headers]

{
  "resourceType": "OperationOutcome",
  "id": "exception",
  "text": {
    "status": "additional",
    "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">Code "ABC-23" not found</div>"
  },
  "issue": [
    {
      "severity": "error",
      "code": "not-found",
      "details": {
        "text": "Code "ABC-23" not found"
      }
    }
  ]
}

 

For more information about operations, including how they are invoked, see Operations.