此页面由 Cloud Translation API 翻译。

控制对 Cloud Healthcare API 中的 FHIR 资源的访问权限

本页面介绍了如何使用 FHIR Consent 资源确定 Cloud Healthcare API 中 FHIR 存储区的数据访问权限。

如需配置具有同意强制执行功能的 FHIR 存储区，请完成以下步骤：

如果您还没有 FHIR 存储区，请创建一个。
设置以下 FHIR 存储区的 ConsentConfig 参数以启用同意强制执行：
- version：指定用于 FHIR 存储区的同意强制执行版本。此值只能由 CreateFhirStore 或 UpdateFhirStore 设置一次。设置后，您必须调用 ApplyConsents 或 ApplyAdminConsents 才能更改版本。
- access_enforced：如果设置为 true，则在访问 FHIR 资源时，系统将根据使用方提供的同意指令验证提供的同意标头。
  
  注意：只有在运行 ApplyConsents 或 ApplyAdminConsents（如下一部分中所述）后，强制执行模型才会生效。
- consent_header_handling：如果设置为 PERMIT_EMPTY_SCOPE（默认值），服务器允许不含（或为空）X-Consent-Scope 标头的请求。如果设置为 REQUIRED_ON_READ 且 access_enforced = true，则服务器会拒绝所有不含（或为空）X-Consent-Scope 标头的请求。

设置具有 `ConsentConfig` 的新 FHIR 存储区

curl -X POST \
    -H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \
    -H "Content-Type: application/json" \
    --data "{
      'version': 'R4',
      'enableUpdateCreate': true,
      'consentConfig': {
        'version': 'V1',
        'accessEnforced': true
      }
    }" "https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/fhirStores?fhirStoreId=FHIR_STORE_ID"

您应该收到类似以下内容的 JSON 响应：

{
  "name": "projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/fhirStores/FHIR_STORE_ID",
  "version": "R4",
  "enableUpdateCreate": true,
  "consentConfig": {
    "version": "V1"
  }
}

如果您已有商店，请使用 UpdateFhirStore 将具有同意强制执行 version 的 ConsentConfig 设置为 V1，并将 accessEnforced 设置为 true。

curl -X PATCH \
    -H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \
    -H "Content-Type: application/json" \
    --data "{
      'consentConfig': {
        'version': 'V1',
        'accessEnforced': true
      }
    }" "https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/fhirStores/FHIR_STORE_ID?update_mask=consentConfig"

政策通过意见征求资源表示。资源字段的用途和使用方式在数据模型文档中进行了说明。

以下示例展示了可为此特定示例创建的所有资源。

创建 FHIR 资源

以下示例展示了如何执行 [FHIR 软件包](/healthcare-api/docs/how-tos/fhir-bundles)以填充以下资源：

名为 Jeffrey Brown 的从业者资源
名为 Darcy Smith 的患者资源
由 Happy Hospital 收集的显示 Darcy 血红蛋白测量值 (LOINC718-7) 的观察结果资源
显示 Darcy 葡萄糖测量值 (LOINC15074-8) 的观察结果资源。
来自 Darcy 的同意，允许 Jeffrey Brown 使用应用 App/123 访问 Happy Hospital 收集的她的数据
来自 Darcy 的同意，允许 Jeffrey Brown 访问她的任何数据以进行紧急处理 (ETREAT)
Happy Hospital 的同意，允许 Jeffrey Brown 在使用应用 App/golden 进行生物医学研究 (BIORCH) 时访问所有数据

cat > bundle.json << 'EOF'
{
  "resourceType": "Bundle",
  "type": "transaction",
  "entry": [
    {
      "request": {"method": "PUT", "url": "Practitioner/12942879-f89f-41ae-aa80-0b911b649833"},
      "resource": {
        "active": true,
        "birthDate": "1970-05-23",
        "gender": "male",
        "id": "12942879-f89f-41ae-aa80-0b911b649833",
        "name": [{
            "family": "Brown",
            "given": ["Jeffrey"],
            "use": "official"
        }],
        "resourceType": "Practitioner"
      }
    },
    {
      "request": {"method": "PUT", "url": "Patient/3c6aa096-c054-4c22-b2b4-1e4a4d203de2"},
      "resource": {
        "active": true,
        "birthDate": "1990-01-01",
        "gender": "female",
        "id": "3c6aa096-c054-4c22-b2b4-1e4a4d203de2",
        "name": [{
            "family": "Smith",
            "given": ["Darcy"],
            "use": "official"
        }],
        "meta": {
          "tag": [{
            "system": "http://terminology.hl7.org/CodeSystem/common-tags",
            "code": "employee"
          }]
        },
        "resourceType": "Patient"
      }
    },
    {
      "request": {"method": "PUT", "url": "Observation/7473784b-46a8-470c-b9a6-fe38a01025aa"},
      "resource": {
        "id": "7473784b-46a8-470c-b9a6-fe38a01025aa",
        "meta": {"source": "http://example.com/HappyHospital"},
        "code": {
          "coding": [{
            "code": "718-7",
            "system": "http://loinc.org",
            "display": "Hemoglobin [Mass/volume] in Blood"
          }]
        },
        "effectivePeriod": {"start": "2021-12-10T05:30:10+01:00"},
        "issued": "2021-12-10T13:30:10+01:00",
        "resourceType": "Observation",
        "status": "final",
        "subject": {"reference": "Patient/3c6aa096-c054-4c22-b2b4-1e4a4d203de2"},
        "valueQuantity": {
          "code": "g/dL",
          "system": "http://unitsofmeasure.org",
          "unit": "g/dl",
          "value": 7.2
        }
      }
    },
    {
      "request": {"method": "PUT", "url": "Observation/68583624-9921-4158-8754-2a306c689abd"},
      "resource": {
        "id": "68583624-9921-4158-8754-2a306c689abd",
        "code": {
          "coding": [{
            "code": "15074-8",
            "system": "http://loinc.org",
            "display": "Glucose [Moles/volume] in Blood"
          }]
        },
        "effectivePeriod": {"start": "2021-12-01T05:30:10+01:00"},
        "issued": "2021-12-01T13:30:10+01:00",
        "resourceType": "Observation",
        "status": "final",
        "subject": {"reference": "Patient/3c6aa096-c054-4c22-b2b4-1e4a4d203de2"},
        "valueQuantity": {
          "code": "mmol/L",
          "system": "http://unitsofmeasure.org",
          "unit": "mmol/l",
          "value": 6.3
        }
      }
    },
    {
      "request": {"method": "PUT", "url": "Consent/10998b60-a252-405f-aa47-0702554ddc8e"},
      "resource": {
        "category": [{
          "coding": [{
            "code": "59284-0",
            "system": "http://terminology.hl7.org/CodeSystem/consentcategorycodes"
          }]
        }],
        "id": "10998b60-a252-405f-aa47-0702554ddc8e",
        "patient": {"reference": "Patient/3c6aa096-c054-4c22-b2b4-1e4a4d203de2"},
        "policyRule": {
          "coding": [{
            "code": "OPTIN",
            "system": "http://terminology.hl7.org/CodeSystem/v3-ActCode"
          }]
        },
        "provision": {
          "actor": [
            {
              "reference": {"reference": "Practitioner/12942879-f89f-41ae-aa80-0b911b649833"},
              "role": {
                "coding": [{
                  "code": "GRANTEE",
                  "system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode"
                }]
              }
            }
          ],
          "extension": [
            {
              "url": "https://g.co/fhir/medicalrecords/Environment",
              "valueCodeableConcept": {
                "coding": [{
                  "code": "123",
                  "system": "App"
                }]
              }
            },
            {
              "url": "https://g.co/fhir/medicalrecords/DataSource",
              "valueUri": "http://example.com/HappyHospital"
            }
          ],
          "type": "permit"
        },
        "resourceType": "Consent",
        "scope": {
          "coding": [{
            "code": "patient-privacy",
            "system": "http://terminology.hl7.org/CodeSystem/consentscope"
          }]
        },
        "status": "active"
      }
    },
    {
      "request": {"method": "PUT", "url": "Consent/73c54e8d-2789-403b-9dee-13085c5d5e34"},
      "resource": {
        "category": [{
          "coding": [{
            "code": "59284-0",
            "system": "http://terminology.hl7.org/CodeSystem/consentcategorycodes"
          }]
        }],
        "id": "73c54e8d-2789-403b-9dee-13085c5d5e34",
        "patient": {"reference": "Patient/3c6aa096-c054-4c22-b2b4-1e4a4d203de2"},
        "policyRule": {
          "coding": [{
            "code": "OPTIN",
            "system": "http://terminology.hl7.org/CodeSystem/v3-ActCode"
          }]
        },
        "provision": {
          "actor": [
            {
              "reference": {"reference": "Practitioner/12942879-f89f-41ae-aa80-0b911b649833"},
              "role": {
                "coding": [{
                  "code": "GRANTEE",
                  "system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode"
                }]
              }
            }
          ],
          "purpose": [{
            "code": "ETREAT",
            "system": "http://terminology.hl7.org/CodeSystem/v3-ActReason"
          }],
          "type": "permit"
        },
        "resourceType": "Consent",
        "scope": {
          "coding": [{
            "code": "patient-privacy",
            "system": "http://terminology.hl7.org/CodeSystem/consentscope"
          }]
        },
        "status": "active"
      }
    },
    {
      "request": {"method": "PUT", "url": "Consent/5c8e3f8a-9fd5-480d-a08e-f29b89feccde"},
      "resource": {
        "category": [{
          "coding": [{
            "code": "57017-6",
            "system": "http://loinc.org"
          }]
        }],
        "id": "5c8e3f8a-9fd5-480d-a08e-f29b89feccde",
        "patient": {},
        "extension": [{
          "url": "https://g.co/fhir/medicalrecords/ConsentAdminPolicy"
        }],
        "policyRule": {
          "coding": [{
            "code": "OPTIN",
            "system": "http://terminology.hl7.org/CodeSystem/v3-ActCode"
          }]
        },
        "provision": {
          "actor": [
            {
              "reference": {"reference": "Practitioner/12942879-f89f-41ae-aa80-0b911b649833"},
              "role": {
                "coding": [{
                  "code": "GRANTEE",
                  "system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode"
                }]
              }
            }
          ],
          "purpose": [{
            "code": "BIORCH",
            "system": "http://terminology.hl7.org/CodeSystem/v3-ActReason"
          }],
          "extension": [
            {
              "url": "https://g.co/fhir/medicalrecords/Environment",
              "valueCodeableConcept": {
                "coding": [{
                  "code": "golden",
                  "system": "App"
                }]
              }
            }
          ],
          "type": "permit"
        },
        "resourceType": "Consent",
        "scope": {},
        "status": "active"
      }
    }
  ]
}
EOF
curl -X POST \
    -H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \
    -H "Content-Type: application/fhir+json; charset=utf-8" \
    --data @bundle.json \
    "https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/fhirStores/FHIR_STORE_ID/fhir"

您应该收到类似以下内容的 JSON 响应：

{
  "entry": [
    {
      "response": {
        "etag": "W/\"VERSION_ID\"",
        "lastModified": "2022-09-01T17:31:40.423469+00:00",
        "location": "https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/fhirStores/FHIR_STORE_ID/fhir/Practitioner/12942879-f89f-41ae-aa80-0b911b649833/_history/VERSION_ID",
        "status": "201 Created"
      }
    },
    {
      "response": {
        "etag": "W/\"VERSION_ID\"",
        "lastModified": "2022-09-01T17:31:40.423469+00:00",
        "location": "https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/fhirStores/FHIR_STORE_ID/fhir/Patient/3c6aa096-c054-4c22-b2b4-1e4a4d203de2/_history/VERSION_ID",
        "status": "201 Created"
      }
    },
    {
      "response": {
        "etag": "W/\"VERSION_ID\"",
        "lastModified": "2022-09-01T17:31:40.423469+00:00",
        "location": "https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/fhirStores/FHIR_STORE_ID/fhir/Observation/7473784b-46a8-470c-b9a6-fe38a01025aa/_history/VERSION_ID",
        "status": "201 Created"
      }
    },
    {
      "response": {
        "etag": "W/\"VERSION_ID\"",
        "lastModified": "2022-09-01T17:31:40.423469+00:00",
        "location": "https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/fhirStores/FHIR_STORE_ID/fhir/Observation/68583624-9921-4158-8754-2a306c689abd/_history/VERSION_ID",
        "status": "201 Created"
      }
    },
    {
      "response": {
        "etag": "W/\"VERSION_ID\"",
        "lastModified": "2022-09-01T17:31:40.423469+00:00",
        "location": "https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/fhirStores/FHIR_STORE_ID/fhir/Consent/10998b60-a252-405f-aa47-0702554ddc8e/_history/VERSION_ID",
        "status": "201 Created"
      }
    },
    {
      "response": {
        "etag": "W/\"VERSION_ID\"",
        "lastModified": "2022-09-01T17:31:40.423469+00:00",
        "location": "https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/fhirStores/FHIR_STORE_ID/fhir/Consent/73c54e8d-2789-403b-9dee-13085c5d5e34/_history/VERSION_ID",
        "status": "201 Created"
      }
    },
    {
      "response": {
        "etag": "W/\"VERSION_ID\"",
        "lastModified": "2022-09-01T17:31:40.423469+00:00",
        "location": "https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/fhirStores/FHIR_STORE_ID/fhir/Consent/5c8e3f8a-9fd5-480d-a08e-f29b89feccde/_history/VERSION_ID",
        "status": "201 Created"
      }
    }
  ],
  "resourceType": "Bundle",
  "type": "transaction-response"
}

以下是更多 R4 Consent 资源示例，展示了如何表示复杂的政策。

{
  "resourceType": "Consent",
  "id": "patient-consent-example",
  "patient": {
    "reference": "Patient/f001"
  },
  "category": [
    {
      "coding": [
        {
          "system": "http://loinc.org",
          "code": "59284-0"
        }
      ]
    }
  ],
  "scope": {
    "coding": [
      {
        "system": "http://terminology.hl7.org/CodeSystem/consentscope",
        "code": "patient-privacy"
      }
    ]
  },
  "policyRule": {
    "coding": [
      {
        "system": "http://terminology.hl7.org/CodeSystem/v3-ActCode",
        "code": "OPTIN"
      }
    ]
  },
  "status": "active",
  "provision": {
    "type": "permit",
    "actor": [
      {
        "reference": {
          "reference": "Practitioner/f002"
        },
        "role": {
          "coding": [
            {
              "system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
              "code": "GRANTEE"
            }
          ]
        }
      }
    ],
    "purpose": [
      {
        "system": "http://terminology.hl7.org/CodeSystem/v3-ActReason",
        "code": "TREAT"
      }
    ],
    "class": [
      {
        "system": "http://hl7.org/fhir/resource-types",
        "code": "Encounter"
      }
    ],
    "data": [
      {
        "meaning": "instance",
        "reference": {
          "reference": "Encounter/e001"
        }
      }
    ],
    "extension": [
      {
        "url": "https://g.co/fhir/medicalrecords/Environment",
        "valueCodeableConcept": {
          "coding": [
            {
              "system": "iso3166-1",
              "code": "CA"
            }
          ]
        }
      },
      {
        "url": "https://g.co/fhir/medicalrecords/DataTag",
        "valueCoding": {
          "system": "http://terminology.hl7.org/CodeSystem/common-tags",
          "code": "actionable"
        }
      },
      {
        "url": "https://g.co/fhir/medicalrecords/DataTag",
        "extension": [
          {
            "url": "https://g.co/fhir/medicalrecords/DataTag",
            "valueCoding": {
              "system": "http://example.com/custom-tags",
              "code": "archived"
            }
          },
          {
            "url": "https://g.co/fhir/medicalrecords/DataTag",
            "valueCoding": {
              "system": "http://example.com/custom-tags",
              "code": "insensitive"
            }
          }
        ]
      },
      {
        "url": "https://g.co/fhir/medicalrecords/DataSource",
        "valueUri": "http://somesystem.example.org/foo"
      }
    ],
    "securityLabel": [
      {
        "system": "http://terminology.hl7.org/CodeSystem/v3-Confidentiality",
        "code": "R"
      },
      {
        "system": "http://terminology.hl7.org/CodeSystem/v3-ActCode",
        "code": "PSY"
      }
    ]
  }
}

上述示例表示一个患者同意资源，其中患者 f001 向从业者 f002 授予权限，其目的是提供由 TREAT 表示的定期处理。从业人员来自地理位置 iso3166-1/CA。该同意资源允许从业者在患者数据满足以下所有条件的情况下访问患者数据。

它是 ID 为 Encounter/e001 的 Encounter 类型。
它来自来源 http://somesystem.example.org/foo。
它满足至少以下一个标记条件（可以通过设置 Meta.tag 的 system 和 code 字段来标记资源）：

具有标记（system = http://terminology.hl7.org/CodeSystem/common-tags 和 code = actionable）
同时具有两个标记（system = http://example.com/custom-tags 和 code = archived）以及（system = http://example.com/custom-tags 和 code = insensitive）

它至少具有以下安全标签之一

system = http://terminology.hl7.org/CodeSystem/v3-Confidentiality 且 code 是 R、N、M、L、U 之一。
system = http://terminology.hl7.org/CodeSystem/v3-ActCode 且 code = PSY。

管理员政策指令示例

{
  "resourceType": "Consent",
  "id": "admin-policy-example",
  "patient": {},
  "extension": [{
    "url": "https://g.co/fhir/medicalrecords/ConsentAdminPolicy"
  }],
  "category": [
    {
      "coding": [
        {
          "system": "http://loinc.org",
          "code": "57017-6"
        }
      ]
    }
  ],
  "scope": {},
  "policyRule": {
    "coding": [
      {
        "system": "http://terminology.hl7.org/CodeSystem/v3-ActCode",
        "code": "OPTIN"
      }
    ]
  },
  "status": "active",
  "provision": {
    "type": "permit",
    "actor": [
      {
        "reference": {
          "reference": "Practitioner/f002"
        },
        "role": {
          "coding": [
            {
              "system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
              "code": "GRANTEE"
            }
          ]
        }
      }
    ],
    "purpose": [
      {
        "system": "http://terminology.hl7.org/CodeSystem/v3-ActReason",
        "code": "TREAT"
      }
    ],
    "class": [
      {
        "system": "http://hl7.org/fhir/resource-types",
        "code": "Encounter"
      }
    ],
    "data": [
      {
        "meaning": "instance",
        "reference": {
          "reference": "Encounter/e001"
        }
      }
    ],
    "extension": [
      {
        "url": "https://g.co/fhir/medicalrecords/Environment",
        "valueCodeableConcept": {
          "coding": [
            {
              "system": "iso3166-1",
              "code": "CA"
            }
          ]
        }
      },
      {
        "url": "https://g.co/fhir/medicalrecords/DataTag",
        "valueCoding": {
          "system": "http://terminology.hl7.org/CodeSystem/common-tags",
          "code": "actionable"
        }
      },
      {
        "url": "https://g.co/fhir/medicalrecords/DataTag",
        "extension": [
          {
            "url": "https://g.co/fhir/medicalrecords/DataTag",
            "valueCoding": {
              "system": "http://example.com/custom-tags",
              "code": "archived"
            }
          },
          {
            "url": "https://g.co/fhir/medicalrecords/DataTag",
            "valueCoding": {
              "system": "http://example.com/custom-tags",
              "code": "insensitive"
            }
          }
        ]
      },
      {
        "url": "https://g.co/fhir/medicalrecords/DataSource",
        "valueUri": "http://somesystem.example.org/foo"
      }
    ],
    "securityLabel": [
      {
        "system": "http://terminology.hl7.org/CodeSystem/v3-Confidentiality",
        "code": "R"
      },
      {
        "system": "http://terminology.hl7.org/CodeSystem/v3-ActCode",
        "code": "PSY"
      }
    ]
  }
}

上述示例表示一个管理员政策同意资源，该资源向从业者 f002 授予权限，其目的是提供由 TREAT 表示的定期处理。从业人员来自地理位置 iso3166-1/CA。该同意资源允许从业者在患者数据满足以下所有条件的情况下访问患者数据：

它是 ID 为 Encounter/e001 的 Encounter 类型。
它来自来源 http://somesystem.example.org/foo。
它满足至少以下一个标记条件：

具有标记（system = http://terminology.hl7.org/CodeSystem/common-tags 和 code = actionable）
同时具有两个标记（system = http://example.com/custom-tags 和 code = archived）以及（system = http://example.com/custom-tags 和 code = insensitive）

它至少具有以下安全标签之一

system = http://terminology.hl7.org/CodeSystem/v3-Confidentiality 且 code 是 R、N、M、L、U 之一。
system = http://terminology.hl7.org/CodeSystem/v3-ActCode 且 code = PSY。

管理员级联政策指令示例

{
  "resourceType": "Consent",
  "id": "admin-cascading-policy-example",
  "patient": {},
  "extension": [
    { "url": "https://g.co/fhir/medicalrecords/ConsentAdminPolicy" },
    { "url": "https://g.co/fhir/medicalrecords/CascadingPolicy" }
  ],
  "category": [
    {
      "coding": [
        {
          "system": "http://loinc.org",
          "code": "57017-6"
        }
      ]
    }
  ],
  "scope": {},
  "policyRule": {
    "coding": [
      {
        "system": "http://terminology.hl7.org/CodeSystem/v3-ActCode",
        "code": "OPTIN"
      }
    ]
  },
  "status": "active",
  "provision": {
    "type": "permit",
    "actor": [
      {
        "reference": {
          "reference": "Practitioner/f002"
        },
        "role": {
          "coding": [
            {
              "system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
              "code": "GRANTEE"
            }
          ]
        }
      }
    ],
    "purpose": [
      {
        "system": "http://terminology.hl7.org/CodeSystem/v3-ActReason",
        "code": "TREAT"
      }
    ],
    "class": [
      {
        "system": "http://hl7.org/fhir/resource-types",
        "code": "Patient"
      }
    ],
    "extension": [
      {
        "url": "https://g.co/fhir/medicalrecords/Environment",
        "valueCodeableConcept": {
          "coding": [
            {
              "system": "iso3166-1",
              "code": "CA"
            }
          ]
        }
      },
      {
        "url": "https://g.co/fhir/medicalrecords/DataTag",
        "valueCoding": {
          "system": "http://terminology.hl7.org/CodeSystem/common-tags",
          "code": "employee"
        }
      }
    ]
  }
}

上述示例表示一个管理员级联政策同意资源，其中向从业者 f002 授予权限，其目的是提供由 TREAT 表示的定期处理。从业人员来自地理位置 iso3166-1/CA。此同意资源允许从业者访问具有标签 employee 的患者的隔间数据。所有资源条件仅适用于隔离区基本资源（即患者资源），因为该资源控制着要从哪些资源进行级联。

强制执行患者同意声明或管理员政策

通过 `ApplyConsents` 强制执行患者的同意情况

curl -X POST \
    -H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \
    -H "Content-Type: application/json" \
    --data "{'validateOnly': false}" \
    "https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/fhirStores/FHIR_STORE_ID:applyConsents"

您应该收到类似以下内容的 JSON 响应：

{
  "name": "projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/operations/OPERATION_ID"
}

响应包含操作名称。如需跟踪操作的状态，您可以使用 [Operation <code>get</code> 方法](/healthcare-api/docs/reference/rest/v1/projects.locations.datasets.operations/get)：

curl -X GET \
    -H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \
    "https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/operations/OPERATION_ID"

操作完成后，服务器将以 JSON 格式返回包含操作状态的响应：

{
  "name": "projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/operations/OPERATION_ID"",
  "metadata": {
    "@type": "type.googleapis.com/google.cloud.healthcare.v1.OperationMetadata",
    "apiMethodName": "google.cloud.healthcare.v1.fhir.FhirStoreService.ApplyConsents",
    "createTime": "CREATE_TIME",
    "endTime": "END_TIME",
    "logsUrl": "https://console.cloud.google.com/logs/query/CLOUD_LOGGING_URL",
    "counter": {
      "success": "2",
      "secondarySuccess": "5"
    }
  },
  "done": true,
  "response": {
    "@type": "type.googleapis.com/google.cloud.healthcare.v1.fhir.ApplyConsentsResponse",
    "consentApplySuccess": "2",
    "affectedResources": "5"
  }
}

此响应表明服务器已成功处理 2 个同意并更新了 5 个资源（1 个患者、2 个同意、2 个观察结果）的同意访问权限。

通过 `ApplyAdminConsents` 强制执行管理员政策

curl -X POST \
    -H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \
    -H "Content-Type: application/json" \
    --data "{
      'validateOnly': false,
      'newConsentsList': {
        'names': ['projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/fhirStores/FHIR_STORE_ID/fhir/Consent/5c8e3f8a-9fd5-480d-a08e-f29b89feccde/_history/VERSION_ID']
      }
    }" \
    "https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/fhirStores/FHIR_STORE_ID:applyAdminConsents"

您应该收到类似以下内容的 JSON 响应：

{
  "name": "projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/operations/OPERATION_ID"
}

响应包含操作名称。如需跟踪操作的状态，您可以使用 [Operation <code>get</code> 方法](/healthcare-api/docs/reference/rest/v1/projects.locations.datasets.operations/get)：

curl -X GET \
    -H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \
    "https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/operations/OPERATION_ID"

操作完成后，服务器将以 JSON 格式返回包含操作状态的响应：

{
  "name": "projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/operations/OPERATION_ID"",
  "metadata": {
    "@type": "type.googleapis.com/google.cloud.healthcare.v1.OperationMetadata",
    "apiMethodName": "google.cloud.healthcare.v1.fhir.FhirStoreService.ApplyAdminConsents",
    "createTime": "CREATE_TIME",
    "endTime": "END_TIME",
    "logsUrl": "https://console.cloud.google.com/logs/query/CLOUD_LOGGING_URL",
    "counter": {
      "success": "1",
      "secondarySuccess": "7"
    }
  },
  "done": true,
  "response": {
    "@type": "type.googleapis.com/google.cloud.healthcare.v1.fhir.ApplyAdminConsentsResponse",
    "consentApplySuccess": "1",
    "affectedResources": "7"
  }
}

此响应表明服务器已成功处理 1 项管理员政策，并更新了 7 个资源（1 个从业人员、1 个患者、2 个观察结果、2 个患者同意和 1 项管理员政策）的同意访问权限。

在调用 ApplyConsents（针对患者同意）或 ApplyAdminConsents（针对管理员政策和管理员级联政策）并成功完成之前，对存储在 FHIR 存储区中的同意的强制执行不会生效。如果您在运行 ApplyConsents 或 ApplyAdminConsents 后添加、修改或移除同意，则必须再次运行相应命令，才能将这些同意包含在强制执行模型中。

FHIR 资源会以异步方式编入索引，因此 ApplyConsents 或 ApplyAdminConsents 完成的时间与强制执行模型在搜索结果中反映的时间可能会略有延迟。此延迟仅适用于搜索请求。

如果这是您第一次在 FHIR 存储区上设置同意强制执行功能，请等待 ApplyConsents 或 ApplyAdminConsents 长时间运行的操作完成，然后再发出同意感知请求。

如需针对部分患者调用 ApplyConsents，您可以使用以下过滤条件：

PatientScope：针对多达 10,000 位患者的 ID 列表运行 ApplyConsents
TimeRange：针对特定时间范围内更新其同意资源的患者资源 ID 列表运行 ApplyConsent

如需调用 ApplyAdminConsents，您需要提供要应用的所有政策的完整列表（而不是增量列表）。因此，空列表将使商店中的所有管理员政策失效。如果 FHIR 存储区支持版本控制，则每项政策都必须是资源版本名称；否则，必须是资源名称。

您可以使用 operations.get 来检索操作的 ProgressCounter。完成后，Operation.response 中会包含 ApplyConsentsResponse。下表介绍了 ProgressCounter 和 ApplyConsentsResponse 或 ApplyAdminConsentsResponse 中的计数器。

`ProgressCounter`	`ApplyConsentsResponse` 或 `ApplyAdminConsentsResponse`	说明
`success`	`consentApplySuccess`	相应操作成功处理的同意资源数量。
`failure`	`consentApplyFailure`	不受支持或无效的意见征求资源数量。您可以在 Cloud Logging 中查看错误日志，或者当 `validateOnly` 为 `false` 时，使用 `CheckConsentEnforcementStatus` 或 `CheckPatientConsentEnforcementStatus` 检索错误详细信息以检查同意强制执行状态。
`secondarySuccess`	`affectedResources`	当 `validateOnly` 为 `false` 时，它表示由于同意更改生效而成功重新编入索引的 FHIR 资源的数量。
`secondaryFailure`	`failedResources`	当 `validateOnly` 为 `false` 时，它表示可能具有同意更改但无法重新编入索引的 FHIR 资源的数量。这可能会影响使用同意上下文进行搜索，但不会影响其他方法。如需查看错误详情，您可以在 Cloud Logging 中查看错误日志。

处理 FHIR 同意资源后，您可以使用以下 API 检查单个同意或患者所有同意的强制执行状态：

CheckConsentEnforcementStatus：返回列出以下参数的 Parameters（STU3、R4）资源：
- id：表示同意资源的 ID
- lastUpdated：表示上次强制执行同意的时间
- versionId：表示用于同意强制执行的版本 ID
- consent-enforcement-status：表示同意强制执行状态
CheckPatientConsentEnforcementStatus：返回 Parameters（STU3、R4）资源的 Bundle（STU3、R4），该资源包含来自单个患者的所有同意的强制执行状态

对于管理员政策，CheckConsentEnforcementStatus 只能用于检查单个意见征求管理员政策的强制执行状态。或者，您也可以使用 fhirStores.get 查看应用于商店的所有有效管理员政策。

consent-enforcement-status 可以具有以下任一值：

OFF：表示新同意资源的默认强制执行状态，其中的同意资源从未被处理。
ENFORCEABLE：同意资源已成功处理的状态。
INACTIVE：同意资源被忽略的非活跃状态。
UNSUPPORTED：可能符合 FHIR 规范但无法执行的同意资源状态。这是由于在当前功能支持级别下 FHIR 同意强制执行的实施有限。
ENFORCEMENT_LIMIT_EXCEEDED：FHIR 同意资源格式和资源支持级别没有错误但以下一个或多个条件为 true 时的状态：
- 患者拥有大量同意资源。
- 所有活跃同意中的同意指令大小都大于 FHIR 服务器强制执行同意指令的最大大小。

Cloud Healthcare API 支持在给定 FHIR 存储区中搜索 FHIR 资源，并使用 actor、purpose 和 environment 作为查询参数。响应仅包含已征得用户同意的资源。

从业者 Jeffrey Brown（由 Practitioner/12942879-f89f-41ae-aa80-0b911b649833 标识）使用受信任的应用 App/123 搜索 status=final 的所有观察结果。

curl -X GET \
    -H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \
    -H "X-Consent-Scope: actor/Practitioner/12942879-f89f-41ae-aa80-0b911b649833 env/App/123" \
    "https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/fhirStores/FHIR_STORE_ID/fhir/Observation?status=final"

您应该收到类似以下内容的 JSON 响应：

{
  "entry": [
    {
      "fullUrl": "https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/datasets/DATASET_ID/fhirStores/FHIR_STORE_ID/fhir/Observation/7473784b-46a8-470c-b9a6-fe38a01025aa",
      "resource": {
        "code": {
          "coding": [
            {
              "code": "718-7",
              "display": "Hemoglobin [Mass/volume] in Blood",
              "system": "http://loinc.org"
            }
          ]
        },
        "effectivePeriod": {
          "start": "2021-12-10T05:30:10+01:00"
        },
        "id": "7473784b-46a8-470c-b9a6-fe38a01025aa",
        "issued": "2021-12-10T13:30:10+01:00",
        "meta": {
          "lastUpdated": "2022-09-01T17:31:40.423469+00:00",
          "source": "http://example.com/HappyHospital",
          "versionId": "VERSION_ID"
        },
        "resourceType": "Observation",
        "status": "final",
        "subject": {
          "reference": "Patient/3c6aa096-c054-4c22-b2b4-1e4a4d203de2"
        },
        "valueQuantity": {
          "code": "g/dL",
          "system": "http://unitsofmeasure.org",
          "unit": "g/dl",
          "value": 7.2
        }
      },
      "search": {
        "mode": "match"
      }
    }
  ],
  "link": [
    {
      "relation": "search",
      "url": "https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/fhirStores/FHIR_STORE_ID/fhir/Observation/?status=final"
    },
    {
      "relation": "first",
      "url": "https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/fhirStores/FHIR_STORE_ID/fhir/Observation/?status=final"
    },
    {
      "relation": "self",
      "url": "https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/fhirStores/FHIR_STORE_ID/fhir/Observation/?status=final"
    }
  ],
  "resourceType": "Bundle",
  "total": 1,
  "type": "searchset"
}

从业者 Jeffrey Brown（由 Practitioner/12942879-f89f-41ae-aa80-0b911b649833 标识）使用应用 App/123 搜索患者 Darcy 的所有观察结果。

curl -X GET \
    -H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \
    -H "X-Consent-Scope: actor/Practitioner/12942879-f89f-41ae-aa80-0b911b649833 env/App/123" \
    "https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/fhirStores/FHIR_STORE_ID/fhir/Observation?subject:Patient.name=Darcy"

您应该收到类似以下内容的 JSON 响应：

{
  "link": [
    {
      "relation": "search",
      "url": "https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/fhirStores/FHIR_STORE_ID/fhir/Observation/?subject%3APatient.name=Darcy"
    },
    {
      "relation": "first",
      "url": "https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/fhirStores/FHIR_STORE_ID/fhir/Observation/?subject%3APatient.name=Darcy"
    },
    {
      "relation": "self",
      "url": "https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/fhirStores/FHIR_STORE_ID/fhir/Observation/?subject%3APatient.name=Darcy"
    }
  ],
  "resourceType": "Bundle",
  "total": 0,
  "type": "searchset"
}

上述查询是链式搜索。由于同意场景 actor/Practitioner/12942879-f89f-41ae-aa80-0b911b649833 env/App/123 访问患者 Darcy 资源（由 Patient/3c6aa096-c054-4c22-b2b4-1e4a4d203de2 标识）被拒绝，因此 FHIR 服务器不会返回患者的观察结果，就像患者不存在一样。

从业者 Jeffrey Brown（由 Practitioner/12942879-f89f-41ae-aa80-0b911b649833 标识）使用应用 App/123 搜索患者 Darcy 的所有观察结果，用于紧急处理。

curl -X GET \
    -H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \
    -H "X-Consent-Scope: actor/Practitioner/12942879-f89f-41ae-aa80-0b911b649833 purp/v3/ETREAT env/App/123" \
    "https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/fhirStores/FHIR_STORE_ID/fhir/Observation?subject:Patient.name=Darcy"

您应该收到类似以下内容的 JSON 响应：

{
  "entry": [
    {
      "fullUrl": "https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/fhirStores/FHIR_STORE_ID/fhir/Observation/68583624-9921-4158-8754-2a306c689abd",
      "resource": {
        "code": {
          "coding": [
            {
              "code": "15074-8",
              "display": "Glucose [Moles/volume] in Blood",
              "system": "http://loinc.org"
            }
          ]
        },
        "effectivePeriod": {
          "start": "2021-12-01T05:30:10+01:00"
        },
        "id": "68583624-9921-4158-8754-2a306c689abd",
        "issued": "2021-12-01T13:30:10+01:00",
        "meta": {
          "lastUpdated": "2022-09-01T17:31:40.423469+00:00",
          "versionId": "VERSION_ID"
        },
        "resourceType": "Observation",
        "status": "final",
        "subject": {
          "reference": "Patient/3c6aa096-c054-4c22-b2b4-1e4a4d203de2"
        },
        "valueQuantity": {
          "code": "mmol/L",
          "system": "http://unitsofmeasure.org",
          "unit": "mmol/l",
          "value": 6.3
        }
      },
      "search": {
        "mode": "match"
      }
    },
    {
      "fullUrl": "https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/fhirStores/FHIR_STORE_ID/fhir/Observation/7473784b-46a8-470c-b9a6-fe38a01025aa",
      "resource": {
        "code": {
          "coding": [
            {
              "code": "718-7",
              "display": "Hemoglobin [Mass/volume] in Blood",
              "system": "http://loinc.org"
            }
          ]
        },
        "effectivePeriod": {
          "start": "2021-12-10T05:30:10+01:00"
        },
        "id": "7473784b-46a8-470c-b9a6-fe38a01025aa",
        "issued": "2021-12-10T13:30:10+01:00",
        "meta": {
          "lastUpdated": "2022-09-01T17:31:40.423469+00:00",
          "source": "http://example.com/HappyHospital",
          "versionId": "VERSION_ID"
        },
        "resourceType": "Observation",
        "status": "final",
        "subject": {
          "reference": "Patient/3c6aa096-c054-4c22-b2b4-1e4a4d203de2"
        },
        "valueQuantity": {
          "code": "g/dL",
          "system": "http://unitsofmeasure.org",
          "unit": "g/dl",
          "value": 7.2
        }
      },
      "search": {
        "mode": "match"
      }
    }
  ],
  "link": [
    {
      "relation": "search",
      "url": "https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/fhirStores/FHIR_STORE_ID/fhir/Observation/?subject:Patient.name=Darcy"
    },
    {
      "relation": "first",
      "url": "https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/fhirStores/FHIR_STORE_ID/fhir/Observation/?subject:Patient.name=Darcy"
    },
    {
      "relation": "self",
      "url": "https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/fhirStores/FHIR_STORE_ID/fhir/Observation/?subject:Patient.name=Darcy"
    }
  ],
  "resourceType": "Bundle",
  "total": 2,
  "type": "searchset"
}

从业者 Jeffrey Brown（由 Practitioner/12942879-f89f-41ae-aa80-0b911b649833 标识）使用 status=final 搜索观察结果，以实现处理和研究这两个目的

curl -X GET \
    -H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \
    -H "X-Consent-Scope: actor/Practitioner/12942879-f89f-41ae-aa80-0b911b649833 purp/v3/TREAT purp/v3/HRESCH" \
    "https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/fhirStores/FHIR_STORE_ID/fhir/Observation?status=final"

您应该收到类似以下内容的 JSON 响应：

{
  "issue": [
    {
      "code": "security",
      "details": {
        "text": "permission_denied"
      },
      "diagnostics": "the maximum number of allowed consent purpose scopes is 1, got 2",
      "severity": "error"
    }
  ],
  "resourceType": "OperationOutcome"
}

在这种情况下，从业者 Jeffrey Brown 应该从请求的 `X-Consent-Scope` 中移除不必要的目的。

医院 IT 管理员使用 bypass 搜索医院中的所有从业人员。

curl -X GET \
    -H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \
    -H "X-Consent-Scope: bypass actor/Admin/ef0592c9-6724-467e-878d-f879e537cd15 env/net/HappyNet" \
    "https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/fhirStores/FHIR_STORE_ID/fhir/Practitioner?"

由于提供了 bypass，因此跳过了意见征求检查。您应该会收到类似以下内容的 JSON 响应：

{
  "entry": [
    {
      "fullUrl": "https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/fhirStores/FHIR_STORE_ID/fhir/Practitioner/12942879-f89f-41ae-aa80-0b911b649833",
      "resource": {
        "active": true,
        "birthDate": "1970-05-23",
        "gender": "male",
        "id": "12942879-f89f-41ae-aa80-0b911b649833",
        "meta": {
          "lastUpdated": "2022-09-01T17:31:40.423469+00:00",
          "versionId": "VERSION_ID"
        },
        "name": [
          {
            "family": "Brown",
            "given": [
              "Jeffrey"
            ],
            "use": "official"
          }
        ],
        "resourceType": "Practitioner"
      },
      "search": {
        "mode": "match"
      }
    }
  ],
  "link": [
    {
      "relation": "search",
      "url": "https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/fhirStores/FHIR_STORE_ID/fhir/Practitioner/?"
    },
    {
      "relation": "first",
      "url": "https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/fhirStores/FHIR_STORE_ID/fhir/Practitioner/?"
    },
    {
      "relation": "self",
      "url": "https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/fhirStores/FHIR_STORE_ID/fhir/Practitioner/?"
    }
  ],
  "resourceType": "Bundle",
  "total": 1,
  "type": "searchset"
}

Cloud Healthcare API 支持在给定 FHIR 存储区中获取 FHIR 资源，并使用 actor、purpose 和 environment 作为查询参数。响应仅包含已征得用户同意的资源。

从业者 Jeffrey Brown（由 Practitioner/12942879-f89f-41ae-aa80-0b911b649833 标识）使用应用 App/123 读取患者的血红蛋白测量值（在此示例中为 Observation/7473784b-46a8-470c-b9a6-fe38a01025aa）。

curl -X GET \
    -H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \
    -H "X-Consent-Scope: actor/Practitioner/12942879-f89f-41ae-aa80-0b911b649833 env/App/123" \
    "https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/fhirStores/FHIR_STORE_ID/fhir/Observation/7473784b-46a8-470c-b9a6-fe38a01025aa"

由于请求者获得了同意，因此响应是观察结果资源的内容。

{
  "code": {
    "coding": [
      {
        "code": "718-7",
        "display": "Hemoglobin [Mass/volume] in Blood",
        "system": "http://loinc.org"
      }
    ]
  },
  "effectivePeriod": {
    "start": "2021-12-10T05:30:10+01:00"
  },
  "id": "7473784b-46a8-470c-b9a6-fe38a01025aa",
  "issued": "2021-12-10T13:30:10+01:00",
  "meta": {
    "lastUpdated": "2022-09-01T17:31:40.423469+00:00",
    "source": "http://example.com/HappyHospital",
    "versionId": "VERSION_ID"
  },
  "resourceType": "Observation",
  "status": "final",
  "subject": {
    "reference": "Patient/3c6aa096-c054-4c22-b2b4-1e4a4d203de2"
  },
  "valueQuantity": {
    "code": "g/dL",
    "system": "http://unitsofmeasure.org",
    "unit": "g/dl",
    "value": 7.2
  }
}

从业者 Jeffrey Brown（由 Practitioner/12942879-f89f-41ae-aa80-0b911b649833 标识）使用未知应用 App/unknown 读取患者的血红蛋白测量值（在此示例中为 Observation/7473784b-46a8-470c-b9a6-fe38a01025aa）。

curl -X GET \
  -H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \
  -H "X-Consent-Scope: actor/Practitioner/12942879-f89f-41ae-aa80-0b911b649833 env/App/unknown" \
  "https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/fhirStores/FHIR_STORE_ID/fhir/Observation/7473784b-46a8-470c-b9a6-fe38a01025aa"

由于患者的同意不允许请求者（“App/unknown”）的边界访问，因此请求被拒绝。

{
  "issue": [
    {
      "code": "security",
      "details": {
        "text": "permission_denied"
      },
      "diagnostics": "Consent access denied or the resource being accessed does not exist",
      "severity": "error"
    }
  ],
  "resourceType": "OperationOutcome"
}

从业者 Jeffrey Brown（由 Practitioner/12942879-f89f-41ae-aa80-0b911b649833 标识）使用应用 App/golden 进行生物医学研究，读取 Darcy 的出生日期（在此示例中为 Patient/3c6aa096-c054-4c22-b2b4-1e4a4d203de2）。

curl -X GET \
  -H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \
  -H "X-Consent-Scope: actor/Practitioner/12942879-f89f-41ae-aa80-0b911b649833 purp/v3/BIORCH env/App/golden" \
  "https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/fhirStores/FHIR_STORE_ID/fhir/Patient/3c6aa096-c054-4c22-b2b4-1e4a4d203de2"

由于请求者获得了同意，因此响应是患者资源的内容。

{
  "active": true,
  "birthDate": "1990-01-01",
  "gender": "female",
  "id": "3c6aa096-c054-4c22-b2b4-1e4a4d203de2",
  "meta": {
    "lastUpdated": "2022-09-01T17:31:40.423469+00:00",
    "versionId": "VERSION_ID",
    "tag": [{
      "system": "http://terminology.hl7.org/CodeSystem/common-tags",
      "code": "employee"
    }]
  },
  "name": [
    {
      "family": "Smith",
      "given": [
        "Darcy"
      ],
      "use": "official"
    }
  ],
  "resourceType": "Patient"
}

从业者 Jeffrey Brown（由 Practitioner/12942879-f89f-41ae-aa80-0b911b649833 标识）使用“紧急情况下的未经授权访问”协议，请求紧急未经授权访问患者记录。（在本示例中为 Observation/7473784b-46a8-470c-b9a6-fe38a01025aa）。

curl -X GET \
  -H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \
  -H "X-Consent-Scope: btg actor/Practitioner/12942879-f89f-41ae-aa80-0b911b649833" \
  "https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/fhirStores/FHIR_STORE_ID/fhir/Observation/7473784b-46a8-470c-b9a6-fe38a01025aa"

由于同意的授权方法为 btg，因此服务器会跳过同意检查。响应是 Observation 资源的内容。

{
  "code": {
    "coding": [
      {
        "code": "718-7",
        "display": "Hemoglobin [Mass/volume] in Blood",
        "system": "http://loinc.org"
      }
    ]
  },
  "effectivePeriod": {
    "start": "2021-12-10T05:30:10+01:00"
  },
  "id": "7473784b-46a8-470c-b9a6-fe38a01025aa",
  "issued": "2021-12-10T13:30:10+01:00",
  "meta": {
    "lastUpdated": "2022-09-01T17:31:40.423469+00:00",
    "source": "http://example.com/HappyHospital",
    "versionId": "VERSION_ID"
  },
  "resourceType": "Observation",
  "status": "final",
  "subject": {
    "reference": "Patient/3c6aa096-c054-4c22-b2b4-1e4a4d203de2"
  },
  "valueQuantity": {
    "code": "g/dL",
    "system": "http://unitsofmeasure.org",
    "unit": "g/dl",
    "value": 7.2
  }
}

配置意见征求标头

以下部分介绍了 Cloud Healthcare API 中支持的同意强制执行方法，以及如何在发出同意感知请求时强制执行资源访问。

发出请求时，您的授权服务器负责生成具有相关同意范围的访问令牌。

设置 HTTP 标头

同意范围使用 X-Consent-Scope HTTP 标头传递给 Cloud Healthcare API。Cloud Healthcare API 使用此标头对 FHIR 存储区中的数据实施基于同意的访问权限控制。

FHIR 请求可支持有限数量的同意条目范围。给定的 FHIR 请求中最多可以包含三个 actor 条目、一个 purp 条目和一个 env 条目。

对于特殊范围，FHIR 请求可支持 btg 或 bypass。

为可信应用设置 HTTP 标头

只有在使用客户控制的授权服务器时，才需要按照本部分执行操作。在这种情况下，您还必须使用 SMARTproxy 或类似的代理。

某些可信应用可以使用指定的 HTTP 标头中的同意范围直接调用 Cloud Healthcare API。这样一来，无需使用 SMARTproxy 或其他代理在外部授权服务器和 Google Cloud之间进行转换，即可直接强制执行意见征求。

例如，您的应用可能注册了部分范围，例如一个应用 environment 范围，或者应用可能会显示选择微件来设置一些范围条目，例如访问者的 purpose。

受信任的用户或受信任的应用也可以使用btg 或 bypass 范围条目，这些条目需要接受事后审核。

为同意范围配置授权服务器

Cloud Healthcare API 根据输入同意范围提供对 FHIR 同意强制执行的内置支持。FHIR 存储区管理员负责在 Cloud Healthcare API 之外创建和配置授予同意范围的授权服务器。

访问令牌示例

以下示例展示了用 base64 编码的访问令牌：

eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzM4NCJ9.eyJpc3MiOiJjb25zZW50LnRva2VuLm9yZyIsImlhdCI6MTYxMjg4NDA4NSwiZXhwIjoxNjQ0NDIwMDg1LCJhdWQiOiJ3d3cuZXhhbXBsZS5jb20iLCJzdWIiOiJkb2N0b3IuZ2FicmllbGFAZXhhbXBsZS5jb20iLCJzY29wZSI6Im9pZGMgYWN0b3IvUHJhY3RpdGlvbmVyLzEyMyBhY3Rvci9Hcm91cC85OTkgcHVycC92My9UUkVBVCBlbnYvQXBwL2FiYyJ9.fC7ljkVUUx8fwUOrJuONcrqA-WKC-k_Bclzlgds0Cq6H_gEe3nUjPlSOCTQsIdYB

对访问令牌进行解码后，您可以看到它包含以下载荷：

{
  "iss": "consent.token.org",
  "iat": 1612884085,
  "exp": 1644420085,
  "aud": "www.example.com",
  "sub": "doctor.gabriela@example.com",
  "scope": "oidc actor/Practitioner/123 actor/Group/999 purp/v3/TREAT env/App/abc"
}

配置 SMARTProxy

SMARTProxy 是 Google 的开源代理，可提供以下功能：

允许 Cloud Healthcare API FHIR 服务器接受并验证同意感知访问令牌。
允许 Cloud Healthcare API 中的 FHIR 实现包含同意感知访问令牌，作为 Cloud Healthcare API 管理和权限模型的一部分。
在 FHIR 支持上也支持 SMART 的令牌功能。

注意：这需要单独的审核流程。

当您发出通过 SMARTProxy 从 Cloud Healthcare API 检索数据的请求时，会发生以下情况：

SMARTProxy 接受包含同意感知令牌的客户端的请求。
SMARTProxy 通过您拥有的 JWT 授权服务器验证同意感知令牌。
SMARTProxy 从同意感知令牌中读取范围，并通过 HTTP 标头将它们传递给 Cloud Healthcare API。
Cloud Healthcare API 会接收标头并对其进行验证，以对请求强制执行同意指令。随后，Cloud Healthcare API 通过 SMARTProxy 向客户端返回响应。

配置 Google Cloud 服务账号

一个代理只能有一个 Google Cloud 服务账号。如果多个客户端使用相同的代理，则这些客户端也将使用相同的服务账号。与多个客户端共享服务账号时，请务必小心，原因如下：

为了在 Cloud Healthcare API 中读取 FHIR 数据，服务账号可以配置为具有广泛的读写权限。如需详细了解权限，请参阅控制对 Cloud Healthcare API 资源的访问权限。请参阅设置代理的一般性最佳实践。
Cloud Audit Logs

主电子邮件地址与服务账号关联。

例如，如果您使用您的 Google 账号直接调用 Cloud Healthcare API 以进行身份验证，则 Cloud Audit Logs 会将您的电子邮件地址记录为主电子邮件地址。当您使用代理调用 Cloud Healthcare API 时，代理使用自己的服务账号，并且主电子邮件地址是此服务账号的电子邮件地址，而原始账号未定义。

审核日志

当有访问请求或资源访问权限强制执行发生变化时，系统会生成审核日志。

访问审核日志

如果 FHIR 存储区启用了审核日志，则 Cloud Logging 中提供的审核日志会包含 consentMode 元数据字段。consentMode 可具有以下值之一：

off：FHIR 存储区配置将 consentConfig.accessEnforced 设置为 false，并且不允许同意感知请求。
emptyScope：FHIR 存储区的 consentConfig.accessEnforced 设置为 true，但未包含同意范围标头。因此，同意未强制执行。
enforced：FHIR 存储区将 consentConfig.accessEnforced 设置为 true，并且存在同意范围标头。因此，系统会针对请求评估并强制执行同意。
btg：FHIR 请求在同意范围标头中提供了 btg。因此，跳过了意见征求检查。此请求仅用于紧急情况，并且仅接受事后审核。
bypass：FHIR 请求的同意范围标头中仅提供了 bypass。因此，系统跳过了意见征求检查。此请求旨在供可信工作流（例如管理员或可信应用，而不是最终用户）使用，因此此审核日志不同于用于数据治理检查的 btg。

您可以选择将 access_determination_log_config 设置为 VERBOSE，以记录有关请求被授予或拒绝的更多信息。

访问权限强制执行变更审核日志

当舱室基本资源发生更改时（例如，移除患者的 employee 标记）：由于管理员级联政策，更改后的资源及其舱室的访问权限控制可能会发生变化。它将触发对所有隔离区资源重新编制索引。您可以在 Cloud Logging 中使用过滤器 jsonPayload.@type="type.googleapis.com/google.cloud.healthcare.logging.FhirConsentCascadeLogEntry" 跟踪每个区间基本资源更新的重新编制索引进度。

级联重新编制索引进度日志示例

{
  "insertId": "tz2gtza8",
  "jsonPayload": {
    "@type": "type.googleapis.com/google.cloud.healthcare.logging.FhirConsentCascadeLogEntry",
    "state": "STATE_FINISHED",
    "affectedResources": "2",
    "lastUpdated": "YYYY-MM-DDTHH:MM:SS+ZZ:ZZ",
    "compartmentBaseResourceName": "projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/fhirStores/FHIR_STORE_ID/fhir/Patient/PATIENT_RESOURCE_ID/_history/PATIENT_RESOURCE_VERSION"
  },
  "resource": {
    "type": "healthcare_fhir_store",
    "labels": {
      "location": "LOCATION",
      "dataset_id": "DATASET_ID",
      "fhir_store_id": "FHIR_STORE_ID",
      "project_id": "PROJECT_ID"
    }
  },
  "timestamp": "YYYY-MM-DDTHH:MM:SS+ZZ:ZZ",
  "severity": "INFO",
  "logName": "projects/PROJECT_ID/logs/healthcare.googleapis.com%2Fconsent_cascading_fhir",
  "receiveTimestamp": "YYYY-MM-DDTHH:MM:SS+ZZ:ZZ"
}

jsonPayload.state 是重新编入索引操作的状态，jsonPayload.affectedResources 是重新编入索引的隔间资源数量，jsonPayload.lastUpdated 是患者资源更新的时间戳。如果操作刚刚开始，则不会显示 jsonPayload.state="STATE_STARTED" 和 jsonPayload.affectedResources。

约束和限制

本部分介绍 FHIR R4 的限制条件和限制，但相同的限制条件和限制适用于 FHIR STU3。

类型	约束和限制
单个同意资源	仅支持单个 `Consent.provision`，不支持多个预配或嵌套预配。至少 1 个 `Consent.provision.actor`，最多 25 个： `Consent.provision.actor.role` 必须为 `http://terminology.hl7.org/CodeSystem/v3-RoleCode`。 `Consent.provision.actor.code` 必须为 `GRANTEE` 或 `HPOWATT`。最多 1 个 `Consent.provision.purpose`： `Consent.provision.purpose.system` 必须为 `http://terminology.hl7.org/CodeSystem/v3-ActReason`。 `Consent.provision.purpose.code` 不为空，且最多包含 13 个字符。最多 1 个 `environment`： `Consent.provision.extension.url` 必须为 `https://g.co/fhir/medicalrecords/Environment`。系统和代码的总长度必须少于 15 个字符。如果按资源类型过滤，则 `Consent.provision.class.system` 必须为 `http://hl7.org/fhir/resource-types`。如果按数据源过滤，则 `Consent.provision.extension.url` 必须为 `https://g.co/fhir/medicalrecords/DataSource`。如果按数据标记过滤，则 `Consent.provision.extension.url` 必须为 `https://g.co/fhir/medicalrecords/DataTag`。数据标记可能是一个复杂的扩展（最多嵌套一层），用于描述将资源与所有指定标记（联合解释）相匹配的政策。最多支持 5 个嵌套标记。除非此行中另有说明，否则所有重复特性最多为 100 个值。
强制执行模型	每个患者一次最多可以强制执行 200 个 `active` 同意资源。每个商店一次最多可以强制执行 200 个 `active` 管理员政策。给定患者的所有有效同意的所有同意指令集的特殊紧凑格式不得超过设置的大小阈值；通常有足够的容量来编码数以千计的同意指令，除非非常长的资源字符串特别多。例如：唯一数据源和数据标记的数百个同意，每个同意都很长并且占用大量空间。单个患者具有 3000 个跨许多有效同意的唯一 `Consent.provision.data.reference` 资源标识符条目（每个条目都指定一个唯一的 `Consent.provision.actor`），该患者比未指定任何数据引用限制条件或以其他方式包含许多相同的参与者引用字符串的预配更积极地使用空间。每个资源最多可以有适用于其的所有同意中的 1000 条同意指令。
`X-Consent-Scope`	最少一个、最多三个 `actor` 条目。最多 1 个 `purp` 条目：每个 `purp` 条目都必须采用 `system/code` 格式（`v3` 是 `http://terminology.hl7.org/CodeSystem/v3-ActReason` 的注册系统）。代码的长度必须小于 13。最多 1 个 `env` 条目：每个 `env` 条目都必须采用 `system/code` 格式。系统和代码的总长度必须小于 15。 `btg` 至少需要一个 `actor` 条目。 `bypass` 至少需要一个 `actor` 条目和一个 `env` 条目。
支持的方法	Cloud Healthcare API 支持针对以下方法强制执行同意： `fhir.read` `fhir.vread` `fhir.history` `fhir.executeBundle`，包含 `GET` 个操作 `fhir.search` 和 `fhir.search-type` `fhir.Observation-lastn` `fhir.Patient-everything` `fhir.Encounter-everything` `fhir.Consent-enforement-status` `fhir.Patient-consent-enforement-status` 不支持针对单个资源或资源包使用 `POST`、`PUT`、`PATCH` 和 `DELETE` 等写入方法。所有 `projects.locations.datasets.fhirStores` 方法都不受支持。
性能	`ApplyConsents` 和 `ApplyAdminConsents` 的效果与 `ImportResources` 相当或更好。如果您需要更高的吞吐量，请与您的支持代表联系。关于同意感知请求：我们的意见征求模型已针对 CRUD 操作的强制执行性能进行了优化，包括大规模搜索许多资源和许多患者。读取各个资源可能会对请求延迟时间产生细微影响，但搜索性能会因基本查询和同意范围的数量而异，从而导致更多访问者条件在搜索期间生效。我们建议您针对各种具有代表性的 FHIR 请求参数运行自己的性能测试，以根据数据的特征（例如 FHIR 存储区中给定搜索资源类型的资源数量）确定您的使用情形的性能特征。我们的解决方案能够持续注入和更新所有资源（包括同意资源），而且是轻量级的解决方案，因此在注入期间的吞吐量和其他形式的写入流量可能会产生最小的影响。

最佳做法

以下部分介绍了使用 FHIR 访问权限控制时的最佳实践。

一般最佳实践

请勿并行执行导入 FHIR 资源以及调用 ApplyConsents 或 ApplyAdminConsents 的操作。我们建议您先导入 FHIR 资源，然后再调用 ApplyConsents 或 ApplyAdminConsents。但是，如果要导入的资源不包含任何患者或同意资源，则强制执行模型不会受到影响，并且不需要处理同意情况或管理员政策。
请勿并行执行创建自定义搜索以及调用 ApplyConsents 的操作。建议您依次执行这些步骤。
如果您的工作流需要在不相交的 PatientScope 上调用多个 ApplyConsents，则可以并行调用它们。
ApplyAdminConsents 可以与任意数量的 ApplyConsents 并行运行，但不能与另一个 ApplyAdminConsents 并行运行。
设置代理时，请限制具有只读权限的 IAM 服务账号，以避免将一位患者的数据写入另一位患者的记录中。
创建或更新记录时，请勿使用同意代理。
验证所有写入请求，以防止意外修改跨患者数据。
强制执行级联同意后，必须先导入隔间基本资源，然后再导入其余隔间资源。或者，也可以将所有区间资源封装在单个软件包中，并使用 fhir.executeBundle 进行提取。

删除患者资源

删除患者资源时，如果您还想移除该患者的同意强制执行（尤其是当 FhirStore.disableReferentialIntegrity 为 true 时），我们建议您遵循以下操作顺序：

删除属于患者资源的所有同意资源。
使用 PatientScope 过滤条件调用 ApplyConsents。

设置现有存储区以实现同意访问

如需设置现有存储区以实现同意访问，请完成以下步骤：

使用 UpdateFhirStore 将具有同意强制执行 version 的 ConsentConfig 设置为 V1，并将 accessEnforced 设置为 true。

curl -X PATCH \
    -H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \
    -H "Content-Type: application/json" \
    --data "{
      'consentConfig': {
        'version': 'V1',
        'accessEnforced': true
      }
    }" "https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/fhirStores/FHIR_STORE_ID?update_mask=consentConfig"

处理患者同意声明或管理员政策

ApplyConsents，用于患者同意书

curl -X POST \
    -H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \
    -H "Content-Type: application/json" \
    --data "{'validateOnly': false}" \
    "https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/fhirStores/FHIR_STORE_ID:applyConsents"

ApplyAdminConsents，用于管理员政策和管理员级联政策。

curl -X POST \
    -H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \
    -H "Content-Type: application/json" \
    --data "{
      'newConsentsList': {
          'names': [
          'projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/fhirStores/FHIR_STORE_ID/fhir/Consent/RESOURCE_ID_1/_history/VERSION_ID_1',
          ...
          'projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/fhirStores/FHIR_STORE_ID/fhir/Consent/RESOURCE_ID_N/_history/VERSION_ID_N'
          ]
      },
      'validateOnly': false
    }" \
    "https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/fhirStores/FHIR_STORE_ID:applyAdminConsents"

运行 ApplyConsents 或 ApplyAdminConsents 的频率

当 ConsentConfig 字段处于未设置状态时：FHIR 存储区首次创建时以及 ConsentConfig 字段被清除时，该字段均处于未设置状态。ConsentConfig取消设置 ConsentConfig 字段后，您必须重复设置存储区以获取同意访问权限，然后再发出同意感知请求，以避免评估已过期的同意强制执行政策。
强制执行模型发生变化时：创建、更新或删除同意资源时，强制执行模型会发生变化。在这种情况下，您必须调用 ApplyConsents 或 ApplyAdminConsents，这些更改才能生效。
- 如果您可以使用同意更改来跟踪患者，我们建议您使用 PatientScope 过滤条件以避免重新处理整个存储区。此过滤条件有助于立即刷新对一小部分患者的强制执行情况。
- 您还可以使用 TimeRange 过滤条件定期运行 ApplyConsents。如果不需要立即刷新，此过滤条件非常有用。例如，以下请求会刷新强制执行，以表示在世界协调时间 (UTC) 2022-09-20 零点与世界协调时间 (UTC) 2022-09-21 零点之间的同意变化。
```
curl -X POST \
  -H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \
  -H "Content-Type: application/json" \
  --data "{
     'validateOnly': false,
     'timeRange': {
       'start': '2022-09-20T00:00:00Z',
       'end': '2022-09-21T00:00:00Z',
     }
    }" \
  "https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/fhirStores/FHIR_STORE_ID:applyConsents"
```

使用 FHIR 同意视图

FHIR Consent Viewer 会显示访问权限控制政策。它提供了一个包含同意范围的表格，用于表示 FHIR 访问权限控制规则。

在使用 FHIR Consent Viewer 之前，请确保满足以下条件：

FHIR 存储区 disableResourceVersioning 设置必须为 false。FHIR 存储区创建后，此设置将无法更改。如需创建新的 FHIR 存储区，请参阅创建 FHIR 存储区。
FHIR 存储区已配置为强制执行同意。

如需查看 FHIR 许可查看器，请完成以下步骤：

执行此任务所需的权限

如需执行此任务，您必须已获得以下权限或以下 Identity and Access Management (IAM) 角色：

权限

healthcare.fhirStores.get
healthcare.fhirResources.get

角色

Healthcare FHIR Store Viewer (roles/healthcare.fhirStoreViewer)
Healthcare FHIR Resource Reader (roles/healthcare.fhirResourceReader)

您可以让管理员为您授予这些 Identity and Access Management 角色。如需了解如何授予角色，请参阅管理访问权限或控制对 Cloud Healthcare API 资源的访问权限。您也可以通过自定义角色或其他预定义角色来获取所需的权限。

注意：如果您为此指南创建了 Google Cloud 项目，那么作为项目创建者，您会自动获得 Owner (roles/owner) IAM 角色，该角色具有相应权限。您无需被授予任何额外的 IAM 角色。

后续步骤

了解强制执行的政策

控制对 Cloud Healthcare API 中的 FHIR 资源的访问权限 使用集合让一切井井有条 根据您的偏好保存内容并对其进行分类。

配置已启用 FHIR 访问权限控制的存储区

设置具有 ConsentConfig 的新 FHIR 存储区

使用同意资源定义政策

创建 FHIR 资源

患者同意指令示例

管理员政策指令示例

管理员级联政策指令示例

强制执行患者同意声明或管理员政策

通过 ApplyConsents 强制执行患者的同意情况

通过 ApplyAdminConsents 强制执行管理员政策

同意强制执行状态

使用同意上下文进行搜索

搜索具有同意范围的 FHIR 资源

获取具有同意上下文的资源

获取具有同意范围的 FHIR 资源

配置意见征求标头

设置 HTTP 标头

为可信应用设置 HTTP 标头

为同意范围配置授权服务器

访问令牌示例

配置 SMARTProxy

配置 Google Cloud 服务账号

审核日志

访问审核日志

访问权限强制执行变更审核日志

级联重新编制索引进度日志示例

约束和限制

最佳做法

一般最佳实践

删除患者资源

设置现有存储区以实现同意访问

运行 ApplyConsents 或 ApplyAdminConsents 的频率

使用 FHIR 同意视图

执行此任务所需的权限

控制台

后续步骤

控制对 Cloud Healthcare API 中的 FHIR 资源的访问权限

设置具有 `ConsentConfig` 的新 FHIR 存储区

通过 `ApplyConsents` 强制执行患者的同意情况

通过 `ApplyAdminConsents` 强制执行管理员政策