practitioner roles

Create Practitioner Role

post
/organizations/{organizationId}/fhir/3/PractitionerRole

A specific set of Roles/Locations/specialties/services that a practitioner may perform at an organization for a period of time.

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug

Body

resourceType*stringPractitionerRoleThis is a PractitionerRole resource
identifierarray(Identifier)Business Identifiers that are specific to a role/location.
activebooleanWhether this practitioner's record is in active use.
periodPeriodThe period during which the person is authorized to act as a practitioner in these role(s) for the organization.
practitionerReferencePractitioner that is able to provide the defined services for the organation.
organizationReferenceThe organization where the Practitioner performs the roles associated.
codearray(CodeableConcept)Roles which this practitioner is authorized to perform for the organization.
specialtyarray(CodeableConcept)Specific specialty of the practitioner.
locationarray(Reference)The location(s) at which this practitioner provides care.
healthcareServicearray(Reference)The list of healthcare services that this worker provides for this role's Organization/Location(s).
telecomarray(ContactPoint)Contact details that are specific to the role/location/service.
availableTimearray(PractitionerRole_AvailableTime)A collection of times that the Service Site is available.
notAvailablearray(PractitionerRole_NotAvailable)The HealthcareService is not available during this period of time due to the provided reason.
availabilityExceptionsstringA description of site availability exceptions, e.g. public holiday availability. Succinctly describing all possible exceptions to normal site availability as details in the available Times and not available Times.
endpointarray(Reference)Technical endpoints providing access to services operated for the practitioner with this role.

Response

Patch Practitioner Role

patch
/organizations/{organizationId}/fhir/3/PractitionerRole/{resourceId}

A specific set of Roles/Locations/specialties/services that a practitioner may perform at an organization for a period of time.

Request

Headers

content-type*stringapplication/json-patch+jsonapplication/json-patch+json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringPractitionerRoleThis is a PractitionerRole resource
identifierarray(Identifier)Business Identifiers that are specific to a role/location.
activebooleanWhether this practitioner's record is in active use.
periodPeriodThe period during which the person is authorized to act as a practitioner in these role(s) for the organization.
practitionerReferencePractitioner that is able to provide the defined services for the organation.
organizationReferenceThe organization where the Practitioner performs the roles associated.
codearray(CodeableConcept)Roles which this practitioner is authorized to perform for the organization.
specialtyarray(CodeableConcept)Specific specialty of the practitioner.
locationarray(Reference)The location(s) at which this practitioner provides care.
healthcareServicearray(Reference)The list of healthcare services that this worker provides for this role's Organization/Location(s).
telecomarray(ContactPoint)Contact details that are specific to the role/location/service.
availableTimearray(PractitionerRole_AvailableTime)A collection of times that the Service Site is available.
notAvailablearray(PractitionerRole_NotAvailable)The HealthcareService is not available during this period of time due to the provided reason.
availabilityExceptionsstringA description of site availability exceptions, e.g. public holiday availability. Succinctly describing all possible exceptions to normal site availability as details in the available Times and not available Times.
endpointarray(Reference)Technical endpoints providing access to services operated for the practitioner with this role.

Response

Read Practitioner Role

get
/organizations/{organizationId}/fhir/3/PractitionerRole/{resourceId}

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Response

Read History Practitioner Role

get
/organizations/{organizationId}/fhir/3/PractitionerRole/{resourceId}/_history

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_countstring
_sincestring

Params

organizationId*string|stringid|slug
resourceId*

Response

Read Version Practitioner Role

get
/organizations/{organizationId}/fhir/3/PractitionerRole/{resourceId}/_history/{versionId}

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*
versionId*

Response

Remove Practitioner Role

delete
/organizations/{organizationId}/fhir/3/PractitionerRole/{resourceId}

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Response

Search Get Practitioner Role

get
/organizations/{organizationId}/fhir/3/PractitionerRole

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_idstring
_languagestring
activestring
datestring
emailstring
endpointstring
identifierstring
locationstring
organizationstring
phonestring
practitionerstring
rolestring
servicestring
specialtystring
telecomstring

Params

organizationId*string|stringid|slug

Response

Search History Practitioner Role

get
/organizations/{organizationId}/fhir/3/PractitionerRole/_history

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_countstring
_sincestring

Params

organizationId*string|stringid|slug

Response

Search Post Practitioner Role

post
/organizations/{organizationId}/fhir/3/PractitionerRole/_search

A specific set of Roles/Locations/specialties/services that a practitioner may perform at an organization for a period of time.

Request

Headers

content-type*stringapplication/json|application/x-www-form-urlencodedapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_idstring
_languagestring
activestring
datestring
emailstring
endpointstring
identifierstring
locationstring
organizationstring
phonestring
practitionerstring
rolestring
servicestring
specialtystring
telecomstring

Params

organizationId*string|stringid|slug

Body

resourceType*stringPractitionerRoleThis is a PractitionerRole resource
identifierarray(Identifier)Business Identifiers that are specific to a role/location.
activebooleanWhether this practitioner's record is in active use.
periodPeriodThe period during which the person is authorized to act as a practitioner in these role(s) for the organization.
practitionerReferencePractitioner that is able to provide the defined services for the organation.
organizationReferenceThe organization where the Practitioner performs the roles associated.
codearray(CodeableConcept)Roles which this practitioner is authorized to perform for the organization.
specialtyarray(CodeableConcept)Specific specialty of the practitioner.
locationarray(Reference)The location(s) at which this practitioner provides care.
healthcareServicearray(Reference)The list of healthcare services that this worker provides for this role's Organization/Location(s).
telecomarray(ContactPoint)Contact details that are specific to the role/location/service.
availableTimearray(PractitionerRole_AvailableTime)A collection of times that the Service Site is available.
notAvailablearray(PractitionerRole_NotAvailable)The HealthcareService is not available during this period of time due to the provided reason.
availabilityExceptionsstringA description of site availability exceptions, e.g. public holiday availability. Succinctly describing all possible exceptions to normal site availability as details in the available Times and not available Times.
endpointarray(Reference)Technical endpoints providing access to services operated for the practitioner with this role.

Response

Update Practitioner Role

put
/organizations/{organizationId}/fhir/3/PractitionerRole/{resourceId}

A specific set of Roles/Locations/specialties/services that a practitioner may perform at an organization for a period of time.

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringPractitionerRoleThis is a PractitionerRole resource
identifierarray(Identifier)Business Identifiers that are specific to a role/location.
activebooleanWhether this practitioner's record is in active use.
periodPeriodThe period during which the person is authorized to act as a practitioner in these role(s) for the organization.
practitionerReferencePractitioner that is able to provide the defined services for the organation.
organizationReferenceThe organization where the Practitioner performs the roles associated.
codearray(CodeableConcept)Roles which this practitioner is authorized to perform for the organization.
specialtyarray(CodeableConcept)Specific specialty of the practitioner.
locationarray(Reference)The location(s) at which this practitioner provides care.
healthcareServicearray(Reference)The list of healthcare services that this worker provides for this role's Organization/Location(s).
telecomarray(ContactPoint)Contact details that are specific to the role/location/service.
availableTimearray(PractitionerRole_AvailableTime)A collection of times that the Service Site is available.
notAvailablearray(PractitionerRole_NotAvailable)The HealthcareService is not available during this period of time due to the provided reason.
availabilityExceptionsstringA description of site availability exceptions, e.g. public holiday availability. Succinctly describing all possible exceptions to normal site availability as details in the available Times and not available Times.
endpointarray(Reference)Technical endpoints providing access to services operated for the practitioner with this role.

Response