Patient

A Patient resource represents an individual receiving medical care.

Overview

See the FHIR documentation for more information about Patient resources.

Mapped Concepts in HIEBus

• Patient
• RecordGroup

Supported Interactions

Patient resources support the following interactions.

• create
• delete
• read
• search
• update

Search Parameters

When searching for Patient resources, the following search parameters are supported.

Name	Type	Prefixes Modifiers	Can be Chained?	Description
_id	Token			Resource id.
_source	Uri	:missing		Where the resource comes from.
address	String	:contains  :exact  :missing		A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text.
address-city	String	:contains  :exact  :missing		A city specified in an address.
address-country	String	:contains  :exact  :missing		A country specified in an address.
address-postalcode	String	:contains  :exact  :missing		A postalCode specified in an address.
address-state	String	:contains  :exact  :missing		A state specified in an address.
age	Number	lt  le  gt  ge  :missing		Searches for patients based on age as calculated based on current date and date of birth. Deceased patients are excluded from the search.
birthdate	Date	ne  lt  le  gt  ge  sa  eb  ap  :missing		The patient's date of birth.
ethnicity	Token	:not  :in  :notin  :missing		Returns patients with an ethnicity extension matching the specified code.
family	String	:contains  :exact  :missing		A portion of the family name of the patient.
gender	Token	:missing		Gender of the patient.
given	String	:contains  :exact  :missing		A portion of the given name of the patient.
identifier	Token	:missing		A patient identifier.
language	Token	:not  :in  :notin  :missing		Language code (irrespective of use value).
name	String	:contains  :exact  :missing		A server defined search that may match any of the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or text.
provenance-agent	Reference	:missing	yes	Search by provenance, specified by its author (aka originator) Organization.
race	Token	:not  :in  :notin  :missing		Returns patients with a race extension matching the specified code.
telecom	Token	:missing		The value in any kind of telecom details of the patient.

Sortable Parameters

When searching Patient resources, it is possible to sort the returned values by the following search parameters.

• name
• address
• address-city
• address-country
• address-postalcode
• address-state
• birthdate
• family
• given
• telecom
• _id

Only one sort parameter may be specified.

Supported Includes

When searching Patient resources, it is possible to include the resources referenced by the following field names.

• Provenance Agent

---

Back to Resources