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.20.20 Resource Person - Search Parameters

Patient Administration icon Work GroupMaturity Level: N/A  Trial UseSecurity 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.21 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
ExpressionPerson.address
Processing ModeNormal
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

8.20.22 address-city

Parameter address-city:string

Person: A city specified in an address

ResourcePerson
ExpressionPerson.address.city
Processing ModeNormal
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

8.20.23 address-country

Parameter address-country:string

Person: A country specified in an address

ResourcePerson
ExpressionPerson.address.country
Processing ModeNormal
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

8.20.24 address-postalcode

Parameter address-postalcode:string

Person: A postal code specified in an address

ResourcePerson
ExpressionPerson.address.postalCode
Processing ModeNormal
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

8.20.25 address-state

Parameter address-state:string

Person: A state specified in an address

ResourcePerson
ExpressionPerson.address.state
Processing ModeNormal
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

8.20.26 address-use

Parameter address-use:token

Person: A use code specified in an address

ResourcePerson
ExpressionPerson.address.use
Processing ModeNormal
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

8.20.27 birthdate

Parameter birthdate:date

Person: The person's date of birth

ResourcePerson
ExpressionPerson.birthDate
Processing ModeNormal
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
ComparatorsAllowed: eq, ne, gt, ge, lt, le, sa, eb, ap
 
http://hl7.org/fhir/SearchParameter/Person-death-date

8.20.28 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 ModeNormal
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
ComparatorsAllowed: eq, ne, gt, ge, lt, le, sa, eb, ap
 
http://hl7.org/fhir/SearchParameter/Person-deceased

8.20.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
Processing ModeNormal
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

8.20.30 email

Parameter email:token

Person: A value in an email contact

ResourcePerson
ExpressionPerson.telecom.where(system='email')
Processing ModeNormal
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

8.20.31 family

Parameter family:string

A portion of the family name of the person

ResourcePerson
ExpressionPerson.name.family
Processing ModeNormal
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

8.20.32 gender

Parameter gender:token

Person: The gender of the person

ResourcePerson
ExpressionPerson.gender
Processing ModeNormal
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

8.20.33 given

Parameter given:string

A portion of the given name of the person

ResourcePerson
ExpressionPerson.name.given
Processing ModeNormal
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

8.20.34 identifier

Parameter identifier:token

Person: A person Identifier

ResourcePerson
ExpressionPerson.identifier
Processing ModeNormal
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

8.20.35 link

Parameter link:reference

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

ResourcePerson
ExpressionPerson.link.target
Processing ModeNormal
Target ResourcesRelatedPerson, 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

8.20.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
Processing ModeNormal
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

8.20.37 organization

Parameter organization:reference

The organization at which this person record is being managed

ResourcePerson
ExpressionPerson.managingOrganization
Processing ModeNormal
Target ResourcesOrganization
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

8.20.38 patient

Parameter patient:reference

Person: The Person links to this Patient

ResourcePerson
ExpressionPerson.link.target.where(resolve() is Patient)
Processing ModeNormal
Target ResourcesPatient
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

8.20.39 phone

Parameter phone:token

Person: A value in a phone contact

ResourcePerson
ExpressionPerson.telecom.where(system='phone')
Processing ModeNormal
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

8.20.40 phonetic

Parameter phonetic:string

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

ResourcePerson
ExpressionPerson.name
Processing ModePhonetic
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

8.20.41 practitioner

Parameter practitioner:reference

The Person links to this Practitioner

ResourcePerson
ExpressionPerson.link.target.where(resolve() is Practitioner)
Processing ModeNormal
Target ResourcesPractitioner
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

8.20.42 relatedperson

Parameter relatedperson:reference

The Person links to this RelatedPerson

ResourcePerson
ExpressionPerson.link.target.where(resolve() is RelatedPerson)
Processing ModeNormal
Target ResourcesRelatedPerson
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

8.20.43 telecom

Parameter telecom:token

Person: The value in any kind of contact

ResourcePerson
ExpressionPerson.telecom
Processing ModeNormal
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