Person - FHIR v5.0.0-draft-final

R5 Final QA

This page is part of the FHIR Specification (v5.0.0-draft-final: Final QA Preview for R5 - see ballot notes). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

8.20.19 Resource Person - Search Parameters

Patient Administration icon

Work Group

Maturity Level: N/A

Trial Use

Security Category: Patient

Compartments: Patient, Practitioner, RelatedPerson

Search parameters for the Resource Person - Search Parameters resource. Also check the Extensions registry for search parameters on extensions related to this resource.

The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.

http://hl7.org/fhir/SearchParameter/individual-address

This search parameter is part of the common search parameter individual-address

8.20.20 address

Parameter address:string

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

Resource Person

Expression Person.address

Processing Mode Normal

Multiples The parameter cannot repeat or have multiple values

http://hl7.org/fhir/SearchParameter/individual-address-city

This search parameter is part of the common search parameter individual-address-city

8.20.21 address-city

Parameter address-city:string

Person: A city specified in an address

Resource Person

Expression Person.address.city

Processing Mode Normal

Multiples The parameter cannot repeat or have multiple values

http://hl7.org/fhir/SearchParameter/individual-address-country

This search parameter is part of the common search parameter individual-address-country

8.20.22 address-country

Parameter address-country:string

Person: A country specified in an address

Resource Person

Expression Person.address.country

Processing Mode Normal

Multiples The parameter cannot repeat or have multiple values

http://hl7.org/fhir/SearchParameter/individual-address-postalcode

This search parameter is part of the common search parameter individual-address-postalcode

8.20.23 address-postalcode

Parameter address-postalcode:string

Person: A postal code specified in an address

Resource Person

Expression Person.address.postalCode

Processing Mode Normal

Multiples The parameter cannot repeat or have multiple values

http://hl7.org/fhir/SearchParameter/individual-address-state

This search parameter is part of the common search parameter individual-address-state

8.20.24 address-state

Parameter address-state:string

Person: A state specified in an address

Resource Person

Expression Person.address.state

Processing Mode Normal

Multiples The parameter cannot repeat or have multiple values

http://hl7.org/fhir/SearchParameter/individual-address-use

This search parameter is part of the common search parameter individual-address-use

8.20.25 address-use

Parameter address-use:token

Person: A use code specified in an address

Resource Person

Expression Person.address.use

Processing Mode Normal

Multiples The parameter cannot repeat or have multiple values

http://hl7.org/fhir/SearchParameter/individual-birthdate

This search parameter is part of the common search parameter individual-birthdate

8.20.26 birthdate

Parameter birthdate:date

Person: The person's date of birth

Resource Person

Expression Person.birthDate

Processing Mode Normal

Multiples The parameter cannot repeat or have multiple values

Comparators Allowed: eq, ne, gt, ge, lt, le, sa, eb, ap

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

8.20.27 death-date

Parameter death-date:date

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

Resource Person

Expression (Person.deceased.ofType(dateTime))

Processing Mode Normal

Multiples The parameter cannot repeat or have multiple values

Comparators Allowed: eq, ne, gt, ge, lt, le, sa, eb, ap

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

8.20.28 deceased

Parameter deceased:token

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

Resource Person

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

Processing Mode Normal

Multiples The parameter cannot repeat or have multiple values

http://hl7.org/fhir/SearchParameter/individual-email

This search parameter is part of the common search parameter individual-email

8.20.29 email

Parameter email:token

Person: A value in an email contact

Resource Person

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

Processing Mode Normal

Multiples The parameter cannot repeat or have multiple values

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

8.20.30 family

Parameter family:string

A portion of the family name of the person

Resource Person

Expression Person.name.family

Processing Mode Normal

Multiples The parameter cannot repeat or have multiple values

http://hl7.org/fhir/SearchParameter/individual-gender

This search parameter is part of the common search parameter individual-gender

8.20.31 gender

Parameter gender:token

Person: The gender of the person

Resource Person

Expression Person.gender

Processing Mode Normal

Multiples The parameter cannot repeat or have multiple values

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

8.20.32 given

Parameter given:string

A portion of the given name of the person

Resource Person

Expression Person.name.given

Processing Mode Normal

Multiples The parameter cannot repeat or have multiple values

http://hl7.org/fhir/SearchParameter/clinical-identifier

This search parameter is part of the common search parameter clinical-identifier

8.20.33 identifier

Parameter identifier:token

Person: A person Identifier

Resource Person

Expression Person.identifier

Processing Mode Normal

Multiples The parameter cannot repeat or have multiple values

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

8.20.34 link

Parameter link:reference

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

Resource Person

Expression Person.link.target

Processing Mode Normal

Target Resources RelatedPerson, Practitioner, Person, Patient

Multiples The parameter cannot repeat or have multiple values

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

8.20.35 name

Parameter 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

Resource Person

Expression Person.name

Processing Mode Normal

Multiples The parameter cannot repeat or have multiple values

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

8.20.36 organization

Parameter organization:reference

The organization at which this person record is being managed

Resource Person

Expression Person.managingOrganization

Processing Mode Normal

Target Resources Organization

Multiples The parameter cannot repeat or have multiple values

http://hl7.org/fhir/SearchParameter/clinical-patient

This search parameter is part of the common search parameter clinical-patient

8.20.37 patient

Parameter patient:reference

Person: The Person links to this Patient

Resource Person

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

Processing Mode Normal

Target Resources Patient

Multiples The parameter cannot repeat or have multiple values

http://hl7.org/fhir/SearchParameter/individual-phone

This search parameter is part of the common search parameter individual-phone

8.20.38 phone

Parameter phone:token

Person: A value in a phone contact

Resource Person

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

Processing Mode Normal

Multiples The parameter cannot repeat or have multiple values

http://hl7.org/fhir/SearchParameter/individual-phonetic

This search parameter is part of the common search parameter individual-phonetic

8.20.39 phonetic

Parameter phonetic:string

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

Resource Person

Expression Person.name

Processing Mode Phonetic

Multiples The parameter cannot repeat or have multiple values

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

8.20.40 practitioner

Parameter practitioner:reference

The Person links to this Practitioner

Resource Person

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

Processing Mode Normal

Target Resources Practitioner

Multiples The parameter cannot repeat or have multiple values

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

8.20.41 relatedperson

Parameter relatedperson:reference

The Person links to this RelatedPerson

Resource Person

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

Processing Mode Normal

Target Resources RelatedPerson

Multiples The parameter cannot repeat or have multiple values

http://hl7.org/fhir/SearchParameter/individual-telecom

This search parameter is part of the common search parameter individual-telecom

8.20.42 telecom

Parameter telecom:token

Person: The value in any kind of contact

Resource Person

Expression Person.telecom

Processing Mode Normal

Multiples The parameter cannot repeat or have multiple values