PractitionerRole
Get 100 practitioner roles (by default):
GET [base]/fhir/PractitionerRole
Get practitioner role by resource id
:
GET [base]/fhir/PractitionerRole/[id]
The full list of FHIR search parameters for PractitionerRole is found PractitionerRole. Aidbox also offers a selection of query parameters to further refine search results. This includes pagination, full-text search, sorting etc. Refer to the Search for information.
The search results are returned in Bundle by default. Alternatively, you can specify a _result
parameter with value array
to receive resources in a JSON array.
Example search scenario
- Get practitioner role by specialty:
GET [base]/fhir/PractitionerRole?specialty=2084P0802X
2. Find practitioner id
:
"practitioner": {
"reference": "Practitioner/bc3d21a5-af67-4ff9-9f08-9758b71a7e0e"
.......
}
3. Get practitioner by id
:
GET [base]/fhir/Practitioner/[id]
Bulk API
The following bulk operations on PractitionerRole are available.
$dump
Aidbox will respond with Chunked Transfer Encoding ndjson stream, optionally you can get the output in FHIR format or GZIPped.
This is a memory-efficient operation. Aidbox just streams the database cursor to a socket. If your HTTP Client supports processing of Chunked Encoding, you can process resources in stream one by one without waiting for the end of the response. See full docs $dump.
GET [base]/PractitionerRole/$dump
HTTP/1.1 200 OK
Content-Type: application/ndjson
Transfer-Encoding: chunked
{"resourceType": "PractitionerRole", "id": .............}
{"resourceType": "PractitionerRole", "id": .............}
{"resourceType": "PractitionerRole", "id": .............}
{"resourceType": "PractitionerRole", "id": .............}
.........
$dump-csv
Dump PractitionerRole resources in CSV format.
This operation dumps resource data in Aidbox format as CSV (RFC4180). In this format, columns are paths to JSON values and Rows are values. It includes the header.
Neither the specific order of columns nor the order of rows is guaranteed. See full docs $dump-csv.
GET [base]/PractitionerRole/$dump-csv
Parameters
Parameter | Description |
---|---|
PractitionerRole.active | true/false |
PractitionerRole.date | the period during which the practitioner is authorized to perform in these role(s) |
PractitionerRole.email | |
PractitionerRole.endpoint | technical endpoints providing access to services operated for the practitioner with this role |
PractitionerRole.healthcareService | the list of healthcare services that this worker provides for this role's Organization/Location(s) |
PractitionerRole.identifier | identifier in a system |
PractitionerRole.location | the location(s) at which this practitioner provides care |
PractitionerRole.network | associated networks |
PractitionerRole.organization | organization where the roles are available |
PractitionerRole.phone | phone |
PractitionerRole.practitioner | associated practitioner(s) |
PractitionerRole.role | the code of a role |
PractitionerRole.service | the list of healthcare services that this worker provides for this role's Organization/Location(s) |
PractitionerRole.specialty | practitioner specialty |
PractitionerRole.telecom | telecom |