Summary of Patient Interactions

The API exposes one FHIR operation, and three FHIR interactions:

  1. Patient $match
  2. Patient Search by ID
  3. Patient Search by MRN
  4. Patient Read

Patient $match

FHIR Operation: $match

HTTP Method: POST

Invocations

URL: [base]/Patient/$match

Parameters (In)

NameCardinalityTypeDocumentation
[Patient]1..1Patient

This is a set of matching criteria in patient demographics.

Return Values (Out)

NameCardinalityTypeDocumentation
bundle1..1Bundle

The patient matching results in a bundle (of type 'searchset') containing the following resources (if any): Patient, OperationOutcome. The OperationOutcome contains any errors or warnings related to this operation if any.

Patients can be matched by their last and first names (mandatory), date of birth (mandatory), date of death, administrative gender and address.

As specified by Client Registry Services (CRS), a minimum search criteria has to be met for patient search to be sucessful.
Minimum search criteria is a combination of

Patient Last Name + First Name + Date of Birth

Addition optional search criteria:

Administrative gender, Date of death, Address

This transaction returns a list of maximum 10 patient resources in a FHIR bundle. Only the most recent patient demographics from EMPI are included in this response. For detail patient demographics, a subsequent call to a Read operation is suggested.

An example of patient $match request and response:

Patient $match Request Body

Patient $match Result in a Bundle

Patient Search by ID

FHIR Interaction: _id

HTTP Method: GET

URL: [base]/Patient?_id=[BC PHN]

Parameters (In)

Name Cardinality Type Documentation
id 1..1 id Patient's BC PHN

Return Values (Out)

Name Cardinality Type Documentation
bundle 1..1 Bundle A Bundle consists of a Patient resource and/or an OperationOutcome

This transaction takes the patient's BC PHN as the parameter and returns a Patient resource containing detail patient demographics from EMPI. Patient demographics may include previous names, addresses and telecom contact information used in the past.

An example of patient search by PHN request and response:

[base]/Patient?_id=9698656164

Sample response

Patient Search by MRN

FHIR Interaction: ?

HTTP Method: GET

URL: [base]/Patient?identifier=[systrem URI for MRN]|[MRN]

Parameters (In)

Name Cardinality Type Documentation
identifier 1..1 uri+string The system URI assigned to the MRN and the value of MRN, separated by a pipe delimiter. For a list of MRN system URIs, refer to Patient Identifiers.

Return Values (Out)

Name Cardinality Type Documentation
bundle 1..1 Bundle A Bundle consists of a Patient resource and/or an OperationOutcome.

This transaction takes the patient's local MRN or SRI as the parameter and returns a detail patient demographics from EMPI. Patient demographics may include previous names, addresses and telecom contact information used in the past.

An example of patient search by MRN request and response:

 [base]/Patient?identifier=https://fhir.infoway-inforoute.ca/NamingSystem/ca-bc-phsa-vpp-cerner-patient-medical-record-number|700002499

Sample response

Patient Read

FHIR Interaction: /

HTTP Method: GET

URL: [base]/Patient/[BC PHN]

Parameters (In)

Name Cardinality Type Documentation
[Patient.id] 1..1 id Patient resource ID

Return Values (Out)

Name Cardinality Type Documentation
Patient 1..1 Patient Patient resource or possibilly OperationOutcome

This transaction performs the FHIR read operation on the resource based on resource.id which is the patient's current active PHN. The query response is Patient resource with detail patient demographics that may include previous names, addresses and telecom contact information used in the past.

An example of patient read request and responses:

 [base]/Patient/9698656164

Sample response