xCaliber healthCare Data Mesh

PractitionerRole-GET

Description

Retrieves a collection of PractitionerRole resources that match the given search parameters.

Use Cases

  • Retrieve Practitioner Roles: Obtain information on specific roles
  • Access Role Details: Retrieve general role details
  • Query Provider Assignments: Obtain details of specific provider assignments
  • Review Specialties: Access details of specific specialties in a role
  • Examine Schedule Assignments: Retrieve information on specific schedule assignments

Request Sample

Athena
Elation
Canvas
cURL
JavaScript
Java
Python
Source Specific Details
EHRAPIsmandatory filtersoptional filters
Elation
  • ${url}/appointments
  • ${url}/practices/${practiceId}
  • practitioner
    Athena
    • ${url}/v1/${practiceId}/departments
    • practitioner
    • hospital-only
    • full-provider-list
    • _count
    • _offset
    Canvas
    • ${url}/Practitioner/${practitionerId}
    • practitioner
      Filters
      FilterNameDescriptionDefault ValueAllowed Values
      _countPagination params
      _offsetPagination params. Athena: Starting point of entries; 0-indexed
      departmentIdIdentifier for the department
      full-provider-listIf set to true, list providers who are configured to be able to see patients in this department
      hospital-onlyIf set to true, return hospital only departments.
      includeList of fields which needed to be shown in result
      patientPatient reference for any fhir resource
      practitionerPractitioner reference for the any fhir resource
      quorumsets sync/async modetrue
      Previous
      PractitionerRole
      Next
      PractitionerRole-ID-DELETE