Tn Fetch clinician details

POSThttps://preview.ontross.com/api/integrations/tn/fetch-clinician-details

input.clinicianID

string

required

Internal staff identifier, as it appears in staff list URLs.

Example

"731802"

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"

clinician

object

The one staff record matched on the clinician id you sent.

clinician.ID

integer

Numeric id of the clinician, or of the calendar entry on schedules.

Example

946827

clinician.EncryptedID

string

Obfuscated clinician or calendar entry id used in portal URLs.

Example

"k8Qp3Nw7Rx2V"

clinician.FirstName

string

Legal first name on the patient or staff record.

Example

"Avery"

clinician.LastName

string

Legal last name on the patient or staff record.

Example

"Ellison"

clinician.Email

string

Email address on file for this patient or clinician.

Example

"avery.ellison@example.com"

clinician.EmailStatus

string

Coded delivery state of the email, but plain text for clinicians.

Example

"Verified"

clinician.Roles

string

Permission roles this staff member holds, as one string.

Example

"Clinician"

clinician.MobilePhoneFormatted

string

Mobile number with punctuation, ready to display.

Example

"(202) 555-0147"

clinician.HomePhoneFormatted

string

Home number with punctuation, ready to display.

Example

"(202) 555-0186"

clinician.MobilePhoneNumber

string

Mobile number as raw digits, without punctuation.

Example

"2025550147"

clinician.HomePhoneNumber

string

Home number as raw digits, without punctuation.

Example

"2025550186"

clinician.IsClinician

boolean

True when this staff member treats patients.

Example

true

clinician.IsSupervisee

boolean

True when another clinician must cosign their notes.

Example

false

clinician.IsSupervisor

boolean

True when they cosign notes for other clinicians.

Example

true

clinician.IsIntern

boolean

True when the staff member is a trainee.

Example

false

clinician.PreferredName

string

Name the clinician prefers to be called.

Example

"Avery"

clinician.ClinicianType

string

Discipline label such as psychologist or social worker.

Example

"Psychologist"

clinician.CanViewProfile

boolean

True when your signed in user may open this profile.

Example

true

clinician.ClinicianLicenseExpirationDate

string

When their state license lapses, blank if never recorded.

Example

"12/31/2027"

clinician.EnrolledInePrescribe

boolean

True when electronic prescribing is live for this clinician.

Example

false

clinician.HasEprescribeEnrollment

boolean

True when an ePrescribe enrollment record exists, active or not.

Example

true

clinician.ClinicianCanReEnroll

boolean

True when a lapsed ePrescribe enrollment may be redone.

Example

true

clinician.IsEpcsClinician

boolean

True when they may prescribe controlled substances electronically.

Example

false

clinician.HasTherapySearch

boolean

True when the clinician appears in TherapyNotes directory search.

Example

true

clinician.ClinicianCanEnrollInEprescribe

boolean

True when they are eligible to start ePrescribe enrollment.

Example

true

curl --request POST \
  --url https://preview.ontross.com/api/integrations/tn/fetch-clinician-details \
  --header 'X-API-Key: REPLACE_KEY_VALUE' \
  --header 'content-type: application/json' \
  --data '{"input":{"clinicianID":"731802"},"auth_id":"auth_uuid_here"}'

Request BODY

{
  "input": {
    "clinicianID": "731802"
  },
  "auth_id": "auth_uuid_here"
}

Response BODY

{
  "id": "string",
  "workflow_id": "string",
  "auth_id": "string",
  "status": "string",
  "input": {},
  "output": {
    "clinician": {
      "ID": 946827,
      "EncryptedID": "k8Qp3Nw7Rx2V",
      "FirstName": "Avery",
      "LastName": "Ellison",
      "Email": "avery.ellison@example.com",
      "EmailStatus": "Verified",
      "Roles": "Clinician",
      "MobilePhoneFormatted": "(202) 555-0147",
      "HomePhoneFormatted": "(202) 555-0186",
      "MobilePhoneNumber": "2025550147",
      "HomePhoneNumber": "2025550186",
      "IsClinician": true,
      "IsSupervisee": false,
      "IsSupervisor": true,
      "IsIntern": false,
      "PreferredName": "Avery",
      "ClinicianType": "Psychologist",
      "CanViewProfile": true,
      "ClinicianLicenseExpirationDate": "12/31/2027",
      "EnrolledInePrescribe": false,
      "HasEprescribeEnrollment": true,
      "ClinicianCanReEnroll": true,
      "IsEpcsClinician": false,
      "HasTherapySearch": true,
      "ClinicianCanEnrollInEprescribe": true
    }
  },
  "files": null,
  "created_at": "2019-08-24T14:15:22Z",
  "started_at": "2019-08-24T14:15:22Z",
  "completed_at": "2019-08-24T14:15:22Z"
}