For a full list of available versions, see the Directory of published versions
2.3. Use Cases
The following use cases detail the functional workflows for the contribution of immunization records to the Immunization Repository (IR) Solution. These scenarios illustrate the interactions between Contributor Health Information Custodians (HICs) and the IR Solution, covering the submission of new records, the management of validation responses (including successful processing and error handling), and the process for submitting updates or corrections to previously submitted information. These workflows ensure that immunization data is accurately validated, persisted in the IR Solution database, and made available for query by authorized Point of Service (PoS) systems
2.3.1. Actors
Table- Use Case Participants
| Participant |
Type |
Description |
| Contributor HIC |
Organization |
Health Information Custodian (HIC) contributing immunization records to the IR and operator of the Contributor HIC System. |
| Contributor HIC System |
System |
A system used by HICs to contribute immunization information to the IR. In these use cases, the Contributor HIC Systems will typically be Panorama (Public Health Units) or a Pharmacy Management System (community pharmacies). |
| IR Solution |
System |
A solution (centralized data repository, infrastructure, data quality, reporting, and web services) that enables the contribution of immunization records from Contributor HICs and the sharing of this information with authorized HICs. |
| PoS Systems |
System |
Represents software applications used by health care or service providers for viewing or managing personal health information (PHI). Common PoS systems include, but are not limited to, provincial clinical viewers, HIS, and primary care EMRs. |
| DQS-IR Data Quality Solution |
System |
This solution, which is part of the IR Solution, will enable authorized Ontario Health and Contributor HIC personnel to review IR records submitted by the Contributor HIC to support conformance, clinical validation, and ongoing data quality analysis of submitted records. |
2.3.2. Use Cases
2.3.2.1. IR-UC-1 – Contributor HIC submits new immunization record to IR Solution
Primary workflow:
Contributor HIC submits a new immunization record to the IR Solution and record passes all validations.
Steps:
- Contributor HIC submits a new immunization record to the IR Solution.
- Record is processed and passes all validation steps.
- HTTP response is sent to Contributor HIC indicating successful processing of the record.
- Record is written to the IR Solution database and is available for query by PoS systems.
Alternate Workflows:
- Contributor HIC submits new immunization record to IR Solution and record fails structural, content, or referential validation with Error annotation.
- Contributor HIC submits a new immunization record to IR Solution.
- Record is processed and fails structural, content, or referential validation with Error annotation.
- HTTP response is sent to Contributor HIC indicating that an error has occurred during record validation.
- Record is written to IR Data Quality Solution (DQS) database.
- Record is not written to IR Solution database and is unavailable for query by PoS systems.
- Contributor HIC submits new immunization record to IR Solution and record fails referential validation with Warning and/or Information annotation (no Error).
- Contributor HIC submits a new immunization record to IR Solution.
- Record is processed and fails referential validation with Warning and/or Information annotation (no Error).
- HTTP response is sent to Contributor HIC indicating that a warning or informational message has been generated during record validation.
- Record is written to IR DQS database.
- Record is written to IR Solution database and is available for query by PoS systems.
2.3.2.2. IR-UC-2 – Contributor HIC receives HTTP response indicating validation failure during record processing
Primary workflow:
Contributor HIC receives an HTTP response indicating that a validation failure (Error, Warning, or Information) has occurred during processing of an immunization record. The Contributor HIC reviews the details returned, corrects the data in the Contributor HIC System as needed, and resubmits the record to the IR Solution.
Steps:
- Contributor HIC receives HTTP response indicating that a validation failure has occurred during record processing.
- Contributor HIC views details of the validation failure contained in the HTTP response (e.g., Operation Outcome).
- Contributor HIC corrects/updates data in the Contributor HIC System and resubmits the record to the IR Solution.
- Corrected version of the record is written to the IR Solution database, superseding previous versions of the record where applicable, and is available for query by PoS systems.
Alternate Workflows:
- Warning/Information only (no Error) - No correction/update required
- Contributor HIC receives an HTTP response indicating that a Warning or Information message has been generated during record validation.
- Contributor HIC views details of the validation message(s) contained in the HTTP response.
- Contributor HIC determines that no further action is required and does not correct/update data in the Contributor HIC System or resubmit the record.
- The record remains persisted in the IR Solution database and is available for query by POS systems; the annotation is recorded in IR DQS.
- Error
- Contributor HIC receives an HTTP response indicating that a validation Error has occurred during record processing.
- Contributor HIC views details of the validation failure contained in the HTTP response.
- Contributor HIC is unable to make corrections in the Contributor HIC System.
- Contributor HIC contacts local support/system vendor and/or Ontario Health Data Quality Administration to address the issue.
- Upon resolution, the Contributor HIC resubmits the corrected record to the IR Solution.
2.3.2.3. IR-UC-3 – Contributor HIC submits changed version of a previously submitted immunization record
Primary workflow:
Contributor HIC submits a changed version (e.g., update/correction) of a previously submitted immunization record to the IR Solution. Changed version is processed and passes all validations.
Steps:
- Contributor HIC submits a changed version of a previously submitted immunization record to the IR Solution.
- Changed version is processed and passes all validation steps.
- HTTP response is sent to the Contributor HIC indicating successful processing of the record.
- Changed version is written to the IR Solution database, superseding previous versions of the record where applicable, and is available for query by PoS systems.
Alternate Workflows:
- Changed version fails structural, content, or referential validation (Error)
- Contributor HIC submits a changed version of a previously submitted immunization record to the IR Solution.
- Changed version is processed and fails structural, content, or referential validation with Error annotation.
- HTTP response is sent to the Contributor HIC indicating that an error has occurred during record validation.
- Changed version of record is written to IR Data Quality Solution (DQS) for remediation.
- Changed version is not written to the IR Solution database and is unavailable for query by PoS systems.
- The previously submitted version of the record remains available for query by PoS systems.
- Changed version fails referential validation with Warning/Information (no Error)
- Contributor HIC submits a changed version of a previously submitted immunization record to the IR Solution.
- Changed version is processed and fails referential validation with Warning and/or Information annotation (no Error).
- HTTP response is sent to the Contributor HIC indicating that a warning or informational message has been generated during record validation.
- Changed version is written to IR DQS (annotation recorded).
- Changed version is written to the IR Solution database, superseding previous versions of the record where applicable, and is available for query by PoS systems.
