Skip to main content

Patient

ResourceBase · IndividualsNormativeMaturity 5

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

Tested supportFull test results →
Backends
PostgreSQLElasticsearch
Interactions
CreateReadUpdatePatchDelete
Search
23 of 23 parameters tested

Structure​

ElementCard.TypeDescription
identifierΣ
0..*IdentifierAn identifier for this patient
active?!Σ
0..1booleanWhether this patient's record is in active use
nameΣ
0..*HumanNameA name associated with the patient
telecomΣ
0..*ContactPointA contact detail for the individual
genderΣ
0..1codemale | female | other | unknownBinding (required): administrative-gender
birthDateΣ
0..1dateThe date of birth for the individual
deceased[x]?!Σ
0..1boolean | dateTimeIndicates if the individual is deceased or not
addressΣ
0..*AddressAn address for the individual
maritalStatus
0..1CodeableConceptMarital (civil) status of a patientBinding (extensible): marital-status
multipleBirth[x]
0..1boolean | integerWhether patient is part of a multiple birth
photo
0..*AttachmentImage of the patient
contact
0..*BackboneElementA contact party (e.g. guardian, partner, friend) for the patient
relationship
0..*CodeableConceptThe kind of relationshipBinding (extensible): patient-contactrelationship
name
0..1HumanNameA name associated with the contact person
telecom
0..*ContactPointA contact detail for the person
address
0..1AddressAddress for the contact person
gender
0..1codemale | female | other | unknownBinding (required): administrative-gender
organization
0..1Reference(Organization)Organization that is associated with the contact
period
0..1PeriodThe period during which this contact person or organization is valid to be contacted relating to this patient
communication
0..*BackboneElementA language which may be used to communicate with the patient about his or her health
languageRequired
1..1CodeableConceptThe language which can be used to communicate with the patient about his or her healthBinding (preferred): languages
preferred
0..1booleanLanguage preference indicator
generalPractitioner
0..*Reference(Organization | Practitioner | PractitionerRole)Patient's nominated primary care provider
managingOrganizationΣ
0..1Reference(Organization)Organization that is the custodian of the patient record
otherRequiredΣ
1..1Reference(Patient | RelatedPerson)The other patient or related person resource that the link refers to
typeRequiredΣ
1..1codereplaced-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.

ParameterTypeDescriptionPGES
activetoken

Whether the patient record is active

Patient.active
addressstring

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-citystring

A city specified in an address

Patient.address.city
address-countrystring

A country specified in an address

Patient.address.country
address-postalcodestring

A postalCode specified in an address

Patient.address.postalCode
address-statestring

A state specified in an address

Patient.address.state
address-usetoken

A use code specified in an address

Patient.address.use
birthdatedate

The patient's date of birth

Patient.birthDate
death-datedate

The date of death has been provided and satisfies this search value

(Patient.deceased.ofType(dateTime))
deceasedtoken

This patient has been marked as deceased, or as a death date entered

Patient.deceased.exists() and Patient.deceased != false
emailtoken

A value in an email contact

Patient.telecom.where(system='email')
familystring

A portion of the family name of the patient

Patient.name.family
gendertoken

Gender of the patient

Patient.gender
general-practitionerreference

Patient's nominated general practitioner, not the organization that manages the record

Patient.generalPractitioner
givenstring

A portion of the given name of the patient

Patient.name.given
identifiertoken

A patient identifier

Patient.identifier
languagetoken

Language code (irrespective of use value)

Patient.communication.language
namestring

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
organizationreference

The organization that is the custodian of the patient record

Patient.managingOrganization
phonetoken

A value in a phone contact

Patient.telecom.where(system='phone')
phoneticstring

A portion of either family or given name using some kind of phonetic matching algorithm

Patient.name
telecomtoken

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-authorreference

The author of the resource

_idtoken

Logical id of this artifact

_lastUpdateddate

When the resource version last changed

_profileuri

Profiles this resource claims to conform to

_securitytoken

Security Labels applied to this resource

_sourceuri

Identifies where the resource comes from

_tagtoken

Tags applied to this resource

_typetoken

Derived from the R4B Definition

Operations​

Invoke with POST [base]/Patient/$[name] on the type, or POST [base]/Patient/[id]/$[name] on one resource, sending a Parameters resource as the body. See invoke-type and invoke-instance.

$everything

TypeInstance

Fetch Patient Record

This operation is used to return all the information related to one or more patients described in the resource or context on which this operation is invoked. The response is a bundle of type "searchset". At a minimum, the patient resource(s) itself is returned, along with any other resources that the server has that are related to the patient(s), and that are available for the given user. The server also returns whatever resources are needed to support the records - e.g. linked practitioners, medications, locations, organizations etc.

The intended use for this operation is to provide a patient with access to their entire record (e.g. "Blue Button"), or for provider or other user to perform a bulk data download. The server SHOULD return at least all resources that it has that are in the patient compartment for the identified patient(s), and any resource referenced from those, including binaries and attachments. In the US Realm, at a minimum, the resources returned SHALL include all the data covered by the meaningful use common data elements as defined in the US Core Implementation Guide. Other applicable implementation guides may make additional rules about how much information that is returned.

POST [base]/Patient/$everythingPOST [base]/Patient/[id]/$everything
Parameters: 5 in, 1 out
NameCard.TypeDescription
In
start0..1date

The date range relates to care dates, not record currency dates - e.g. all records relating to care provided in a certain date range. If no start date is provided, all records prior to the end date are in scope.

end0..1date

The date range relates to care dates, not record currency dates - e.g. all records relating to care provided in a certain date range. If no end date is provided, all records subsequent to the start date are in scope.

_since0..1instant

Resources updated after this period will be included in the response. The intent of this parameter is to allow a client to request only records that have changed since the last request, based on either the return header time, or or (for asynchronous use), the transaction time

_type0..*code

One or more parameters, each containing one or more comma-delimited FHIR resource types to include in the return resources. In the absence of any specified types, the server returns all resource types

_count0..1integer

See discussion below on the utility of paging through the results of the $everything operation

Out
return1..1Bundle

The bundle type is "searchset"