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": "phQueryExampleScenarioDirect",
  "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/phQueryExampleScenarioDirect",
  "version": "0.1.0",
  "name": "QueryWithoutIntermediary",
  "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": "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": "patientQuery",
      "resourceType": "Binary",
      "name": "Query for Patient Record",
      "description": "The PHA shares patient demographics as a Patient search or $match operation to identify the individual of interest."
    },
    {
      "resourceId": "patientQueryResponse",
      "resourceType": "Bundle",
      "name": "Response to Query for Patient Record",
      "description": "Based on the patient demographics provided, the HCO returns one or more corresponding Patient resources."
    },
    {
      "resourceId": "clinicalQuery",
      "resourceType": "Binary",
      "name": "Query for Clinical Data",
      "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": "clinicalQueryResponse",
      "resourceType": "Bundle",
      "name": "Response to Query for Clinical Data",
      "description": "The HCO returns appropriate FHIR-formatted data in response to the PHA query."
    }
  ],
  "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",
            "initiator": "PublicHealthAgency",
            "receiver": "HealthcareOrganization",
            "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 HCO responses with one or more matching FHIR Patient resources.",
            "request": {
              "resourceId": "patientQuery"
            },
            "response": {
              "resourceId": "patientQueryResponse"
            }
          }
        }
      ]
    },
    {
      "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": "2",
            "type": "RESTful Query",
            "name": "Clinical Data Query",
            "initiator": "PublicHealthAgency",
            "receiver": "HealthcareOrganization",
            "description": "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.",
            "request": {
              "resourceId": "clinicalQuery"
            },
            "response": {
              "resourceId": "clinicalQueryResponse"
            }
          }
        }
      ]
    }
  ]
}