使用检索 ValueSet 验证码 $expand - AWS HealthLake
用量支持的参数示例

本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。

使用检索 ValueSet 验证码 $expand

AWS HealthLake 现在支持您作为客户提取的 ValueSets 内容的$expand操作，使您能够检索这些 ValueSet 资源中包含的完整代码列表。当您需要执行以下操作时，此操作特别有用：

  • 检索所有可能的代码以进行验证

  • 在用户界面中显示可用选项

  • 在特定的术语上下文中执行全面的代码查找

用量

可以使用 GET 和 POST 方法对 ValueSet 资源调用该$expand操作：

支持的操作

GET/POST [base]/ValueSet/[id]/$expand
GET [base]/ValueSet/$expand?url=http://example.com
POST [base]/ValueSet/$expand

支持的参数

HealthLake 支持 FHIR R4 $expand 参数的子集：

参数 类型 必需 说明
url uri 否 待扩展的权威网址 ValueSet
id id 否 ValueSet 要扩展的资源 ID（用于 GET 或 POST 操作）
filter 字符串 否 筛选代码扩展结果
count 整数 否 要返回的代码数量
offset 整数 否 返回之前要跳过的匹配代码的数量。过滤后仅适用于匹配的代码，不适用于原始代码中未经过滤的完整内容 ValueSet

示例

通过 ID 获取请求

GET [base]/ValueSet/example-valueset/$expand
使用过滤器通过 URL 获取请求

GET [base]/ValueSet/$expand?url=http://example.com/ValueSet/my-valueset&filter=male&count=5
带参数的 POST 请求（按 ID）

POST [base]/ValueSet/example-valueset/$expand
Content-Type: application/fhir+json

{
  "resourceType": "Parameters",
  "parameter": [
    {
      "name": "count",
      "valueInteger": 10
    },
    {
      "name": "filter",
      "valueString": "admin"
    }
  ]
}
带参数的 POST 请求（通过 URL）

POST [base]/ValueSet/$expand
Content-Type: application/fhir+json

{
  "resourceType": "Parameters",
  "parameter": [
    {
      "name": "url",
      "valueUri": "http://hl7.org/fhir/ValueSet/administrative-gender"
    },
    {
      "name": "count",
      "valueInteger": 10
    }
  ]
}
示例响应

该操作返回一个 ValueSet 资源，其expansion元素包含扩展代码：

{
  "resourceType": "ValueSet",
  "id": "administrative-gender",
  "status": "active",
  "expansion": {
    "identifier": "urn:uuid:12345678-1234-1234-1234-123456789abc",
    "timestamp": "2024-01-15T10:30:00Z",
    "total": 4,
    "parameter": [
      {
        "name": "count",
        "valueInteger": 10
      }
    ],
    "contains": [
      {
        "system": "http://hl7.org/fhir/administrative-gender",
        "code": "male",
        "display": "Male"
      },
      {
        "system": "http://hl7.org/fhir/administrative-gender",
        "code": "female",
        "display": "Female"
      },
      {
        "system": "http://hl7.org/fhir/administrative-gender",
        "code": "other",
        "display": "Other"
      },
      {
        "system": "http://hl7.org/fhir/administrative-gender",
        "code": "unknown",
        "display": "Unknown"
      }
    ]
  }
}

响应包括以下内容：

  • expansion.total：扩展版中的代码总数 ValueSet

  • expansion.contains：扩展代码数组及其系统、代码和显示值

  • expansion.parameter：扩展请求中使用的参数

有关$expand操作规范的更多信息，请参阅 FHIR R4 文档 ValueSet $expand。