Patient - FHIR v5.0.0-ballot

Release 5 Ballot

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

Patient Administration

Work Group

Maturity Level: N/A

Standards Status: Informative

Security Category: Patient

Compartments: Patient, Practitioner, RelatedPerson

Search Parameter Registry for the patient resource

8.1.5 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/SearchParameter/Patient-active

8.1.6 active

Parameter active:token

Whether the patient record is active

Resource Patient

Expression Patient.active

Multiples The parameter cannot repeat or have multiple values

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

8.1.7 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

Resources Patient Person Practitioner RelatedPerson

Expression Patient.address | Person.address | Practitioner.address | RelatedPerson.address

Multiples The parameter cannot repeat or have multiple values

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

8.1.8 address-city

Parameter address-city:string

Multiple Resources:

Patient: A city specified in an address
Person: A city specified in an address
Practitioner: A city specified in an address
RelatedPerson: A city specified in an address

Resources Patient Person Practitioner RelatedPerson

Expression Patient.address.city | Person.address.city | Practitioner.address.city | RelatedPerson.address.city

Multiples The parameter cannot repeat or have multiple values

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

8.1.9 address-country

Parameter address-country:string

Multiple Resources:

Patient: A country specified in an address
Person: A country specified in an address
Practitioner: A country specified in an address
RelatedPerson: A country specified in an address

Resources Patient Person Practitioner RelatedPerson

Expression Patient.address.country | Person.address.country | Practitioner.address.country | RelatedPerson.address.country

Multiples The parameter cannot repeat or have multiple values

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

8.1.10 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

Resources Patient Person Practitioner RelatedPerson

Expression Patient.address.postalCode | Person.address.postalCode | Practitioner.address.postalCode | RelatedPerson.address.postalCode

Multiples The parameter cannot repeat or have multiple values

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

8.1.11 address-state

Parameter address-state:string

Multiple Resources:

Patient: A state specified in an address
Person: A state specified in an address
Practitioner: A state specified in an address
RelatedPerson: A state specified in an address

Resources Patient Person Practitioner RelatedPerson

Expression Patient.address.state | Person.address.state | Practitioner.address.state | RelatedPerson.address.state

Multiples The parameter cannot repeat or have multiple values

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

8.1.12 address-use

Parameter address-use:token

Multiple Resources:

Patient: A use code specified in an address
Person: A use code specified in an address
Practitioner: A use code specified in an address
RelatedPerson: A use code specified in an address

Resources Patient Person Practitioner RelatedPerson

Expression Patient.address.use | Person.address.use | Practitioner.address.use | RelatedPerson.address.use

Multiples The parameter cannot repeat or have multiple values

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

8.1.13 birthdate

Parameter birthdate:date

Multiple Resources:

Patient: The patient's date of birth
Person: The person's date of birth
RelatedPerson: The Related Person's date of birth

Resources Patient Person RelatedPerson

Expression Patient.birthDate | Person.birthDate | RelatedPerson.birthDate

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/Patient-death-date

8.1.14 death-date

Parameter death-date:date

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

Resource Patient

Expression (Patient.deceased as dateTime)

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/Patient-deceased

8.1.15 deceased

Parameter deceased:token

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

Resource Patient

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

Multiples The parameter cannot repeat or have multiple values

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

8.1.16 email

Parameter email:token

Multiple Resources:

Patient: A value in an email contact
Person: A value in an email contact
Practitioner: A value in an email contact
PractitionerRole: A value in an email contact
RelatedPerson: A value in an email contact

Resources Patient Person Practitioner PractitionerRole RelatedPerson

Expression Patient.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')

Multiples The parameter cannot repeat or have multiple values

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

8.1.17 family

Parameter family:string

Multiple Resources:

Patient: A portion of the family name of the patient
Practitioner: A portion of the family name

Resources Patient Practitioner

Expression Patient.name.family | Practitioner.name.family

Multiples The parameter cannot repeat or have multiple values

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

8.1.18 gender

Parameter gender:token

Multiple Resources:

Patient: Gender of the patient
Person: The gender of the person
Practitioner: Gender of the practitioner
RelatedPerson: Gender of the related person

Resources Patient Person Practitioner RelatedPerson

Expression Patient.gender | Person.gender | Practitioner.gender | RelatedPerson.gender

Multiples The parameter cannot repeat or have multiple values

http://hl7.org/fhir/SearchParameter/Patient-general-practitioner

8.1.19 general-practitioner

Parameter general-practitioner:reference

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

Resource Patient

Expression Patient.generalPractitioner

Target Resources Practitioner, Organization, PractitionerRole

Multiples The parameter cannot repeat or have multiple values

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

8.1.20 given

Parameter given:string

Multiple Resources:

Patient: A portion of the given name of the patient
Practitioner: A portion of the given name

Resources Patient Practitioner

Expression Patient.name.given | Practitioner.name.given

Multiples The parameter cannot repeat or have multiple values

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

8.1.21 identifier

Parameter identifier:token

A patient identifier

Resource Patient

Expression Patient.identifier

Multiples The parameter cannot repeat or have multiple values

http://hl7.org/fhir/SearchParameter/Patient-language

8.1.22 language

Parameter language:token

Language code (irrespective of use value)

Resource Patient

Expression Patient.communication.language

Multiples The parameter cannot repeat or have multiple values

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

8.1.23 link

Parameter link:reference

All patients/related persons linked to the given patient

Resource Patient

Expression Patient.link.other

Target Resources Patient, RelatedPerson

Multiples The parameter cannot repeat or have multiple values

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

8.1.24 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

Resource Patient

Expression Patient.name

Multiples The parameter cannot repeat or have multiple values

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

8.1.25 organization

Parameter organization:reference

The organization that is the custodian of the patient record

Resource Patient

Expression Patient.managingOrganization

Target Resources Organization

Multiples The parameter cannot repeat or have multiple values

http://hl7.org/fhir/SearchParameter/patient-extensions-Patient-age

8.1.26 age

Parameter age:number

Searches for patients based on age as calculated based on current date and date of birth. Deceased patients are excluded from the search.

Resource Patient

Expression Patient.birthDate

Usage Normal

Multiples The parameter cannot repeat or have multiple values

http://hl7.org/fhir/SearchParameter/patient-extensions-Patient-birthOrderBoolean

8.1.27 birthOrderBoolean

Parameter birthOrderBoolean:token

Search based on whether a patient was part of a multiple birth or not.

Resource Patient

Expression Patient.multipleBirthBoolean | Patient.multipleBirthInteger

Usage Normal

Multiples The parameter cannot repeat or have multiple values

http://hl7.org/fhir/SearchParameter/patient-extensions-Patient-mothersMaidenName

8.1.28 mothersMaidenName

Parameter mothersMaidenName:string

Search based on patient's mother's maiden name

Resource Patient

Expression Patient.extension('http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName').value

Usage Normal

Multiples The parameter cannot repeat or have multiple values

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

8.1.29 phone

Parameter phone:token

Multiple Resources:

Patient: A value in a phone contact
Person: A value in a phone contact
Practitioner: A value in a phone contact
PractitionerRole: A value in a phone contact
RelatedPerson: A value in a phone contact

Resources Patient Person Practitioner PractitionerRole RelatedPerson

Expression Patient.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')

Multiples The parameter cannot repeat or have multiple values

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

8.1.30 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

Resources Patient Person Practitioner RelatedPerson

Expression Patient.name | Person.name | Practitioner.name | RelatedPerson.name

Multiples The parameter cannot repeat or have multiple values

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

8.1.31 telecom

Parameter telecom:token

Multiple Resources:

Patient: The value in any kind of telecom details of the patient
Person: The value in any kind of contact
Practitioner: The value in any kind of contact
PractitionerRole: The value in any kind of contact
RelatedPerson: The value in any kind of contact

Resources Patient Person Practitioner PractitionerRole RelatedPerson

Expression Patient.telecom | Person.telecom | Practitioner.telecom | PractitionerRole.contact.telecom | RelatedPerson.telecom

Multiples The parameter cannot repeat or have multiple values