Patient Resource

Patient is a FHIR resource that is used to represent a person "receiving care or other health-related services". FHIR Patients are mapped to OpenMRS Patient objects.

Supported Elements

The following properties are supported by the OpenMRS FHIR Module:

  • Patient.id

  • Patient.identifier

  • Patient.active

  • Patient.name

  • Patient.telecom (phone)

  • Patient.gender

  • Patient.birthDate

  • Patient.deceased[x]

  • Patient.address

OpenMRS ↔ FHIR Mapping

OpenMRS Data Model

FHIR Resource Element

Notes

OpenMRS Data Model

FHIR Resource Element

Notes

Patient.uuid

Patient.id

 

Patient.activeIdentifiers

Patient.identifier

 

Patient.name

Patient.name

 

Person.personAttribute

Person.telecom (phone)

The attribute used is determined by the fhir2.personContactPointAttributeTypeUuid global property

Patient.gender

Patient.gender

 

Patient.birthdate

Patient.birthDate

 

Patient.deathDate or Patient.dead

Patient.deceased[x]

 

Patient.address

Patient.address

 

not Patient.voided

Patient.active

 

Available RESTful Endpoints

Note: placeholder "{release}" below must be replaced by the FHIR Release - currently "R3" and "R4" are implemented. See more on the  FHIR Release support  page.

GET

URL

Description

URL

Description

/ws/fhir2/{release}/Patient

Gets all patients

/ws/fhir2/{release}/Patient/{uuid}

Gets a specific patient

/ws/fhir2/{release}/Patient?{query}

Searches for patients matching the provided criteria

Supported Search Parameters

Parameter

Type

Description

Parameter

Type

Description

name

string

Searches the full name of the patient

given

string

Searches the given name(s) of the patient

family

string

Searches the family name of the patient

identifier

token

Searches based on the patients identifiers

gender

token

Searches based on the gender of the patient. Note that this value must be from the AdministrativeGender valueset

birthdate

date

Searches based on the patient's birthdate

death-date

date

Searches based on the death date of the patient (if any)

deceased

token

Searches based on whether a patient is marked as deceased. Acceptable values are true or false

address-city

string

Searches based on the patient's recorded city/village of address

address-state

string

Searches based on the patient's recorded state/province of address

address-postalcode

string

Searches based on the patient's recorded postal code of address

address-country

string

Searches based on the patient's recorded country of address

_id

 

Searches based on the exact UUID of the patient record

_lastUpdated

date

Searches based on the the dateCreated or dateUpdated field for the patient record

Supported _revincludes

Include

Description

Include

Description

Observation:patient

Includes observations that are about this patient

AllergyIntolerance:patient

Includes allergies of this patient

DiagnosticReport:patient

Includes any diagnostic reports about this patient

Encounter:patient

Includes any encounters involving this patient

MedicationRequest:patient

Includes any drug orders involving this patient

ServiceRequest:patient

Includes any test orders involving this patient

POST

URL

Description

URL

Description

/ws/fhir2/{release}/Patient

Creates a new patient

PUT

URL

Description

URL

Description

/ws/fhir2/{release}/Patient/{uuid}

Updates an existing patient

DELETE

URL

Description

URL

Description

/ws/fhir2/{release}/Patient/{uuid}

Deletes (voids) an existing patient