FHIR PractitionerRole

Base Path: /fhir/4.0/PractitionerRole

Version: 2.0.0

The FHIR PractitionerRole API allows you to look up and retrieve PractitionerRole information. The endpoint provides the ability to:

  • Retrieve all PractitionerRole resources that match a search criteria.
  • Retrieve a specific PractitionerRole resource based on its FHIR ID.
  • Retrieve the history of an PractitionerRole resource based on its FHIR ID.
  • Retrieve a specific version of a PractitionerRole resource based on its FHIR ID and Version ID.
  • Retrieve PractitionerRole results from third-party sources.

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

Retrieve PractitionerRoles

GET /fhir/4.0/PractitionerRole/

Return all PractitionerRole resources for the given search criteria, or all PractitionerRole if a search criteria is not specified.

Parameters

Name

Type

Data Type

Description

Name:

active

optional

Type:

query

Data Type:

string

Description:

Filters the PractitionerRoles by whether this practitioner role record is in active use.

Note: Set the value to true to retrieve active PractitionerRoles or false to retrieve inactive PractitionerRoles.


Sample Value: true

Name:

date

optional

Type:

query

Data Type:

array

Description:

Filters the PractitionerRoles by the period during which the practitioner is authorized to perform in these role(s). The supported prefixes are gt, ge, lt, le and eq. If no prefix is used, exact date or date-time matching is implied. Dates must be formatted according to ISO 8601 either as a date only (e.g. 1997-07-16) or as a date-time including the timezone (e.g. 1997-07-16T19:20:30+13:00). Ensure that special characters such as + are URL encoded i.e. %2B. Note: Date range searches are not supported in solutions containing Orion Health Problem List since the patient may have non-date onsets.

The format of the query is

  • date=gt{dateTimeValue}
  • date=ge{dateTimeValue}&date=le{dateTimeValue}


Sample Value: gt1990-01-01T01:00:00+13:00

Name:

email

optional

Type:

query

Data Type:

string

Description:

Filters the PractitionerRoles based on the contact email.

Note:

  • Supports passing in a comma-separated list of values.


Sample Value: help@smiledental.com

Name:

endpoint

optional

Type:

query

Data Type:

array

Description:

Filters the PractitionerRoles by the technical endpoints providing access to services operated for this role, identified by their PractitionerRole.endpoint reference.

Note: endpoint can be chained to define filters on the reference, each of the chained parameters can specify multiple comma separated values.


Sample Value: endpoint.name=Health Intersections CarePlan Hub

Name:

identifier

optional

Type:

query

Data Type:

array

Description:

Filters the PractitionerRoles by the identifier associated with the PractitionerRole.

Note: The identifier can be a single item or a comma separated list of identifiers. Each identifier is defined by system and value , separated using a URL encoded | character i.e. %7c.


Sample Value: urn:oid:1.3.4.5.6.7|2345234234234, urn:text:sysA|2345

Name:

location

optional

Type:

query

Data Type:

array

Description:

Filters the PractitionerRoles by one of the locations at which this practitioner provides care, identified by their PractitionerRole.location reference.

Note: location can be chained to define filters on the reference, each of the chained parameters can specify multiple comma separated values.


Sample Value: location.address-city=AUCKLAND

Name:

organization

optional

Type:

query

Data Type:

array

Description:

Filters the PractitionerRoles by the identity of the organization the practitioner represents / acts on behalf of, identified by their PractitionerRole.organization reference.

Note: organization can be chained to define filters on the reference, each of the chained parameters can specify multiple comma separated values.


Sample Value: Organization.name=Auckland%20Hospital

Name:

phone

optional

Type:

query

Data Type:

string

Description:

Filters the PractitionerRoles based on the contact phone number.

Note:

  • Supports passing in a comma-separated list of values.


Sample Value: 34059342

Name:

practitioner

optional

Type:

query

Data Type:

array

Description:

Filters the PractitionerRoles by the practitioner that is able to provide the defined services for the organization, identified by their PractitionerRole.practitioner reference.

Note: practitioner can be chained to define filters on the reference, each of the chained parameters can specify multiple comma separated values.


Sample Value: Practitioner.family=Smith&Practitioner.given=Bob,Robert

Name:

role

optional

Type:

query

Data Type:

array

Description:

Filters PractitionerRoles by the practitioner can perform this role at for the organization. The code value consists of a coding system and a code separated using a URL encoded | character i.e. %7c.

Note: Supports passing in a comma-separated list of values.


Sample Value: http://snomed.info/sct|1421009

Name:

service

optional

Type:

query

Data Type:

array

Description:

Filters the PractitionerRoles by the list of healthcare services that this worker provides for this role's Organization/Location(s), identified by their PractitionerRole.healthcareService reference.

Note: service can be chained to define filters on the reference, each of the chained parameters can specify multiple comma separated values.


Sample Value: service.name=Consulting psychologists

Name:

specialty

optional

Type:

query

Data Type:

array

Description:

Filters PractitionerRoles by the practitioner has this specialty at an organization. The code value consists of a coding system and a code separated using a URL encoded | character i.e. %7c.

Note: Supports passing in a comma-separated list of values.


Sample Value: http://snomed.info/sct|408467006

Name:

telecom

optional

Type:

query

Data Type:

array

Description:

Filters PractitionerRoles by the value in any kind of contact. The code value consists of a coding system and a code separated using a URL encoded | character i.e. %7c.

Note: Supports passing in a comma-separated list of values.


Sample Value: email|dr.adam.careful@example.org

Name:

practitionerrole-network

optional

Type:

query

Data Type:

array

Description:

Filters the PractitionerRoles by the network extension/extensions for this role, identified by their PractitionerRole.extension reference.

Note: practitionerrole-network can be chained to define filters on the reference, each of the chained parameters can specify multiple comma separated values.


Sample Value: Organization.name=AcmeofCTStdNet

Name:

-include-sources

optional

Type:

query

Data Type:

array

Description:

The -include-sources parameter defines which sources should be queried for the results.

Note: Either -include-sources or -exclude-sources parameter can be specified, not both. If -include-sources is specified, ONLY the specified sources will be searched. Note that the sources specified should be enabled.


Sample Value: Orion%20Health%E2%84%A2%20R4%20HL7V2%20PractitionerRoles

Name:

-exclude-sources

optional

Type:

query

Data Type:

array

Description:

The -exclude-sources parameter defines which sources should NOT be queried for the results.

Note: Either -include-sources or -exclude-sources parameter can be specified, not both. If -exclude-sources is specified, the specified sources will NOT be searched. Note that the sources specified should be enabled.


Sample Value: Orion%20Health%E2%84%A2%20R4%20HL7V2%20PractitionerRoles

Name:

_summary

optional

Type:

query

Data Type:

string

Description:

Instructs the server to return a subset of the resource, reducing the size of the reponse payload. Possible values are:

  • true: return summaries only
  • false: return full resources
  • count: return the count of search matches
  • text: return only the text, id, meta, and top-level mandatory elements
  • data: remove the text element


Sample Value: true

Name:

_lastUpdated

optional

Type:

query

Data Type:

array

Description:

Filters based on when the resource version was last changed, before, or after a specific date, date-time, or date range. The supported prefixes are gt, ge, lt, le and eq. If no prefix is used, exact date or date-time matching is implied. Dates must be formatted according to ISO 8601 either as a date only (e.g. 1997-07-16) or as a date-time including the timezone (e.g. 1997-07-16T19:20:30+13:00). Ensure that special characters such as + are URL encoded i.e. %2B.

The format of the query is

  • _lastUpdated=gt{dateTimeValue}
  • _lastUpdated=ge{dateTimeValue}&_lastUpdated=le{dateTimeValue}


Sample Value: ge2012-01-01T01:00:00+13:00

Name:

_elements

optional

Type:

query

Data Type:

array

Description:

Request a specific set of elements be returned, or excluded as part of a resource in the search results. Use _elements for the elements to include and _elements:exclude for the elements to exclude.


Sample Value: _elements=active,endpoint,_elements:exclude=*.extension

Name:

-cursor

optional

Type:

query

Data Type:

string

Description:

A server internal parameter to navigate different pages.

This parameter is returned by the server as part of the Bundle 'next' link of a paginated query. And is used to retrieve the next page.


Name:

_count

optional

Type:

query

Data Type:

integer

Description:

Limit the number of match results to the specified _count. When _count is specified, the query will be paginated, and only _count or less results will be returned.

The returned bundle may contain a next link if more results could be available.


Sample Value: 30

Name:

_sort

optional

Type:

query

Data Type:

array

Description:

Request which order results should be returned in.

Supported _sort parameters are:

  • active to sort by PractitionerRole.active ascending
  • -active to sort by PractitionerRole.active descending
  • practitioner.name to sort by PractitionerRole.practitioner.name ascending
  • -practitioner.name to sort by PractitionerRole.practitioner.name descending
  • organization.name to sort by PractitionerRole.organization.name ascending
  • -organization.name to sort by PractitionerRole.organization.name descending
  • _lastUpdated to sort by PractitionerRole.Meta.lastUpdated ascending
  • -_lastUpdatedto sort by PractitionerRole.Meta.lastUpdated descending

You can use any combination of the parameters


Default Value: -active, practitioner.name

Sample Value: _sort=-active,_sort=-date, -_lastUpdated

Name:

X-Request-Id

optional

Type:

header

Data Type:

string

Description:

Supply a request Id to track the request.


Sample Value: adUEctf6urd

Name:

Accept

optional

Type:

header

Data Type:

string

Description:

Media type of the response. Possible values are application/json and application/xml. If both _format and Accept are specified, _format takes precedence.


Default Value: application/json

Sample Value: application/json

Name:

Accept-Language

optional

Type:

header

Data Type:

string

Description:

Specifies the language that the results will be translated to. If not specified it will default to the server's locale. (e.g. fr-FR for french)


Sample Value: en-US

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.


Default Value: json

Sample Value: json

Name:

_pretty

optional

Type:

query

Data Type:

string

Description:

Ask for a pretty printed response for human convenience.


Default Value: true

Sample Value: true

Name:

CSRF-Token

required

Type:

header

Data Type:

string

Description:

This header is required for CSRF protection. The csrfToken from the OHP session must be included in this header.

System will validate the token and reject the request if the token is invalid or not present.

Note: Either CSRF-Token or X-Send-Open-API must be included in headers to do the CSRF protection.


Name:

X-Send-Open-API

required

Type:

header

Data Type:

string

Description:

This header is required for CSRF protection. This header is required to distinguish the api requests from known senders.

System will validate "X-Send-Open-API" request header is present or not. If it is not present, system will reject the request.

Note: Either CSRF-Token or X-Send-Open-API must be included in headers to do the CSRF protection.


Responses

application/json+fhir

200

Returns a FHIR Bundle containing 0.. OperationOutcome resources and 0.. PractitionerRole resources.

application/json+fhir

400

This response code is returned when the query is invalid e.g. an invalid parameter or a partial token in the search.

Sample Requests

Get all PractitionerRoles by crietria
curl -X GET "https://developer-solution/fhir/4.0/PractitionerRole?date=gt1990-01-01T01:00:00+13:00&specialty=http://snomed.info/sct%7C408467006" \
-H 'Accept: application/json' \
-H 'Authorization: Basic bGV2ZWwxLnN5c19hOk9yaW9uc3k1IT8='

Retrieve PractitionerRoles

POST /fhir/4.0/PractitionerRole/_search

This method returns all PractitionerRoles by search criteria. This is the secure alternative to the GET search.

Parameters

Name

Type

Data Type

Description

Name:

Content-Type

required

Type:

header

Data Type:

string

Description:

Specifies how to encode the form data. The Content-Type value must be application/x-www-form-urlencoded.


Sample Value: application/x-www-form-urlencoded

Name:

active

optional

Type:

formData

Data Type:

string

Description:

Filters the PractitionerRoles by whether this practitioner role record is in active use.

Note: Set the value to true to retrieve active PractitionerRoles or false to retrieve inactive PractitionerRoles.


Sample Value: true

Name:

date

optional

Type:

formData

Data Type:

array

Description:

Filters the PractitionerRoles by the period during which the practitioner is authorized to perform in these role(s). The supported prefixes are gt, ge, lt, le and eq. If no prefix is used, exact date or date-time matching is implied. Dates must be formatted according to ISO 8601 either as a date only (e.g. 1997-07-16) or as a date-time including the timezone (e.g. 1997-07-16T19:20:30+13:00). Ensure that special characters such as + are URL encoded i.e. %2B. Note: Date range searches are not supported in solutions containing Orion Health Problem List since the patient may have non-date onsets.

The format of the query is

  • date=gt{dateTimeValue}
  • date=ge{dateTimeValue}&date=le{dateTimeValue}


Sample Value: lt2023-01-01

Name:

email

optional

Type:

formData

Data Type:

string

Description:

Filters the PractitionerRoles based on the contact email.

Note:

  • Supports passing in a comma-separated list of values.


Sample Value: help@smiledental.com

Name:

endpoint

optional

Type:

formData

Data Type:

array

Description:

Filters the PractitionerRoles by the technical endpoints providing access to services operated for this role, identified by their PractitionerRole.endpoint reference.

Note: endpoint can be chained to define filters on the reference, each of the chained parameters can specify multiple comma separated values.


Sample Value: endpoint.name=Health Intersections CarePlan Hub

Name:

identifier

optional

Type:

formData

Data Type:

array

Description:

Filters the PractitionerRoles by the identifier associated with the PractitionerRole.

Note: The identifier can be a single item or a comma separated list of identifiers. Each identifier is defined by system and value , separated using a URL encoded | character i.e. %7c.


Sample Value: urn:oid:1.3.4.5.6.7|2345234234234, urn:text:sysA|2345

Name:

location

optional

Type:

formData

Data Type:

array

Description:

Filters the PractitionerRoles by one of the locations at which this practitioner provides care, identified by their PractitionerRole.location reference.

Note: location can be chained to define filters on the reference, each of the chained parameters can specify multiple comma separated values.


Sample Value: location.address-city=AUCKLAND

Name:

organization

optional

Type:

formData

Data Type:

array

Description:

Filters the PractitionerRoles by the identity of the organization the practitioner represents / acts on behalf of, identified by their PractitionerRole.organization reference.

Note: organization can be chained to define filters on the reference, each of the chained parameters can specify multiple comma separated values.


Sample Value: Organization.name=Auckland%20Hospital

Name:

phone

optional

Type:

formData

Data Type:

string

Description:

Filters the PractitionerRoles based on the contact phone number.

Note:

  • Supports passing in a comma-separated list of values.


Sample Value: 34059342

Name:

practitioner

optional

Type:

formData

Data Type:

array

Description:

Filters the PractitionerRoles by the practitioner that is able to provide the defined services for the organization, identified by their PractitionerRole.practitioner reference.

Note: practitioner can be chained to define filters on the reference, each of the chained parameters can specify multiple comma separated values.


Sample Value: Practitioner.family=Smith&Practitioner.given=Bob,Robert

Name:

role

optional

Type:

formData

Data Type:

array

Description:

Filters PractitionerRoles by the practitioner can perform this role at for the organization. The code value consists of a coding system and a code separated using a URL encoded | character i.e. %7c.

Note: Supports passing in a comma-separated list of values.


Sample Value: http://snomed.info/sct|1421009

Name:

service

optional

Type:

formData

Data Type:

array

Description:

Filters the PractitionerRoles by the list of healthcare services that this worker provides for this role's Organization/Location(s), identified by their PractitionerRole.healthcareService reference.

Note: service can be chained to define filters on the reference, each of the chained parameters can specify multiple comma separated values.


Sample Value: service.name=Consulting psychologists

Name:

specialty

optional

Type:

formData

Data Type:

array

Description:

Filters PractitionerRoles by the practitioner has this specialty at an organization. The code value consists of a coding system and a code separated using a URL encoded | character i.e. %7c.

Note: Supports passing in a comma-separated list of values.


Sample Value: http://snomed.info/sct|8724009

Name:

telecom

optional

Type:

formData

Data Type:

array

Description:

Filters PractitionerRoles by the value in any kind of contact. The code value consists of a coding system and a code separated using a URL encoded | character i.e. %7c.

Note: Supports passing in a comma-separated list of values.


Sample Value: email|dr.adam.careful@example.org

Name:

practitionerrole-network

optional

Type:

formData

Data Type:

array

Description:

Filters the PractitionerRoles by the network extension/extensions for this role, identified by their PractitionerRole.extension reference.

Note: practitionerrole-network can be chained to define filters on the reference, each of the chained parameters can specify multiple comma separated values.


Sample Value: Organization.name=AcmeofCTStdNet

Name:

-include-sources

optional

Type:

formData

Data Type:

array

Description:

The -include-sources parameter defines which sources should be queried for the results.

Note: Either -include-sources or -exclude-sources parameter can be specified, not both. If -include-sources is specified, ONLY the specified sources will be searched. Note that the sources specified should be enabled.


Sample Value: Orion%20Health%E2%84%A2%20R4%20HL7V2%20PractitionerRoles

Name:

-exclude-sources

optional

Type:

formData

Data Type:

array

Description:

The -exclude-sources parameter defines which sources should NOT be queried for the results.

Note: Either -include-sources or -exclude-sources parameter can be specified, not both. If -exclude-sources is specified, the specified sources will NOT be searched. Note that the sources specified should be enabled.


Sample Value: Orion%20Health%E2%84%A2%20R4%20HL7V2%20PractitionerRoles

Name:

_summary

optional

Type:

formData

Data Type:

string

Description:

Instructs the server to return a subset of the resource, reducing the size of the reponse payload. Possible values are:

  • true: return summaries only
  • false: return full resources
  • count: return the count of search matches
  • text: return only the text, id, meta, and top-level mandatory elements
  • data: remove the text element


Sample Value: true

Name:

_lastUpdated

optional

Type:

formData

Data Type:

array

Description:

Filters based on when the resource version was last changed, before, or after a specific date, date-time, or date range. The supported prefixes are gt, ge, lt, le and eq. If no prefix is used, exact date or date-time matching is implied. Dates must be formatted according to ISO 8601 either as a date only (e.g. 1997-07-16) or as a date-time including the timezone (e.g. 1997-07-16T19:20:30+13:00). Ensure that special characters such as + are URL encoded i.e. %2B.

The format of the query is

  • _lastUpdated=gt{dateTimeValue}
  • _lastUpdated=ge{dateTimeValue}&_lastUpdated=le{dateTimeValue}


Sample Value: ge2012-01-01T01:00:00+13:00

Name:

_elements

optional

Type:

formData

Data Type:

array

Description:

Request a specific set of elements be returned, or excluded as part of a resource in the search results. Use _elements for the elements to include and _elements:exclude for the elements to exclude.


Sample Value: _elements=active,endpoint,_elements:exclude=*.extension

Name:

-cursor

optional

Type:

formData

Data Type:

string

Description:

A server internal parameter to navigate different pages.

This parameter is returned by the server as part of the Bundle 'next' link of a paginated query. And is used to retrieve the next page.


Name:

_count

optional

Type:

formData

Data Type:

integer

Description:

Limit the number of match results to the specified _count. When _count is specified, the query will be paginated, and only _count or less results will be returned.

The returned bundle may contain a next link if more results could be available.


Sample Value: 30

Name:

_sort

optional

Type:

formData

Data Type:

array

Description:

Request which order results should be returned in.

Supported _sort parameters are:

  • active to sort by PractitionerRole.active ascending
  • -active to sort by PractitionerRole.active descending
  • practitioner.name to sort by PractitionerRole.practitioner.name ascending
  • -practitioner.name to sort by PractitionerRole.practitioner.name descending
  • organization.name to sort by PractitionerRole.organization.name ascending
  • -organization.name to sort by PractitionerRole.organization.name descending
  • _lastUpdated to sort by PractitionerRole.Meta.lastUpdated ascending
  • -_lastUpdatedto sort by PractitionerRole.Meta.lastUpdated descending

You can use any combination of the parameters


Default Value: -active, practitioner.name

Sample Value: _sort=-active,_sort=-date, -_lastUpdated

Name:

X-Request-Id

optional

Type:

header

Data Type:

string

Description:

Supply a request Id to track the request.


Sample Value: adUEctf6urd

Name:

Accept

optional

Type:

header

Data Type:

string

Description:

Media type of the response. Possible values are application/json and application/xml. If both _format and Accept are specified, _format takes precedence.


Default Value: application/json

Sample Value: application/json

Name:

Accept-Language

optional

Type:

header

Data Type:

string

Description:

Specifies the language that the results will be translated to. If not specified it will default to the server's locale. (e.g. fr-FR for french)


Sample Value: en-US

Name:

_format

optional

Type:

formData

Data Type:

string

Description:

Media type of the response. It takes precedence over the Accept header. Possible values are json and xml.


Default Value: json

Sample Value: json

Name:

_pretty

optional

Type:

formData

Data Type:

string

Description:

Ask for a pretty printed response for human convenience.


Default Value: true

Sample Value: true

Name:

CSRF-Token

required

Type:

header

Data Type:

string

Description:

This header is required for CSRF protection. The csrfToken from the OHP session must be included in this header.

System will validate the token and reject the request if the token is invalid or not present.

Note: Either CSRF-Token or X-Send-Open-API must be included in headers to do the CSRF protection.


Name:

X-Send-Open-API

required

Type:

header

Data Type:

string

Description:

This header is required for CSRF protection. This header is required to distinguish the api requests from known senders.

System will validate "X-Send-Open-API" request header is present or not. If it is not present, system will reject the request.

Note: Either CSRF-Token or X-Send-Open-API must be included in headers to do the CSRF protection.


Responses

application/json+fhir

200

Returns a FHIR Bundle containing 0.. OperationOutcome resources and 0.. PractitionerRole resources.

application/json+fhir

400

This response code is returned when the query is invalid e.g. an invalid parameter or a partial token in the search.

Sample Requests

Get all PractitionerRoles by specific crietria
curl -X POST "https://developer-solution/fhir/4.0/PractitionerRole/_search" \
-H 'Accept: application/json' \
-H 'Authorization: Basic bGV2ZWwxLnN5c19hOk9yaW9uc3k1IT8=' \
-H 'Content-Type: application/x-www-form-urlencoded' \
-d 'date=lt2023-01-01' \
-d 'specialty=http://snomed.info/sct%7C8724009'

Retrieve a single PractitionerRole

GET /fhir/4.0/PractitionerRole/{id}

This method returns the PractitionerRole resource matching the requested resource ID.

Parameters

Name

Type

Data Type

Description

Name:

id

required

Type:

path

Data Type:

string

Description:

The id of the PractitionerRole resource to retrieve.


Sample Value: GRQTEZRVGI4GILJTMQ4WMLJUGIYTILLBGJRTALLFMM2TGZRRG44TOZLDGJAFGMI

Name:

Accept-Language

optional

Type:

header

Data Type:

string

Description:

The language that the results will be translated to. If not specified it will default to the server's locale. (e.g. fr-FR for french)


Sample Value: en-US

Name:

X-Request-Id

optional

Type:

header

Data Type:

string

Description:

Supply a request Id to track the request.


Sample Value: adUEctf6urd

Name:

_elements

optional

Type:

query

Data Type:

array

Description:

Request a specific set of elements be returned, or excluded as part of a resource in the search results. Use _elements for the elements to include and _elements:exclude for the elements to exclude.


Sample Value: _elements=active,endpoint,_elements:exclude=*.extension

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.


Default Value: json

Sample Value: json

Name:

_pretty

optional

Type:

query

Data Type:

string

Description:

Ask for a pretty printed response for human convenience.


Default Value: true

Sample Value: true

Name:

Accept

optional

Type:

header

Data Type:

string

Description:

Media type of the response. Possible values are application/json and application/xml. If both _format and Accept are specified, _format takes precedence.


Default Value: application/json

Sample Value: application/json

Name:

CSRF-Token

required

Type:

header

Data Type:

string

Description:

This header is required for CSRF protection. The csrfToken from the OHP session must be included in this header.

System will validate the token and reject the request if the token is invalid or not present.

Note: Either CSRF-Token or X-Send-Open-API must be included in headers to do the CSRF protection.


Name:

X-Send-Open-API

required

Type:

header

Data Type:

string

Description:

This header is required for CSRF protection. This header is required to distinguish the api requests from known senders.

System will validate "X-Send-Open-API" request header is present or not. If it is not present, system will reject the request.

Note: Either CSRF-Token or X-Send-Open-API must be included in headers to do the CSRF protection.


Responses

application/json+fhir

200

Returns an PractitionerRole resource matching the requested resource ID.

application/json+fhir

400

This code is returned when the FHIR ID is empty or not valid.

application/json+fhir

404

No PractitionerRole resource found with the requested resource ID.

Sample Requests

Retrieve a PractitionerRole identified by a specific resource id
curl -X GET "https://developer-solution/fhir/4.0/PractitionerRole/GRQTEZRVGI4GILJTMQ4WMLJUGIYTILLBGJRTALLFMM2TGZRRG44TOZLDGJAFGMI" \
-H 'Accept: application/json' \
-H 'Authorization: Basic bGV2ZWwxLnN5c19hOk9yaW9uc3k1IT8='

Retrieve a PractitionerRole's history

GET /fhir/4.0/PractitionerRole/{id}/_history

This method returns the change history for an PractitionerRole resource matching the requested resource ID. PractitionerRole resources can be retrieved from multiple data sources, and not all sources are able to return history information. This operation will return an empty set of data if no versions of the specified PractitionerRole can be found, which includes cases where:

  • The specified PractitionerRole resource cannot be found.
  • The data source for the PractitionerRole is unable to return history information.

Parameters

Name

Type

Data Type

Description

Name:

id

required

Type:

path

Data Type:

string

Description:

The id of the PractitionerRole resource to retrieve history for.


Sample Value: shaS24BG4RHYSP6TPMK6ZHLO6AKSE25KB6OWIFPLQLLKANOP2ERG6QA

Name:

Accept-Language

optional

Type:

header

Data Type:

string

Description:

The language that the results will be translated to. If not specified it will default to the server's locale. (e.g. fr-FR for french)


Sample Value: en-US

Name:

X-Request-Id

optional

Type:

header

Data Type:

string

Description:

Supply a request Id to track the request.


Sample Value: adUEctf6urd

Name:

_elements

optional

Type:

query

Data Type:

array

Description:

Request a specific set of elements be returned, or excluded as part of a resource in the search results. Use _elements for the elements to include and _elements:exclude for the elements to exclude.


Sample Value: _elements=active,endpoint,_elements:exclude=*.extension

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.


Default Value: json

Sample Value: json

Name:

_pretty

optional

Type:

query

Data Type:

string

Description:

Ask for a pretty printed response for human convenience.


Default Value: true

Sample Value: true

Name:

Accept

optional

Type:

header

Data Type:

string

Description:

Media type of the response. Possible values are application/json and application/xml. If both _format and Accept are specified, _format takes precedence.


Default Value: application/json

Sample Value: application/json

Name:

CSRF-Token

required

Type:

header

Data Type:

string

Description:

This header is required for CSRF protection. The csrfToken from the OHP session must be included in this header.

System will validate the token and reject the request if the token is invalid or not present.

Note: Either CSRF-Token or X-Send-Open-API must be included in headers to do the CSRF protection.


Name:

X-Send-Open-API

required

Type:

header

Data Type:

string

Description:

This header is required for CSRF protection. This header is required to distinguish the api requests from known senders.

System will validate "X-Send-Open-API" request header is present or not. If it is not present, system will reject the request.

Note: Either CSRF-Token or X-Send-Open-API must be included in headers to do the CSRF protection.


Responses

application/json+fhir

200

A FHIR Bundle containing 0..* PractitionerRole resources matching the requested resource ID.

application/json+fhir

400

he source providing the PractitionerRole resource is not capable of returning history of PractitionerRole resources.

application/json+fhir

404

No PractitionerRole resource found with the requested resource ID.

Sample Requests

Retrieve the history of a PractitionerRole identified a specific resource id
curl -X GET "https://developer-solution/fhir/4.0/PractitionerRole/shaS24BG4RHYSP6TPMK6ZHLO6AKSE25KB6OWIFPLQLLKANOP2ERG6QA/_history" \
-H 'Accept: application/json' \
-H 'Authorization: Basic bGV2ZWwxLnN5c19hOk9yaW9uc3k1IT8='

Retrieve a specific version of a PractitionerRole

GET /fhir/4.0/PractitionerRole/{id}/_history/{versionid}

This method returns a specific version of the PractitionerRole resource matching the requested resource ID. PractitionerRole resources can be retrieved from multiple data sources. This operation will return an empty set of data if no versions of the specified PractitionerRole can be found, which includes cases where:

  • The specified PractitionerRole resource cannot be found.

Parameters

Name

Type

Data Type

Description

Name:

id

required

Type:

path

Data Type:

string

Description:

The id of the PractitionerRole resource to retrieve history for.


Sample Value: shaS24BG4RHYSP6TPMK6ZHLO6AKSE25KB6OWIFPLQLLKANOP2ERG6QA

Name:

versionid

required

Type:

path

Data Type:

string

Description:

The version of the PractitionerRole resource.


Sample Value: 1

Name:

Accept-Language

optional

Type:

header

Data Type:

string

Description:

The language that the results will be translated to. If not specified it will default to the server's locale. (e.g. fr-FR for french)


Sample Value: en-US

Name:

X-Request-Id

optional

Type:

header

Data Type:

string

Description:

Supply a request Id to track the request.


Sample Value: adUEctf6urd

Name:

_elements

optional

Type:

query

Data Type:

array

Description:

Request a specific set of elements be returned, or excluded as part of a resource in the search results. Use _elements for the elements to include and _elements:exclude for the elements to exclude.


Sample Value: _elements=active,endpoint,_elements:exclude=*.extension

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.


Default Value: json

Sample Value: json

Name:

_pretty

optional

Type:

query

Data Type:

string

Description:

Ask for a pretty printed response for human convenience.


Default Value: true

Sample Value: true

Name:

Accept

optional

Type:

header

Data Type:

string

Description:

Media type of the response. Possible values are application/json and application/xml. If both _format and Accept are specified, _format takes precedence.


Default Value: application/json

Sample Value: application/json

Name:

CSRF-Token

required

Type:

header

Data Type:

string

Description:

This header is required for CSRF protection. The csrfToken from the OHP session must be included in this header.

System will validate the token and reject the request if the token is invalid or not present.

Note: Either CSRF-Token or X-Send-Open-API must be included in headers to do the CSRF protection.


Name:

X-Send-Open-API

required

Type:

header

Data Type:

string

Description:

This header is required for CSRF protection. This header is required to distinguish the api requests from known senders.

System will validate "X-Send-Open-API" request header is present or not. If it is not present, system will reject the request.

Note: Either CSRF-Token or X-Send-Open-API must be included in headers to do the CSRF protection.


Responses

application/json+fhir

200

Returns a PractitionerRole resource matching the the requested resource ID and version id.

application/json+fhir

400

The source providing the PractitionerRole resource is not capable of returning history of PractitionerRole resources.

application/json+fhir

404

  • No PractitionerRole resource found with the requested resource ID.
  • The version id specified does not exist for the PractitionerRole resource with the requested resource ID.

Sample Requests

Retrieve the version of PractitionerRole identified by a resource id and a version id
curl -X GET "https://developer-solution/fhir/4.0/PractitionerRole/shaS24BG4RHYSP6TPMK6ZHLO6AKSE25KB6OWIFPLQLLKANOP2ERG6QA/_history/1" \
-H 'Accept: application/json' \
-H 'Authorization: Basic bGV2ZWwxLnN5c19hOk9yaW9uc3k1IT8='