Release 5 R6 Ballot (1st Draft)

This page is part of the FHIR Specification (v5.0.0: R5 - STU v6.0.0-ballot1: Release 6 Ballot (1st Draft) (see Ballot Notes ). This is the The current published version in it's permanent home (it will always be available at this URL). is 5.0.0 . For a full list of available versions, see the Directory of published versions

8.4.16 Resource Practitioner - Search Parameters

Patient Administration icon Work Group Maturity Level : N/A   Trial Use Security Category : Individual Compartments : Practitioner

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

8.4.17 active

Parameter active : token

Whether the practitioner record is active

Resource Practitioner
Expression Practitioner.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
This search parameter is part of the common search parameter individual-address

8.4.18 address

Parameter address : string

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

Resource Practitioner
Expression Practitioner.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
This search parameter is part of the common search parameter individual-address-city

8.4.19 address-city

Parameter address-city : string

Practitioner : A city specified in an address

Resource Practitioner
Expression Practitioner.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
This search parameter is part of the common search parameter individual-address-country

8.4.20 address-country

Parameter address-country : string

Practitioner : A country specified in an address

Resource Practitioner
Expression Practitioner.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
This search parameter is part of the common search parameter individual-address-postalcode

8.4.21 address-postalcode

Parameter address-postalcode : string

Practitioner : A postalCode specified in an address

Resource Practitioner
Expression Practitioner.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
This search parameter is part of the common search parameter individual-address-state

8.4.22 address-state

Parameter address-state : string

Practitioner : A state specified in an address

Resource Practitioner
Expression Practitioner.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
This search parameter is part of the common search parameter individual-address-use

8.4.23 address-use

Parameter address-use : token

Practitioner : A use code specified in an address

Resource Practitioner
Expression Practitioner.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/Practitioner-communication

8.4.24 communication

Parameter communication : token

A language to communicate with the practitioner

Resource Practitioner
Expression Practitioner.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/Practitioner-death-date

8.4.25 death-date

Parameter death-date : date

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

Resource Practitioner
Expression (Practitioner.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/Practitioner-deceased

8.4.26 deceased

Parameter deceased : token

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

Resource Practitioner
Expression Practitioner.deceased.exists() and Practitioner.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
This search parameter is part of the common search parameter individual-email

8.4.27 email

Parameter email : token

Practitioner : A value in an email contact

Resource Practitioner
Expression Practitioner.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
This search parameter is part of the common search parameter individual-family

8.4.28 family

Parameter family : string

Practitioner : A portion of the family name

Resource Practitioner
Expression 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
This search parameter is part of the common search parameter individual-gender

8.4.29 gender

Parameter gender : token

Practitioner : Gender of the practitioner

Resource Practitioner
Expression Practitioner.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/individual-given
This search parameter is part of the common search parameter individual-given

8.4.30 given

Parameter given : string

Practitioner : A portion of the given name

Resource Practitioner
Expression 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/Practitioner-identifier

8.4.31 identifier

Parameter identifier : token

A practitioner's Identifier

Resource Practitioner
Expression Practitioner.identifier | Practitioner.qualification.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/Practitioner-name

8.4.32 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

Resource Practitioner
Expression Practitioner.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/individual-phone
This search parameter is part of the common search parameter individual-phone

8.4.33 phone

Parameter phone : token

Practitioner : A value in a phone contact

Resource Practitioner
Expression Practitioner.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
This search parameter is part of the common search parameter individual-phonetic

8.4.34 phonetic

Parameter phonetic : string

Practitioner : A portion of either family or given name using some kind of phonetic matching algorithm

Resource Practitioner
Expression Practitioner.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/Practitioner-qualification-period

8.4.35 qualification-period

Parameter qualification-period : date

The date(s) a qualification is valid for

Resource Practitioner
Expression Practitioner.qualification.period
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/individual-telecom
This search parameter is part of the common search parameter individual-telecom

8.4.36 telecom

Parameter telecom : token

Practitioner : The value in any kind of contact

Resource Practitioner
Expression Practitioner.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