xCaliber healthCare Data Mesh

Practitioner-GET

Description

Retrieves a collection of Practitioner resources matching given search parameters.

Use Cases

  • Retrieve Practitioner Details: Obtain information on a specific practitioner
  • Access Provider Credentials: Retrieve details of provider credentials
  • Query Specialties: Obtain specific specialty information
  • Review Appointment Schedule: Access details of appointment schedules
  • Examine Patient Interaction Records: Retrieve information on patient interactions

Request Sample

Athena
Elation
Canvas
cURL
JavaScript
Java
Python

Source Specific Details

EHRAPIsmandatory filtersoptional filters
Athena
  • ${url}/v1/${practiceId}/providers
  • departmentId
  • name
  • provider-type
  • _count
  • _offset
  • include
Elation
  • ${url}/physicians
    • type
    • name
    • given
    • family
    • identifier
    • _count
    • _offset
    Canvas
    • ${url}/Practitioner

        Filters

        FilterNameDescriptionDefault ValueAllowed Values
        _countPagination params
        _offsetPagination params. Athena: Starting point of entries; 0-indexed
        departmentIdIdentifier for the department
        familyLast name associated with the practitioner
        givenGiven Name of the individual
        includeList of fields which needed to be shown in result
        nameA name associated with the practitioner
        patientPatient reference for any fhir resource
        practitionerPractitioner reference for the any fhir resource
        provider-typeprovider type
        quorumsets sync/async modetrue
        show-usual-department-guess-thresholdusual department guess threshold