Patient

The MediRecords FHIR API supports the following Patient operations.

Search

GET {API_URL}/v1/Patient

This API interface enables the client to search Patient instances from MediRecords repository. This is in compliance with the MediRecords Patient profile.

• When searched with ‘identifier’, a Patient’s ‘family’, ‘birthdate’ and ‘gender’ must be provided in the search criteria.

• When searched with ‘phone’, ‘telecom’ must be provided in the search criteria. For example:
  /Patient?phone=0412030741&telecom=mobile
  NOTE: the above use of telecom is not compliant with FHIR specification

• By default, only active patients will be returned in search results. Use parameter &active=false to retreive inactive patients.

Response

The server returns matching Patient instances in a Bundle that the logged-in user has access to. If no search criteria is provided, then all Patient instances that the logged-in user has access to will be returned.

In an error situation, server SHALL return OperationOutcome detailing the error with the appropriate HTTP Error code as follows.

Read

GET {API_URL}/v1/Patient/{id}

This API interface enables the client to read an Patient resource from MediRecords repository which is compliant with the MediRecords Patient profile.

Response

In an error situation, server SHALL return OperationOutcome detailing the error with the appropriate HTTP Error code as follows.

Create

POST {API_URL}/v1/Patient

This API interface enables the client to create a Patient resource in MediRecords repository which is compliant with the MediRecords Patient profile.

Request Body

Request body that creates a new Patient resource

Response

In an error situation, server SHALL return OperationOutcome detailing the error with the appropriate HTTP Error code as follows.

Update

PUT {API_URL}/v1/Patient/{id}

This API interface enables the client to update a specific Patient resource instance existed in MediRecords repository which is compliant with the MediRecords Patient profile.

Request Body

Request body that updates an existing Patient record details

Response

In an error situation, server SHALL return OperationOutcome detailing the error with the appropriate HTTP Error code as follows.

Delete

DELETE {API_URL}/v1/Patient/{id}

This API interface enables the client to delete a specific Patient resource instance from MediRecords repository.

Response

In an error situation, server SHALL return OperationOutcome detailing the error with the appropriate HTTP Error code as follows.

Webhook

The following table provides the FHIR Webhook event types generated for the Patient resource.

Bundle
  Patient (1) 
  PractitionerRole (0..1) 
  Practitioner (0..1) 
  Organization (0..2)

Bundle
  request (1)
    url: DELETE Patient/{id}