DFT Ballot - This specification is currently in ballot review and subject to change. It is not ready for limited roll-out or production level use. For a full list of available versions, see the Directory of published versions
Table 2 – Interoperability Recommendations for Use Case 2: Query and Retrieve Document
Implementation Note:
Within CA:FeX, two valid approaches are defined for satisfying the requirements of UC-02.
Implementers may choose either Option A (Search + Retrieve) or Option D (Patient Summary via$summary), depending on the needs and constraints of their solution.
Common Workflow (applies to Option A and Option D)
| USE CASE ACTOR | SERVICE SUPPORTED | TECHNICAL ACTOR | Implementation Expectation | PROFILE/STANDARD |
|---|---|---|---|---|
| Consumer | Authenticate User | Client (e.g. EMR) | Optional | Internet User Authorization (IUA) |
| Consumer | Retrieve Patient Identifier | Client (e.g. EMR) | Optional | Use Existing Standard Employed by the Clinical System |
| Consumer | Retrieve Patient Identifier | Patient Demographic Consumer | Optional | PDQm |
| Central Infrastructure | Return Patient Identifier | Patient Identity Registry | Optional | PMIR |
| Consumer | Request/Search Document (Patient Identifier) | Client (e.g. EMR) | Expected | Use Existing Standard Employed by the Clinical System |
Flow for Option A
| USE CASE ACTOR | SERVICE SUPPORTED | TECHNICAL ACTOR | Implementation Expectation | PROFILE/STANDARD | |
|---|---|---|---|---|---|
| Consumer | Request/Search Document (Patient Identifier) | Data Consumer | Expected | CA:FeX 2A: Search FHIR Document | |
| Consumer | Request Document (Resource ID) | Client (e.g. EMR) | Expected | Use Existing Standard Employed by the Clinical System | |
| Consumer | Request Document (Resource ID) | Data Consumer | Expected | CA:FeX 3A: Retrieve FHIR Document | |
| Responder | Return Searchset Bundle | Data Responder | Expected | CA:FeX 2A: Search FHIR Document | |
| Responder | Return Document Bundle | Data Responder | Expected | CA:FeX 3A: Retrieve FHIR Document |
Flow for Option D
| USE CASE ACTOR | SERVICE SUPPORTED | TECHNICAL ACTOR | Implementation Expectation | PROFILE/STANDARD |
|---|---|---|---|---|
| Consumer | Request Patient Summary (Patient Identifier) | Data Consumer | Expected | CA:FeX 3D: Retrieve Patient Summary ($summary) |
| Responder | Return Patient Summary | Data Responder | Expected | CA:FeX 3D: Retrieve Patient Summary ($summary) |
Note: These tables are not exhaustive and do not include all components required for a robust production deployment.
Aspects such as security, privacy, consent enforcement, and patient identity resolution are implementation-dependent and governed by jurisdictional or organizational policy.
Legend
- Expected – Represents interactions that are typically expected in baseline implementations of CA:FeX.
- Optional – Represents interactions that may apply based on local context, system configuration, or jurisdictional policy.