FHIR Practitioner
Base Path: /fhir/4.0/Practitioner
Version: 1.0.0
This API allows you to:
- Retrieve a practitioner with a given practitioner ID
- Retrieve practitioners with the ID in a given list of IDs
- Retrieve practitioners with the identifiers in a given list of identifiers
- Search for practitioners by their name, city, state, or qualification
This API is based on the R4 release of the FHIR standard, for more information on this API refer to the official FHIR documentation.
Methods
Get Practitioner by ID
GET /fhir/4.0/Practitioner/{id}
Get a practitioner using a practitioner ID.
Parameters
Name
Type
Data Type
Description
Name:
practitioner_id
required
Type:
path
Data Type:
string
Description:
The ID of the practitioner.
Sample Value: shaBFKLMDEIT5PYYZ7WPTOULUGF3EUTBNLX4FL433XC6FGU7J566OPA
Name:
_format
optional
Type:
query
Data Type:
string
Description:
Media type of the response. It takes precedence over the Accept header.
Possible values are json and xml. The default value is xml.
Sample Value: json
Name:
Accept
optional
Type:
header
Data Type:
string
Description:
Media type of the response.
Possible values are application/json and application/xml. The default value is application/xml.
Sample Value: application/xml
Responses
200
The practitioner has been retrieved successfully.
400
There are invalid fields in the request (such as not including all mandatory fields).
404
No practitioner is available for the specified parameters. This could be either because a correctly formatted practitioner ID no longer matches a practitioner or the practitioner ID is not in the correct format.
Sample Requests
Search by Practitioner ID
curl -X GET "https://developer-solution/fhir/4.0/Practitioner/{id}" \
-H 'Accept: application/json' \
-H 'Authorization: Basic bGV2ZWwxLnN5c19hOk9yaW9uc3k1IT8='Search Practitioner by ID(s)
GET /fhir/4.0/Practitioner/_id={id1},...{idN}
Search for one or more practitioners with practitioner IDs.
Parameters
Name
Type
Data Type
Description
Name:
_id
required
Type:
query
Data Type:
array
Description:
The comma-separated IDs of one or more practitioners.
Sample Value: shaBFKLMDEIT5PYYZ7WPTOULUGF3EUTBNLX4FL433XC6FGU7J566OPA
Name:
_format
optional
Type:
query
Data Type:
string
Description:
Media type of the response. It takes precedence over the Accept header.
Possible values are json and xml. The default value is xml.
Sample Value: json
Name:
Accept
optional
Type:
header
Data Type:
string
Description:
Media type of the response.
Possible values are application/json and application/xml. The default value is application/xml.
Sample Value: application/xml
Responses
200
The practitioner(s) have been retrieved successfully.
400
There are invalid fields in the request (such as not including all mandatory fields).
Sample Requests
Search by Practitioner name
curl -X GET "https://developer-solution/fhir/4.0/Practitioner/_id={id1},...{idN}" \
-H 'Accept: application/json' \
-H 'Authorization: Basic bGV2ZWwxLnN5c19hOk9yaW9uc3k1IT8='Search Practitioner by Identifier(s)
GET /fhir/4.0/Practitioner/_identifier={identifier1},...{identifierN}
Search for one or more practitioners with practitioner identifiers.
Parameters
Name
Type
Data Type
Description
Name:
identifier
required
Type:
query
Data Type:
array
Description:
The comma-separated IDs of one or more practitioners. The following format is used: <system>|<code>
Sample Value: provider-index|926358
Name:
_format
optional
Type:
query
Data Type:
string
Description:
Media type of the response. It takes precedence over the Accept header.
Possible values are json and xml. The default value is xml.
Sample Value: json
Name:
Accept
optional
Type:
header
Data Type:
string
Description:
Media type of the response.
Possible values are application/json and application/xml. The default value is application/xml.
Sample Value: application/xml
Responses
200
The practitioner(s) have been retrieved successfully.
400
There are invalid fields in the request (such as not including all mandatory fields).
Sample Requests
Search by Practitioner name
curl -X GET "https://developer-solution/fhir/4.0/Practitioner/_identifier={identifier1},...{identifierN}" \
-H 'Accept: application/json' \
-H 'Authorization: Basic bGV2ZWwxLnN5c19hOk9yaW9uc3k1IT8='Search Practitioners
GET /fhir/4.0/Practitioner/
Search for practitioners with a practitioner name and other optional search parameters. At least one of the family, given, and name parameters is required for the search.
Parameters
Name
Type
Data Type
Description
Name:
address-city
optional
Type:
query
Data Type:
string
Description:
The city associated with one or more of the practitioner's addresses.
Sample Value: chicago
Name:
address-state
optional
Type:
query
Data Type:
string
Description:
The state associated with one or more of the practitioner's addresses.
Sample Value: illinois
Name:
family
required
Type:
query
Data Type:
string
Description:
Sample Value: doe
Name:
given
required
Type:
query
Data Type:
string
Description:
The practitioner's first name or forename.
Sample Value: john
Name:
name
required
Type:
query
Data Type:
string
Description:
The practitioner's full name. It includes the practitioner's given and family names.
Sample Value: dr john doe
Name:
qualification
optional
Type:
query
Data Type:
string
Description:
The practitioner's medical qualification.
Sample Value: doctor of medicine
Name:
_count
optional
Type:
query
Data Type:
string
Description:
The maximum number of results to return from the search. The default value is 25, and the maximum value is 100.
Sample Value: 30
Name:
_format
optional
Type:
query
Data Type:
string
Description:
Media type of the response. It takes precedence over the Accept header.
Possible values are json and xml. The default value is xml.
Sample Value: json
Name:
Accept
optional
Type:
header
Data Type:
string
Description:
Media type of the response.
Possible values are application/json and application/xml. The default value is application/xml.
Sample Value: application/xml
Responses
200
The practitioner(s) have been retrieved successfully.
400
There are invalid fields in the request (such as not including all mandatory fields).
Sample Requests
Search by Practitioner's given name and family name
curl -X GET "https://developer-solution/fhir/4.0/Practitioner/?family=doe&given=john" \
-H 'Accept: application/json' \
-H 'Authorization: Basic bGV2ZWwxLnN5c19hOk9yaW9uc3k1IT8='