FHIR IG analytics

Resources that use this resource

No resources found

Resources that this resource uses

No resources found

Narrative

Note: links and images are rebased to the (stated) source

Source1

{
  "resourceType": "ExampleScenario",
  "id": "phQueryExampleScenario",
  "text": {
    "status": "extensions",
    "div": "<!-- snip (see above) -->"
  },
  "extension": [
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
      "valueCode": "pher"
    }
  ],
  "url": "http://hl7.org/fhir/us/ph-query/ExampleScenario/phQueryExampleScenario",
  "version": "0.1.0",
  "name": "QueryWithIntermediary",
  "status": "active",
  "date": "2025-12-19T13:42:07+00:00",
  "publisher": "HL7 International / Public Health",
  "contact": [
    {
      "name": "HL7 International / Public Health",
      "telecom": [
        {
          "system": "url",
          "value": "http://www.hl7.org/Special/committees/pher"
        },
        {
          "system": "email",
          "value": "pher@lists.HL7.org"
        }
      ]
    }
  ],
  "jurisdiction": [
    {
      "coding": [
        {
          "system": "urn:iso:std:iso:3166",
          "code": "US",
          "display": "United States of America (the)"
        }
      ]
    }
  ],
  "purpose": "This ExampleScenario describes the generic workflow to apply the FHIR RESTful API query & response paradigm to public health use cases. Potential use cases include case investigation, newborn screening and cancer reporting among others.",
  "actor": [
    {
      "actorId": "PublicHealthAgency",
      "type": "entity",
      "name": "Public Health Agency (PHA)",
      "description": "The Public Health Agency that holds the authority to access appropriate data to support program activities, goals, and services."
    },
    {
      "actorId": "Intermediary",
      "type": "entity",
      "name": "Network/Intermediary",
      "description": "An interoperability partner that facilitates the exchange data between the PHA and the HCO."
    },
    {
      "actorId": "HealthcareOrganization",
      "type": "entity",
      "name": "Healthcare Organization (HCO)",
      "description": "The Healthcare Organization is a critical element in collecting and exchanging clinical and administrative data that are essential for local PHA programs."
    }
  ],
  "instance": [
    {
      "resourceId": "patientQuery1",
      "resourceType": "Binary",
      "name": "Query for Patient Record to an Intermediary",
      "description": "The PHA shares patient demographics with the Intermediary as a Patient search or $match operation to identify the individual of interest."
    },
    {
      "resourceId": "patientQueryResponse1",
      "resourceType": "Bundle",
      "name": "Response to Query for Patient Record from an Intermediary",
      "description": "The Intermediary returns one or more Patient resources provided by the queried HCO."
    },
    {
      "resourceId": "patientQuery2",
      "resourceType": "Binary",
      "name": "Query for Patient Record from an Intermediary",
      "description": "The Intermediary shares the patient demographics provided by the PHA with an HCO's FHIR Server to identify the appropriate individual of interest."
    },
    {
      "resourceId": "patientQueryResponse2",
      "resourceType": "Bundle",
      "name": "Response to Query for Patient Record to an Intermediary",
      "description": "The HCO returns one or more corresponding Patient resources."
    },
    {
      "resourceId": "clinicalQuery1",
      "resourceType": "Binary",
      "name": "Query for Clinical Data to an Intermediary",
      "description": "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."
    },
    {
      "resourceId": "clinicalQueryResponse1",
      "resourceType": "Bundle",
      "name": "Response to Query for Clinical Data from an Intermediary",
      "description": "The Intermediary returns appropriate data received from the HCO."
    },
    {
      "resourceId": "clinicalQuery2",
      "resourceType": "Binary",
      "name": "Query for Clinical Data from an Intermediary",
      "description": "The Intermediary requests additional data, on behalf of the PHA, related to the identified Patient resource."
    },
    {
      "resourceId": "clinicalQueryResponse2",
      "resourceType": "Bundle",
      "name": "Response to Query for Clinical Data to an Intermediary",
      "description": "The HCO returns appropriate FHIR-formatted data in response to the PHA query for additional data."
    }
  ],
  "process": [
    {
      "title": "Patient Identification Query",
      "description": "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.",
      "preConditions": "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.",
      "postConditions": "The PHA will have validated any returned resouces and made the data available for additional queries if appropriate.",
      "step": [
        {
          "operation": {
            "number": "1",
            "type": "RESTful Query",
            "name": "Patient Identification Query to an Intermediary",
            "initiator": "PublicHealthAgency",
            "receiver": "Intermediary",
            "description": "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.",
            "request": {
              "resourceId": "patientQuery1"
            }
          }
        },
        {
          "operation": {
            "number": "2",
            "type": "RESTful Query",
            "name": "Patient Identification Query from an Intermediary",
            "initiator": "Intermediary",
            "receiver": "HealthcareOrganization",
            "description": "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.",
            "request": {
              "resourceId": "patientQuery2"
            },
            "response": {
              "resourceId": "patientQueryResponse2"
            }
          }
        },
        {
          "operation": {
            "number": "3",
            "type": "RESTful Query",
            "name": "Patient Identification Response to a PHA",
            "initiator": "Intermediary",
            "receiver": "PublicHealthAgency",
            "description": "The Intermediary returns the FHIR Patient resource(s) provided by the HCO back to the PHA.",
            "request": {
              "resourceId": "patientQueryResponse1"
            }
          }
        }
      ]
    },
    {
      "title": "Additional Data Query",
      "description": "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.",
      "preConditions": "The PHA must have identified a single Patient record corresponding to the individual of interest via the Patient Identiification Query process.",
      "postConditions": "The PHA will have validated any returned resources and made the data available to end users to support program activities.",
      "step": [
        {
          "operation": {
            "number": "4",
            "type": "RESTful Query",
            "name": "Clinical Data Query via an Intermediary",
            "initiator": "PublicHealthAgency",
            "receiver": "Intermediary",
            "description": "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.",
            "request": {
              "resourceId": "clinicalQuery1"
            }
          }
        },
        {
          "operation": {
            "number": "5",
            "type": "RESTful Query",
            "name": "Clinical Data Query from an Intermediary",
            "initiator": "Intermediary",
            "receiver": "HealthcareOrganization",
            "description": "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.",
            "request": {
              "resourceId": "clinicalQuery2"
            },
            "response": {
              "resourceId": "clinicalQueryResponse2"
            }
          }
        },
        {
          "operation": {
            "number": "6",
            "type": "RESTful Query",
            "name": "Clinical Data Response to a PHA",
            "initiator": "Intermediary",
            "receiver": "PublicHealthAgency",
            "description": "The Intermediary returns the FHIR resource(s) provided by the HCO back to the PHA.",
            "request": {
              "resourceId": "clinicalQueryResponse1"
            }
          }
        }
      ]
    }
  ]
}