Visit the HL7 website
Visit the FHIR website

Pan-Canadian FHIR Exchange (CA:FeX) IGuide 2.2.0 DFT-Ballot

2.2.0-DFT-Ballot   Canada flag
  • Home
  • Business Context
    • Project Background
    • Scope
    • Relationship to Other Specifications
    • Use Cases
  • Technical Context
    • Overview
    • FHIR Exchange Paradigms
    • Sequence Diagrams
    • Actor Mapping to Interoperability Specification
    • Security
  • Actor and Conformance Options
    • Technical Actors
    • Actor Options
    • Conformance Requirements
  • FHIR Artifacts
    • Profiles and Extensions
    • Search Parameters
    • Operations
    • Capability Statements
  • Change Log
    • Change Log
    1. Home
    2. FHIR Artifacts
    3. Search Parameters

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

Search Parameters

The following search parameters have been defined for the CA:FeX. For more information on the FHIR RESTful Search API and the standard see the FHIR specification.

Search Parameters defined by CA:FeX

The following custom search parameters have been added to CA:FeX:

  • CAFeXClinicalPatient
  • CAFeXPatientName
  • CAFeXPatientFamily
  • CAFeXPatientGiven
  • CAFeXPractitionerName
  • CAFeXBundleCompositionPatient
  • CAFeXBundleCompositionPatientIdentifier
  • CAFeXBundleCompositionType
  • CAFeXBundleCompositionDate
  • CAFeXBundleCompositionstatus
  • CAFeXBundleCompositionauthor
  • CAFeXBundleCompositionCategory

Search Parameters from or derived from the Base FHIR Specification

CA:FeX references the following 'standard' HL7 search parameters:

  • Bundle-timestamp
  • Composition-status
  • Composition-author
  • Composition-category

CA:FeX also uses the US Core Search Parameters below which constrain the ‘standard’ HL7 search parameters to explicitly declare conformance expectations for the following elements. This is done to enable the combination of search parameters.

  • http://hl7.org/fhir/us/core/SearchParameter/us-core-allergyintolerance-clinical-status
  • http://hl7.org/fhir/us/core/SearchParameter/us-core-condition-category
  • http://hl7.org/fhir/us/core/SearchParameter/us-core-condition-clinical-status
  • http://hl7.org/fhir/us/core/SearchParameter/us-core-condition-onset-date
  • http://hl7.org/fhir/us/core/SearchParameter/us-core-condition-code
  • http://hl7.org/fhir/us/core/SearchParameter/us-core-diagnosticreport-status
  • http://hl7.org/fhir/us/core/SearchParameter/us-core-diagnosticreport-category
  • http://hl7.org/fhir/us/core/SearchParameter/us-core-diagnosticreport-code
  • http://hl7.org/fhir/us/core/SearchParameter/us-core-diagnosticreport-date
  • http://hl7.org/fhir/us/core/SearchParameter/us-core-documentreference-id
  • http://hl7.org/fhir/us/core/SearchParameter/us-core-documentreference-status
  • http://hl7.org/fhir/us/core/SearchParameter/us-core-documentreference-category
  • http://hl7.org/fhir/us/core/SearchParameter/us-core-documentreference-type
  • http://hl7.org/fhir/us/core/SearchParameter/us-core-documentreference-date
  • http://hl7.org/fhir/us/core/SearchParameter/us-core-documentreference-period
  • http://hl7.org/fhir/us/core/SearchParameter/us-core-immunization-status
  • http://hl7.org/fhir/us/core/SearchParameter/us-core-immunization-date
  • http://hl7.org/fhir/us/core/SearchParameter/us-core-medicationrequest-status
  • http://hl7.org/fhir/us/core/SearchParameter/us-core-medicationrequest-intent
  • http://hl7.org/fhir/us/core/SearchParameter/us-core-medicationrequest-authoredon
  • http://hl7.org/fhir/us/core/SearchParameter/us-core-observation-status
  • http://hl7.org/fhir/us/core/SearchParameter/us-core-observation-category
  • http://hl7.org/fhir/us/core/SearchParameter/us-core-observation-code
  • http://hl7.org/fhir/us/core/SearchParameter/us-core-observation-date
  • http://hl7.org/fhir/us/core/SearchParameter/us-core-patient-id
  • http://hl7.org/fhir/us/core/SearchParameter/us-core-patient-identifier
  • http://hl7.org/fhir/us/core/SearchParameter/us-core-patient-birthdate
  • http://hl7.org/fhir/us/core/SearchParameter/us-core-patient-gender
  • http://hl7.org/fhir/us/core/SearchParameter/us-core-practitioner-identifier
  • http://hl7.org/fhir/us/core/SearchParameter/us-core-practitioner-id
  • http://hl7.org/fhir/us/core/SearchParameter/us-core-practitionerrole-specialty
  • http://hl7.org/fhir/us/core/SearchParameter/us-core-practitionerrole-practitioner
  • http://hl7.org/fhir/us/core/SearchParameter/us-core-procedure-status
  • http://hl7.org/fhir/us/core/SearchParameter/us-core-procedure-date
  • http://hl7.org/fhir/us/core/SearchParameter/us-core-procedure-code

To see a full list of SearchParameter expectations by resource, see Capability Statements

Table of Contents | IG © based on FHIR R4 | Package package:ca.infoway.io.cafex@2.2.0-DFT-Ballot | Version History
HL7® and FHIR® are the registered trademarks of Health Level Seven International