Technical Actors

The figure below illustrates the actors involved in CA:FeX and the relevant transactions between them.

The overview illustrates the transaction flow. For CA:FeX-1B, the MHD $generate-metadata definition returns a reference to the generated DocumentReference; the image's generic acknowledgement label does not specify that response payload. CA:FeX-2A returns a searchset Bundle containing matching document Bundles, as described in Document Exchange.

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 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 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 Responder

The Data Responder returns data matching the criteria submitted by a Data Consumer, as 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 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: