Release 5 R6 Ballot (2nd Draft)

This page is part of the FHIR Specification (v5.0.0: R5 - STU v6.0.0-ballot2: Release 6 Ballot (2nd 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.5.16 8.5.15 Resource PractitionerRole - Search Parameters

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

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

8.5.17 Generated Narrative: SearchParameter PractitionerRole-active

8.5.16 active

Parameter active : token

Whether this practitioner role record is in active use

Resource PractitionerRole
Expression PractitionerRole.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/PractitionerRole-characteristic

8.5.18 Generated Narrative: SearchParameter PractitionerRole-characteristic

8.5.17 characteristic

Parameter characteristic : token

One of the PractitionerRole's characteristics

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

8.5.19 Generated Narrative: SearchParameter PractitionerRole-communication

8.5.18 communication

Parameter communication : token

One of the languages that the practitioner can communicate with

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

8.5.20 Generated Narrative: SearchParameter PractitionerRole-date

8.5.19 date

Parameter date : date

The period during which the practitioner is authorized to perform in these role(s)

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

8.5.21 Generated Narrative: SearchParameter individual-email

8.5.20 email

Parameter email : token

PractitionerRole : A value in an email contact

Resource PractitionerRole
Expression PractitionerRole.contact.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/PractitionerRole-endpoint

8.5.22 Generated Narrative: SearchParameter PractitionerRole-endpoint

8.5.21 endpoint

Parameter endpoint : reference

Technical endpoints providing access to services operated for the practitioner with this role

Resource PractitionerRole
Expression PractitionerRole.endpoint
Processing Mode Normal
Target Resources Endpoint
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/PractitionerRole-identifier

8.5.23 Generated Narrative: SearchParameter PractitionerRole-identifier

8.5.22 identifier

Parameter identifier : token

A practitioner's Identifier

Resource PractitionerRole
Expression PractitionerRole.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/PractitionerRole-location

8.5.24 Generated Narrative: SearchParameter PractitionerRole-location

8.5.23 location

Parameter location : reference

One of the locations at which this practitioner provides care

Resource PractitionerRole
Expression PractitionerRole.location
Processing Mode Normal
Target Resources Location
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/PractitionerRole-organization

8.5.25 Generated Narrative: SearchParameter PractitionerRole-organization

8.5.24 organization

Parameter organization : reference

The identity of the organization the practitioner represents / acts on behalf of

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

8.5.26 Generated Narrative: SearchParameter individual-phone

8.5.25 phone

Parameter phone : token

PractitionerRole : A value in a phone contact

Resource PractitionerRole
Expression PractitionerRole.contact.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/PractitionerRole-practitioner

8.5.27 Generated Narrative: SearchParameter PractitionerRole-practitioner

8.5.26 practitioner

Parameter practitioner : reference

Practitioner that is able to provide the defined services for the organization

Resource PractitionerRole
Expression PractitionerRole.practitioner
Processing Mode Normal
Target Resources 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/PractitionerRole-role

8.5.28 Generated Narrative: SearchParameter PractitionerRole-role

8.5.27 role

Parameter role : token

The practitioner can perform this role at for the organization

Resource PractitionerRole
Expression PractitionerRole.code
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/PractitionerRole-service

8.5.29 Generated Narrative: SearchParameter PractitionerRole-service

8.5.28 service

Parameter service : reference

The list of healthcare services that this worker provides for this role's Organization/Location(s)

Resource PractitionerRole
Expression PractitionerRole.healthcareService
Processing Mode Normal
Target Resources HealthcareService
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/PractitionerRole-specialty

8.5.30 Generated Narrative: SearchParameter PractitionerRole-specialty

8.5.29 specialty

Parameter specialty : token

The practitioner has this specialty at an organization

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

8.5.31 Generated Narrative: SearchParameter individual-telecom

8.5.30 telecom

Parameter telecom : token

PractitionerRole : The value in any kind of contact

Resource PractitionerRole
Expression PractitionerRole.contact.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