FHIR 的$questionnaire-package手术 HealthLake

该$questionnaire-package操作会检索一个包含FHIR调查问卷及其呈现和处理问卷所需的所有依赖项的综合包。该操作实现了《达芬奇文档模板和规则 (DTR) 实施指南》，从而实现了医疗工作流程中文档要求的动态表单呈现。

工作原理

应用场景

API 端点

POST /datastore/{datastoreId}/r4/Questionnaire/$questionnaire-package  
Content-Type: application/fhir+json

请求参数

输入参数

请求正文必须包含带有以下参数的 FHIR 参数资源：

参数验证规则

必须提供以下至少一项（除必填项外coverage）：

有效的请求组合：

示例请求

POST /datastore/example-datastore/r4/Questionnaire/$questionnaire-package  
Content-Type: application/fhir+json  
Authorization: Bearer <your-token>  
  
{  
  "resourceType": "Parameters",  
  "parameter": [  
    {  
      "name": "coverage",  
      "resource": {  
        "resourceType": "Coverage",  
        "id": "example-coverage",  
        "status": "active",  
        "beneficiary": {  
          "reference": "Patient/example-patient"  
        },  
        "payor": [{  
          "reference": "Organization/example-payer"  
        }],  
        "class": [{  
          "type": {  
            "coding": [{  
              "system": "http://terminology.hl7.org/CodeSystem/coverage-class",  
              "code": "group"  
            }]  
          },  
          "value": "12345"  
        }]  
      }  
    },  
    {  
      "name": "questionnaire",  
      "valueCanonical": "http://example.org/fhir/Questionnaire/home-oxygen-therapy|2.0"  
    },  
    {  
      "name": "order",  
      "resource": {  
        "resourceType": "ServiceRequest",  
        "id": "example-service-request",  
        "status": "active",  
        "intent": "order",  
        "code": {  
          "coding": [{  
            "system": "http://www.ama-assn.org/go/cpt",  
            "code": "94660",  
            "display": "Continuous positive airway pressure ventilation (CPAP)"  
          }]  
        },  
        "subject": {  
          "reference": "Patient/example-patient"  
        }  
      }  
    },  
    {  
      "name": "changedSince",  
      "valueDateTime": "2024-01-01T00:00:00Z"  
    }  
  ]  
}

响应格式

成功响应 (200 OK)

该操作返回包含一个或多个 Pack age Bund le 的 FHIR 参数资源。每个 Package 套装包括：

{  
  "resourceType": "Parameters",  
  "parameter": [  
    {  
      "name": "PackageBundle",  
      "resource": {  
        "resourceType": "Bundle",  
        "id": "questionnaire-package-example",  
        "meta": {  
          "profile": ["http://hl7.org/fhir/us/davinci-dtr/StructureDefinition/DTR-QPackageBundle"]  
        },  
        "type": "collection",  
        "timestamp": "2024-03-15T10:30:00Z",  
        "entry": [  
          {  
            "fullUrl": "http://example.org/fhir/Questionnaire/home-oxygen-therapy",  
            "resource": {  
              "resourceType": "Questionnaire",  
              "id": "home-oxygen-therapy",  
              "url": "http://example.org/fhir/Questionnaire/home-oxygen-therapy",  
              "version": "2.0",  
              "status": "active",  
              "title": "Home Oxygen Therapy Documentation",  
              "item": [  
                {  
                  "linkId": "1",  
                  "text": "Patient diagnosis",  
                  "type": "choice",  
                  "answerValueSet": "http://example.org/fhir/ValueSet/oxygen-diagnoses"  
                }  
              ]  
            }  
          },  
          {  
            "fullUrl": "http://example.org/fhir/Library/oxygen-prepopulation",  
            "resource": {  
              "resourceType": "Library",  
              "id": "oxygen-prepopulation",  
              "url": "http://example.org/fhir/Library/oxygen-prepopulation",  
              "version": "1.0",  
              "type": {  
                "coding": [{  
                  "system": "http://terminology.hl7.org/CodeSystem/library-type",  
                  "code": "logic-library"  
                }]  
              },  
              "content": [{  
                "contentType": "text/cql",  
                "data": "bGlicmFyeSBPeHlnZW5QcmVwb3B1bGF0aW9u..."  
              }]  
            }  
          },  
          {  
            "fullUrl": "http://example.org/fhir/ValueSet/oxygen-diagnoses",  
            "resource": {  
              "resourceType": "ValueSet",  
              "id": "oxygen-diagnoses",  
              "url": "http://example.org/fhir/ValueSet/oxygen-diagnoses",  
              "status": "active",  
              "expansion": {  
                "timestamp": "2024-03-15T10:30:00Z",  
                "contains": [  
                  {  
                    "system": "http://hl7.org/fhir/sid/icd-10",  
                    "code": "J44.0",  
                    "display": "COPD with acute lower respiratory infection"  
                  },  
                  {  
                    "system": "http://hl7.org/fhir/sid/icd-10",  
                    "code": "J96.01",  
                    "display": "Acute respiratory failure with hypoxia"  
                  }  
                ]  
              }  
            }  
          },  
          {  
            "fullUrl": "http://example.org/fhir/QuestionnaireResponse/example-prepopulated",  
            "resource": {  
              "resourceType": "QuestionnaireResponse",  
              "id": "example-prepopulated",  
              "questionnaire": "http://example.org/fhir/Questionnaire/home-oxygen-therapy|2.0",  
              "status": "in-progress",  
              "subject": {  
                "reference": "Patient/example-patient"  
              },  
              "basedOn": [{  
                "reference": "ServiceRequest/example-service-request"  
              }],  
              "item": [  
                {  
                  "linkId": "1",  
                  "text": "Patient diagnosis",  
                  "answer": [{  
                    "valueCoding": {  
                      "system": "http://hl7.org/fhir/sid/icd-10",  
                      "code": "J44.0",  
                      "display": "COPD with acute lower respiratory infection"  
                    }  
                  }]  
                }  
              ]  
            }  
          }  
        ]  
      }  
    },  
    {  
      "name": "Outcome",  
      "resource": {  
        "resourceType": "OperationOutcome",  
        "issue": [{  
          "severity": "information",  
          "code": "informational",  
          "details": {  
            "text": "Successfully retrieved questionnaire package"  
          }  
        }]  
      }  
    }  
  ]  
}

操作工作流程

如何 HealthLake 处理您的请求

拨打电话时$questionnaire-package， HealthLake 执行以下步骤：

结果：一个完整、独立的软件包可以渲染了。

错误响应

400 错误请求

请求验证失败时返回。

{  
  "resourceType": "OperationOutcome",  
  "issue": [{  
    "severity": "error",  
    "code": "required",  
    "details": {  
      "text": "At least one of 'questionnaire' or 'order' must be provided along with 'coverage'"  
    }  
  }]  
}

424 失败的依赖关系

当无法检索依赖资源时返回。

{  
  "resourceType": "OperationOutcome",  
  "issue": [{  
    "severity": "warning",  
    "code": "not-found",  
    "details": {  
      "text": "Referenced Library 'http://example.org/fhir/Library/missing-library' could not be retrieved"  
    }  
  }]  
}

401 未经授权

当身份验证凭证缺失或无效时返回。

403 禁止访问

当经过身份验证的用户无权访问所请求的资源时返回。

406 不可接受

当无法提供请求的内容类型时返回。

409 冲突

存在版本或并发冲突时返回。

410 Gone

当请求的资源已被永久删除时返回。

429 请求过多

超过速率限制时返回。

500 内部服务器错误

服务器发生意外错误时返回。

501 未实施

当请求的操作尚未实现时返回。

验证规则

输入验证

QuestionnaireResponse 验证

资源重复数据删除

性能规格

所需的权限

要使用该$questionnaire-package操作，请确保您的 IAM 角色具有：

FHIR 瞄准镜上的智能

所需的最低范围：

重要的实施说明

资源检索策略

问卷识别优先级：

依赖关系解决方案

CQL 库：

ValueSets:

QuestionnaireResponse 种群前

在以下情况下，该操作可能会返回 QuestionnaireResponse 带有预填充数据的a：

搜索标准 QuestionnaireResponse：

已更改的资源筛选

提供changedSince参数时：

多个套餐捆绑包

在以下情况下，该操作可能会返回多个 Package Bundle：

每个 Package Bundle 都是独立的，具有所有必要的依赖关系。

常见使用案例

用例 1：事先授权文档

场景：提供者需要收集家庭氧气疗法的文件，事先获得授权。

{  
  "resourceType": "Parameters",  
  "parameter": [  
    {  
      "name": "coverage",  
      "resource": { /* Patient's insurance coverage */ }  
    },  
    {  
      "name": "order",  
      "resource": {  
        "resourceType": "ServiceRequest",  
        "code": {  
          "coding": [{  
            "system": "http://www.ama-assn.org/go/cpt",  
            "code": "94660"  
          }]  
        }  
      }  
    }  
  ]  
}

结果：返回包含氧气治疗问卷的包裹，其中预先填充了电子病历中的患者生命体征和诊断代码。

用例 2：检索特定的调查问卷版本

场景：提供者需要特定版本的问卷以保证合规性。

{  
  "resourceType": "Parameters",  
  "parameter": [  
    {  
      "name": "coverage",  
      "resource": { /* Coverage resource */ }  
    },  
    {  
      "name": "questionnaire",  
      "valueCanonical": "http://example.org/fhir/Questionnaire/dme-request|3.1.0"  
    }  
  ]  
}

结果：精确返回包含所有依赖项的 DME 请求调查问卷的 3.1.0 版本。

用例 3：检查更新

场景：提供者想要检查自上次检索以来是否有任何问卷资源已更新。

{  
  "resourceType": "Parameters",  
  "parameter": [  
    {  
      "name": "coverage",  
      "resource": { /* Coverage resource */ }  
    },  
    {  
      "name": "questionnaire",  
      "valueCanonical": "http://example.org/fhir/Questionnaire/medication-request"  
    },  
    {  
      "name": "changedSince",  
      "valueDateTime": "2024-03-01T00:00:00Z"  
    }  
  ]  
}

结果：仅返回 2024 年 3 月 1 日之后修改过的资源，如果没有任何更改，则返回空包。

用例 4：多个订单

场景：提供商提交多个服务请求，可能需要不同的调查表。

{  
  "resourceType": "Parameters",  
  "parameter": [  
    {  
      "name": "coverage",  
      "resource": { /* Coverage resource */ }  
    },  
    {  
      "name": "order",  
      "resource": { /* ServiceRequest for imaging */ }  
    },  
    {  
      "name": "order",  
      "resource": { /* ServiceRequest for DME */ }  
    }  
  ]  
}

结果：返回多个 Package Bundle，每个适用的问卷对应一个。

与其他达芬奇集成 IGs

保险需求发现 (CRD)

工作流程集成：

事先授权支持 (PAS)

工作流程集成：

临床数据交换 (CDex)

工作流程集成：

故障排除指南

问题：未返回问卷

可能的原因：

解决方案：

问题：Package 中缺少依赖关系

可能的原因：

解决方案：

问题：带有 changedSince 的空包

可能的原因：

解决方案：

问题： QuestionnaireResponse 未预先填充

可能的原因：

解决方案：

最佳实践

1. 将 Canonical 与版本一起 URLs 使用

在申请特定问卷时，请务必指定版本号：

{  
  "name": "questionnaire",  
  "valueCanonical": "http://example.org/fhir/Questionnaire/dme|2.1.0"  
}

原因：确保问卷更新时的一致性并防止意外更改。

2. 为了提高性能，杠杆率已改变

对于经常访问的调查表，请使用changedSince以最大限度地减少数据传输：

{  
  "name": "changedSince",  
  "valueDateTime": "2024-03-10T15:30:00Z"  
}

原因：通过仅检索更新的资源来减少延迟和带宽使用量。

3. 包括完整的承保范围信息

提供全面的覆盖范围详情，以确保正确选择问卷：

{  
  "name": "coverage",  
  "resource": {  
    "resourceType": "Coverage",  
    "beneficiary": { "reference": "Patient/123" },  
    "payor": [{ "reference": "Organization/payer-abc" }],  
    "class": [{ /* Group/plan information */ }]  
  }  
}

原因：帮助 HealthLake 确定付款人特定的调查问卷和要求。

相关 操作