Tross
Demo dataBook a demo
THERAPYNOTES

Fetch patient info

Get patient demographics and visit statistics.

POSThttps://preview.ontross.com/api/integrations/tn/fetch-patient-info
Request Fields
input.patientID
string
required
Internal numeric chart ID used across billing and chart pages.
Example
"75843069"
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
patient
object
Demographic and billing record for the patient you asked for.
patient.PatientId
integer
Numeric TherapyNotes id for the patient on this record.
Example
98001234
patient.FirstName
string
Legal first name on the patient or staff record.
Example
"Avery"
patient.MiddleName
string
Middle name from the chart, blank for most patients.
Example
"Lee"
patient.LastName
string
Legal last name on the patient or staff record.
Example
"Sample"
patient.Nickname
string
Informal name staff typed for this patient, often blank.
Example
"Ave"
patient.PracticeId
integer
The TherapyNotes practice this patient belongs to.
Example
980012
patient.Phone
string
Primary phone for the patient, or the payer's phone.
Example
"6085550142"
patient.PhoneMessages
boolean
True when staff may leave messages on that phone.
Example
true
patient.Country
string
Country for the mailing address, held outside the Address object.
Example
"US"
patient.Email
string
Email address on file for this patient or clinician.
Example
"avery.sample@example.com"
patient.DateOfBirth
string
Birth date, formatted the way the portal returns it.
Example
"1988-04-12T00:00:00"
patient.PcpConsent
integer
Coded consent to share records with the primary care provider.
Example
1
patient.Hipaa
boolean
True when a signed HIPAA notice is on file.
Example
true
patient.PadDate
string
Date on the stored PAD form, blank when unsigned.
Example
"2024-02-15T00:00:00"
patient.PadForm
string
Identifier of the stored PAD form, often blank.
Example
"980076421"
patient.HomePhone
string
Home phone digits as stored, without formatting.
Example
"6085550142"
patient.WorkPhone
string
Work phone digits as stored, without formatting.
Example
"6085550143"
patient.MobilePhone
string
Mobile phone digits as stored, without formatting.
Example
"6085550144"
patient.OtherPhone
string
Any additional phone number kept on the chart.
Example
"6085550145"
patient.HomePhoneMessages
boolean
True when staff may leave voice messages at home.
Example
true
patient.WorkPhoneMessages
boolean
True when staff may leave voice messages at work.
Example
false
patient.MobilePhoneMessages
boolean
True when staff may leave voice messages on mobile.
Example
true
patient.OtherPhoneMessages
boolean
True when staff may leave messages on that line.
Example
false
patient.PreferredPhone
integer
Coded pointer to which phone number to try first.
Example
1
patient.Comments
string
Free text note staff typed on this record.
Example
"Prefers calls after 3 PM."
patient.DateCreated
string
When this chart was first created in TherapyNotes.
Example
"2024-02-15T09:30:00"
patient.AccountNumber
string
Practice assigned account number, only set when that feature is on.
Example
"DEMO-004812"
patient.AcceptPaymentAssignment
boolean
True when the patient assigned benefit payment to the practice.
Example
true
patient.PortalUserId
integer
Patient portal account linked to this chart, zero when none.
Example
0
patient.DateOfCurrentIllness
string
Onset date of the current condition, for claim submission.
Example
"2026-08-12T00:00:00"
patient.DateOfSimilarIllness
string
Date of an earlier similar condition, usually blank.
Example
"2023-06-20T00:00:00"
patient.UnableToWorkStartDate
string
First date the patient could not work, for claims.
Example
"2026-08-12T00:00:00"
patient.UnableToWorkEndDate
string
Last date the patient could not work, for claims.
Example
"2026-08-19T00:00:00"
patient.HospitalizationStartDate
string
Admission date tied to this condition, usually blank.
Example
"2026-08-12T00:00:00"
patient.HospitalizationEndDate
string
Discharge date tied to this condition, usually blank.
Example
"2026-08-15T00:00:00"
patient.ConditionFromEmployment
boolean
True when the condition is work related.
Example
false
patient.ConditionFromAutoAccident
boolean
True when the condition came from a car accident.
Example
false
patient.RelatedAutoAccidentState
string
State where the auto accident happened, blank otherwise.
Example
"WI"
patient.ConditionFromOtherAccident
boolean
True when the condition came from some other accident.
Example
false
patient.ReferringProviderNpi
string
National provider id of the referring provider.
Example
"1999999984"
patient.BillingNotes
string
Free text billing note staff keep on the chart.
Example
"Confirm coverage before the next visit."
patient.Status
integer
Coded state of the patient, appointment, or insurance provider returned.
Example
1
patient.CurrentPhotoFile
string
Filename of the patient's photo, blank when none uploaded.
Example
"patient-photo-7c4e92a1.jpg"
patient.MobilePhoneSms
boolean
True when the patient agreed to text messages.
Example
true
patient.Ssn
string
Social security number, blank unless the practice collects it.
Example
"900-12-3456"
patient.EmailStatus
integer
Coded delivery state of the email, but plain text for clinicians.
Example
1
patient.ReferralNumber
string
Referral or prior authorization number to put on claims.
Example
"DEMO-AUTH-004812"
patient.ReferralDate
string
Date the referral was issued, blank for self referrals.
Example
"2026-08-10T00:00:00"
patient.ReferralExpirationDate
string
Date the referral stops covering visits.
Example
"2027-08-10T00:00:00"
patient.ReferringProviderFirstName
string
First name of the provider who referred this patient.
Example
"Jordan"
patient.ReferringProviderLastName
string
Last name of the provider who referred this patient.
Example
"Example"
patient.IsEpsdtReferral
boolean
True when the referral is an EPSDT Medicaid screening referral.
Example
false
patient.HomePhoneStatus
integer
Coded reachability state for the home phone line.
Example
1
patient.MobilePhoneStatus
integer
Coded reachability state for the mobile phone line.
Example
1
patient.OtherPhoneStatus
integer
Coded reachability state for the other phone line.
Example
1
patient.TimeZoneOffsetMinutes
integer
The patient's offset from UTC in minutes.
patient.TimeZoneIsDST
boolean
True when the patient's zone is on daylight saving time.
Example
false
patient.MaritalStatus
integer
Coded marital status, returned as a TherapyNotes number.
Example
1
patient.Gender
integer
Coded sex on file, returned as a TherapyNotes number.
Example
1
patient.EmploymentStatus
integer
Coded employment status used on insurance claims.
Example
1
patient.ApptRemindersTypes
integer
Bit coded set of reminder channels enabled for this patient.
Example
3
patient.Address
object
Street, city, state, and postal code, with country stored separately.
patient.Address.Address1
string
First street line of the mailing address.
Example
"482 Example Lane"
patient.Address.Address2
string
Apartment or suite line, blank for most addresses.
Example
"Apt 6"
patient.Address.City
string
City on the mailing address.
Example
"Madison"
patient.Address.State
string
Two letter state code on the mailing address.
Example
"WI"
patient.Address.PostalCode
string
Zip code on the mailing address.
Example
"53703"
patient.Suffix
string
Name suffix such as Jr or III.
Example
"Jr"
patient.PreferredPronouns
string
Free text pronouns the patient gave, often blank.
Example
"they/them"
patient.SmokerStatus
integer
Coded smoking status recorded for this patient.
Example
1
patient.EncryptedId
string
Obfuscated patient id the portal uses in its URLs.
Example
"b7Q2mX9vL4cR8nK3pT6wZA=="
patient.DisplayName
string
Name string TherapyNotes shows in its own interface.
Example
"Avery Sample"
patient_statistics
object
Appointment history and upcoming visit dates for this patient.
patient_statistics.PatientId
integer
Numeric TherapyNotes id for the patient on this record.
Example
98001234
patient_statistics.MostRecentPastAppointmentId
integer
The last appointment this patient already attended.
Example
980045671
patient_statistics.MostRecentPastAppointmentDate
string
Date of that most recent past appointment.
Example
"2026-10-02T14:00:00"
patient_statistics.MostRecentTerminationNoteDate
string
Date of the last termination note, blank for active patients.
Example
"2025-11-14T00:00:00"
patient_statistics.NextFutureAppointmentId
integer
The next appointment already on the books.
Example
980045672
patient_statistics.NextFutureAppointmentDate
string
Date of that next scheduled appointment.
Example
"2026-10-16T14:00:00"
patient_statistics.NextFutureApptDateServerTime
string
Same next appointment time, in the server's own timezone.
Example
"2026-10-16T14:00:00"
patient_statistics.NextFutureIntakeId
integer
The next scheduled intake appointment, if one exists.
Example
980045673
patient_statistics.NextFutureIntakeDate
string
Date of that next scheduled intake.
Example
"2026-10-23T10:00:00"
Code
curl --request POST \
  --url https://preview.ontross.com/api/integrations/tn/fetch-patient-info \
  --header 'X-API-Key: REPLACE_KEY_VALUE' \
  --header 'content-type: application/json' \
  --data '{"input":{"patientID":"75843069"},"auth_id":"auth_uuid_here"}'
Request BODY
{
  "input": {
    "patientID": "75843069"
  },
  "auth_id": "auth_uuid_here"
}
Response BODY
{
  "id": "string",
  "workflow_id": "string",
  "auth_id": "string",
  "status": "string",
  "input": {},
  "output": {
    "patient": {
      "PatientId": 98001234,
      "FirstName": "Avery",
      "MiddleName": "Lee",
      "LastName": "Sample",
      "Nickname": "Ave",
      "PracticeId": 980012,
      "Phone": "6085550142",
      "PhoneMessages": true,
      "Country": "US",
      "Email": "avery.sample@example.com",
      "DateOfBirth": "1988-04-12T00:00:00",
      "PcpConsent": 1,
      "Hipaa": true,
      "PadDate": "2024-02-15T00:00:00",
      "PadForm": "980076421",
      "HomePhone": "6085550142",
      "WorkPhone": "6085550143",
      "MobilePhone": "6085550144",
      "OtherPhone": "6085550145",
      "HomePhoneMessages": true,
      "WorkPhoneMessages": false,
      "MobilePhoneMessages": true,
      "OtherPhoneMessages": false,
      "PreferredPhone": 1,
      "Comments": "Prefers calls after 3 PM.",
      "DateCreated": "2024-02-15T09:30:00",
      "AccountNumber": "DEMO-004812",
      "AcceptPaymentAssignment": true,
      "PortalUserId": 0,
      "DateOfCurrentIllness": "2026-08-12T00:00:00",
      "DateOfSimilarIllness": "2023-06-20T00:00:00",
      "UnableToWorkStartDate": "2026-08-12T00:00:00",
      "UnableToWorkEndDate": "2026-08-19T00:00:00",
      "HospitalizationStartDate": "2026-08-12T00:00:00",
      "HospitalizationEndDate": "2026-08-15T00:00:00",
      "ConditionFromEmployment": false,
      "ConditionFromAutoAccident": false,
      "RelatedAutoAccidentState": "WI",
      "ConditionFromOtherAccident": false,
      "ReferringProviderNpi": "1999999984",
      "BillingNotes": "Confirm coverage before the next visit.",
      "Status": 1,
      "CurrentPhotoFile": "patient-photo-7c4e92a1.jpg",
      "MobilePhoneSms": true,
      "Ssn": "900-12-3456",
      "EmailStatus": 1,
      "ReferralNumber": "DEMO-AUTH-004812",
      "ReferralDate": "2026-08-10T00:00:00",
      "ReferralExpirationDate": "2027-08-10T00:00:00",
      "ReferringProviderFirstName": "Jordan",
      "ReferringProviderLastName": "Example",
      "IsEpsdtReferral": false,
      "HomePhoneStatus": 1,
      "MobilePhoneStatus": 1,
      "OtherPhoneStatus": 1,
      "TimeZoneOffsetMinutes": 0,
      "TimeZoneIsDST": false,
      "MaritalStatus": 1,
      "Gender": 1,
      "EmploymentStatus": 1,
      "ApptRemindersTypes": 3,
      "Address": {
        "Address1": "482 Example Lane",
        "Address2": "Apt 6",
        "City": "Madison",
        "State": "WI",
        "PostalCode": "53703"
      },
      "Suffix": "Jr",
      "PreferredPronouns": "they/them",
      "SmokerStatus": 1,
      "EncryptedId": "b7Q2mX9vL4cR8nK3pT6wZA==",
      "DisplayName": "Avery Sample"
    },
    "patient_statistics": {
      "PatientId": 98001234,
      "MostRecentPastAppointmentId": 980045671,
      "MostRecentPastAppointmentDate": "2026-10-02T14:00:00",
      "MostRecentTerminationNoteDate": "2025-11-14T00:00:00",
      "NextFutureAppointmentId": 980045672,
      "NextFutureAppointmentDate": "2026-10-16T14:00:00",
      "NextFutureApptDateServerTime": "2026-10-16T14:00:00",
      "NextFutureIntakeId": 980045673,
      "NextFutureIntakeDate": "2026-10-23T10:00:00"
    }
  },
  "files": null,
  "created_at": "2019-08-24T14:15:22Z",
  "started_at": "2019-08-24T14:15:22Z",
  "completed_at": "2019-08-24T14:15:22Z"
}