practitioner roles
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* | string | application/json | application/json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Query params
Params
| organizationId* | string|string | id|slug |
Body
| resourceType* | string | PractitionerRole | This is a PractitionerRole resource |
| identifier | array(Identifier) | Business Identifiers that are specific to a role/location. | |
| active | boolean | Whether this practitioner's record is in active use. | |
| period | Period | The period during which the person is authorized to act as a practitioner in these role(s) for the organization. | |
| practitioner | Reference | Practitioner that is able to provide the defined services for the organation. | |
| organization | Reference | The organization where the Practitioner performs the roles associated. | |
| code | array(CodeableConcept) | Roles which this practitioner is authorized to perform for the organization. | |
| specialty | array(CodeableConcept) | Specific specialty of the practitioner. | |
| location | array(Reference) | The location(s) at which this practitioner provides care. | |
| healthcareService | array(Reference) | The list of healthcare services that this worker provides for this role's Organization/Location(s). | |
| telecom | array(ContactPoint) | Contact details that are specific to the role/location/service. | |
| availableTime | array(PractitionerRole_AvailableTime) | A collection of times that the Service Site is available. | |
| notAvailable | array(PractitionerRole_NotAvailable) | The HealthcareService is not available during this period of time due to the provided reason. | |
| availabilityExceptions | string | A 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. | |
| endpoint | array(Reference) | Technical endpoints providing access to services operated for the practitioner with this role. |
Response
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* | string | application/json | application/json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Query params
Params
| organizationId* | string|string | id|slug | |
| resourceId* |
Body
| resourceType* | string | PractitionerRole | This is a PractitionerRole resource |
| identifier | array(Identifier) | Business Identifiers that are specific to a role/location. | |
| active | boolean | Whether this practitioner's record is in active use. | |
| period | Period | The period during which the person is authorized to act as a practitioner in these role(s) for the organization. | |
| practitioner | Reference | Practitioner that is able to provide the defined services for the organation. | |
| organization | Reference | The organization where the Practitioner performs the roles associated. | |
| code | array(CodeableConcept) | Roles which this practitioner is authorized to perform for the organization. | |
| specialty | array(CodeableConcept) | Specific specialty of the practitioner. | |
| location | array(Reference) | The location(s) at which this practitioner provides care. | |
| healthcareService | array(Reference) | The list of healthcare services that this worker provides for this role's Organization/Location(s). | |
| telecom | array(ContactPoint) | Contact details that are specific to the role/location/service. | |
| availableTime | array(PractitionerRole_AvailableTime) | A collection of times that the Service Site is available. | |
| notAvailable | array(PractitionerRole_NotAvailable) | The HealthcareService is not available during this period of time due to the provided reason. | |
| availabilityExceptions | string | A 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. | |
| endpoint | array(Reference) | Technical endpoints providing access to services operated for the practitioner with this role. |
Response
get
/organizations/{organizationId}/fhir/3/practitionerrole/{resourceId}
Request
Headers
| content-type* | string | application/json | application/json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Query params
Params
| organizationId* | string|string | id|slug | |
| resourceId* |
Response
get
/organizations/{organizationId}/fhir/3/practitionerrole/{resourceId}/_history
Request
Headers
| content-type* | string | application/json | application/json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Query params
| _count | string | ||
| _since | string |
Params
| organizationId* | string|string | id|slug | |
| resourceId* |
Response
get
/organizations/{organizationId}/fhir/3/practitionerrole/{resourceId}/_history/{versionId}
Request
Headers
| content-type* | string | application/json | application/json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Query params
Params
| organizationId* | string|string | id|slug | |
| resourceId* | |||
| versionId* |
Response
delete
/organizations/{organizationId}/fhir/3/practitionerrole/{resourceId}
Request
Headers
| content-type* | string | application/json | application/json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Query params
Params
| organizationId* | string|string | id|slug | |
| resourceId* |
Response
get
/organizations/{organizationId}/fhir/3/practitionerrole
Request
Headers
| content-type* | string | application/json | application/json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Query params
| _id | string | ||
| _language | string | ||
| active | string | ||
| date | string | ||
| string | |||
| endpoint | string | ||
| identifier | string | ||
| location | string | ||
| organization | string | ||
| phone | string | ||
| practitioner | string | ||
| role | string | ||
| service | string | ||
| specialty | string | ||
| telecom | string |
Params
| organizationId* | string|string | id|slug |
Response
get
/organizations/{organizationId}/fhir/3/practitionerrole/_history
Request
Headers
| content-type* | string | application/json | application/json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Query params
| _count | string | ||
| _since | string |
Params
| organizationId* | string|string | id|slug |
Response
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* | string | application/json|application/x-www-form-urlencoded | application/json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Query params
| _id | string | ||
| _language | string | ||
| active | string | ||
| date | string | ||
| string | |||
| endpoint | string | ||
| identifier | string | ||
| location | string | ||
| organization | string | ||
| phone | string | ||
| practitioner | string | ||
| role | string | ||
| service | string | ||
| specialty | string | ||
| telecom | string |
Params
| organizationId* | string|string | id|slug |
Body
| resourceType* | string | PractitionerRole | This is a PractitionerRole resource |
| identifier | array(Identifier) | Business Identifiers that are specific to a role/location. | |
| active | boolean | Whether this practitioner's record is in active use. | |
| period | Period | The period during which the person is authorized to act as a practitioner in these role(s) for the organization. | |
| practitioner | Reference | Practitioner that is able to provide the defined services for the organation. | |
| organization | Reference | The organization where the Practitioner performs the roles associated. | |
| code | array(CodeableConcept) | Roles which this practitioner is authorized to perform for the organization. | |
| specialty | array(CodeableConcept) | Specific specialty of the practitioner. | |
| location | array(Reference) | The location(s) at which this practitioner provides care. | |
| healthcareService | array(Reference) | The list of healthcare services that this worker provides for this role's Organization/Location(s). | |
| telecom | array(ContactPoint) | Contact details that are specific to the role/location/service. | |
| availableTime | array(PractitionerRole_AvailableTime) | A collection of times that the Service Site is available. | |
| notAvailable | array(PractitionerRole_NotAvailable) | The HealthcareService is not available during this period of time due to the provided reason. | |
| availabilityExceptions | string | A 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. | |
| endpoint | array(Reference) | Technical endpoints providing access to services operated for the practitioner with this role. |
Response
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* | string | application/json | application/json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Query params
Params
| organizationId* | string|string | id|slug | |
| resourceId* |
Body
| resourceType* | string | PractitionerRole | This is a PractitionerRole resource |
| identifier | array(Identifier) | Business Identifiers that are specific to a role/location. | |
| active | boolean | Whether this practitioner's record is in active use. | |
| period | Period | The period during which the person is authorized to act as a practitioner in these role(s) for the organization. | |
| practitioner | Reference | Practitioner that is able to provide the defined services for the organation. | |
| organization | Reference | The organization where the Practitioner performs the roles associated. | |
| code | array(CodeableConcept) | Roles which this practitioner is authorized to perform for the organization. | |
| specialty | array(CodeableConcept) | Specific specialty of the practitioner. | |
| location | array(Reference) | The location(s) at which this practitioner provides care. | |
| healthcareService | array(Reference) | The list of healthcare services that this worker provides for this role's Organization/Location(s). | |
| telecom | array(ContactPoint) | Contact details that are specific to the role/location/service. | |
| availableTime | array(PractitionerRole_AvailableTime) | A collection of times that the Service Site is available. | |
| notAvailable | array(PractitionerRole_NotAvailable) | The HealthcareService is not available during this period of time due to the provided reason. | |
| availabilityExceptions | string | A 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. | |
| endpoint | array(Reference) | Technical endpoints providing access to services operated for the practitioner with this role. |