Patient
Demographics and other administrative information about an individual or animal receiving care or other health-related services.
- Backends
- PostgreSQLElasticsearch
- Interactions
- CreateReadUpdatePatchDelete
- Search
- 23 of 23 parameters tested
Structure
| 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. The author of the resource Logical id of this artifact When the resource version last changed Profiles this resource claims to conform to Security Labels applied to this resource Identifies where the resource comes from Tags applied to this resource Derived from the R4B DefinitionCommon parameters on every resource (8)
_haste-health-authorreference _idtoken _lastUpdateddate _profileuri _securitytoken _sourceuri _tagtoken _typetoken
Operations
Invoke with 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. 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. 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. 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 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 See discussion below on the utility of paging through the results of the $everything operation The bundle type is "searchset"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
TypeInstancePOST [base]/Patient/$everythingPOST [base]/Patient/[id]/$everythingParameters: 5 in, 1 out
Name Card. Type Description In start 0..1 date end 0..1 date _since 0..1 instant _type 0..* code _count 0..1 integer Out return 1..1 Bundle