Query & Response for Public Health
1.0.0 - ci-build
Query & Response for Public Health
1.0.0 - ci-build
Query & Response for Public Health, published by HL7 International / Public Health. This guide is not an authorized publication; it is the continuous build for version 1.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/us-helios-QR/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.org/fhir/us/ph-query/ExampleScenario/phQueryExampleScenarioDirect | Version: 1.0.0 | ||||
| Standards status: Informative Active as of 2026-03-18 | Computable Name: QueryWithoutIntermediary | ||||
The process of generating a FHIR RESTful API query to identify the individual of interest in an external system which may contain additional authorized data required by the PHA to support program activities.
Pre-conditions:
The PHA must be aware of the existance of the individual and have sufficient demographics to positively identify the individual on the HCO's FHIR server.
Post-conditions:
The PHA will have validated any returned resouces and made the data available for additional queries if appropriate.
| Step | Name | Description | Initiator | Receiver | Request | Response |
|---|---|---|---|---|---|---|
| 1 | Patient Identification Query - RESTful Query (Details: FHIR Restful Interactions code RESTful Query) | The PHA generates a FHIR RESTful API query containing patient demographics to identify the appropriate Patient resource on the HCO's FHIR Server. The HCO responses with one or more matching FHIR Patient resources. |
Public Health Agency (PHA) | Healthcare Organization (HCO) | Query for Patient Record | Response to Query for Patient Record |
The process of generating one or more FHIR RESTful API queries to retrieve additional data necessary to carry out public health activities and/or provide services.
Pre-conditions:
The PHA must have identified a single Patient record corresponding to the individual of interest via the Patient Identiification Query process.
Post-conditions:
The PHA will have validated any returned resources and made the data available to end users to support program activities.
| Step | Name | Description | Initiator | Receiver | Request | Response |
|---|---|---|---|---|---|---|
| 2 | Clinical Data Query - RESTful Query (Details: FHIR Restful Interactions code RESTful Query) | Using the identified Patient resource, the PHA formulates one or more use case specific FHIR RESTful API queries to collect additional relevant data. The HCO responses with the appropriate set of FHIR resources. |
Public Health Agency (PHA) | Healthcare Organization (HCO) | Query for Clinical Data | Response to Query for Clinical Data |
| Name | Type | Content | Description |
|---|---|---|---|
| Query for Patient Record | Binary | The PHA shares patient demographics as a Patient search or $match operation to identify the individual of interest. | |
| Response to Query for Patient Record | Bundle | Based on the patient demographics provided, the HCO returns one or more corresponding Patient resources. | |
| Query for Clinical Data | Binary | The PHA requests additional data related to the identified Patient resource. The exact nature of the query and data requested will vary based on the use case being fulfilled. PHAs only request data that they have clear authority to access. | |
| Response to Query for Clinical Data | Bundle | The HCO returns appropriate FHIR-formatted data in response to the PHA query. |
IG © 2025+ HL7 International / Public Health.
Package hl7.fhir.us.ph-query#1.0.0 based on FHIR 4.0.1.
Generated
2026-03-18
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change