---
type: "search-params"
title: "Patient Search Parameters"
resource: "Patient"
---
# Patient Search Parameters

<a id="active"></a>

## active
**Description:** Whether the patient record is active

**Type:** token

**Expression:** Patient.active

**Path:** Patient.active

**Standards Status:** normative

**URL:** http://hl7.org/fhir/build/SearchParameter/Patient-active


<a id="address"></a>

## address
**Description:** 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

**Type:** string

**Expression:** Patient.address

**Path:** Patient.address

**Standards Status:** normative

**URL:** http://hl7.org/fhir/build/SearchParameter/Patient-address


<a id="address-city"></a>

## address-city
**Description:** A city specified in an address

**Type:** string

**Expression:** Patient.address.city

**Path:** Patient.address.city

**Standards Status:** normative

**URL:** http://hl7.org/fhir/build/SearchParameter/Patient-address-city


<a id="address-country"></a>

## address-country
**Description:** A country specified in an address

**Type:** string

**Expression:** Patient.address.country

**Path:** Patient.address.country

**Standards Status:** normative

**URL:** http://hl7.org/fhir/build/SearchParameter/Patient-address-country


<a id="address-postalcode"></a>

## address-postalcode
**Description:** A postalCode specified in an address

**Type:** string

**Expression:** Patient.address.postalCode

**Path:** Patient.address.postalCode

**Standards Status:** normative

**URL:** http://hl7.org/fhir/build/SearchParameter/Patient-address-postalcode


<a id="address-state"></a>

## address-state
**Description:** A state specified in an address

**Type:** string

**Expression:** Patient.address.state

**Path:** Patient.address.state

**Standards Status:** normative

**URL:** http://hl7.org/fhir/build/SearchParameter/Patient-address-state


<a id="address-use"></a>

## address-use
**Description:** A use code specified in an address

**Type:** token

**Expression:** Patient.address.use

**Path:** Patient.address.use

**Standards Status:** normative

**URL:** http://hl7.org/fhir/build/SearchParameter/Patient-address-use


<a id="birthdate"></a>

## birthdate
**Description:** The patient's date of birth

**Type:** date

**Expression:** Patient.birthDate

**Path:** Patient.birthDate

**Standards Status:** normative

**URL:** http://hl7.org/fhir/build/SearchParameter/Patient-birthdate


<a id="death-date"></a>

## death-date
**Description:** The date of death has been provided and satisfies this search value

**Type:** date

**Expression:** (Patient.deceased.ofType(dateTime))

**Path:** Patient.deceasedDateTime

**Standards Status:** normative

**URL:** http://hl7.org/fhir/build/SearchParameter/Patient-death-date


<a id="deceased"></a>

## deceased
**Description:** This patient has been marked as deceased, or has a death date entered

**Type:** token

**Expression:** Patient.deceased.exists() and Patient.deceased != false

**Path:** Patient.deceased[x]

**Standards Status:** normative

**URL:** http://hl7.org/fhir/build/SearchParameter/Patient-deceased


<a id="email"></a>

## email
**Description:** A value in an email contact

**Type:** token

**Expression:** Patient.telecom.where(system='email')

**Path:** Patient.telecom(system=email)

**Standards Status:** normative

**URL:** http://hl7.org/fhir/build/SearchParameter/Patient-email


<a id="family"></a>

## family
**Description:** A portion of the family name of the patient

**Type:** string

**Expression:** Patient.name.family

**Path:** Patient.name.family

**Standards Status:** normative

**URL:** http://hl7.org/fhir/build/SearchParameter/Patient-family


<a id="gender"></a>

## gender
**Description:** Gender of the patient

**Type:** token

**Expression:** Patient.gender

**Path:** Patient.gender

**Standards Status:** normative

**URL:** http://hl7.org/fhir/build/SearchParameter/Patient-gender


<a id="general-practitioner"></a>

## general-practitioner
**Description:** Patient's nominated general practitioner, not the organization that manages the record

**Type:** reference

**Expression:** Patient.generalPractitioner

**Path:** Patient.generalPractitioner

**Standards Status:** normative

**URL:** http://hl7.org/fhir/build/SearchParameter/Patient-general-practitioner


<a id="given"></a>

## given
**Description:** A portion of the given name of the patient

**Type:** string

**Expression:** Patient.name.given

**Path:** Patient.name.given

**Standards Status:** normative

**URL:** http://hl7.org/fhir/build/SearchParameter/Patient-given


<a id="identifier"></a>

## identifier
**Description:** A patient identifier

**Type:** token

**Expression:** Patient.identifier

**Path:** Patient.identifier

**Standards Status:** normative

**URL:** http://hl7.org/fhir/build/SearchParameter/Patient-identifier


<a id="language"></a>

## language
**Description:** Language code (irrespective of use value)

**Type:** token

**Expression:** Patient.communication.language

**Path:** Patient.communication.language

**Standards Status:** normative

**URL:** http://hl7.org/fhir/build/SearchParameter/Patient-language


<a id="link"></a>

## link
**Description:** All patients/related persons linked to the given patient

**Type:** reference

**Expression:** Patient.link.other

**Path:** Patient.link.other

**Standards Status:** normative

**URL:** http://hl7.org/fhir/build/SearchParameter/Patient-link


<a id="name"></a>

## name
**Description:** A server defined search that may match any of the string fields in the HumanName, including family, given, prefix, suffix, and/or text

**Type:** string

**Expression:** Patient.name

**Path:** Patient.name

**Standards Status:** normative

**URL:** http://hl7.org/fhir/build/SearchParameter/Patient-name


<a id="organization"></a>

## organization
**Description:** The organization that is the custodian of the patient record

**Type:** reference

**Expression:** Patient.managingOrganization

**Path:** Patient.managingOrganization

**Standards Status:** normative

**URL:** http://hl7.org/fhir/build/SearchParameter/Patient-organization


<a id="phone"></a>

## phone
**Description:** A value in a phone contact

**Type:** token

**Expression:** Patient.telecom.where(system='phone')

**Path:** Patient.telecom(system=phone)

**Standards Status:** normative

**URL:** http://hl7.org/fhir/build/SearchParameter/Patient-phone


<a id="phonetic"></a>

## phonetic
**Description:** A portion of either family or given name using some kind of phonetic matching algorithm

**Type:** string

**Expression:** Patient.name

**Path:** Patient.name

**Standards Status:** normative

**URL:** http://hl7.org/fhir/build/SearchParameter/Patient-phonetic


<a id="telecom"></a>

## telecom
**Description:** The value in any kind of telecom details of the patient

**Type:** token

**Expression:** Patient.telecom

**Path:** Patient.telecom

**Standards Status:** normative

**URL:** http://hl7.org/fhir/build/SearchParameter/Patient-telecom