PractitionerRole
Search Parameters
Below is an overview of the mandatory and optional search parameters and combined search parameters. See the CapabilityStatements of this guide for a complete list of supported RESTful interactions.
FHIR search operations are described in the FHIR specification. Any search parameter defined in FHIR may be 'allowed' by the system unless explicitly marked as "SHALL NOT". A few items are marked as MAY in this implementation guide to highlight their potential relevance.
| Parameter(s) | Conformance | Type(s) | Requirements (when used alone or in combination) |
|---|---|---|---|
| identifier | SHALL | token | The requester SHALL provide both the system and code values. The responder SHALL support both. The requester SHOULD support search using a Medicare Provider Number identifier as defined in the profile. The responder SHOULD support search using a Medicare Provider Number identifier as defined in the profile. |
| practitioner | SHALL | reference | The requester SHALL provide at least an id value and MAY provide both the Type and id values. The responder SHALL support both. The requester SHOULD support chained search practitioner.identifier using a HPI-I identifier as defined in the AU Core Practitioner profile. The responder SHOULD support chained search practitioner.identifier using a HPI-I identifier as defined in the AU Core Practitioner profile. |
| _id | SHOULD | token | |
| specialty | SHOULD | token | The requester SHALL provide at least a code value and MAY provide both the system and code values. The responder SHALL support both. |
| role | SHOULD | token | The requester SHALL provide at least a code value and MAY provide both the system and code values. The responder SHALL support both. |
| organization | MAY | reference | The requester SHALL provide at least an id value and MAY provide both the Type and id values. The responder SHALL support both. |
Mandatory Search Parameters
The following search parameters and search parameter combinations SHALL be supported:
SHALL support searching using the identifier search parameter:
- SHOULD support search using a Medicare Provider Number identifier as defined in the profile.
GET [base]/PractitionerRole?identifier={system|}[code]
SHALL support searching using the practitioner search parameter:
- SHOULD support chained search practitioner.identifier using a HPI-I identifier as defined in the AU Core Practitioner profile.
GET [base]/PractitionerRole?practitioner={Type/}[id]
Optional Search Parameters
The following search parameters and search parameter combinations SHOULD be supported:
SHOULD support searching using the _id search parameter:
GET [base]/PractitionerRole?_id=[id]
SHOULD support searching using the specialty search parameter:
GET [base]/PractitionerRole?specialty={system|}[code]
SHOULD support searching using the role search parameter:
GET [base]/PractitionerRole?role={system|}[code]
Examples
Example requests and implementation notes for this profile (hand-written).