Base structure definition
API Endpoints
READ
The [patient|user|system]/Practitioner.read scope is required.
GET /fhir/Practitioner/{id}
| Parameter |
Type |
Description |
id |
string |
Required. The logical id of the resource |
Response Codes
| Code |
Description |
| 200 OK |
The requested Practitioner resource within the body of the HTTP response. |
| 400 Bad Request |
The server could not understand the request due to invalid syntax. The response body will contain a message property with the error description |
| 404 Not Found |
The requested resource does not exist. |
| 500 Internal Server Error |
An error occurred and the server doesn't know how to handle it. The response body will contain a message property with the error description |
GET Search
The [patient|user|system]/Practitioner.read scope is required.
GET /fhir/Practitioner
| Parameter |
Type |
Description |
name |
string |
A server defined search that may match any of the string fields in the HumanName |
identifier |
string |
Practitioner.identifier is the parameter used when searching on identifier |
Response Codes
| Code |
Description |
| 200 OK |
The body of the response will contain a Bundle resource. |
| 400 Bad Request |
The server could not understand the request due to invalid syntax. The response body will contain a message property with the error description |
| 404 Not Found |
The requested resource does not exist. |
| 500 Internal Server Error |
An error occurred and the server doesn't know how to handle it. The response body will contain a message property with the error description |
POST Search
The [patient|user|system]/Practitioner.read scope is required.
POST /fhir/Practitioner/_search
| Parameter |
Type |
Description |
name |
string |
A server defined search that may match any of the string fields in the HumanName |
identifier |
string |
Practitioner.identifier is the parameter used when searching on identifier |
