visit the hl7 website
Provincial Client Registry (PCR) HL7 FHIR® Contribution Implementation Guide v1.0.0-draft1
fhir-logo
  • Index
  • Home
    • Home
    • Introduction
    • Relationship to other Specifications
    • Scope
    • Glossary
  • Business Context
    • Business Context
    • Business Model
    • Business Data
    • Use Cases
    • Business Rules
    • Contribution Models
  • Technical Context
    • Technical Context
    • Implementer Responsibility
    • Conformance Rules
    • Connectivity Summary
  • FHIR Artifacts
    • FHIR Artifacts
    • Interactions
    • Operations
    • Profiles
    • Terminology
    • System URIs
    • Examples
    • Capability Statement
    • Response Handling
    • Downloads
  • Change Log
    • Change Log
    • Known Issues & Future Developments
    • Revision History
    1. Index
    2. FHIR Artifacts
    3. Interactions
    4. Patient Batch Submission

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

4.1.1. Patient Batch Submission

The Batch Transaction Submission business use case enables a Contributor to submit multiple patient transactions for processing within a single batch. The batch may contain patient create, patient update, and patient merge requests.

PCR validates the batch submission and processes each transaction according to applicable patient identity management, governance, stewardship, duplicate prevention, and survivorship policies. Individual transactions within the batch are evaluated independently and may result in successful processing, rejection, or routing for stewardship review.

The process supports efficient high-volume patient identity management activities while maintaining patient identity integrity, auditability, lineage preservation, source attribution, and compliance with approved governance requirements.

4.1.1.1. Usage

Contributor submits a batch transaction request containing one or more patient create, patient update, and patient merge transactions.

Positive Scenario PCR successfully processes the batch submission. New patient identities are created where appropriate, existing patient records are updated, duplicate patient records are merged, audit information is recorded, and processing results are returned to the Contributor.

**Alternative Positive Scenario ** PCR successfully processes valid transactions within the batch while rejecting or deferring transactions that fail validation or require stewardship review. Processing results are provided for each transaction.

Negative Scenario The batch submission is rejected when authorization, governance, message validation, or operational requirements cannot be satisfied. Audit information is recorded and the Contributor is notified of the reason for rejection.

POST: Patient Batch Submission

Actor: Contributor
Role: Submits a Bundle of Create/Update/Merge submissions to the PCR.

Actor: PCR Role: Receives, authenticates, validates, and stores incoming patient information from the Contributor.

4.1.1.2. Specification

Patient Batch Submission Request

Patient Batch Submission Request

The batch interaction is performed by an HTTP POST command as shown:

POST [base-submit]/

Patient Batch Submission Response

Patient Batch Submission Response

4.1.1.3. Expected Behavior

Outcome Header HTTP Response Payload OperationOutcome
Batch interaction processed 200 OK Yes
Validation failure 400 Bad Request or 422 Unprocessable Entity Yes
Contributor not authorized 401 Unauthorized or 403 Forbidden No
Processing failure or service unavailable 5xx Server Error No
Version: 1.0.0 FHIR Version: R4.0.1

Powered by SIMPLIFIER.NET

HL7® and FHIR® are the registered trademarks of Health Level Seven International