...
The actors defined by CA:FeX are described below.
Actor | Description |
Data Source | Submits data to a Data Recipient |
Data Consumer | Queries a Data Responder and retrieves data matching a set of criteria |
Data Recipient | Receives data from a Data Source |
Data Responder | Returns data matching a set of criteria queried by Data Consumer |
...
CA:FeX actor options are organized into four options providing implementers with choices that most suit their context and needs, while minimizing implementation details not relevant to them. Implementers may choose to opt into one or more actor option. The table below summarizes the CA:FeX actor options.
Actor Option | Description |
A. Bundle Option | Exchange of data using /Bundle endpoint |
B. Metadata Option | Exchange of data through metadata resources |
C. Single Resource Option | Exchange of data using FHIR single resource endpoints |
D. Summary Option | Exchange of document using $summary operation |
...
The tables below list the transactions for each actor directly involved in CA:FeX. To claim compliance with CA:FeX, an actor shall support all required transactions (labeled “R”).
Bundle Option (A)
Actor | Transaction | Endpoint Info (Summary) | Optionality |
Data Source | Submit FHIR Document [CA:FeX-1A] | /Bundle | R |
Data Consumer | Search FHIR Document [CA:FeX-2A] | /Bundle | R |
Retrieve FHIR Document [CA:FeX-3A] | /Bundle | R | |
Data Recipient | Submit FHIR Document [CA:FeX-1A] | /Bundle | R |
Data Responder | Search FHIR Document [CA:FeX-2A] | /Bundle | R |
Retrieve FHIR Document [CA:FeX-3A] | /Bundle | R |
...
- Submit FHIR Document [CA:FeX-1A] – This transaction performs a FHIR Create interaction to transfer a FHIR Document, typically Bundle of type Composition.
- Search FHIR Document [CA:FeX-2A] – This transaction performs a FHIR Search interaction to obtain FHIR Documents that satisfies a set of parameters.
- Retrieve FHIR Document [CA:FeX-3A] – This transaction performs a FHIR Read interaction to retrieve a FHIR Document.
Metadata Option (B)
Actor | Transaction | Endpoint Info (Summary) | Optionality | Notes |
Data Source | Generate Metadata [CA:FeX-1B] | $generate-metadata | R | Based on MHD |
Data Consumer | Fetch DocumentReference [CA:FeX-2B] | $docref | R | Based on IPA |
Retrieve Document [CA:FeX-3B] | /Bundle, /Binary | R | ||
Data Recipient | Generate Metadata [CA:FeX-1B] | $generate-metadata | R | Based on MHD |
Data Responder | Fetch DocumentReference [CA:FeX-2B] | $docref | R | Based on IPA |
Retrieve Document [CA:FeX-3B] | /Bundle, /Binary | R |
...
Single Resource Option (C)
Actor | Transaction | Endpoint Info (Summary) | Optionality |
Data Source | Submit Resource [CA:FeX-1C] | /<type> | R |
Data Consumer | Search Resource [CA:FeX-2C] | /<type> | R |
Retrieve Resource [CA:FeX-3C] | /<type> | R | |
Data Recipient | Submit Resource [CA:FeX-1C] | /<type> | R |
Data Responder | Search Resource [CA:FeX-2C] | /<type> | R |
Retrieve Resource [CA:FeX-3C] | /<type> | R |
...
- Submit Resource [CA:FeX-1C] – This transaction performs a FHIR Create interaction to submit a single FHIR resource.
- Search Resource [CA:FeX-2C] – This transaction performs a FHIR Search interaction to find FHIR resources matching a set of parameters.
- Retrieve Resource [CA:FeX-3C] – This interaction performs a FHIR Read to retrieve a FHIR resource using a known resource ID.
Summary Option (D)
Actor | Transaction | Endpoint Info (Summary) | Optionality | Notes |
Data Consumer | Retrieve Patient Summary [CA:FeX-3D] | /Patient/$summary /Patient/[id]/$summary | R | Based on IPS |
Data Responder | Retrieve Patient Summary [CA:FeX-3D] | /Patient/$summary /Patient/[id]/$summary | R | Based on IPS |
...