Bulk Retrieval of Public Health Data
2.0.0-ballot - Informative 2 Ballot United States of America flag

Bulk Retrieval of Public Health Data, published by HL7 International / Public Health. This guide is not an authorized publication; it is the continuous build for version 2.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/us-helios-bulk/ and changes regularly. See the Directory of published versions

: Public Health Bulk Export Example

Page standards status: Informative

Raw ttl | Download

@prefix fhir: <http://hl7.org/fhir/> .
@prefix owl: <http://www.w3.org/2002/07/owl#> .
@prefix rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#> .
@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
@prefix xsd: <http://www.w3.org/2001/XMLSchema#> .

# - resource -------------------------------------------------------------------

 a fhir:ExampleScenario ;
  fhir:nodeRole fhir:treeRoot ;
  fhir:id [ fhir:v "phBulkExportExampleScenario"] ; # 
  fhir:language [ fhir:v "en"] ; # 
  fhir:text [
fhir:status [ fhir:v "extensions" ] ;
fhir:div [ fhir:v "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: ExampleScenario phBulkExportExampleScenario</b></p><a name=\"phBulkExportExampleScenario\"> </a><a name=\"hcphBulkExportExampleScenario\"> </a><p><b>StructureDefinition Work Group</b>: pher</p><p><b>url</b>: <a href=\"ExampleScenario-phBulkExportExampleScenario.html\">PublicHealthBulkExportExample</a></p><p><b>version</b>: 2.0.0-ballot</p><p><b>name</b>: PublicHealthBulkExportExample</p><p><b>status</b>: Active</p><p><b>date</b>: 2026-03-30 13:59:05+0000</p><p><b>publisher</b>: HL7 International / Public Health</p><p><b>contact</b>: HL7 International / Public Health: <a href=\"http://www.hl7.org/Special/committees/pher\">http://www.hl7.org/Special/committees/pher</a>,<a href=\"mailto:pher@lists.HL7.org\">pher@lists.HL7.org</a></p><p><b>jurisdiction</b>: <span title=\"Codes:{urn:iso:std:iso:3166 US}\">United States of America</span></p><p><b>purpose</b>: </p><div><p>This ExampleScenario describes the actors and processes associated with a Bulk Export of data from an Immunization Program for by use by an Authorized User.</p>\n</div><blockquote><p><b>actor</b></p><p><b>actorId</b>: eventSubmitters</p><p><b>type</b>: System</p><p><b>name</b>: Immunization Event Submitters</p><p><b>description</b>: </p><div><p>Healthcare providers, pharmacies and any other submitter of data related to the administration of vaccines to individuals.</p>\n</div></blockquote><blockquote><p><b>actor</b></p><p><b>actorId</b>: IIS</p><p><b>type</b>: System</p><p><b>name</b>: Immunization Program</p><p><b>description</b>: </p><div><p>The public health program designated to receive and collate information on vaccination events for individuals in the catchment area.</p>\n</div></blockquote><blockquote><p><b>actor</b></p><p><b>actorId</b>: authorizedUser</p><p><b>type</b>: System</p><p><b>name</b>: Authorized Users</p><p><b>description</b>: </p><div><p>Organizations authorized to access and use IIS data to serve indidivuals and populations. Authorized Users may be healthcare providers, payers, schools and other types of organizations.</p>\n</div></blockquote><blockquote><p><b>instance</b></p><p><b>resourceId</b>: event</p><p><b>resourceType</b>: Binary</p><p><b>name</b>: Immunization Event Information</p><p><b>description</b>: </p><div><p>The Immunization Event Submitter shares discrete data about an administered vaccine with the IIS (typically in the form of an HL7 v2 VXU message).</p>\n</div></blockquote><blockquote><p><b>instance</b></p><p><b>resourceId</b>: patientIdentification</p><p><b>resourceType</b>: Resource</p><p><b>name</b>: Demographics for Patient Identification</p><p><b>description</b>: </p><div><p>The Authorized User provides demographics on one or more individuals to be identified by the Immunization Program. A wide variety of methods, some FHIR-based, are possible to fulfill this step.</p>\n</div></blockquote><blockquote><p><b>instance</b></p><p><b>resourceId</b>: patientReturn</p><p><b>resourceType</b>: Patient</p><p><b>name</b>: Return Identified Patients</p><p><b>description</b>: </p><div><p>Based on patient demographics provided, the Immunization Program returns one or more corresponding Patient resources.</p>\n</div></blockquote><blockquote><p><b>instance</b></p><p><b>resourceId</b>: cohortRequest</p><p><b>resourceType</b>: Resource</p><p><b>name</b>: Request to create or modify a cohort</p><p><b>description</b>: </p><div><p>The Authorized User requests the creation of a new cohort of individuals or updates to an existing cohort. A wide variety of methods, some FHIR-based, are possible to fulfill this step.</p>\n</div></blockquote><blockquote><p><b>instance</b></p><p><b>resourceId</b>: bulkQuery</p><p><b>resourceType</b>: Resource</p><p><b>name</b>: Bulk Query Request</p><p><b>description</b>: </p><div><p>The Authorized User request bulk data via an Operation defined by the Bulk Data Access FHIR Implementation Guide.</p>\n</div></blockquote><blockquote><p><b>instance</b></p><p><b>resourceId</b>: bulkResponse</p><p><b>resourceType</b>: Bundle</p><p><b>name</b>: Provide Data in Bulk</p><p><b>description</b>: </p><div><p>The Immunization Program returns relevant data for consumption by the Authorized User. The exact data payload may vary with the use case and Authorized User.</p>\n</div></blockquote><blockquote><p><b>process</b></p><p><b>title</b>: Immunization Administration Event Submission</p><p><b>description</b>: </p><div><p>Immunization Event Submitters administer vaccines to individual (or records historical administrations) and submit that data to their local IIS, typically using the HL7 v2 VXU message type. IIS receive and integrate data from a large number of unique Data Submitters.</p>\n</div><p><b>preConditions</b>: </p><div><p>The Data Submitter records discrete details about the immunization event.</p>\n</div><p><b>postConditions</b>: </p><div><p>The IIS recieves, validates and ingests the immunization event data, performing patient identification (and if necessary deduplication) and stores the data in association with the individual's record.</p>\n</div><blockquote><p><b>step</b></p><blockquote><p><b>operation</b></p><p><b>number</b>: 1</p><p><b>type</b>: eventSubmission</p><p><b>name</b>: Immunization Administration Event Submission</p><p><b>initiator</b>: eventSubmitters</p><p><b>receiver</b>: IIS</p><p><b>description</b>: </p><div><p>The Immunization Event Submitter generates a valid HL7 v2 VXU message and submits it to the IIS.</p>\n</div><h3>Requests</h3><table class=\"grid\"><tr><td style=\"display: none\">-</td><td><b>ResourceId</b></td></tr><tr><td style=\"display: none\">*</td><td>event</td></tr></table></blockquote></blockquote></blockquote><blockquote><p><b>process</b></p><p><b>title</b>: Patient Identification Query</p><p><b>description</b>: </p><div><p>The process of identifying individual(s) of interest in the Immunization program system.</p>\n</div><p><b>preConditions</b>: </p><div><p>The Authorized User must have enough patient demographics to assure a reasonable chance of matching the patient. The Authorized User and Immunization Program must support a common method of patient identification.</p>\n</div><p><b>postConditions</b>: </p><div><p>The Authorized User is able to persist the Patient resouce ID(s) returned so that a cohort of individuals can be created.</p>\n</div><blockquote><p><b>step</b></p><blockquote><p><b>operation</b></p><p><b>number</b>: 2</p><p><b>type</b>: Patient Identification Query</p><p><b>name</b>: Patient Identification Query</p><p><b>initiator</b>: authorizedUser</p><p><b>receiver</b>: IIS</p><p><b>description</b>: </p><div><p>Patient demographics are exchanged between the Authorized User and the Immunization Program to positively identify cognate individual(s) of interest in both systems.</p>\n</div><h3>Requests</h3><table class=\"grid\"><tr><td style=\"display: none\">-</td><td><b>ResourceId</b></td></tr><tr><td style=\"display: none\">*</td><td>patientIdentification</td></tr></table><h3>Responses</h3><table class=\"grid\"><tr><td style=\"display: none\">-</td><td><b>ResourceId</b></td></tr><tr><td style=\"display: none\">*</td><td>patientReturn</td></tr></table></blockquote></blockquote></blockquote><blockquote><p><b>process</b></p><p><b>title</b>: Cohort Create or Update</p><p><b>description</b>: </p><div><p>The Authorized User creates or updates a cohort of individuals of interest that will be the focus of a bulk data query.</p>\n</div><p><b>preConditions</b>: </p><div><p>The Authorized User knows the Immunization Program's FHIR Patient IDs for the individuals in the cohort.</p>\n</div><p><b>postConditions</b>: </p><div><p>The Immunization Program maintains a cohort list for the Authorized User.</p>\n</div><blockquote><p><b>step</b></p><blockquote><p><b>operation</b></p><p><b>number</b>: 3</p><p><b>type</b>: Cohort Create or Update</p><p><b>name</b>: Cohort Create or Update</p><p><b>initiator</b>: authorizedUser</p><p><b>receiver</b>: IIS</p><p><b>description</b>: </p><div><p>Using the identified Patient resources, the Authorized User creates and maintains a cohort of individuals of interest.</p>\n</div><h3>Requests</h3><table class=\"grid\"><tr><td style=\"display: none\">-</td><td><b>ResourceId</b></td></tr><tr><td style=\"display: none\">*</td><td>cohortRequest</td></tr></table></blockquote></blockquote></blockquote><blockquote><p><b>process</b></p><p><b>title</b>: Bulk Data Export</p><p><b>description</b>: </p><div><p>The process of retrieving relevant data on a population of individuals as per the Bulk Data Access FHIR Implementation Guide.</p>\n</div><p><b>preConditions</b>: </p><div><p>The Immunization Program knows the cohort of individuals of interest to the Authorized User.</p>\n</div><p><b>postConditions</b>: </p><div><p>The Authorized User validates and consumers the bulk data returned by the Immunization Program and makes it available to end users or system activities.</p>\n</div><blockquote><p><b>step</b></p><blockquote><p><b>operation</b></p><p><b>number</b>: 4</p><p><b>type</b>: Bulk Data Export</p><p><b>name</b>: Bulk Data Export</p><p><b>initiator</b>: authorizedUser</p><p><b>receiver</b>: IIS</p><p><b>description</b>: </p><div><p>Appropriate FHIR resources are requested, gathered and retrieved.</p>\n</div><h3>Requests</h3><table class=\"grid\"><tr><td style=\"display: none\">-</td><td><b>ResourceId</b></td></tr><tr><td style=\"display: none\">*</td><td>bulkQuery</td></tr></table><h3>Responses</h3><table class=\"grid\"><tr><td style=\"display: none\">-</td><td><b>ResourceId</b></td></tr><tr><td style=\"display: none\">*</td><td>bulkResponse</td></tr></table></blockquote></blockquote></blockquote></div>"^^rdf:XMLLiteral ]
  ] ; # 
  fhir:extension ( [
fhir:url [
fhir:v "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg"^^xsd:anyURI ;
fhir:l <http://hl7.org/fhir/StructureDefinition/structuredefinition-wg>     ] ;
fhir:value [
a fhir:Code ;
fhir:v "pher"     ]
  ] ) ; # 
  fhir:url [
fhir:v "http://hl7.org/fhir/us/ph-bulk-data/ExampleScenario/phBulkExportExampleScenario"^^xsd:anyURI ;
fhir:l <http://hl7.org/fhir/us/ph-bulk-data/ExampleScenario/phBulkExportExampleScenario>
  ] ; # 
  fhir:version [ fhir:v "2.0.0-ballot"] ; # 
  fhir:name [ fhir:v "PublicHealthBulkExportExample"] ; # 
  fhir:status [ fhir:v "active"] ; # 
  fhir:date [ fhir:v "2026-03-30T13:59:05+00:00"^^xsd:dateTime] ; # 
  fhir:publisher [ fhir:v "HL7 International / Public Health"] ; # 
  fhir:contact ( [
fhir:name [ fhir:v "HL7 International / Public Health" ] ;
    ( fhir:telecom [
fhir:system [ fhir:v "url" ] ;
fhir:value [ fhir:v "http://www.hl7.org/Special/committees/pher" ]     ] [
fhir:system [ fhir:v "email" ] ;
fhir:value [ fhir:v "pher@lists.HL7.org" ]     ] )
  ] ) ; # 
  fhir:jurisdiction ( [
    ( fhir:coding [
fhir:system [
fhir:v "urn:iso:std:iso:3166"^^xsd:anyURI ;
fhir:l <urn:iso:std:iso:3166>       ] ;
fhir:code [ fhir:v "US" ]     ] )
  ] ) ; # 
  fhir:purpose [ fhir:v "This ExampleScenario describes the actors and processes associated with a Bulk Export of data from an Immunization Program for by use by an Authorized User."] ; # 
  fhir:actor ( [
fhir:actorId [ fhir:v "eventSubmitters" ] ;
fhir:type [ fhir:v "entity" ] ;
fhir:name [ fhir:v "Immunization Event Submitters" ] ;
fhir:description [ fhir:v "Healthcare providers, pharmacies and any other submitter of data related to the administration of vaccines to individuals." ]
  ] [
fhir:actorId [ fhir:v "IIS" ] ;
fhir:type [ fhir:v "entity" ] ;
fhir:name [ fhir:v "Immunization Program" ] ;
fhir:description [ fhir:v "The public health program designated to receive and collate information on vaccination events for individuals in the catchment area." ]
  ] [
fhir:actorId [ fhir:v "authorizedUser" ] ;
fhir:type [ fhir:v "entity" ] ;
fhir:name [ fhir:v "Authorized Users" ] ;
fhir:description [ fhir:v "Organizations authorized to access and use IIS data to serve indidivuals and populations. Authorized Users may be healthcare providers, payers, schools and other types of organizations." ]
  ] ) ; # 
  fhir:instance ( [
fhir:resourceId [ fhir:v "event" ] ;
fhir:resourceType [ fhir:v "Binary" ] ;
fhir:name [ fhir:v "Immunization Event Information" ] ;
fhir:description [ fhir:v "The Immunization Event Submitter shares discrete data about an administered vaccine with the IIS (typically in the form of an HL7 v2 VXU message)." ]
  ] [
fhir:resourceId [ fhir:v "patientIdentification" ] ;
fhir:resourceType [ fhir:v "Resource" ] ;
fhir:name [ fhir:v "Demographics for Patient Identification" ] ;
fhir:description [ fhir:v "The Authorized User provides demographics on one or more individuals to be identified by the Immunization Program. A wide variety of methods, some FHIR-based, are possible to fulfill this step." ]
  ] [
fhir:resourceId [ fhir:v "patientReturn" ] ;
fhir:resourceType [ fhir:v "Patient" ] ;
fhir:name [ fhir:v "Return Identified Patients" ] ;
fhir:description [ fhir:v "Based on patient demographics provided, the Immunization Program returns one or more corresponding Patient resources." ]
  ] [
fhir:resourceId [ fhir:v "cohortRequest" ] ;
fhir:resourceType [ fhir:v "Resource" ] ;
fhir:name [ fhir:v "Request to create or modify a cohort" ] ;
fhir:description [ fhir:v "The Authorized User requests the creation of a new cohort of individuals or updates to an existing cohort. A wide variety of methods, some FHIR-based, are possible to fulfill this step." ]
  ] [
fhir:resourceId [ fhir:v "bulkQuery" ] ;
fhir:resourceType [ fhir:v "Resource" ] ;
fhir:name [ fhir:v "Bulk Query Request" ] ;
fhir:description [ fhir:v "The Authorized User request bulk data via an Operation defined by the Bulk Data Access FHIR Implementation Guide." ]
  ] [
fhir:resourceId [ fhir:v "bulkResponse" ] ;
fhir:resourceType [ fhir:v "Bundle" ] ;
fhir:name [ fhir:v "Provide Data in Bulk" ] ;
fhir:description [ fhir:v "The Immunization Program returns relevant data for consumption by the Authorized User. The exact data payload may vary with the use case and Authorized User." ]
  ] ) ; # 
  fhir:process ( [
fhir:title [ fhir:v "Immunization Administration Event Submission" ] ;
fhir:description [ fhir:v "Immunization Event Submitters administer vaccines to individual (or records historical administrations) and submit that data to their local IIS, typically using the HL7 v2 VXU message type. IIS receive and integrate data from a large number of unique Data Submitters." ] ;
fhir:preConditions [ fhir:v "The Data Submitter records discrete details about the immunization event." ] ;
fhir:postConditions [ fhir:v "The IIS recieves, validates and ingests the immunization event data, performing patient identification (and if necessary deduplication) and stores the data in association with the individual's record." ] ;
    ( fhir:step [
fhir:operation [
fhir:number [ fhir:v "1" ] ;
fhir:type [ fhir:v "eventSubmission" ] ;
fhir:name [ fhir:v "Immunization Administration Event Submission" ] ;
fhir:initiator [ fhir:v "eventSubmitters" ] ;
fhir:receiver [ fhir:v "IIS" ] ;
fhir:description [ fhir:v "The Immunization Event Submitter generates a valid HL7 v2 VXU message and submits it to the IIS." ] ;
fhir:request [
fhir:resourceId [ fhir:v "event" ]         ]       ]     ] )
  ] [
fhir:title [ fhir:v "Patient Identification Query" ] ;
fhir:description [ fhir:v "The process of identifying individual(s) of interest in the Immunization program system." ] ;
fhir:preConditions [ fhir:v "The Authorized User must have enough patient demographics to assure a reasonable chance of matching the patient. The Authorized User and Immunization Program must support a common method of patient identification." ] ;
fhir:postConditions [ fhir:v "The Authorized User is able to persist the Patient resouce ID(s) returned so that a cohort of individuals can be created." ] ;
    ( fhir:step [
fhir:operation [
fhir:number [ fhir:v "2" ] ;
fhir:type [ fhir:v "Patient Identification Query" ] ;
fhir:name [ fhir:v "Patient Identification Query" ] ;
fhir:initiator [ fhir:v "authorizedUser" ] ;
fhir:receiver [ fhir:v "IIS" ] ;
fhir:description [ fhir:v "Patient demographics are exchanged between the Authorized User and the Immunization Program to positively identify cognate individual(s) of interest in both systems." ] ;
fhir:request [
fhir:resourceId [ fhir:v "patientIdentification" ]         ] ;
fhir:response [
fhir:resourceId [ fhir:v "patientReturn" ]         ]       ]     ] )
  ] [
fhir:title [ fhir:v "Cohort Create or Update" ] ;
fhir:description [ fhir:v "The Authorized User creates or updates a cohort of individuals of interest that will be the focus of a bulk data query." ] ;
fhir:preConditions [ fhir:v "The Authorized User knows the Immunization Program's FHIR Patient IDs for the individuals in the cohort." ] ;
fhir:postConditions [ fhir:v "The Immunization Program maintains a cohort list for the Authorized User." ] ;
    ( fhir:step [
fhir:operation [
fhir:number [ fhir:v "3" ] ;
fhir:type [ fhir:v "Cohort Create or Update" ] ;
fhir:name [ fhir:v "Cohort Create or Update" ] ;
fhir:initiator [ fhir:v "authorizedUser" ] ;
fhir:receiver [ fhir:v "IIS" ] ;
fhir:description [ fhir:v "Using the identified Patient resources, the Authorized User creates and maintains a cohort of individuals of interest." ] ;
fhir:request [
fhir:resourceId [ fhir:v "cohortRequest" ]         ]       ]     ] )
  ] [
fhir:title [ fhir:v "Bulk Data Export" ] ;
fhir:description [ fhir:v "The process of retrieving relevant data on a population of individuals as per the Bulk Data Access FHIR Implementation Guide." ] ;
fhir:preConditions [ fhir:v "The Immunization Program knows the cohort of individuals of interest to the Authorized User." ] ;
fhir:postConditions [ fhir:v "The Authorized User validates and consumers the bulk data returned by the Immunization Program and makes it available to end users or system activities." ] ;
    ( fhir:step [
fhir:operation [
fhir:number [ fhir:v "4" ] ;
fhir:type [ fhir:v "Bulk Data Export" ] ;
fhir:name [ fhir:v "Bulk Data Export" ] ;
fhir:initiator [ fhir:v "authorizedUser" ] ;
fhir:receiver [ fhir:v "IIS" ] ;
fhir:description [ fhir:v "Appropriate FHIR resources are requested, gathered and retrieved." ] ;
fhir:request [
fhir:resourceId [ fhir:v "bulkQuery" ]         ] ;
fhir:response [
fhir:resourceId [ fhir:v "bulkResponse" ]         ]       ]     ] )
  ] ) . #