FHIR CI-Build

This is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions icon

8.21.19 Resource Person - Search Parameters

Patient Administration icon Work GroupMaturity Level: N/A  Trial UseSecurity Category: Patient Compartments: Patient, Practitioner, RelatedPerson

Search parameters for the Person 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

Generated Narrative: SearchParameter individual-address

8.21.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

ResourcePerson
Expression Person.address
Processing Mode Normal
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/individual-address-city
This search parameter is part of the common search parameter individual-address-city

Generated Narrative: SearchParameter individual-address-city

8.21.21 address-city

Parameter address-city:string

Person: A city specified in an address

ResourcePerson
Expression Person.address.city
Processing Mode Normal
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/individual-address-country
This search parameter is part of the common search parameter individual-address-country

Generated Narrative: SearchParameter individual-address-country

8.21.22 address-country

Parameter address-country:string

Person: A country specified in an address

ResourcePerson
Expression Person.address.country
Processing Mode Normal
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/individual-address-postalcode
This search parameter is part of the common search parameter individual-address-postalcode

Generated Narrative: SearchParameter individual-address-postalcode

8.21.23 address-postalcode

Parameter address-postalcode:string

Person: A postal code specified in an address

ResourcePerson
Expression Person.address.postalCode
Processing Mode Normal
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/individual-address-state
This search parameter is part of the common search parameter individual-address-state

Generated Narrative: SearchParameter individual-address-state

8.21.24 address-state

Parameter address-state:string

Person: A state specified in an address

ResourcePerson
Expression Person.address.state
Processing Mode Normal
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/individual-address-use
This search parameter is part of the common search parameter individual-address-use

Generated Narrative: SearchParameter individual-address-use

8.21.25 address-use

Parameter address-use:token

Person: A use code specified in an address

ResourcePerson
Expression Person.address.use
Processing Mode Normal
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/individual-birthdate
This search parameter is part of the common search parameter individual-birthdate

Generated Narrative: SearchParameter individual-birthdate

8.21.26 birthdate

Parameter birthdate:date

Person: The person's date of birth

ResourcePerson
Expression Person.birthDate
Processing Mode Normal
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
Comparators Allowed: eq, ne, gt, ge, lt, le, sa, eb, ap
 
http://hl7.org/fhir/SearchParameter/Person-death-date

Generated Narrative: SearchParameter Person-death-date

8.21.27 death-date

Parameter death-date:date

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

ResourcePerson
Expression (Person.deceased.ofType(dateTime))
Processing Mode Normal
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
Comparators Allowed: eq, ne, gt, ge, lt, le, sa, eb, ap
 
http://hl7.org/fhir/SearchParameter/Person-deceased

Generated Narrative: SearchParameter Person-deceased

8.21.28 deceased

Parameter deceased:token

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

ResourcePerson
Expression Person.deceased.exists() and Person.deceased != false
Processing Mode Normal
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/individual-email
This search parameter is part of the common search parameter individual-email

Generated Narrative: SearchParameter individual-email

8.21.29 email

Parameter email:token

Person: A value in an email contact

ResourcePerson
Expression Person.telecom.where(system='email')
Processing Mode Normal
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/Person-family

Generated Narrative: SearchParameter Person-family

8.21.30 family

Parameter family:string

A portion of the family name of the person

ResourcePerson
Expression Person.name.family
Processing Mode Normal
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/individual-gender
This search parameter is part of the common search parameter individual-gender

Generated Narrative: SearchParameter individual-gender

8.21.31 gender

Parameter gender:token

Person: The gender of the person

ResourcePerson
Expression Person.gender
Processing Mode Normal
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/Person-given

Generated Narrative: SearchParameter Person-given

8.21.32 given

Parameter given:string

A portion of the given name of the person

ResourcePerson
Expression Person.name.given
Processing Mode Normal
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/clinical-identifier
This search parameter is part of the common search parameter clinical-identifier

Generated Narrative: SearchParameter clinical-identifier

8.21.33 identifier

Parameter identifier:token

Person: A person Identifier

ResourcePerson
Expression Person.identifier
Processing Mode Normal
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/Person-link

Generated Narrative: SearchParameter Person-link

8.21.34 link

Parameter link:reference

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

ResourcePerson
Expression Person.link.target
Processing Mode Normal
Target Resources RelatedPerson, Practitioner, Person, Patient
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/Person-name

Generated Narrative: SearchParameter Person-name

8.21.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

ResourcePerson
Expression Person.name
Processing Mode Normal
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/Person-organization

Generated Narrative: SearchParameter Person-organization

8.21.36 organization

Parameter organization:reference

The organization at which this person record is being managed

ResourcePerson
Expression Person.managingOrganization
Processing Mode Normal
Target Resources Organization
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/clinical-patient
This search parameter is part of the common search parameter clinical-patient

Generated Narrative: SearchParameter clinical-patient

8.21.37 patient

Parameter patient:reference

Person: The Person links to this Patient

ResourcePerson
Expression Person.link.target.where(resolve() is Patient)
Processing Mode Normal
Target Resources Patient
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/individual-phone
This search parameter is part of the common search parameter individual-phone

Generated Narrative: SearchParameter individual-phone

8.21.38 phone

Parameter phone:token

Person: A value in a phone contact

ResourcePerson
Expression Person.telecom.where(system='phone')
Processing Mode Normal
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/individual-phonetic
This search parameter is part of the common search parameter individual-phonetic

Generated Narrative: SearchParameter individual-phonetic

8.21.39 phonetic

Parameter phonetic:string

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

ResourcePerson
Expression Person.name
Processing Mode Phonetic
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/Person-practitioner

Generated Narrative: SearchParameter Person-practitioner

8.21.40 practitioner

Parameter practitioner:reference

The Person links to this Practitioner

ResourcePerson
Expression Person.link.target.where(resolve() is Practitioner)
Processing Mode Normal
Target Resources Practitioner
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/Person-relatedperson

Generated Narrative: SearchParameter Person-relatedperson

8.21.41 relatedperson

Parameter relatedperson:reference

The Person links to this RelatedPerson

ResourcePerson
Expression Person.link.target.where(resolve() is RelatedPerson)
Processing Mode Normal
Target Resources RelatedPerson
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/individual-telecom
This search parameter is part of the common search parameter individual-telecom

Generated Narrative: SearchParameter individual-telecom

8.21.42 telecom

Parameter telecom:token

Person: The value in any kind of contact

ResourcePerson
Expression Person.telecom
Processing Mode Normal
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true