Public Health Query & Response Example With an Intermediary - Query & Response for Public Health v1.0.0

Query & Response for Public Health
1.0.0 - ci-build United States of America (the) flag

Table of Contents
Artifacts Summary

Public Health Query & Response Example With an Intermediary/b>

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

Narrative Content

XML

JSON

TTL

ExampleScenario: Public Health Query & Response Example With an Intermediary

Official URL: http://hl7.org/fhir/us/ph-query/ExampleScenario/phQueryExampleScenario Version: 1.0.0 Highlight text changes?

Standards status: Informative Active as of 2026-03-18 Computable Name: QueryWithIntermediary

Actors

Name Type Description

Public Health Agency (PHA) System
The Public Health Agency that holds the authority to access appropriate data to support program activities, goals, and services.

Network/Intermediary System
An interoperability partner that facilitates the exchange data between the PHA and the HCO.

Healthcare Organization (HCO) System
The Healthcare Organization is a critical element in collecting and exchanging clinical and administrative data that are essential for local PHA programs.

Diagram

Processes

Process: Patient Identification Query
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 to an Intermediary - 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 query is via the Intermediary which handles the direct connection to the HCO's FHIR Server.

Public Health Agency (PHA) Network/Intermediary Query for Patient Record to an Intermediary

2 Patient Identification Query from an Intermediary - RESTful Query (Details: FHIR Restful Interactions code RESTful Query)
The Intermediary forwards the patient demographics received from the PHA to the HCO's FHIR Server. The HCO responses with one or more matching FHIR Patient resources.

Network/Intermediary Healthcare Organization (HCO) Query for Patient Record from an Intermediary Response to Query for Patient Record to an Intermediary

3 Patient Identification Response to a PHA - RESTful Query (Details: FHIR Restful Interactions code RESTful Query)
The Intermediary returns the FHIR Patient resource(s) provided by the HCO back to the PHA.

Network/Intermediary Public Health Agency (PHA) Response to Query for Patient Record from an Intermediary

Process: Additional Data Query
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

4 Clinical Data Query via an Intermediary - 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 and transmits them to an Intermediary.

Public Health Agency (PHA) Network/Intermediary Query for Clinical Data to an Intermediary

5 Clinical Data Query from an Intermediary - RESTful Query (Details: FHIR Restful Interactions code RESTful Query)
The Intermediary forwards the queries received from the PHA to the HCO's FHIR Server. The HCO responses with the appropriate set of FHIR resources.

Network/Intermediary Healthcare Organization (HCO) Query for Clinical Data from an Intermediary Response to Query for Clinical Data to an Intermediary

6 Clinical Data Response to a PHA - RESTful Query (Details: FHIR Restful Interactions code RESTful Query)
The Intermediary returns the FHIR resource(s) provided by the HCO back to the PHA.

Network/Intermediary Public Health Agency (PHA) Response to Query for Clinical Data from an Intermediary

Instances

Name Type Content Description

Query for Patient Record to an Intermediary Binary
The PHA shares patient demographics with the Intermediary as a Patient search or $match operation to identify the individual of interest.

Response to Query for Patient Record from an Intermediary Bundle
The Intermediary returns one or more Patient resources provided by the queried HCO.

Query for Patient Record from an Intermediary Binary
The Intermediary shares the patient demographics provided by the PHA with an HCO's FHIR Server to identify the appropriate individual of interest.

Response to Query for Patient Record to an Intermediary Bundle
The HCO returns one or more corresponding Patient resources.

Query for Clinical Data to an Intermediary 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 from an Intermediary Bundle
The Intermediary returns appropriate data received from the HCO.

Query for Clinical Data from an Intermediary Binary
The Intermediary requests additional data, on behalf of the PHA, related to the identified Patient resource.

Response to Query for Clinical Data to an Intermediary Bundle
The HCO returns appropriate FHIR-formatted data in response to the PHA query for additional data.

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

Official URL: http://hl7.org/fhir/us/ph-query/ExampleScenario/phQueryExampleScenario				Version: 1.0.0	Highlight text changes?
Standards status: Informative Active as of 2026-03-18					Computable Name: QueryWithIntermediary

Name	Type	Description
Public Health Agency (PHA)	System	The Public Health Agency that holds the authority to access appropriate data to support program activities, goals, and services.
Network/Intermediary	System	An interoperability partner that facilitates the exchange data between the PHA and the HCO.
Healthcare Organization (HCO)	System	The Healthcare Organization is a critical element in collecting and exchanging clinical and administrative data that are essential for local PHA programs.

Step	Name	Description	Initiator	Receiver	Request	Response
1	Patient Identification Query to an Intermediary - 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 query is via the Intermediary which handles the direct connection to the HCO's FHIR Server.	Public Health Agency (PHA)	Network/Intermediary	Query for Patient Record to an Intermediary
2	Patient Identification Query from an Intermediary - RESTful Query (Details: FHIR Restful Interactions code RESTful Query)	The Intermediary forwards the patient demographics received from the PHA to the HCO's FHIR Server. The HCO responses with one or more matching FHIR Patient resources.	Network/Intermediary	Healthcare Organization (HCO)	Query for Patient Record from an Intermediary	Response to Query for Patient Record to an Intermediary
3	Patient Identification Response to a PHA - RESTful Query (Details: FHIR Restful Interactions code RESTful Query)	The Intermediary returns the FHIR Patient resource(s) provided by the HCO back to the PHA.	Network/Intermediary	Public Health Agency (PHA)	Response to Query for Patient Record from an Intermediary

Step	Name	Description	Initiator	Receiver	Request	Response
4	Clinical Data Query via an Intermediary - 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 and transmits them to an Intermediary.	Public Health Agency (PHA)	Network/Intermediary	Query for Clinical Data to an Intermediary
5	Clinical Data Query from an Intermediary - RESTful Query (Details: FHIR Restful Interactions code RESTful Query)	The Intermediary forwards the queries received from the PHA to the HCO's FHIR Server. The HCO responses with the appropriate set of FHIR resources.	Network/Intermediary	Healthcare Organization (HCO)	Query for Clinical Data from an Intermediary	Response to Query for Clinical Data to an Intermediary
6	Clinical Data Response to a PHA - RESTful Query (Details: FHIR Restful Interactions code RESTful Query)	The Intermediary returns the FHIR resource(s) provided by the HCO back to the PHA.	Network/Intermediary	Public Health Agency (PHA)	Response to Query for Clinical Data from an Intermediary

Name	Type	Description
Query for Patient Record to an Intermediary	Binary	The PHA shares patient demographics with the Intermediary as a Patient search or $match operation to identify the individual of interest.
Response to Query for Patient Record from an Intermediary	Bundle	The Intermediary returns one or more Patient resources provided by the queried HCO.
Query for Patient Record from an Intermediary	Binary	The Intermediary shares the patient demographics provided by the PHA with an HCO's FHIR Server to identify the appropriate individual of interest.
Response to Query for Patient Record to an Intermediary	Bundle	The HCO returns one or more corresponding Patient resources.
Query for Clinical Data to an Intermediary	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 from an Intermediary	Bundle	The Intermediary returns appropriate data received from the HCO.
Query for Clinical Data from an Intermediary	Binary	The Intermediary requests additional data, on behalf of the PHA, related to the identified Patient resource.
Response to Query for Clinical Data to an Intermediary	Bundle	The HCO returns appropriate FHIR-formatted data in response to the PHA query for additional data.