For a full list of available versions, see the Directory of published versions

4.1.1. Submit Immunization Document Bundle

The Submit Immunization interaction is used to transfer immunization records to the IR. This encompasses both Create and Update.

4.1.1.1. Scope

This transaction involves a request by a Point of Service system to transfer an Immunization Bundle, including a Composition and other linked resources to the IR Solution. The request is received by the IR which stores the received Bundle and returns an HTTP response code and an OperationOutcome resource if applicable.

For example, a user at a HIC site records an Immunization in a Point of Care System. The Point of Care System will extract and assemble the immunization record as per the Ontario Immunization Repository HL7 FHIR Implementation Guide specification and submit it to the IR, where it is available for viewing by other IR Consumers.

4.1.1.2. Interaction Diagram

Actor: Client Application

Role: Submits an immunization document bundle containing a Composition and linked resources that may be populated with data to the IR Solution.

Actor: IR Solution

Role: Receives and stores Immunization document Bundles from the Client Application.

4.1.1.3. Specification

The FHIR IR specification is based on the HL7 FHIR R4 Create operation.

Immunization Create Request

The Create Request will create a new immunization record based upon information available from the immunization source, if one does not already exist in the repository. If there is already an existing record, the newly submitted version will replace the existing version in the repository.

The Immunization Document Bundle Create Request creates a new resource in a server-assigned location. The create interaction is performed by an HTTP POST command as shown:

POST [base-submit]/Bundle/

Immunization Create Response

• OperationOutcome

Immunization Conditional Update Request

The Conditional Update Request will update an existing immunization record based upon information available from the immunization record source.

PUT [base-submit]/Bundle?[search parameters]

The following parameters shall be used for conditional update:

• identifier (Source Submitter ID + Immunization Record ID)

Immunization Conditional Updated Response

• OperationOutcome
  
  

Example Create Bundle Message

HTTP Method:

POST

Headers:

Content-Type: application/fhir+json

Address:

[base-submit]/Bundle/

Message Body:

[Link to Example Bundle]

4.1.1.4. Supported Profiles

4.1.1.5. Extensions

4.1.1.6. Expected Behavior