Patient

ResourceBase · IndividualsNormativeMaturity 5

Demographics and other administrative information about an individual or animal receiving care or other health-related services.

StructureSearch parametersHL7 specificationStructureDefinition JSON

Tested supportFull test results →

Backends

PostgreSQLElasticsearch

Interactions

CreateReadUpdatePatchDelete

Search

23 of 23 parameters tested

Structure

Show inherited elements (17)

Element	Card.	Type	Description
identifierΣ	0..*	Identifier	An identifier for this patient
active?!Σ	0..1	boolean	Whether this patient's record is in active use
nameΣ	0..*	HumanName	A name associated with the patient
telecomΣ	0..*	ContactPoint	A contact detail for the individual
genderΣ	0..1	code	male | female | other | unknownBinding (required): administrative-gender
birthDateΣ	0..1	date	The date of birth for the individual
deceased[x]?!Σ	0..1	boolean | dateTime	Indicates if the individual is deceased or not
addressΣ	0..*	Address	An address for the individual
maritalStatus	0..1	CodeableConcept	Marital (civil) status of a patientBinding (extensible): marital-status
multipleBirth[x]	0..1	boolean | integer	Whether patient is part of a multiple birth
photo	0..*	Attachment	Image of the patient
contact	0..*	BackboneElement	A contact party (e.g. guardian, partner, friend) for the patient
relationship	0..*	CodeableConcept	The kind of relationshipBinding (extensible): patient-contactrelationship
name	0..1	HumanName	A name associated with the contact person
telecom	0..*	ContactPoint	A contact detail for the person
address	0..1	Address	Address for the contact person
gender	0..1	code	male | female | other | unknownBinding (required): administrative-gender
organization	0..1	Reference(Organization)	Organization that is associated with the contact
period	0..1	Period	The period during which this contact person or organization is valid to be contacted relating to this patient
communication	0..*	BackboneElement	A language which may be used to communicate with the patient about his or her health
languageRequired	1..1	CodeableConcept	The language which can be used to communicate with the patient about his or her healthBinding (preferred): languages
preferred	0..1	boolean	Language preference indicator
generalPractitioner	0..*	Reference(Organization | Practitioner | PractitionerRole)	Patient's nominated primary care provider
managingOrganizationΣ	0..1	Reference(Organization)	Organization that is the custodian of the patient record
link?!Σ	0..*	BackboneElement	Link to another patient resource that concerns the same actual person
otherRequiredΣ	1..1	Reference(Patient | RelatedPerson)	The other patient or related person resource that the link refers to
typeRequiredΣ	1..1	code	replaced-by | replaces | refer | seealsoBinding (required): link-type

Σ in _summary results · ?! modifier element · 1.. required · inherited elements in grey

Search parameters

Query with GET [base]/Patient?[parameter]=[value]. Type decides which modifiers and prefixes apply, see search features.

Parameter	Type	Description	PG	ES
active	token	Whether the patient record is active Patient.active
address	string	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 Patient.address
address-city	string	A city specified in an address Patient.address.city
address-country	string	A country specified in an address Patient.address.country
address-postalcode	string	A postalCode specified in an address Patient.address.postalCode
address-state	string	A state specified in an address Patient.address.state
address-use	token	A use code specified in an address Patient.address.use
birthdate	date	The patient's date of birth Patient.birthDate
death-date	date	The date of death has been provided and satisfies this search value (Patient.deceased.ofType(dateTime))
deceased	token	This patient has been marked as deceased, or as a death date entered Patient.deceased.exists() and Patient.deceased != false
email	token	A value in an email contact Patient.telecom.where(system='email')
family	string	A portion of the family name of the patient Patient.name.family
gender	token	Gender of the patient Patient.gender
general-practitioner	reference	Patient's nominated general practitioner, not the organization that manages the record Patient.generalPractitioner
given	string	A portion of the given name of the patient Patient.name.given
identifier	token	A patient identifier Patient.identifier
language	token	Language code (irrespective of use value) Patient.communication.language
link	reference	All patients linked to the given patient Patient.link.other
name	string	A server defined search that may match any of the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or text Patient.name
organization	reference	The organization that is the custodian of the patient record Patient.managingOrganization
phone	token	A value in a phone contact Patient.telecom.where(system='phone')
phonetic	string	A portion of either family or given name using some kind of phonetic matching algorithm Patient.name
telecom	token	The value in any kind of telecom details of the patient Patient.telecom

PG: PostgreSQL, ES: Elasticsearch. passes its TestScript checks, fails, not tested yet.

Common parameters on every resource (8)

_haste-health-author	reference	The author of the resource
_id	token	Logical id of this artifact
_lastUpdated	date	When the resource version last changed
_profile	uri	Profiles this resource claims to conform to
_security	token	Security Labels applied to this resource
_source	uri	Identifies where the resource comes from
_tag	token	Tags applied to this resource
_type	token	Derived from the R4B Definition