Release 5

This page is part of the FHIR Specification (v5.0.0: R5 - STU). This is the current published version. For a full list of available versions, see the Directory of published versions

Patient Administration icon Work GroupMaturity Level: N/A  Normative (from v4.0.0)Security Category: Patient Compartments: Patient, Practitioner, RelatedPerson

Search parameters for the Resource Patient - 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/Patient-active

Parameter active:token

Whether the patient record is active

ResourcePatient
ExpressionPatient.active
Processing ModeNormal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/individual-address

Parameter address:string

Multiple Resources:

  • Patient: 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
  • 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
  • Practitioner: 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
  • RelatedPerson: 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
ResourcesPatient, Person, Practitioner, RelatedPerson
ExpressionPatient.address | Person.address | Practitioner.address | RelatedPerson.address
Processing ModeNormal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/individual-address-city

Parameter address-city:string

Multiple Resources:

ResourcesPatient, Person, Practitioner, RelatedPerson
ExpressionPatient.address.city | Person.address.city | Practitioner.address.city | RelatedPerson.address.city
Processing ModeNormal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/individual-address-country

Parameter address-country:string

Multiple Resources:

ResourcesPatient, Person, Practitioner, RelatedPerson
ExpressionPatient.address.country | Person.address.country | Practitioner.address.country | RelatedPerson.address.country
Processing ModeNormal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/individual-address-postalcode

Parameter address-postalcode:string

Multiple Resources:

  • Patient: A postalCode specified in an address
  • Person: A postal code specified in an address
  • Practitioner: A postalCode specified in an address
  • RelatedPerson: A postal code specified in an address
ResourcesPatient, Person, Practitioner, RelatedPerson
ExpressionPatient.address.postalCode | Person.address.postalCode | Practitioner.address.postalCode | RelatedPerson.address.postalCode
Processing ModeNormal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/individual-address-state

Parameter address-state:string

Multiple Resources:

ResourcesPatient, Person, Practitioner, RelatedPerson
ExpressionPatient.address.state | Person.address.state | Practitioner.address.state | RelatedPerson.address.state
Processing ModeNormal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/individual-address-use

Parameter address-use:token

Multiple Resources:

ResourcesPatient, Person, Practitioner, RelatedPerson
ExpressionPatient.address.use | Person.address.use | Practitioner.address.use | RelatedPerson.address.use
Processing ModeNormal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/individual-birthdate

Parameter birthdate:date

Multiple Resources:

ResourcesPatient, Person, RelatedPerson
ExpressionPatient.birthDate | Person.birthDate | RelatedPerson.birthDate
Processing ModeNormal
MultiplesThe parameter cannot repeat or have multiple values
ComparatorsAllowed: eq, ne, gt, ge, lt, le, sa, eb, ap
 
http://hl7.org/fhir/SearchParameter/Patient-death-date

Parameter death-date:date

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

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

Parameter deceased:token

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

ResourcePatient
ExpressionPatient.deceased.exists() and Patient.deceased != false
Processing ModeNormal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/individual-email

Parameter email:token

Multiple Resources:

ResourcesPatient, Person, Practitioner, PractitionerRole, RelatedPerson
ExpressionPatient.telecom.where(system='email') | Person.telecom.where(system='email') | Practitioner.telecom.where(system='email') | PractitionerRole.contact.telecom.where(system='email') | RelatedPerson.telecom.where(system='email')
Processing ModeNormal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/individual-family

Parameter family:string

Multiple Resources:

  • Patient: A portion of the family name of the patient
  • Practitioner: A portion of the family name
ResourcesPatient, Practitioner
ExpressionPatient.name.family | Practitioner.name.family
Processing ModeNormal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/individual-gender

Parameter gender:token

Multiple Resources:

ResourcesPatient, Person, Practitioner, RelatedPerson
ExpressionPatient.gender | Person.gender | Practitioner.gender | RelatedPerson.gender
Processing ModeNormal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/Patient-general-practitioner

Parameter general-practitioner:reference

Patient's nominated general practitioner, not the organization that manages the record

ResourcePatient
ExpressionPatient.generalPractitioner
Processing ModeNormal
Target ResourcesOrganization, PractitionerRole, Practitioner
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/individual-given

Parameter given:string

Multiple Resources:

  • Patient: A portion of the given name of the patient
  • Practitioner: A portion of the given name
ResourcesPatient, Practitioner
ExpressionPatient.name.given | Practitioner.name.given
Processing ModeNormal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/Patient-identifier

Parameter identifier:token

A patient identifier

ResourcePatient
ExpressionPatient.identifier
Processing ModeNormal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/Patient-language

Parameter language:token

Language code (irrespective of use value)

ResourcePatient
ExpressionPatient.communication.language
Processing ModeNormal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/Patient-link

Parameter link:reference

All patients/related persons linked to the given patient

ResourcePatient
ExpressionPatient.link.other
Processing ModeNormal
Target ResourcesRelatedPerson, Patient
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/Patient-name

Parameter name:string

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

ResourcePatient
ExpressionPatient.name
Processing ModeNormal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/Patient-organization

Parameter organization:reference

The organization that is the custodian of the patient record

ResourcePatient
ExpressionPatient.managingOrganization
Processing ModeNormal
Target ResourcesOrganization
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/individual-phone

Parameter phone:token

Multiple Resources:

ResourcesPatient, Person, Practitioner, PractitionerRole, RelatedPerson
ExpressionPatient.telecom.where(system='phone') | Person.telecom.where(system='phone') | Practitioner.telecom.where(system='phone') | PractitionerRole.contact.telecom.where(system='phone') | RelatedPerson.telecom.where(system='phone')
Processing ModeNormal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/individual-phonetic

Parameter phonetic:string

Multiple Resources:

  • Patient: A portion of either family or given name using some kind of phonetic matching algorithm
  • Person: A portion of name using some kind of phonetic matching algorithm
  • Practitioner: A portion of either family or given name using some kind of phonetic matching algorithm
  • RelatedPerson: A portion of name using some kind of phonetic matching algorithm
ResourcesPatient, Person, Practitioner, RelatedPerson
ExpressionPatient.name | Person.name | Practitioner.name | RelatedPerson.name
Processing ModePhonetic
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/individual-telecom

Parameter telecom:token

Multiple Resources:

ResourcesPatient, Person, Practitioner, PractitionerRole, RelatedPerson
ExpressionPatient.telecom | Person.telecom | Practitioner.telecom | PractitionerRole.contact.telecom | RelatedPerson.telecom
Processing ModeNormal
MultiplesThe parameter cannot repeat or have multiple values