practitioner roles

Create Practitioner Role

post
/organizations/{organizationId}/fhir/4/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/json|application/json+fhirapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug

Body

resourceType*This is a PractitionerRole resource
ididThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
metaMetaThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
implicitRulesuriA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
languagecodeThe base language in which the resource is written.
textNarrativeA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
containedarray(ResourceList)These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
extensionarray(Extension)May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
modifierExtensionarray(Extension)May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
identifierarray(Identifier)Business Identifiers that are specific to a role/location.
activebooleanWhether this practitioner role 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 organization.
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 the practitioner is available or performing this role at the location and/or healthcareservice.
notAvailablearray(PractitionerRole_NotAvailable)The practitioner is not available or performing this role 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/4/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*This is a PractitionerRole resource
ididThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
metaMetaThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
implicitRulesuriA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
languagecodeThe base language in which the resource is written.
textNarrativeA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
containedarray(ResourceList)These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
extensionarray(Extension)May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
modifierExtensionarray(Extension)May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
identifierarray(Identifier)Business Identifiers that are specific to a role/location.
activebooleanWhether this practitioner role 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 organization.
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 the practitioner is available or performing this role at the location and/or healthcareservice.
notAvailablearray(PractitionerRole_NotAvailable)The practitioner is not available or performing this role 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/4/PractitionerRole/{resourceId}

Request

Headers

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

Params

organizationId*string|stringid|slug
resourceId*

Response

Read History Practitioner Role

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

Request

Headers

content-type*stringapplication/json|application/json+fhirapplication/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/4/PractitionerRole/{resourceId}/_history/{versionId}

Request

Headers

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

Params

organizationId*string|stringid|slug
resourceId*
versionId*

Response

Remove Practitioner Role

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

Request

Headers

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

Params

organizationId*string|stringid|slug
resourceId*

Response

Search Get Practitioner Role

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

Request

Headers

content-type*stringapplication/json|application/json+fhirapplication/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/4/PractitionerRole/_history

Request

Headers

content-type*stringapplication/json|application/json+fhirapplication/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/4/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*This is a PractitionerRole resource
ididThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
metaMetaThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
implicitRulesuriA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
languagecodeThe base language in which the resource is written.
textNarrativeA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
containedarray(ResourceList)These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
extensionarray(Extension)May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
modifierExtensionarray(Extension)May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
identifierarray(Identifier)Business Identifiers that are specific to a role/location.
activebooleanWhether this practitioner role 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 organization.
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 the practitioner is available or performing this role at the location and/or healthcareservice.
notAvailablearray(PractitionerRole_NotAvailable)The practitioner is not available or performing this role 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/4/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|application/json+fhirapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*This is a PractitionerRole resource
ididThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
metaMetaThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
implicitRulesuriA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
languagecodeThe base language in which the resource is written.
textNarrativeA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
containedarray(ResourceList)These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
extensionarray(Extension)May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
modifierExtensionarray(Extension)May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
identifierarray(Identifier)Business Identifiers that are specific to a role/location.
activebooleanWhether this practitioner role 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 organization.
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 the practitioner is available or performing this role at the location and/or healthcareservice.
notAvailablearray(PractitionerRole_NotAvailable)The practitioner is not available or performing this role 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