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

8.4.16 Resource Practitioner - Search Parameters

Patient Administration icon Work GroupMaturity Level: N/A  Trial UseSecurity 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

ResourcePractitioner
ExpressionPractitioner.active
Processing ModeNormal
MultiplesThe parameter cannot repeat or have multiple values
 
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

ResourcePractitioner
ExpressionPractitioner.address
Processing ModeNormal
MultiplesThe parameter cannot repeat or have multiple values
 
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

ResourcePractitioner
ExpressionPractitioner.address.city
Processing ModeNormal
MultiplesThe parameter cannot repeat or have multiple values
 
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

ResourcePractitioner
ExpressionPractitioner.address.country
Processing ModeNormal
MultiplesThe parameter cannot repeat or have multiple values
 
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

ResourcePractitioner
ExpressionPractitioner.address.postalCode
Processing ModeNormal
MultiplesThe parameter cannot repeat or have multiple values
 
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

ResourcePractitioner
ExpressionPractitioner.address.state
Processing ModeNormal
MultiplesThe parameter cannot repeat or have multiple values
 
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

ResourcePractitioner
ExpressionPractitioner.address.use
Processing ModeNormal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/Practitioner-communication

8.4.24 communication

Parameter communication:token

A language to communicate with the practitioner

ResourcePractitioner
ExpressionPractitioner.communication.language
Processing ModeNormal
MultiplesThe parameter cannot repeat or have multiple values
 
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

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

8.4.26 deceased

Parameter deceased:token

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

ResourcePractitioner
ExpressionPractitioner.deceased.exists() and Practitioner.deceased != false
Processing ModeNormal
MultiplesThe parameter cannot repeat or have multiple values
 
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

ResourcePractitioner
ExpressionPractitioner.telecom.where(system='email')
Processing ModeNormal
MultiplesThe parameter cannot repeat or have multiple values
 
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

ResourcePractitioner
ExpressionPractitioner.name.family
Processing ModeNormal
MultiplesThe parameter cannot repeat or have multiple values
 
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

ResourcePractitioner
ExpressionPractitioner.gender
Processing ModeNormal
MultiplesThe parameter cannot repeat or have multiple values
 
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

ResourcePractitioner
ExpressionPractitioner.name.given
Processing ModeNormal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/Practitioner-identifier

8.4.31 identifier

Parameter identifier:token

A practitioner's Identifier

ResourcePractitioner
ExpressionPractitioner.identifier | Practitioner.qualification.identifier
Processing ModeNormal
MultiplesThe parameter cannot repeat or have multiple values
 
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

ResourcePractitioner
ExpressionPractitioner.name
Processing ModeNormal
MultiplesThe parameter cannot repeat or have multiple values
 
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

ResourcePractitioner
ExpressionPractitioner.telecom.where(system='phone')
Processing ModeNormal
MultiplesThe parameter cannot repeat or have multiple values
 
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

ResourcePractitioner
ExpressionPractitioner.name
Processing ModePhonetic
MultiplesThe parameter cannot repeat or have multiple values
 
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

ResourcePractitioner
ExpressionPractitioner.qualification.period
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/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

ResourcePractitioner
ExpressionPractitioner.telecom
Processing ModeNormal
MultiplesThe parameter cannot repeat or have multiple values