Ontario Health
Ontario Clinical Report Exchange Implementation Guide v1.0.0 - Trial Use
fhir-logo
  • Index
  • Home
    • Home
    • Introduction
    • Relationship to Other Specifications
    • Scope
    • Glossary
  • Business Context
    • Business Context
    • Business Model
    • Business Data
    • Use Cases
    • Business Rules
  • Technical Context
    • Technical Context
    • Implementer Responsibility
    • Conformance Rules
    • Connectivity Summary
  • FHIR Artifacts
    • FHIR Artifacts
    • Interactions
    • Profiles
    • Extensions
    • 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. Submit Document Bundle - Clinical Report

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

4.1.1. Submit Document Bundle - Clinical Report

4.1.1.1. Scope

This transaction involves a request by a Data Contribution system to transfer a clinical report as a Document Bundle, including a Composition and other linked resources to the OCRE Solution to make these available to the point of service systems (e.g. EMRs). The request is received by the OCRE which validates and forwards the received Bundle to OH Pub/Sub services and returns an HTTP response code and an OperationOutcome resource if applicable.

4.1.1.1.1. Attachments

  • For all attachments, submitters SHALL follow the Upload Attachment flow and use AttachmentMetadata extension on Binary.data instead of embedding an actual base64Binary in Binary.data.

4.1.1.2. Interaction Diagram

Actor: Data Contributor (e.g., Hospital or ICHSC)

Role: Submits a clinical report as a Document Bundle to the OCRE FHIR server.

Actor: OCRE Solution

Role: Receives and validates a Document Bundle, sends to OH Pub/Sub services.

Actor: OH Pub/Sub services

Role: Receives and stores a Document Bundle, notifies subscribers.

4.1.1.3. Specification

This interaction is based on FHIR R4 transaction.

Submit Document Bundle Interaction

POST [base-submit]/Bundle

4.1.1.4. Clinical Report Document Bundle Submission Resources

OCRE Document Bundle Submission

4.1.1.5. Clinical Report Document Bundle Submission Example

Unstructured Document Bundle Example

Dicharge Summary (Structured Document Bundle) Example

Consultation Note (Structured Document Bundle) Example

4.1.1.6. Expected Behavior

See Response Handling page for additional response handling behavior.

Legend
code = OperationOutcome.issue.code
severity = OperationOutcome.issue.severity
details.coding.code=OperationOutcome.issue.details.coding.code
details.coding.display=OperationOutcome.issue.details.coding.display
details.text = OperationOutcome.issue.details.coding.text
HTTP Status Scenario Description severity code details.coding.code details.coding.display details.text
202 Accepted The submission payload has passed conformance rules, and put into message queue for further processing. No OperationOutcome is returned.
400 Bad Request Missing security token error required Missing required security token
401 Unauthorized Failed authentication error security Authorization is required for the interaction that was attempted
500 Internal Server Error API validates the request but cannot return a valid response due to internal issues. fatal exception Internal Error
503 Service Unavailable Indicates that the services has been temporarily taken down (on purpose)
504 Gateway Timeout Downstream system(s) did not return timely response error timeout
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