CI Build - This specification is a draft continuous integration build and is 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
Search Parameters
CA:FeX search requirements are limited to FHIR document exchange. For general search behaviour, see the FHIR RESTful Search API.
FHIR document Bundle search
The following CA:FeX SearchParameters search the Composition contained in a FHIR document Bundle:
- CAFeXBundleCompositionPatient
- CAFeXBundleCompositionPatientIdentifier
- CAFeXBundleCompositionType
- CAFeXBundleCompositionDate
- CAFeXBundleCompositionStatus
- CAFeXBundleCompositionAuthor
- CAFeXBundleCompositionCategory
CA:FeX also uses the base FHIR Bundle-timestamp SearchParameter.
DocumentReference search
The CA:FeX Server CapabilityStatement uses the following US Core 6.1.0 SearchParameters unchanged:
- DocumentReference
_id - DocumentReference
patient - DocumentReference
status - DocumentReference
category - DocumentReference
type - DocumentReference
date - DocumentReference
period
The $docref operation requires the patient input to contain a Patient logical ID. Patient name, given, and family, and Practitioner name, are not $docref input parameters. A client may use a separate Patient lookup to obtain the logical ID, but that lookup is not a CA:FeX document-exchange search requirement.
See Capability Statements for conformance expectations.