Tn Fetch patient billiing insurance

POSThttps://preview.ontross.com/api/integrations/tn/fetch-patient-billiing-insurance

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"

billing_settings

object

Billing configuration plus the insurance providers on file.

billing_settings.billing_settings_aggregate

object

Practice billing toggles bundled with the patient record.

billing_settings.billing_settings_aggregate.Patient

object

The patient record nested inside the billing settings.

billing_settings.billing_settings_aggregate.Patient.PatientId

integer

Numeric TherapyNotes id for the patient on this record.

Example

99000001

billing_settings.billing_settings_aggregate.Patient.FirstName

string

Legal first name on the patient or staff record.

Example

"Avery"

billing_settings.billing_settings_aggregate.Patient.MiddleName

string

Middle name from the chart, blank for most patients.

Example

"Lee"

billing_settings.billing_settings_aggregate.Patient.LastName

string

Legal last name on the patient or staff record.

Example

"Example"

billing_settings.billing_settings_aggregate.Patient.Nickname

string

Informal name staff typed for this patient, often blank.

Example

"Ave"

billing_settings.billing_settings_aggregate.Patient.PracticeId

integer

The TherapyNotes practice this patient belongs to.

Example

99000101

billing_settings.billing_settings_aggregate.Patient.Phone

string

Primary phone for the patient, or the payer's phone.

Example

"6145550101"

billing_settings.billing_settings_aggregate.Patient.PhoneMessages

boolean

True when staff may leave messages on that phone.

Example

true

billing_settings.billing_settings_aggregate.Patient.Country

string

Country for the mailing address, held outside the Address object.

Example

"United States"

billing_settings.billing_settings_aggregate.Patient.Email

string

Email address on file for this patient or clinician.

Example

"avery.example@example.com"

billing_settings.billing_settings_aggregate.Patient.DateOfBirth

string

Birth date, formatted the way the portal returns it.

Example

"1988-04-12T00:00:00"

billing_settings.billing_settings_aggregate.Patient.PcpConsent

integer

Coded consent to share records with the primary care provider.

Example

0

billing_settings.billing_settings_aggregate.Patient.Hipaa

boolean

True when a signed HIPAA notice is on file.

Example

true

billing_settings.billing_settings_aggregate.Patient.PadDate

string

Date on the stored PAD form, blank when unsigned.

Example

"2025-01-15T00:00:00"

billing_settings.billing_settings_aggregate.Patient.PadForm

string

Identifier of the stored PAD form, often blank.

Example

"99000601"

billing_settings.billing_settings_aggregate.Patient.HomePhone

string

Home phone digits as stored, without formatting.

Example

"6145550102"

billing_settings.billing_settings_aggregate.Patient.WorkPhone

string

Work phone digits as stored, without formatting.

Example

"6145550103"

billing_settings.billing_settings_aggregate.Patient.MobilePhone

string

Mobile phone digits as stored, without formatting.

Example

"6145550104"

billing_settings.billing_settings_aggregate.Patient.OtherPhone

string

Any additional phone number kept on the chart.

Example

"6145550105"

billing_settings.billing_settings_aggregate.Patient.HomePhoneMessages

boolean

True when staff may leave voice messages at home.

Example

true

billing_settings.billing_settings_aggregate.Patient.WorkPhoneMessages

boolean

True when staff may leave voice messages at work.

Example

false

billing_settings.billing_settings_aggregate.Patient.MobilePhoneMessages

boolean

True when staff may leave voice messages on mobile.

Example

true

billing_settings.billing_settings_aggregate.Patient.OtherPhoneMessages

boolean

True when staff may leave messages on that line.

Example

false

billing_settings.billing_settings_aggregate.Patient.PreferredPhone

integer

Coded pointer to which phone number to try first.

Example

1

billing_settings.billing_settings_aggregate.Patient.Comments

string

Free text note staff typed on this record.

Example

"Prefers calls after 3 PM."

billing_settings.billing_settings_aggregate.Patient.DateCreated

string

When this chart was first created in TherapyNotes.

Example

"2025-01-15T14:30:00"

billing_settings.billing_settings_aggregate.Patient.AccountNumber

string

Practice assigned account number, only set when that feature is on.

Example

"TEST990001"

billing_settings.billing_settings_aggregate.Patient.AcceptPaymentAssignment

boolean

True when the patient assigned benefit payment to the practice.

Example

true

billing_settings.billing_settings_aggregate.Patient.PortalUserId

integer

Patient portal account linked to this chart, zero when none.

Example

0

billing_settings.billing_settings_aggregate.Patient.DateOfCurrentIllness

string

Onset date of the current condition, for claim submission.

Example

"2025-01-10T00:00:00"

billing_settings.billing_settings_aggregate.Patient.DateOfSimilarIllness

string

Date of an earlier similar condition, usually blank.

Example

"2023-08-20T00:00:00"

billing_settings.billing_settings_aggregate.Patient.UnableToWorkStartDate

string

First date the patient could not work, for claims.

Example

"2025-01-10T00:00:00"

billing_settings.billing_settings_aggregate.Patient.UnableToWorkEndDate

string

Last date the patient could not work, for claims.

Example

"2025-01-24T00:00:00"

billing_settings.billing_settings_aggregate.Patient.HospitalizationStartDate

string

Admission date tied to this condition, usually blank.

Example

"2025-01-10T00:00:00"

billing_settings.billing_settings_aggregate.Patient.HospitalizationEndDate

string

Discharge date tied to this condition, usually blank.

Example

"2025-01-13T00:00:00"

billing_settings.billing_settings_aggregate.Patient.ConditionFromEmployment

boolean

True when the condition is work related.

Example

false

billing_settings.billing_settings_aggregate.Patient.ConditionFromAutoAccident

boolean

True when the condition came from a car accident.

Example

false

billing_settings.billing_settings_aggregate.Patient.RelatedAutoAccidentState

string

State where the auto accident happened, blank otherwise.

Example

"OH"

billing_settings.billing_settings_aggregate.Patient.ConditionFromOtherAccident

boolean

True when the condition came from some other accident.

Example

false

billing_settings.billing_settings_aggregate.Patient.ReferringProviderNpi

string

National provider id of the referring provider.

Example

"1999999984"

billing_settings.billing_settings_aggregate.Patient.BillingNotes

string

Free text billing note staff keep on the chart.

Example

"Collect copay at each visit."

billing_settings.billing_settings_aggregate.Patient.Status

integer

Coded state of the patient, appointment, or insurance provider returned.

Example

1

billing_settings.billing_settings_aggregate.Patient.CurrentPhotoFile

string

Filename of the patient's photo, blank when none uploaded.

Example

"patient-photo-99000001.jpg"

billing_settings.billing_settings_aggregate.Patient.MobilePhoneSms

boolean

True when the patient agreed to text messages.

Example

true

billing_settings.billing_settings_aggregate.Patient.Ssn

string

Social security number, blank unless the practice collects it.

Example

"900123456"

billing_settings.billing_settings_aggregate.Patient.EmailStatus

integer

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

Example

1

billing_settings.billing_settings_aggregate.Patient.ReferralNumber

string

Referral or prior authorization number to put on claims.

Example

"TESTAUTH990001"

billing_settings.billing_settings_aggregate.Patient.ReferralDate

string

Date the referral was issued, blank for self referrals.

Example

"2025-01-08T00:00:00"

billing_settings.billing_settings_aggregate.Patient.ReferralExpirationDate

string

Date the referral stops covering visits.

Example

"2025-12-31T00:00:00"

billing_settings.billing_settings_aggregate.Patient.ReferringProviderFirstName

string

First name of the provider who referred this patient.

Example

"Morgan"

billing_settings.billing_settings_aggregate.Patient.ReferringProviderLastName

string

Last name of the provider who referred this patient.

Example

"Example"

billing_settings.billing_settings_aggregate.Patient.IsEpsdtReferral

boolean

True when the referral is an EPSDT Medicaid screening referral.

Example

false

billing_settings.billing_settings_aggregate.Patient.HomePhoneStatus

integer

Coded reachability state for the home phone line.

Example

1

billing_settings.billing_settings_aggregate.Patient.MobilePhoneStatus

integer

Coded reachability state for the mobile phone line.

Example

1

billing_settings.billing_settings_aggregate.Patient.OtherPhoneStatus

integer

Coded reachability state for the other phone line.

Example

0

billing_settings.billing_settings_aggregate.Patient.TimeZoneOffsetMinutes

integer

The patient's offset from UTC in minutes.

billing_settings.billing_settings_aggregate.Patient.TimeZoneIsDST

boolean

True when the patient's zone is on daylight saving time.

Example

false

billing_settings.billing_settings_aggregate.Patient.MaritalStatus

integer

Coded marital status, returned as a TherapyNotes number.

Example

1

billing_settings.billing_settings_aggregate.Patient.Gender

integer

Coded sex on file, returned as a TherapyNotes number.

Example

1

billing_settings.billing_settings_aggregate.Patient.EmploymentStatus

integer

Coded employment status used on insurance claims.

Example

1

billing_settings.billing_settings_aggregate.Patient.ApptRemindersTypes

integer

Bit coded set of reminder channels enabled for this patient.

Example

3

billing_settings.billing_settings_aggregate.Patient.Address

object

Street, city, state, and postal code, with country stored separately.

billing_settings.billing_settings_aggregate.Patient.Address.Address1

string

First street line of the mailing address.

Example

"123 Example St"

billing_settings.billing_settings_aggregate.Patient.Address.Address2

string

Apartment or suite line, blank for most addresses.

Example

"Suite 200"

billing_settings.billing_settings_aggregate.Patient.Address.City

string

City on the mailing address.

Example

"Columbus"

billing_settings.billing_settings_aggregate.Patient.Address.State

string

Two letter state code on the mailing address.

Example

"OH"

billing_settings.billing_settings_aggregate.Patient.Address.PostalCode

string

Zip code on the mailing address.

Example

"43215"

billing_settings.billing_settings_aggregate.Patient.Suffix

string

Name suffix such as Jr or III.

Example

"Jr"

billing_settings.billing_settings_aggregate.Patient.PreferredPronouns

string

Free text pronouns the patient gave, often blank.

Example

"they/them"

billing_settings.billing_settings_aggregate.Patient.SmokerStatus

integer

Coded smoking status recorded for this patient.

Example

0

billing_settings.billing_settings_aggregate.Patient.EncryptedId

string

Obfuscated patient id the portal uses in its URLs.

Example

"Q7m2K9v4R8x1N6c3T5p0Lg"

billing_settings.billing_settings_aggregate.Patient.DisplayName

string

Name string TherapyNotes shows in its own interface.

Example

"Avery Example"

billing_settings.billing_settings_aggregate.UsePatientAccountNumbers

boolean

True when the practice assigns its own account numbers.

Example

true

billing_settings.billing_settings_aggregate.UsePatientSsn

boolean

True when the practice stores patient social security numbers.

Example

false

billing_settings.billing_settings_aggregate.EnableApptReminders

boolean

True when the practice sends appointment reminders at all.

Example

true

billing_settings.billing_settings_aggregate.CreditCardProcessingEnabled

boolean

True when the practice can charge cards inside TherapyNotes.

Example

true

billing_settings.billing_settings_aggregate.InsuranceProviderGroup

integer

Primary payer group, a plain id here but an object on providers.

Example

99000201

billing_settings.billing_settings_aggregate.InsuranceProviderItemId

integer

The patient's primary insurance entry in TherapyNotes.

Example

99000401

billing_settings.billing_settings_aggregate.InsuranceProviderName

string

Readable name of the patient's primary insurance.

Example

"Example Health PPO"

billing_settings.billing_settings_aggregate.SecondaryInsuranceProviderGroup

integer

Numeric id of the secondary payer group, not an object.

Example

99000202

billing_settings.billing_settings_aggregate.SecondaryInsuranceProviderItemId

integer

The patient's secondary insurance entry, zero when none.

Example

99000402

billing_settings.billing_settings_aggregate.SecondaryInsuranceProviderName

string

Readable name of the patient's secondary insurance.

Example

"Example Supplemental Health"

billing_settings.billing_settings_aggregate.EnablePortal

boolean

True when this patient has portal access turned on.

Example

true

billing_settings.billing_settings_aggregate.PracticeType

integer

Coded kind of practice this chart belongs to.

Example

1

billing_settings.billing_settings_aggregate.PatientHasInsurance

boolean

True when any insurance is on file for the patient.

Example

true

billing_settings.billing_settings_aggregate.PatientBalanceOwed

number

What the patient owes right now across all charges.

Example

125.5

billing_settings.billing_settings_aggregate.PatientUnassignedCredits

number

Patient money not yet applied to any charge.

Example

25

billing_settings.billing_settings_aggregate.PatientHasUpcomingAppointmentsToday

boolean

True when the patient still has appointments later today.

Example

false

billing_settings.insurance_providers

array

Every insurance payer attached to this patient.

billing_settings.insurance_providers[].Id

integer

TherapyNotes id of the payer, or of its group.

Example

99000301

billing_settings.insurance_providers[].ItemId

integer

Identifier of this insurance entry on the patient.

Example

99000401

billing_settings.insurance_providers[].PayerId

string

Clearinghouse payer id used to route claims.

Example

"99999"

billing_settings.insurance_providers[].Status

integer

Coded state of the patient, appointment, or insurance provider returned.

Example

1

billing_settings.insurance_providers[].Phone

string

Primary phone for the patient, or the payer's phone.

Example

"8005550106"

billing_settings.insurance_providers[].Fax

string

Fax number for the payer, often blank.

Example

"8005550107"

billing_settings.insurance_providers[].Comments

string

Free text note staff typed on this record.

Example

"Verify eligibility before the first visit."

billing_settings.insurance_providers[].EnrollmentInstructionType

integer

Coded enrollment steps needed before billing this payer.

Example

0

billing_settings.insurance_providers[].EnrollmentEraInstructionType

integer

Coded enrollment steps needed before receiving electronic remittances.

Example

0

billing_settings.insurance_providers[].InNetwork

boolean

True when the practice is contracted with this payer.

Example

true

billing_settings.insurance_providers[].Name

string

Readable name of the payer or payer group.

Example

"Example Health PPO"

billing_settings.insurance_providers[].PaymentMethod

integer

Coded way the primary payer or patient pays.

Example

1

billing_settings.insurance_providers[].EligibilityId

string

Id used for real time eligibility checks, often blank.

Example

"99999"

billing_settings.insurance_providers[].HasHie

boolean

True when health information exchange is available for this payer.

Example

true

billing_settings.insurance_providers[].HieStatus

boolean

True when health information exchange is actually switched on.

Example

false

billing_settings.insurance_providers[].InsuranceType

integer

Coded role of this coverage, such as primary or secondary.

Example

1

billing_settings.insurance_providers[].TelehealthPlaceOfService

string

Place of service code this payer wants for telehealth.

Example

"10"

billing_settings.insurance_providers[].TelehealthModifier

string

CPT modifier this payer wants on telehealth claims.

Example

"95"

billing_settings.insurance_providers[].Address

object

Street, city, state, and postal code, with country stored separately.

billing_settings.insurance_providers[].Address.Address1

string

First street line of the mailing address.

Example

"123 Example St"

billing_settings.insurance_providers[].Address.Address2

string

Apartment or suite line, blank for most addresses.

Example

"Suite 200"

billing_settings.insurance_providers[].Address.City

string

City on the mailing address.

Example

"Columbus"

billing_settings.insurance_providers[].Address.State

string

Two letter state code on the mailing address.

Example

"OH"

billing_settings.insurance_providers[].Address.PostalCode

string

Zip code on the mailing address.

Example

"43215"

billing_settings.insurance_providers[].InsuranceProviderGroup

object

Primary payer group, a plain id here but an object on providers.

billing_settings.insurance_providers[].InsuranceProviderGroup.Id

integer

TherapyNotes id of the payer, or of its group.

Example

99000201

billing_settings.insurance_providers[].InsuranceProviderGroup.Name

string

Readable name of the payer or payer group.

Example

"Example Health"

billing_settings.insurance_providers[].InsuranceProviderGroup.InNetwork

boolean

True when the practice is contracted with this payer.

Example

true

billing_settings.insurance_providers[].InsuranceProviderGroup.HasActiveSetting

boolean

True when billing settings exist for this payer group.

Example

true

billing_settings.insurance_providers[].EncryptedItemId

string

Obfuscated insurance entry id used in portal URLs.

Example

"B8r3M6n1V9q4C7x2L5t0Pw"

curl --request POST \
  --url https://preview.ontross.com/api/integrations/tn/fetch-patient-billiing-insurance \
  --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": {
    "billing_settings": {
      "billing_settings_aggregate": {
        "Patient": {
          "PatientId": 99000001,
          "FirstName": "Avery",
          "MiddleName": "Lee",
          "LastName": "Example",
          "Nickname": "Ave",
          "PracticeId": 99000101,
          "Phone": "6145550101",
          "PhoneMessages": true,
          "Country": "United States",
          "Email": "avery.example@example.com",
          "DateOfBirth": "1988-04-12T00:00:00",
          "PcpConsent": 0,
          "Hipaa": true,
          "PadDate": "2025-01-15T00:00:00",
          "PadForm": "99000601",
          "HomePhone": "6145550102",
          "WorkPhone": "6145550103",
          "MobilePhone": "6145550104",
          "OtherPhone": "6145550105",
          "HomePhoneMessages": true,
          "WorkPhoneMessages": false,
          "MobilePhoneMessages": true,
          "OtherPhoneMessages": false,
          "PreferredPhone": 1,
          "Comments": "Prefers calls after 3 PM.",
          "DateCreated": "2025-01-15T14:30:00",
          "AccountNumber": "TEST990001",
          "AcceptPaymentAssignment": true,
          "PortalUserId": 0,
          "DateOfCurrentIllness": "2025-01-10T00:00:00",
          "DateOfSimilarIllness": "2023-08-20T00:00:00",
          "UnableToWorkStartDate": "2025-01-10T00:00:00",
          "UnableToWorkEndDate": "2025-01-24T00:00:00",
          "HospitalizationStartDate": "2025-01-10T00:00:00",
          "HospitalizationEndDate": "2025-01-13T00:00:00",
          "ConditionFromEmployment": false,
          "ConditionFromAutoAccident": false,
          "RelatedAutoAccidentState": "OH",
          "ConditionFromOtherAccident": false,
          "ReferringProviderNpi": "1999999984",
          "BillingNotes": "Collect copay at each visit.",
          "Status": 1,
          "CurrentPhotoFile": "patient-photo-99000001.jpg",
          "MobilePhoneSms": true,
          "Ssn": "900123456",
          "EmailStatus": 1,
          "ReferralNumber": "TESTAUTH990001",
          "ReferralDate": "2025-01-08T00:00:00",
          "ReferralExpirationDate": "2025-12-31T00:00:00",
          "ReferringProviderFirstName": "Morgan",
          "ReferringProviderLastName": "Example",
          "IsEpsdtReferral": false,
          "HomePhoneStatus": 1,
          "MobilePhoneStatus": 1,
          "OtherPhoneStatus": 0,
          "TimeZoneOffsetMinutes": 0,
          "TimeZoneIsDST": false,
          "MaritalStatus": 1,
          "Gender": 1,
          "EmploymentStatus": 1,
          "ApptRemindersTypes": 3,
          "Address": {
            "Address1": "123 Example St",
            "Address2": "Suite 200",
            "City": "Columbus",
            "State": "OH",
            "PostalCode": "43215"
          },
          "Suffix": "Jr",
          "PreferredPronouns": "they/them",
          "SmokerStatus": 0,
          "EncryptedId": "Q7m2K9v4R8x1N6c3T5p0Lg",
          "DisplayName": "Avery Example"
        },
        "UsePatientAccountNumbers": true,
        "UsePatientSsn": false,
        "EnableApptReminders": true,
        "CreditCardProcessingEnabled": true,
        "InsuranceProviderGroup": 99000201,
        "InsuranceProviderItemId": 99000401,
        "InsuranceProviderName": "Example Health PPO",
        "SecondaryInsuranceProviderGroup": 99000202,
        "SecondaryInsuranceProviderItemId": 99000402,
        "SecondaryInsuranceProviderName": "Example Supplemental Health",
        "EnablePortal": true,
        "PracticeType": 1,
        "PatientHasInsurance": true,
        "PatientBalanceOwed": 125.5,
        "PatientUnassignedCredits": 25,
        "PatientHasUpcomingAppointmentsToday": false
      },
      "insurance_providers": [
        {
          "Id": 99000301,
          "ItemId": 99000401,
          "PayerId": "99999",
          "Status": 1,
          "Phone": "8005550106",
          "Fax": "8005550107",
          "Comments": "Verify eligibility before the first visit.",
          "EnrollmentInstructionType": 0,
          "EnrollmentEraInstructionType": 0,
          "InNetwork": true,
          "Name": "Example Health PPO",
          "PaymentMethod": 1,
          "EligibilityId": "99999",
          "HasHie": true,
          "HieStatus": false,
          "InsuranceType": 1,
          "TelehealthPlaceOfService": "10",
          "TelehealthModifier": "95",
          "Address": {
            "Address1": "123 Example St",
            "Address2": "Suite 200",
            "City": "Columbus",
            "State": "OH",
            "PostalCode": "43215"
          },
          "InsuranceProviderGroup": {
            "Id": 99000201,
            "Name": "Example Health",
            "InNetwork": true,
            "HasActiveSetting": true
          },
          "EncryptedItemId": "B8r3M6n1V9q4C7x2L5t0Pw"
        }
      ]
    }
  },
  "files": null,
  "created_at": "2019-08-24T14:15:22Z",
  "started_at": "2019-08-24T14:15:22Z",
  "completed_at": "2019-08-24T14:15:22Z"
}