Visit the HL7 website
Visit the FHIR website

Pan-Canadian Patient Summary (PS-CA) CI Build

current   Canada flag
  • Table-of-Contents
  • Home
  • Business Context
    • Use Cases
    • Requirements
    • Privacy and Security Guidance
    • Relationship to Other Specifications
  • Technical Context
    • Sequence Diagrams
    • Core Interoperability Specification Requirements
    • Conformance and Specification Guidance
    • General Principles & Design
  • FHIR Artifacts
    • FHIR Artifacts
    • PS-CA Library of Profiles
    • Bundle (PS-CA)
    • Composition (PS-CA)
    • Patient (PS-CA)
    • Medication (PS-CA)
    • MedicationRequest (PS-CA)
    • MedicationStatement (PS-CA)
    • AllergyIntolerance (PS-CA)
    • Condition (PS-CA)
    • Procedure (PS-CA)
    • Immunization (PS-CA)
    • DiagnosticReport (PS-CA)
    • ImagingStudy (PS-CA)
    • Organization-Lab (PS-CA)
    • Practitioner-Lab (PS-CA)
    • PractitionerRole-Lab (PS-CA)
    • Observation Laboratory/Pathology (PS-CA)
    • Observation Radiology (PS-CA)
    • Observation Social History (PS-CA)
    • Observation Alcohol Use (PS-CA)
    • Observation Tobacco Use (PS-CA)
    • Family Member History (PS-CA)
    • Data Type Profiles
    • Extensions
    • Examples
    • Terminology
    • Downloads
  • Change Log
    1. Table-of-Contents
    2. Technical Context
    3. Sequence Diagrams
    4. Sequence Diagrams for UC-04: HCP Requests PS-CA On-Demand

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

UC-04: HCP Requests PS-CA On-Demand

A Health Care Provider in any care setting requests and uses a PS-CA on-demand at the point of care, including for unscheduled/scheduled local care.

Implementation Option 1: CA:FeX $summary operation

This option is recommended for systems where the clinical data needed to generate the Patient Summary is internal to the Clinical Data Repository.

Note that generally with $summary operation, servers may choose not to produce “fresh” patient summaries on every request. Due to performance impacts, servers may choose to generate Patient Summaries on a nightly or cached basis, and return those.

Implementation Option 2: CA:FeX $docref operation

This option is recommended for systems where the clinical data needed to generate the Patient Summary is either external to the Clinical Data Repository generating the summary, or distributed across various internal and external data sources.

Implementation Option 1: CA:FeX $summary

Scenario: Clinical Solution A Requests Patient Summary-CA On Demand from Clinical Data Repository

Assumption: Clinical data used to generate the Patient Summary is retrieved from sources internal to the Clinical Data Repository

Implementation Option : This sequence diagram provides the option of using the CA:FeX Interoperability Specifications that provide support for requesting a Patient Summary-CA on demand from a Clinical Data Repository (Local to PS-Producer or Central). This profile includes a Data Consumer and a Data Responder actor. Additionally, this sequence diagram uses the 'Retrieve Patient Summary' CA:FeX-3D transaction which is based on IPS Summary ($summary).

This implementation option is suitable for systems where the discrete FHIR resources needed to generate the Patient Summary are internal to the Clinical Data Repository where the Patient Summary is generated.

Note that generally with $summary operation, servers may choose not to produce “fresh” patient summaries on every request. Due to performance impacts, servers may choose to generate Patient Summaries on a nightly or cached basis, and return those.

Note: Additionally, this sequence diagram includes the CA:FMT Interoperability Specifications that handle transformations to and from various formats (e.g. FHIR to PDF, CDA, etc.).

Sequence Diagram

SQ Diagram-UC4CAFEXsummary

Implementation Option 2: CA:FeX $docref

Scenario: Clinical Solution A Requests Patient Summary-CA On Demand from Clinical Data Repository

Assumption: Clinical data used to generate the Patient Summary is retrieved from sources that are internal and/or external to the Clinical Data Repository

Implementation Option 2 : This sequence diagram provides the option of using the CA:FeX Interoperability Specifications that provide support for requesting a Patient Summary-CA on demand from a Clinical Data Repository (Local to PS-Producer or Central). This profile includes a Data Consumer and a Data Responder actor. Additionally, this sequence diagram uses the 'Fetch DocumentReference' CA:FeX-2B transaction which is based on $docRef

This implementation option is suitable for systems where the discrete FHIR resources needed to generate the Patient Summary are either external to the Clinical Data Repository generating the summary, or distributed across various internal and external data sources.

The on-demand Patient Summary generation occurs in two steps and involves asynchronous processing when data retrieval has longer response times, which is typically the case for external data sources. In the first step, a DocumentReference resource is created, that contains the location where the Patient Summary document is or will be available. The retrieval of the discrete FHIR resources needed to assemble the Patient Summary document is an asynchronous operation. In the second step, the on-demand Patient Summary document is retrieved once the assembly of the discrete FHIR resources is complete.

Note: Additionally, this sequence diagram includes the CA:FMT Interoperability Specifications that handle transformations to and from various formats (e.g. FHIR to PDF, CDA, etc.). Additional details will be included in the PS-CA Interoperability Specifications.

Sequence Diagram

SQ Diagram-UC4CAFEXdocref


IG © based on FHIR R4 | Package project:PS-CA-R1
HL7® and FHIR® are the registered trademarks of Health Level Seven International