Release 5 FHIR CI-Build

This page is part of the Continuous Integration Build of FHIR Specification (v5.0.0: R5 - STU ). This is the current published version in it's permanent home (it will always (will be available incorrect/inconsistent at this URL). For a full list of available versions, see times).
See the Directory of published versions icon

8.1.22 Resource Patient - Search Parameters

Maturity Level : N/A
Responsible Owner: Patient Administration icon Work Group   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

Generated Narrative: SearchParameter Patient-active

8.1.23 active

Parameter active : token

Whether the patient record is active

Resource Patient
Expression Patient.active
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or 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

Generated Narrative: SearchParameter individual-address

8.1.24 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
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or 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

Generated Narrative: SearchParameter individual-address-city

8.1.25 address-city

Parameter address-city : string

Multiple Resources:

Resources Patient , Person , Practitioner , RelatedPerson
Expression Patient.address.city | Person.address.city | Practitioner.address.city | RelatedPerson.address.city
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or 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

Generated Narrative: SearchParameter individual-address-country

8.1.26 address-country

Parameter address-country : string

Multiple Resources:

Resources Patient , Person , Practitioner , RelatedPerson
Expression Patient.address.country | Person.address.country | Practitioner.address.country | RelatedPerson.address.country
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or 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

Generated Narrative: SearchParameter individual-address-postalcode

8.1.27 address-postalcode

Parameter address-postalcode : string

Multiple Resources:

Resources Patient , Person , Practitioner , RelatedPerson
Expression Patient.address.postalCode | Person.address.postalCode | Practitioner.address.postalCode | RelatedPerson.address.postalCode
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or 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

Generated Narrative: SearchParameter individual-address-state

8.1.28 address-state

Parameter address-state : string

Multiple Resources:

Resources Patient , Person , Practitioner , RelatedPerson
Expression Patient.address.state | Person.address.state | Practitioner.address.state | RelatedPerson.address.state
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or 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

Generated Narrative: SearchParameter individual-address-use

8.1.29 address-use

Parameter address-use : token

Multiple Resources:

Resources Patient , Person , Practitioner , RelatedPerson
Expression Patient.address.use | Person.address.use | Practitioner.address.use | RelatedPerson.address.use
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or 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

Generated Narrative: SearchParameter individual-birthdate

8.1.30 birthdate

Parameter birthdate : date

Multiple Resources:

Resources Patient , Person , RelatedPerson
Expression Patient.birthDate | Person.birthDate | RelatedPerson.birthDate
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or 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/Patient-death-date

Generated Narrative: SearchParameter Patient-death-date

8.1.31 death-date

Parameter death-date : date

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

Resource Patient
Expression (Patient.deceased.ofType(dateTime))
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or 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/Patient-deceased

Generated Narrative: SearchParameter Patient-deceased

8.1.32 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
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or 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

Generated Narrative: SearchParameter individual-email

8.1.33 email

Parameter email : token

Multiple Resources:

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')
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or 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-family

Generated Narrative: SearchParameter individual-family

8.1.34 family

Parameter family : string

Multiple Resources:

Resources Patient , Practitioner
Expression Patient.name.family | Practitioner.name.family
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or 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

Generated Narrative: SearchParameter individual-gender

8.1.35 gender

Parameter gender : token

Multiple Resources:

Resources Patient , Person , Practitioner , RelatedPerson
Expression Patient.gender | Person.gender | Practitioner.gender | RelatedPerson.gender
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or 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/Patient-general-practitioner

Generated Narrative: SearchParameter Patient-general-practitioner

8.1.36 general-practitioner

Parameter general-practitioner : reference

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

Resource Patient
Expression Patient.generalPractitioner
Processing Mode Normal
Target Resources Organization , PractitionerRole , Practitioner
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or 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-given

Generated Narrative: SearchParameter individual-given

8.1.37 given

Parameter given : string

Multiple Resources:

Resources Patient , Practitioner
Expression Patient.name.given | Practitioner.name.given
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or 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/Patient-identifier

Generated Narrative: SearchParameter Patient-identifier

8.1.38 identifier

Parameter identifier : token

A patient identifier

Resource Patient
Expression Patient.identifier
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or 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/Patient-language

Generated Narrative: SearchParameter Patient-language

8.1.39 language

Parameter language : token

Language code (irrespective of use value)

Resource Patient
Expression Patient.communication.language
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or 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/Patient-link

Generated Narrative: SearchParameter Patient-link

8.1.40 link

Parameter link : reference

All patients/related persons linked to the given patient

Resource Patient
Expression Patient.link.other
Processing Mode Normal
Target Resources RelatedPerson , Patient
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or 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/Patient-name

Generated Narrative: SearchParameter Patient-name

8.1.41 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
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or 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/Patient-organization

Generated Narrative: SearchParameter Patient-organization

8.1.42 organization

Parameter organization : reference

The organization that is the custodian of the patient record

Resource Patient
Expression Patient.managingOrganization
Processing Mode Normal
Target Resources Organization
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or 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

Generated Narrative: SearchParameter individual-phone

8.1.43 phone

Parameter phone : token

Multiple Resources:

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')
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or 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

Generated Narrative: SearchParameter individual-phonetic

8.1.44 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
Processing Mode Phonetic
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or 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

Generated Narrative: SearchParameter individual-telecom

8.1.45 telecom

Parameter telecom : token

Multiple Resources:

Resources Patient , Person , Practitioner , PractitionerRole , RelatedPerson
Expression Patient.telecom | Person.telecom | Practitioner.telecom | PractitionerRole.contact.telecom | RelatedPerson.telecom
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or 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