Ecw Fetch patients

POSThttps://preview.ontross.com/api/integrations/ecw/fetch-patients

input.patientId

string

required

Patient chart being read or written, from fetch-patients.

Example

"348144"

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"

patientCellPhoneNumber

string

Mobile telephone contact number from the patient record.

Example

"202-555-0142"

dob

string

Birth date returned in the source patient record.

Example

"01/05/2012"

firstName

string

Given personal label returned in the patient record.

Example

"Jane"

middleName

string

Additional given personal label from the patient record.

Example

"Lee"

lastName

string

Family surname returned in the source patient record.

Example

"Doe"

patientHomePhoneNumber

string

Residential telephone contact number from the patient record.

Example

"903-278-8495"

string

Electronic contact address returned in the patient record.

Example

"jordan.example@example.com"

lastAppointment

string

Previous visit summary value from the patient record.

Example

"09/06/2026"

nextAppointment

string

Upcoming visit summary value from the patient record.

Example

"11/06/2026"

gender

string

Recorded demographic identity value from the patient response.

Example

"F"

addressLine1

string

Primary street location returned in the patient record.

Example

"123 Main St"

addressLine2

string

Additional street location details from the patient record.

Example

"Apt 4"

zip

string

Postal delivery code returned in the patient record.

Example

"02110"

city

string

Municipality returned in the patient's recorded mailing address.

Example

"Riverton"

state

string

Regional value returned in the patient's mailing address.

Example

"MA"

workPhone

string

Employment telephone contact number from the patient record.

Example

"202-555-0147"

accountNo

string

Billing account identifier returned in the patient record.

Example

"348144"

mrn

string

Medical record tracking number from the patient response.

Example

"90000001"

suffix

string

Trailing personal designation from the patient's recorded identity.

Example

"Jr."

pcp

string

Primary care clinician display label from the patient record.

Example

"Rivera, Alex"

pcpId

string

Primary care clinician identifier from the patient record.

Example

"070"

encounterReason

string

Visit explanation returned with the patient lookup response.

Example

"Annual wellness visit"

encounterId

string

Associated visit identifier returned with the patient response.

Example

"9000001"

picPath

string

Source storage path for the patient's chart photograph.

Example

"/patientphotos/900001/"

nextFacility

string

Care location associated with the patient's upcoming visit.

Example

"Example Family Clinic"

lastFacility

string

Care location associated with the patient's previous visit.

Example

"Example Family Clinic"

defaultFacility

string

Usual care location returned in the patient record.

Example

"Example Clinic"

acBalance

string

Account financial amount returned in the patient response.

Example

"125.00"

collBalance

string

Collections financial amount returned in the patient response.

Example

"0.00"

ptBalance

string

Patient financial responsibility amount returned by the source.

Example

"25.00"

patientCollectionBalance

string

Patient collections amount returned in the source record.

Example

"0.00"

guarantorId

string

Financially responsible party identifier from the patient record.

Example

"348144"

fullNameWithSuffix

string

Complete personal display label including any trailing designation.

Example

"Doe, Jane"

lastvmsg

string

Raw latest message value returned with the patient record.

Example

"Appointment reminder delivered."

billingalert

string

Financial warning text returned in the patient record.

Example

"0"

givenToColl

string

Raw indication of referral to a collections process.

Example

"0"

assignedTo

string

Staff assignment value returned with the patient record.

Example

"Example,Riley"

renprovider

string

Rendering clinician display value from the patient record.

Example

"Example,Alex"

renproviderid

string

Rendering clinician identifier returned in the patient response.

Example

"9001"

inactive

string

Raw indicator that the chart is no longer active.

Example

"0"

optout

string

Raw participation refusal value from the patient record.

Example

"1"

previousName

string

Former personal display label from the patient record.

Example

"Jordan Sample"

preferredName

string

Chosen personal display label from the patient record.

Example

"Jordan"

race

string

Recorded racial demographic value from the patient response.

Example

"White"

ethnicity

string

Recorded ethnic demographic wording from the patient response.

Example

"Example text."

ethnicityId

string

Source identifier for the recorded ethnic demographic value.

Example

"9989-4"

language

string

Preferred communication wording returned in the patient record.

Example

"Example"

ssn

string

Social Security identification value from the patient record.

Example

"000-00-0000"

maritalStatus

string

Recorded relationship classification from the patient demographics response.

Example

"Example"

sex

string

Recorded demographic classification returned separately from gender identity.

Example

"Female"

country

string

National address value returned in the patient record.

Example

"US"

tob

string

Birth clock time returned in the patient record.

Example

"08:30:00"

prefix

string

Leading personal designation from the patient's recorded identity.

Example

"Ms."

deceased

string

Raw indicator that the patient's death is recorded.

Example

"0"

doctorName

string

Clinician display label returned in the patient response.

Example

"Rivera, Alex"

namewithsuffix

string

Alternate personal display label including any trailing designation.

Example

"Doe, Jane"

transGender

string

Raw transgender demographic value from the patient response.

Example

"0"

webenabled

string

Raw indicator of patient portal access availability.

Example

"1"

refPrId

string

Referring clinician identifier returned in the patient record.

Example

"9003"

rendPrId

string

Alternate rendering clinician identifier from the patient record.

Example

"9001"

picFileName

string

Source filename for the patient's stored chart photograph.

Example

"900001.jpg"

regdate

string

Registration calendar value returned in the patient record.

Example

"01/15/2024"

controlNo

string

Source tracking reference returned in the patient response.

Example

"348144"

languageISOCode1

string

First standardized communication language code from the patient response.

Example

"en"

languageISOCode2

string

Second standardized communication language code from the patient response.

Example

"eng"

deceasedDate

string

Recorded calendar day of the patient's death.

Example

"09/20/2026"

deceasedNotes

string

Recorded annotations concerning the patient's reported death.

Example

"Date reported by a family member."

insurances

array

Coverage records returned with the patient lookup response.

insurances[].name

string

Coverage carrier display label from the patient record.

Example

"Example Health Plan"

insurances[].state

string

Regional address value returned for the coverage record.

Example

"CO"

insurances[].subscriberNo

string

Policyholder membership identifier returned with the coverage record.

Example

"05162828"

insurances[].rel

string

Patient relationship to the policyholder on this coverage.

Example

"1"

insurances[].insured

string

Covered policyholder wording returned with the insurance record.

Example

"Doe, Jane"

insurances[].coPay

string

Patient contribution amount returned with the coverage record.

Example

"25.00"

insurances[].groupNo

string

Employer or plan grouping identifier for this coverage.

Example

"EXG900123"

insurances[].city

string

Municipality address value returned for the coverage record.

Example

"Riverton"

insurances[].insType

string

Coverage classification returned with the patient insurance record.

Example

"QG"

insurances[].active

string

Raw indicator of whether this coverage is current.

Example

"F"

insurances[].feeSchedName

string

Display label of the associated billing rate schedule.

Example

"Standard"

pharmacies

array

Dispensing locations listed in the source patient record.

pharmacies[].name

string

Dispensing location display label from the patient record.

Example

"Jane Doe"

pharmacies[].address

string

Primary street location returned for the dispensing business.

Example

"123 Main St"

pharmacies[].city

string

Municipality containing the patient's listed dispensing location.

Example

"Riverton"

pharmacies[].state

string

Regional address value for the listed dispensing location.

Example

"CO"

pharmacies[].zip

string

Postal delivery code for the listed dispensing location.

Example

"99923"

pharmacies[].tel

string

Telephone contact number for the listed dispensing location.

Example

"428-755-2735"

pharmacies[].address2

string

Additional street location details for the dispensing business.

Example

"123 Main St"

pharmacies[].fax

string

Document transmission number for the listed dispensing location.

Example

"920-114-7480"

pharmacies[].ncpdpId

string

National pharmacy directory identifier for the dispensing location.

Example

"2104557"

responsibleParty

object

Financial guarantor details returned with the patient record.

responsibleParty.grId

string

Source identifier for the patient's financial guarantor.

Example

"900002"

responsibleParty.grName

string

Display label of the patient's financial guarantor.

Example

"Example,Casey"

responsibleParty.grPhone

string

Telephone contact number for the patient's financial guarantor.

Example

"202-555-0145"

responsibleParty.grRel

string

Relationship between the patient and the financial guarantor.

Example

"Spouse"

responsibleParty.isGrPt

string

Raw flag indicating the patient guarantees their own charges.

Example

"0"

demographicsData

object

Nested scheduling and administrative details from the patient response.

demographicsData.lastAppt

object

Nested scheduling details for the patient's previous visit.

demographicsData.lastAppt.encounterID

string

Source visit identifier for the previous appointment.

Example

"9000000"

demographicsData.lastAppt.date

string

Calendar day returned for the previous appointment.

Example

"09/06/2026"

demographicsData.lastAppt.startTime

string

Beginning clock time returned for the previous appointment.

Example

"09:00:00"

demographicsData.lastAppt.timeZone

string

Local time region associated with the previous appointment.

Example

"America/New_York"

demographicsData.lastAppt.name

string

Source display label returned for the previous appointment.

Example

"Office Visit"

demographicsData.lastAppt.code

string

Source classification value returned for the previous appointment.

Example

"OV"

demographicsData.nextAppt

object

Nested scheduling details for the patient's upcoming visit.

demographicsData.nextAppt.encounterID

string

Source visit identifier for the upcoming appointment.

Example

"9000002"

demographicsData.nextAppt.date

string

Calendar day returned for the upcoming appointment.

Example

"11/06/2026"

demographicsData.nextAppt.startTime

string

Beginning clock time returned for the upcoming appointment.

Example

"09:00:00"

demographicsData.nextAppt.timeZone

string

Local time region associated with the upcoming appointment.

Example

"America/New_York"

demographicsData.nextAppt.name

string

Source display label returned for the upcoming appointment.

Example

"Office Visit"

demographicsData.nextAppt.code

string

Source classification value returned for the upcoming appointment.

Example

"OV"

demographicsData.wcvAppt

string

Raw well-child scheduling value from the demographics response.

Example

"11/06/2026"

demographicsData.advDir

string

Advance directive information returned with the demographics record.

Example

"On file"

demographicsData.billingAlert

string

Financial warning text returned with the demographics record.

Example

"1"

demographicsData.givenToColl

string

Raw indication of referral to a collections process.

Example

"0"

phoneNumbers

array

All configured phone slots, ordered by display order.

phoneNumbers[].key

string

eCW's internal slot key for this phone number.

Example

"cell"

phoneNumbers[].id

any

Source identifier associated with this configured phone slot.

phoneNumbers[].phoneNumberType

string

Slot label such as cell, home, or work.

Example

"Cell"

phoneNumbers[].description

string

Source explanatory label for the configured phone slot.

Example

"Primary mobile"

phoneNumbers[].phoneNumber

any

Number in this slot, typed as eCW sends it.

phoneNumbers[].ext

any

Extension on a phone number slot, often empty.

phoneNumbers[].phoneNumberWithExt

any

Number with extension, falling back to the bare number.

phoneNumbers[].leaveMessage

any

Whether this phone slot allows leaving a message.

phoneNumbers[].voiceEnabled

any

Whether voice calling is enabled, boolean or string.

phoneNumbers[].textEnabled

any

Whether texting is enabled, boolean or string.

phoneNumbers[].displayOrder

any

Order eCW lists this phone number slot in.

phoneNumbers[].updatedOnlyNumber

any

Raw eCW phone-slot flag passed through without coercion.

phoneNumbers[].updated

any

Whether the write was accepted, or a raw phone-slot flag.

communicationSettings

object

Patient's voice and text contact preferences.

communicationSettings.voice

object

Voice call communication preferences for this patient.

communicationSettings.voice.voiceEnabled

any

Whether voice calling is enabled, boolean or string.

Example

"1"

communicationSettings.voice.language

any

Preferred language, also repeated inside communication settings.

Example

"Example"

communicationSettings.voice.contacttype

any

Preferred contact type inside the voice or text settings.

Example

"Example"

communicationSettings.voice.timetocall

any

Preferred time to call, from voice communication settings.

Example

"Example"

communicationSettings.text

object

Messaging permissions and preferences recorded for the patient.

communicationSettings.text.textEnabled

any

Whether texting is enabled, boolean or string.

Example

"1"

communicationSettings.text.language

any

Preferred language, also repeated inside communication settings.

Example

"Example"

communicationSettings.text.contacttype

any

Preferred contact type inside the voice or text settings.

Example

"Example"

communicationSettings.optOutAllPracticeCommunication

any

eCW's isptoptsout flag, raw 0 or 1, never coerced.

Example

"8"

curl --request POST \
  --url https://preview.ontross.com/api/integrations/ecw/fetch-patients \
  --header 'X-API-Key: REPLACE_KEY_VALUE' \
  --header 'content-type: application/json' \
  --data '{"input":{"patientId":"348144"},"auth_id":"auth_uuid_here"}'

Request BODY

{
  "input": {
    "patientId": "348144"
  },
  "auth_id": "auth_uuid_here"
}

Response BODY

{
  "firstName": "Maya",
  "lastName": "Patel",
  "dob": "1987-04-18",
  "gender": "Female",
  "patientCellPhoneNumber": "(415) 555-0142",
  "email": "maya.patel@example.test",
  "mrn": "MRN-10482",
  "accountNo": "ACCT-88219",
  "city": "San Francisco",
  "state": "CA",
  "zip": "94107",
  "lastAppointment": "2026-07-22",
  "nextAppointment": "2026-08-19",
  "pcp": "Dr. Elena Ruiz",
  "phoneNumbers": [
    {
      "key": "CELL_PHONE",
      "id": 10482,
      "phoneNumberType": "Cell Phone",
      "description": "Cell Phone",
      "phoneNumber": "(415) 555-0142",
      "ext": null,
      "phoneNumberWithExt": "(415) 555-0142",
      "leaveMessage": null,
      "voiceEnabled": true,
      "textEnabled": true,
      "displayOrder": 0,
      "updatedOnlyNumber": false,
      "updated": false
    }
  ],
  "communicationSettings": {
    "voice": {
      "voiceEnabled": "1",
      "language": "English",
      "contacttype": "Home",
      "timetocall": "Morning"
    },
    "text": {
      "textEnabled": "1",
      "language": "En",
      "contacttype": "Cell"
    },
    "optOutAllPracticeCommunication": "0"
  }
}