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
Technical Actors
The figure below illustrates the actors involved in CA:FeX and the relevant transactions between them.
Actor | Transactions | Description |
---|---|---|
Data Source | - CA:FeX-1A - CA:FeX-1B - CA:FeX-1C |
Submits data to a Data Recipient |
Data Consumer | - CA:FeX-2A - CA:FeX-2B - CA:FeX-2C - CA:FeX-3A - CA:FeX-3B - CA:FeX-3C - CA:FeX-3D |
Queries a Data Responder and retrieves data matching criteria |
Data Recipient | - CA:FeX-1A - CA:FeX-1B - CA:FeX-1C |
Receives data from a Data Source |
Data Responder | - CA:FeX-2A - CA:FeX-2B - CA:FeX-2C - CA:FeX-3A - CA:FeX-3B - CA:FeX-3C - CA:FeX-3D |
Returns data matching a set of criteria queried by Data Consumer |
Actor Conformance
In order to implement a system that supports the CA:FeX Interoperability Specifications, the system shall be able to demonstrate conformance to every required transaction for the specific actor(s) and option(s) for which it is claiming conformance.
Data Source
The Data Source submits data to a Data Recipient in the appropriate format defined by the transaction. The following CapabilityStatements describe the behaviour based on the Actor Option:
- Data Source with Bundle Option CA:FeX CapabilityStatement - Data Source - Option A (Submit FHIR Document)
- Data Source with Metadata Option CA:FeX CapabilityStatement - Data Source - Option B (Metadata)
- Data Source with Single Resource Option CA:FeX CapabilityStatement - Data Source - Option C (Submit Resource)
Data Consumer
The Data Consumer queries a Data Responder to retrieve data matching a set of criteria defined by the transaction.
- Data Consumer with Bundle Option CA:FeX CapabilityStatement - Data Consumer - Option A (Search and Retrieve FHIR Document)
- Data Consumer with Metadata Option CA:FeX CapabilityStatement - Data Consumer - Option B (Metadata Option)
- Data Consumer with Single Resource Option CA:FeX CapabilityStatement - Data Consumer - Option C (Single Resource Option)
- Data Consumer with Summary Option CA:FeX CapabilityStatement - Data Consumer - Option D (Summary Option)
Data Recipient
The Data Recipient receives data from a Data Source and their response is defined by the transaction.
- Data Recipient with Bundle Option CA:FeX CapabilityStatement - Data Recipient - Option A (Accept FHIR Document)
- Data Recipient with Metadata Option CA:FeX CapabilityStatement - Data Recipient - Option B (Metadata)
- Data Recipient with Single Resource Option CA:FeX CapabilityStatement - Data Recipient - Option C (Submit Resource)
Data Responder
The Data Responder returns data matching a set of criteria queried by a Data Responder defined by the transaction.
- Data Responder with Bundle Option CA:FeX CapabilityStatement - Data Responder - Option A (Search and Retrieve FHIR Document)
- Data Responder with Metadata Option CA:FeX CapabilityStatement - Data Responder - Option B (Metadata)
- Data Responder with Single Resource Option CA:FeX CapabilityStatement - Data Responder - Option C (Single Resource Option)
- Data Responder with Summary Option CA:FeX CapabilityStatement - Data Responder - Option D (Summary Option)
Constraints on Actors
This section captures design constraints on Actors when developing functionality to support the services mapped to them. The following section provides key design constraints for the implementation of these required services using RESTful APIs based on CA:FeX and FHIR standards.
Note:
The scope of this section is limited to the constraints applicable to actors and transactions defined for the CA:FeX Interoperability Specifications.
The key services supported by CA:FeX are:
Service Supported | Actors | FHIR RESTful Transactions |
---|---|---|
Submit Data | Data Source Data Recipient |
- CA:FeX-1A - CA:FeX-1B - CA:FeX-1C |
Search Data | Data Consumer Data Recipient |
- CA:FeX-2A - CA:FeX-2B - CA:FeX-2C |
Retrieve Data | Data Consumer Data Recipient |
- CA:FeX-3A - CA:FeX-3B - CA:FeX-3C - CA:FeX-3D |