Resources: DSTU2: Patient

Patient resource

The Patient resource is used to retrieve a specific patient's information (DAF Patient) including the patient's ID which can be used for other FHIR actions.

To retrieve a patient, use the following syntax:

GET {FHIR URL}/FHIR/Patient?{search string}&{search string}


GET {FHIR URL}/FHIR/Patient?given=Allison

Returns all patients with the first name "Allison."

GET {FHIR URL}/FHIR/Patient?given=Allison&gender=female

Returns all female patients with the first name "Allison."

GET {FHIR URL}/FHIR/Patient?given=Allison&gender=female&birthdate=1973-03-05

Returns all female patients with the first name "Allison" who were born on 3-5-1973.

GET {FHIR URL}/FHIR/Patient?ID=123

Returns the patient with the ID of 123.

Input parameters

Name Required? Type Description
name No string Portion of either the family or given name of the patient.
_id No string Logical ID of the patient.
family No string Portion of the family (last) name of the patient.
given No string Portion of the given (first) name of the patient.
gender No token Patient's gender. For more information on this value set, see here.
birthdate No date Patient's date of birth.
identifier No token Patient's identifier. For example, MRN.

Output specification

Name Type Cardinality Description
identifier Identifier 0..* Patient's identifier. Patients are usually assigned a specific numerical identifier that is unique within the system.
active boolean 0..1 Is the patient's record active? The default value is true. You must be able to mark a patient record as not to be used because it was created in error. If a record is inactive, and linked to an active record, then future patient/record updates should occur on the other patient.
name HumanName 0..* Name associated with the patient.
telecom ContactPoint 0..* Patient contact communication detail. This indicates the value in any kind of telecom details field for the patient. If capturing a phone, fax, or similar contact point, the value is a properly formatted telephone number according to ITU-T E.123. However, this is frequently not possible due to legacy data and/or clerical practices when recording contact details. For this reason, phone, fax, page, and email addresses are not handled as formal URLs.
gender code 0..1 Patient's gender. Returns Male, Female, Other, or Unknown. For more information on this value set, see here.
birthDate date 0..1 Patient's date of birth. This indicates a specific calendar date or partial date (either a year or a month and year combination). Time zone is not included. Fuzzy (approximate) dates are not valid.
deceasedBoolean boolean 0..1 Is the patient deceased? If a patient is deceased, it influences the clinical process and human communication. If this value is blank, most systems interpret the missing information as an indication that the patient is alive.
address Address 0..* Patient's postal address. Postal addresses are often used to record a location that can be visited to find a patient or person.
maritalStatus CodeableConcept 0..1 Patient marital (civil) status. For more information on this value set, see here.
multipleBirthBoolean boolean 0..1 Was the patient part of a multiple birth?
contact 0..* Patient's contact party. For example, Guardian, Partner, or Friend.
-- contact.relationship CodeableConcept 0..* Patient contact's relationship with the patient. For more information on this value set, see here.
-- HumanName 0..1 Patient contact's name.
-- contact.telecom ContactPoint 0..* Patient contact's detailed information.
-- contact.address Address 0..1 Patient contact's address.
communication.language CodeableConcept 0..* Language used to communicate with the patient about their health. For more information on this value set, see here.
careProvider Reference (Practitioner) 0..* Patient's nominated primary care provider.
us-core-race CodeableConcept 0..1 Patient's race (category of humans sharing history, origin, or nationality). For more information on this value set, see here.
us-core-ethnicitye CodeableConcept 0..1 Patient's ethnicity (category of humans sharing heritage). For more information on this value set, see here.
us-core-religion CodeableConcept 0..1 Patient's professed religious affiliation. For more information on this value set, see here.