Release 5 Ballot

This page is part of the FHIR Specification (v5.0.0-ballot: R5 Ballot - 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.18.19 Resource Person - Search Parameters

Patient Administration icon Work GroupMaturity Level: N/AStandards Status: InformativeSecurity Category: Patient Compartments: Patient, Practitioner, RelatedPerson

Search Parameter Registry for the person resource

8.18.20 Search Parameters

Search parameter list for this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.

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

8.18.21 address

Parameter 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

Resources
ExpressionPerson.address
UsageNormal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/build/SearchParameter/Person-address-city

8.18.22 address-city

Parameter address-city:string

A city specified in an address

Resources
ExpressionPerson.address.city
UsageNormal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/build/SearchParameter/Person-address-country

8.18.23 address-country

Parameter address-country:string

A country specified in an address

Resources
ExpressionPerson.address.country
UsageNormal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/build/SearchParameter/Person-address-postalcode

8.18.24 address-postalcode

Parameter address-postalcode:string

A postal code specified in an address

Resources
ExpressionPerson.address.postalCode
UsageNormal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/build/SearchParameter/Person-address-state

8.18.25 address-state

Parameter address-state:string

A state specified in an address

Resources
ExpressionPerson.address.state
UsageNormal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/build/SearchParameter/Person-address-use

8.18.26 address-use

Parameter address-use:token

A use code specified in an address

Resources
ExpressionPerson.address.use
UsageNormal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/build/SearchParameter/Person-birthdate

8.18.27 birthdate

Parameter birthdate:date

The person's date of birth

Resources
ExpressionPerson.birthDate
UsageNormal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/Person-death-date

8.18.28 death-date

Parameter death-date:date

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

ResourcePerson
Expression(Person.deceased as dateTime)
MultiplesThe parameter cannot repeat or have multiple values
ComparatorsAllowed: eq, ne, gt, ge, lt, le, sa, eb, ap
 
http://hl7.org/fhir/SearchParameter/Person-deceased

8.18.29 deceased

Parameter deceased:token

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

ResourcePerson
ExpressionPerson.deceased.exists() and Person.deceased != false
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/build/SearchParameter/Person-email

8.18.30 email

Parameter email:token

A value in an email contact

Resources
ExpressionPerson.telecom.where(system='email')
UsageNormal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/Person-family

8.18.31 family

Parameter family:string

A portion of the family name of the person

ResourcePerson
ExpressionPerson.name.family
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/build/SearchParameter/Person-gender

8.18.32 gender

Parameter gender:token

The gender of the person

Resources
ExpressionPerson.gender
UsageNormal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/Person-given

8.18.33 given

Parameter given:string

A portion of the given name of the person

ResourcePerson
ExpressionPerson.name.given
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/Person-identifier

8.18.34 identifier

Parameter identifier:token

A person Identifier

ResourcePerson
ExpressionPerson.identifier
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/Person-link

8.18.35 link

Parameter link:reference

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

ResourcePerson
ExpressionPerson.link.target
Target ResourcesPractitioner, Patient, Person, RelatedPerson
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/Person-name

8.18.36 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

ResourcePerson
ExpressionPerson.name
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/Person-organization

8.18.37 organization

Parameter organization:reference

The organization at which this person record is being managed

ResourcePerson
ExpressionPerson.managingOrganization
Target ResourcesOrganization
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/Person-patient

8.18.38 patient

Parameter patient:reference

The Person links to this Patient

ResourcePerson
ExpressionPerson.link.target.where(resolve() is Patient)
Target ResourcesPatient
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/build/SearchParameter/Person-phone

8.18.39 phone

Parameter phone:token

A value in a phone contact

Resources
ExpressionPerson.telecom.where(system='phone')
UsageNormal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/build/SearchParameter/Person-phonetic

8.18.40 phonetic

Parameter phonetic:string

A portion of name using some kind of phonetic matching algorithm

Resources
ExpressionPerson.name
UsagePhonetic
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/Person-practitioner

8.18.41 practitioner

Parameter practitioner:reference

The Person links to this Practitioner

ResourcePerson
ExpressionPerson.link.target.where(resolve() is Practitioner)
Target ResourcesPractitioner
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/Person-relatedperson

8.18.42 relatedperson

Parameter relatedperson:reference

The Person links to this RelatedPerson

ResourcePerson
ExpressionPerson.link.target.where(resolve() is RelatedPerson)
Target ResourcesRelatedPerson
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/build/SearchParameter/Person-telecom

8.18.43 telecom

Parameter telecom:token

The value in any kind of contact

Resources
ExpressionPerson.telecom
UsageNormal
MultiplesThe parameter cannot repeat or have multiple values