你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

根据 Azure Health Data Services 中的配置文件验证 FHIR 资源

在 FHIR 服务文章中的存储配置文件中,你演练了 FHIR® 配置文件的基础知识并存储它们。 Azure Health Data Services 中的 FHIR 服务允许根据配置文件验证资源,以查看资源是否符合配置文件。 本文将指导你了解如何对 $validate 配置文件验证资源。

$validate 是 Fast Healthcare 互操作性资源(FHIR)中的一项操作,可让你确保 FHIR 资源符合基本资源要求或指定的配置文件。 此操作可确保 FHIR 服务中的数据具有预期的特性和值。 有关验证操作的信息,请访问 HL7 FHIR 规范

根据规范,可以使用模式指定 $validate,例如创建和更新:

  • create:FHIR 服务检查配置文件内容是否与现有资源是唯一的,并且可以将其创建为新资源。
  • update:检查配置文件是否是针对指定现有资源的更新(也就是说,不会对不可变字段进行更改)。

提供了不同的方法来验证资源:

  • 选项 1:使用验证操作验证现有资源。
  • 选项 2:使用验证操作验证新资源。
  • 选项 3:使用标头验证资源 CREATE 或 UPDATE。

使用验证操作成功验证现有或新资源时,资源不会保存到 FHIR 服务中。 使用选项 3 将验证的资源成功保存到 FHIR 服务。

FHIR 服务始终返回 OperationOutcome $validate操作的验证结果。 将资源传递到$validate终结点后,FHIR 服务将执行两个步骤验证。 第一步是基本验证,以确保可以分析资源。 在资源分析期间,需要在继续下一步之前修复各个错误。 成功分析资源后,将执行完整验证作为第二步。

注意

要用于验证的任何值集都必须上传到 FHIR 服务器。 这包括属于 FHIR 规范的任何值集,以及实现指南中定义的任何 ValueSet。 仅支持包含所有代码的完整列表的完全展开值集。 不支持引用外部源的任何 ValueSet 定义。

选项 1:验证现有资源

若要验证现有资源, $validate 请在请求中使用 GET

GET http://<your FHIR service base URL>/{resource}/{resource ID}/$validate

例如:

GET https://myworkspace-myfhirserver.fhir.azurehealthcareapis.com/Patient/a6e11662-def8-4dde-9ebc-4429e68d130e/$validate

在此示例中,你将根据基本患者资源验证现有患者资源 a6e11662-def8-4dde-9ebc-4429e68d130e 。 如果有效,则会收到如下 OperationOutcome 代码示例。

{
    "resourceType": "OperationOutcome",
    "issue": [
        {
            "severity": "information",
            "code": "informational",
            "diagnostics": "All OK"
        }
    ]
}

如果资源无效,则会收到错误代码和错误消息,其中包含有关资源无效的原因的详细信息。 返回一个包含错误消息的示例 OperationOutcome ,如下面的代码示例所示。

{
    "resourceType": "OperationOutcome",
    "issue": [
        {
            "severity": "error",
            "code": "invalid",
            "details": {
                "coding": [
                    {
                        "system": "http://hl7.org/fhir/dotnet-api-operation-outcome",
                        "code": "1028"
                    }
                ],
                "text": "Instance count for 'Patient.identifier.value' is 0, which is not within the specified cardinality of 1..1"
            },
            "location": [
                "Patient.identifier[1]"
            ]
        },
        {
            "severity": "error",
            "code": "invalid",
            "details": {
                "coding": [
                    {
                        "system": "http://hl7.org/fhir/dotnet-api-operation-outcome",
                        "code": "1028"
                    }
                ],
                "text": "Instance count for 'Patient.gender' is 0, which is not within the specified cardinality of 1..1"
            },
            "location": [
                "Patient"
            ]
        }
    ]
}

在此示例中,资源不符合所提供的患者配置文件,该配置文件需要患者标识符值和性别。

如果要将配置文件指定为参数,可以指定要验证的配置文件的规范 URL,例如以下示例中的 HL7 基配置文件 heartrate

GET https://myworkspace-myfhirserver.fhir.azurehealthcareapis.com/Observation/12345678/$validate?profile=http://hl7.org/fhir/StructureDefinition/heartrate

选项 2:验证新资源

如果要验证要上传到服务器的新资源,可以执行 POST 请求。

POST http://<your FHIR service base URL>/{Resource}/$validate

例如:

POST https://myworkspace-myfhirserver.fhir.azurehealthcareapis.com/Patient/$validate

此请求验证资源。 在请求中指定的新资源将在验证后创建。 服务器始终返回 OperationOutcome 结果。

选项 3:使用标头验证资源 CREATE 或 UPDATE

可以选择何时验证资源,例如资源或 CREATE UPDATE。 默认情况下,FHIR 服务配置为选择不对资源 Create/Update进行验证。 此功能允许使用标头进行x-ms-profile-validation验证Create/Update。 设置为 x-ms-profile-validation true 进行验证。

注意

在开源 FHIR 服务中,可以在 CoreFeatures 下更改服务器配置设置。

{
   "FhirServer": {
      "CoreFeatures": {
            "ProfileValidationOnCreate": true,
            "ProfileValidationOnUpdate": false
        }
}

若要启用严格验证,请使用值为 strict 的“Prefer: handling”标头。 通过设置此标头,验证警告将报告为错误。

后续步骤

在本文中,你已了解如何使用 $validate.. 若要了解其他 FHIR 服务支持的功能,请参阅

注意

FHIR® 是 HL7 的注册商标,经 HL7 许可使用。