View raw Markdown
type: search-paramsresource: Person

Person Search Parameters

<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: Person.address

Path: Person.address

Standards Status: normative

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

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

address-city

Description: A city specified in an address

Type: string

Expression: Person.address.city

Path: Person.address.city

Standards Status: normative

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

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

address-country

Description: A country specified in an address

Type: string

Expression: Person.address.country

Path: Person.address.country

Standards Status: normative

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

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

address-postalcode

Description: A postal code specified in an address

Type: string

Expression: Person.address.postalCode

Path: Person.address.postalCode

Standards Status: normative

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

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

address-state

Description: A state specified in an address

Type: string

Expression: Person.address.state

Path: Person.address.state

Standards Status: normative

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

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

address-use

Description: A use code specified in an address

Type: token

Expression: Person.address.use

Path: Person.address.use

Standards Status: normative

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

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

birthdate

Description: The person's date of birth

Type: date

Expression: Person.birthDate

Path: Person.birthDate

Standards Status: normative

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

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

email

Description: A value in an email contact

Type: token

Expression: Person.telecom.where(system='email')

Path: Person.telecom(system=email)

Standards Status: normative

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

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

gender

Description: The gender of the person

Type: token

Expression: Person.gender

Path: Person.gender

Standards Status: normative

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

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

identifier

Description: A person Identifier

Type: token

Expression: Person.identifier

Path: Person.identifier

Standards Status: normative

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

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

Description: Any link has this Patient, Person, RelatedPerson or Practitioner reference

Type: reference

Expression: Person.link.target

Path: Person.link.target

Standards Status: normative

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

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

name

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

Type: string

Expression: Person.name

Path: Person.name

Standards Status: normative

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

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

organization

Description: The organization at which this person record is being managed

Type: reference

Expression: Person.managingOrganization

Path: Person.managingOrganization

Standards Status: normative

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

<a id="patient"></a>

patient

Description: The Person links to this Patient

Type: reference

Expression: Person.link.target.where(resolve() is Patient)

Path: Person.link.target

Standards Status: normative

URL: http://hl7.org/fhir/build/SearchParameter/Person-patient

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

phone

Description: A value in a phone contact

Type: token

Expression: Person.telecom.where(system='phone')

Path: Person.telecom(system=phone)

Standards Status: normative

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

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

phonetic

Description: A portion of name using some kind of phonetic matching algorithm

Type: string

Expression: Person.name

Path: Person.name

Standards Status: normative

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

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

practitioner

Description: The Person links to this Practitioner

Type: reference

Expression: Person.link.target.where(resolve() is Practitioner)

Path: Person.link.target

Standards Status: normative

URL: http://hl7.org/fhir/build/SearchParameter/Person-practitioner

<a id="relatedperson"></a>

relatedperson

Description: The Person links to this RelatedPerson

Type: reference

Expression: Person.link.target.where(resolve() is RelatedPerson)

Path: Person.link.target

Standards Status: normative

URL: http://hl7.org/fhir/build/SearchParameter/Person-relatedperson

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

telecom

Description: The value in any kind of contact

Type: token

Expression: Person.telecom

Path: Person.telecom

Standards Status: normative

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

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

family

Description: A portion of the family name of the person

Type: string

Expression: Person.name.family

Path: Person.name.family

Standards Status: normative

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

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

given

Description: A portion of the given name of the person

Type: string

Expression: Person.name.given

Path: Person.name.given

Standards Status: normative

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

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

death-date

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

Type: date

Expression: (Person.deceased.ofType(dateTime))

Path: Person.deceasedDateTime

Standards Status: normative

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

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

deceased

Description: This person has been marked as deceased, or has a death date entered

Type: token

Expression: Person.deceased.exists() and Person.deceased != false

Path: Person.deceased[x]

Standards Status: normative

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