ATHENA PROD

Fetch providers

List the practice's providers, locations and schedule IDs.

POSThttps://api.ontross.com/api/integrations/athena-prod/fetch-providers

Request Fields

input.org_id

integer

required

Athena practice ID; also the scheduling context id.

Example

32817

input.department_id

integer

required

Runtime Athena context department.

Example

1

input.name

string

Resolve a display name to its IDs; exact matches win, else substring.

Example

"Dana Whitfield"

input.exclude_inactive

boolean

Leave out providers Athena marks inactive.

Example

true

Default

true

input.providers_only

boolean

Keep only human providers; false also returns rooms and equipment.

Example

true

Default

true

auth_id

string

required

Saved connection to run this operation through, from the Authentication page. It decides which practice and login the call uses.

Example

"00000000-0000-4000-8000-000000000000"

Output Fields

providers

array

Providers in the practice directory, with their schedule IDs.

providers[].id

string

Scheduling provider ID, context-qualified.

Example

"32817-4"

providers[].name

string

Display name as the practice directory shows it.

Example

"Dana Whitfield, MD"

providers[].first_name

string

Provider's given name.

Example

"Dana"

providers[].last_name

string

Provider's family name.

Example

"Whitfield"

providers[].prefix

string

Name prefix recorded for the provider.

Example

"Dr"

providers[].suffix

string

Credential letters shown after the name.

Example

"MD"

providers[].is_provider

boolean

True for a human provider, false for a room or equipment resource.

Example

true

providers[].provider_type

string

Athena provider type.

Example

"MD"

providers[].specialty

string

Specialty recorded for the provider.

Example

"Family Medicine"

providers[].resource_type

string

Schedule resource type Athena assigns.

Example

"Provider"

providers[].group_id

string

Provider group the provider belongs to, if any.

Example

"32817-2"

providers[].location_ids

array

Locations the provider is active in.

providers[].schedules

array

The provider's active schedules, with the IDs booking needs.

providers[].schedules[].schedule_id

string

Scheduling resource ID that search-appointment-availability and book-appointment take.

Example

"32817-4-10"

providers[].schedules[].provider_id

string

Provider the schedule belongs to.

Example

"32817-4"

providers[].schedules[].department_id

string

Department the schedule sits in.

Example

"32817-1"

providers[].schedules[].provider_group_id

string

Provider group the schedule belongs to, if any.

Example

"32817-2"

providers[].npi

string

National Provider Identifier from the practice's provider directory; null for resources and providers without one.

Example

"1215009113"

providers[].taxonomy_code

string

Provider taxonomy code.

Example

"207R00000X"

providers[].taxonomy_name

string

Provider taxonomy name.

Example

"Internal Medicine"

providers[].display_name

string

Display name as the provider directory shows it.

Example

"Dana Whitfield, MD"

providers[].billed_name

string

Name the practice bills under for this provider.

Example

"Dana Whitfield, MD"

providers[].medical_group_id

string

Medical group the provider bills under.

Example

"1"

providers[].entity_type

string

Person or Non-person entity.

Example

"Person"

providers[].username

string

The provider's athenaNet username.

Example

"dwhitfield1"

locations

array

Practice locations (departments) the schedules sit in.

locations[].id

string

Location (department) ID, context-qualified.

Example

"32817-1"

locations[].name

string

Location name as scheduling shows it.

Example

"Main Street Clinic"

locations[].canonical_name

string

Athena's canonical name for the location.

Example

"MAIN STREET CLINIC"

locations[].group_id

string

Provider group the location belongs to, if any.

Example

"32817-2"

locations[].timezone

string

Location's timezone.

Example

"America/New_York"

locations[].address_lines

array

Street address lines.

locations[].city

string

Location city.

Example

"Watertown"

locations[].state

string

Location state.

Example

"MA"

locations[].postal_code

string

Location postal code.

Example

"02472"

locations[].is_scheduling_department

boolean

Whether appointments can be booked into this location.

Example

true

locations[].accepts_urgent

boolean

Whether the location accepts urgent bookings.

Example

true

locations[].provider_ids

array

Providers active in this location.

locations[].schedules

array

Schedules the location hosts.

locations[].schedules[].schedule_id

string

Scheduling resource ID that search-appointment-availability and book-appointment take.

Example

"32817-4-10"

locations[].schedules[].provider_id

string

Provider the schedule belongs to.

Example

"32817-4"

locations[].schedules[].department_id

string

Department the schedule sits in.

Example

"32817-1"

locations[].schedules[].provider_group_id

string

Provider group the schedule belongs to, if any.

Example

"32817-2"

total

integer

Number of providers returned.

Example

1

Code

curl curl %s %s POST \
  --url https://api.ontross.com/api/integrations/athena-prod/fetch-providers \
  %s %s 'X-API-Key: REPLACE_KEY_VALUE' \
  %s %s 'content-type: application/json' \
  %s %s '{"input":{"department_id":1,"exclude_inactive":true,"name":"Dana Whitfield","org_id":32817,"providers_only":true},"auth_id":"auth_uuid_here"}'

Request BODY

{
  "input": {
    "department_id": 1,
    "exclude_inactive": true,
    "name": "Dana Whitfield",
    "org_id": 32817,
    "providers_only": true
  },
  "auth_id": "auth_uuid_here"
}

Response BODY

{
  "id": "string",
  "workflow_id": "string",
  "auth_id": "string",
  "status": "string",
  "input": {},
  "output": {
    "providers": [
      {
        "id": "32817-4",
        "name": "Dana Whitfield, MD",
        "first_name": "Dana",
        "last_name": "Whitfield",
        "prefix": "Dr",
        "suffix": "MD",
        "is_provider": true,
        "provider_type": "MD",
        "specialty": "Family Medicine",
        "resource_type": "Provider",
        "group_id": "32817-2",
        "location_ids": [
          "string"
        ],
        "schedules": [
          {
            "schedule_id": "32817-4-10",
            "provider_id": "32817-4",
            "department_id": "32817-1",
            "provider_group_id": "32817-2"
          }
        ],
        "npi": "1215009113",
        "taxonomy_code": "207R00000X",
        "taxonomy_name": "Internal Medicine",
        "display_name": "Dana Whitfield, MD",
        "billed_name": "Dana Whitfield, MD",
        "medical_group_id": "1",
        "entity_type": "Person",
        "username": "dwhitfield1"
      }
    ],
    "locations": [
      {
        "id": "32817-1",
        "name": "Main Street Clinic",
        "canonical_name": "MAIN STREET CLINIC",
        "group_id": "32817-2",
        "timezone": "America/New_York",
        "address_lines": [
          "string"
        ],
        "city": "Watertown",
        "state": "MA",
        "postal_code": "02472",
        "is_scheduling_department": true,
        "accepts_urgent": true,
        "provider_ids": [
          "string"
        ],
        "schedules": [
          {
            "schedule_id": "32817-4-10",
            "provider_id": "32817-4",
            "department_id": "32817-1",
            "provider_group_id": "32817-2"
          }
        ]
      }
    ],
    "total": 1
  },
  "files": null,
  "created_at": "2019-08-24T14:15:22Z",
  "started_at": "2019-08-24T14:15:22Z",
  "completed_at": "2019-08-24T14:15:22Z"
}