xCaliber healthCare Data Mesh

Organization-GET

Description

Retrieves a list of healthcare provider organizations with summary information like name, type, specialties, location.

Use Cases

  • Retrieve Organization Details: Obtain information on a specific organization
  • Access Healthcare Network: Retrieve details of a healthcare network
  • Query Department Information: Obtain details of a specific department
  • Review Affiliated Providers: Access details of affiliated providers
  • Examine Service Locations: Retrieve information on service locations

Request Sample

Athena
Elation
Canvas
cURL
JavaScript
Java
Python

Source Specific Details

EHRAPIsmandatory filtersoptional filters
Athena
  • ${url}/v1/${practiceId}/employers
  • category=employer
  • exact-name
  • city
  • address
  • zip
  • name
  • phone
  • state
  • _count
  • _offset

Filters

FilterNameDescriptionDefault ValueAllowed Values
_countPagination params
_offsetPagination params. Athena: Starting point of entries; 0-indexed
addressA server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text
categoryCategory of organizationemployer
cityThe city of the employer (exact match).
departmentIdIdentifier for the department
exact-nameThe name of the employer (exact match).
includeList of fields which needed to be shown in result
nameA portion of the organization's name or alias
patientPatient reference for any fhir resource
phoneThe phone of the employer (exact match).
practitionerPractitioner reference for the any fhir resource
quorumsets sync/async modetrue
stateThe zip of the employer (exact match).
zipThe zip of the employer (exact match).