Person Resource

Person is a FHIR resource that is used to represent "demographics and administrative information about a person independent of a specific health-related context." FHIR Persons are mapped to OpenMRS Person objects.

Supported Elements

The following properties are supported by the OpenMRS FHIR Module:

Person.id
Person.name
Person.telecom
Person.gender
Person.birthDate
Person.address
Person.link

OpenMRS ↔ FHIR Mapping

OpenMRS Data Model	FHIR Resource Element	Notes

OpenMRS Data Model	FHIR Resource Element	Notes
`Person.uuid`	`Person.id`
`Person.name`	`Person.name`
`Person.personAttribute`	`Person.telecom (phone)`	The attribute used is determined by the `fhir2.personContactPointAttributeTypeUuid` global property
`Person.gender`	`Person.gender`
`Person.birthdate`	`Person.birthDate`	Estimated birthdates report month and year for people 5 and under or only year for people older than 5
`Person.address`	`Person.address`
`Person is a Patient? link to Patient : nothing`	`Person.link`

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}/Person`	Gets all persons
`/ws/fhir2/{release}/Person/{uuid}`	Gets a specific person
`/ws/fhir2/{release}/Person?{query}`	Searches for person matching the given criteria

Supported Search Parameters

Parameter	Type	Description

Parameter	Type	Description
`name`	string	Searches the full name of the person
`gender`	token	Searches based on the gender of the person. Note that this value must be from the AdministrativeGender valueset
`birthdate`	date	Searches based on the person's birthdate
`address-city`	string	Searches based on the person's recorded city/village of address
`address-state`	string	Searches based on the person's recorded state/province of address
`address-postalcode`	string	Searches based on the person's recorded postal code of address
`address-country`	string	Searches based on the person's recorded country of address
`_id`	token	Searches based on the exact UUID of the person record
`_lastUpdated`	date	Searches based on the the dateCreated or dateUpdated field for the person record

Supported _includes

Include	Description

Include	Description
`Person:link:Patient`	Includes the patient record linked to this person if any
`Person:patient`	Includes the patient record linked to this person if any

POST

URL	Description

URL	Description
`/ws/fhir2/{release}/Person`	Creates a new person

PUT

URL	Description

URL	Description
`/ws/fhir2/{release}/Person/{uuid}`	Updates an existing person

DELETE

URL	Description

URL	Description
`/ws/fhir2/{release}/Person/{uuid}`	Deletes (voids) an existing person