Ezderm List providers

POSThttps://preview.ontross.com/api/integrations/ezderm/list-providers

input.facility_id

string

required

Clinic from list-facilities, which EZDerm also calls practiceId and clinicId.

Example

"a1d93f57-62b8-4e14-9c70-38fb5d2ea150"

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"

providers

array

Active users at that facility who can own an encounter.

providers[].id

string

Practice user UUID accepted when selecting an encounter clinician.

Example

"6f21a684-4d87-4b10-82ce-93f5d0a71b68"

providers[].name

string

Combined title and personal details, falling back to the username.

Example

"Dr. Avery Morgan"

providers[].role

string

One encounter capable role the user holds, alphabetically first.

Example

"PROVIDER"

curl --request POST \
  --url https://preview.ontross.com/api/integrations/ezderm/list-providers \
  --header 'X-API-Key: REPLACE_KEY_VALUE' \
  --header 'content-type: application/json' \
  --data '{"input":{"facility_id":"a1d93f57-62b8-4e14-9c70-38fb5d2ea150"},"auth_id":"auth_uuid_here"}'

Request BODY

{
  "input": {
    "facility_id": "a1d93f57-62b8-4e14-9c70-38fb5d2ea150"
  },
  "auth_id": "auth_uuid_here"
}

Response BODY

{
  "id": "string",
  "workflow_id": "string",
  "auth_id": "string",
  "status": "string",
  "input": {},
  "output": {
    "providers": [
      {
        "id": "6f21a684-4d87-4b10-82ce-93f5d0a71b68",
        "name": "Dr. Avery Morgan",
        "role": "PROVIDER"
      }
    ]
  },
  "files": null,
  "created_at": "2019-08-24T14:15:22Z",
  "started_at": "2019-08-24T14:15:22Z",
  "completed_at": "2019-08-24T14:15:22Z"
}