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.4.15 Resource Practitioner - Search Parameters

Patient Administration Work GroupMaturity Level: N/AStandards Status: InformativeSecurity Category: Individual Compartments: Practitioner

Search Parameter Registry for the practitioner resource

8.4.16 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/Practitioner-active

8.4.17 active

Parameter active:token

Whether the practitioner record is active

ResourcePractitioner
ExpressionPractitioner.active
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/build/SearchParameter/Practitioner-address

8.4.18 address

Parameter address:string

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
ExpressionPractitioner.address
UsageNormal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/build/SearchParameter/Practitioner-address-city

8.4.19 address-city

Parameter address-city:string

A city specified in an address

Resources
ExpressionPractitioner.address.city
UsageNormal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/build/SearchParameter/Practitioner-address-country

8.4.20 address-country

Parameter address-country:string

A country specified in an address

Resources
ExpressionPractitioner.address.country
UsageNormal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/build/SearchParameter/Practitioner-address-postalcode

8.4.21 address-postalcode

Parameter address-postalcode:string

A postalCode specified in an address

Resources
ExpressionPractitioner.address.postalCode
UsageNormal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/build/SearchParameter/Practitioner-address-state

8.4.22 address-state

Parameter address-state:string

A state specified in an address

Resources
ExpressionPractitioner.address.state
UsageNormal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/build/SearchParameter/Practitioner-address-use

8.4.23 address-use

Parameter address-use:token

A use code specified in an address

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

8.4.24 communication

Parameter communication:token

One of the languages that the practitioner can communicate with

ResourcePractitioner
ExpressionPractitioner.communication
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 as dateTime)
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
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/build/SearchParameter/Practitioner-email

8.4.27 email

Parameter email:token

A value in an email contact

Resources
ExpressionPractitioner.telecom.where(system='email')
UsageNormal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/build/SearchParameter/Practitioner-family

8.4.28 family

Parameter family:string

A portion of the family name

Resources
ExpressionPractitioner.name.family
UsageNormal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/build/SearchParameter/Practitioner-gender

8.4.29 gender

Parameter gender:token

Gender of the practitioner

Resources
ExpressionPractitioner.gender
UsageNormal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/build/SearchParameter/Practitioner-given

8.4.30 given

Parameter given:string

A portion of the given name

Resources
ExpressionPractitioner.name.given
UsageNormal
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
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
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/build/SearchParameter/Practitioner-phone

8.4.33 phone

Parameter phone:token

A value in a phone contact

Resources
ExpressionPractitioner.telecom.where(system='phone')
UsageNormal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/build/SearchParameter/Practitioner-phonetic

8.4.34 phonetic

Parameter phonetic:string

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

Resources
ExpressionPractitioner.name
UsagePhonetic
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
MultiplesThe parameter cannot repeat or have multiple values
ComparatorsAllowed: eq, ne, gt, ge, lt, le, sa, eb, ap
 
http://hl7.org/fhir/build/SearchParameter/Practitioner-telecom

8.4.36 telecom

Parameter telecom:token

The value in any kind of contact

Resources
ExpressionPractitioner.telecom
UsageNormal
MultiplesThe parameter cannot repeat or have multiple values