Ecw Fetch notes

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

input.patientId

string

required

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

Example

"348144"

input.encounterId

string

required

Encounter being read or written, from fetch-appointments.

Example

"9620412"

input.date

string

Optional calendar value supplied with the note lookup.

Example

"10/06/2026"

Default

""

input.toProviderId

string

Provider whose note view to request, defaulting to the session's.

Example

"6086"

Default

""

input.gd

string

Guard token from note URLs, scraped from the session when omitted.

Example

"3b81df0c54a74e1d9c6f20ab7e4d15c9"

Default

""

input.cip

string

Session token from note URLs, scraped automatically when omitted.

Example

"9f2c4b7ae1d9154fa05c71be2d9f3a68"

Default

""

input.formData

string

Note section ids to request, defaulting to the full set.

Example

"471,478,475,1,5,2,3,4"

Default

""

input.clientTimezone

string

IANA timezone stamped on the note request, defaults to the session's.

Example

"America/New_York"

Default

""

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"

current_medications

string

Current medications section text as it reads in the note.

Example

"Taking Folic Acid 1 MG Tablet daily."

past_medical_history

string

Past medical history with social and family history appended.

Example

"Hypertension. Father has hypertension. Never smoked."

allergies

string

Allergies section text copied from the progress note.

Example

"Penicillin: hives."

review_of_systems

string

Review of Systems text from the progress note.

Example

"No fever or chills."

vital_signs

string

Vital Signs text from the progress note.

Example

"BP 120/80, HR 72."

reason_for_appointment

string

Chief Complaints text from the progress note.

Example

"Sore throat for three days."

history_of_present_illness

string

HPI section text as it reads in the note.

Example

"Example text."

examination

string

Examination section text as it reads in the note.

Example

"Alert and in no acute distress."

assessments

string

Assessment section text as it reads in the note.

Example

"Acute pharyngitis."

treatment

string

Treatment section text from the progress note.

Example

"Supportive care and adequate hydration."

procedure_codes

array

Procedure code and description pairs parsed from the note.

procedure_codes[].code

string

Billing identifier parsed from the progress note.

Example

"93000"

procedure_codes[].description

string

Readable procedure wording paired with the billing identifier.

Example

"Electrocardiogram"

visit_codes

string

Empty from fetch-notes, which never populates this field.

Example

"99213"

follow_up

string

Follow-up section text as it reads in the note.

Example

"Follow up in 2 Weeks."

medical_history

array

Past Medical History lines split into separate entries.

surgical_history

array

Surgical History lines split into separate entries.

hospitalization_history

string

Hospital admission narrative copied from the progress note.

Example

"Pneumonia 06/2022."

hospitalization

array

Hospital admission narrative split into separate entries.

family_history

string

Family history section text as it reads in the note.

Example

"Father has hypertension."

social_history

string

Lifestyle narrative copied from the progress note.

Example

"Never smoked. Exercises three times weekly."

preventive_medicine

string

Preventive Medicine text, empty when the note lacks that section.

Example

"Discussed routine exercise and balanced nutrition."

structured_note

object

Typed source-backed records for supported subjective and history sections.

structured_note.chief_complaints

object

Source-backed presenting concerns with section annotations and normalized records.

structured_note.chief_complaints.notes

string

Opaque direct section note. It is display/copy data, not a writer-ready structured record.

Example

"Symptoms reviewed with the patient."

structured_note.chief_complaints.items

array

Normalized records belonging to this progress note section.

structured_note.chief_complaints.items[].id

string

Source identifier for the normalized section record.

Example

"38243"

structured_note.chief_complaints.items[].categoryId

string

Chart category for the section being written, from fetch-chart-catalog.

Example

"065822"

structured_note.chief_complaints.items[].propertyId

string

Structured HPI property for the field being answered, from structuredFields.

Example

"900201"

structured_note.chief_complaints.items[].name

string

Display label returned for the source record.

Example

"Jane Doe"

structured_note.chief_complaints.items[].value

string

Recorded answer or content from the source record.

Example

"Example"

structured_note.chief_complaints.items[].notes

string

Opaque source note. It is preserved for encounter parity and must not be parsed to invent structured writer fields.

Example

"Symptoms began after travel."

structured_note.chief_complaints.items[].status

string

Source disposition associated with the normalized section record.

Example

"Active"

structured_note.chief_complaints.items[].extra

object

Additional source data preserved without HTML or XML.

structured_note.chief_complaints.extra

object

Additional section data retained from the source response.

structured_note.history_of_present_illness

object

HPI section text as it reads in the note.

structured_note.history_of_present_illness.notes

string

Opaque direct section note. It is display/copy data, not a writer-ready structured record.

Example

"Symptoms reviewed with the patient."

structured_note.history_of_present_illness.extra

object

Additional section data retained from the source response.

structured_note.history_of_present_illness.categories

array

List of categories.

structured_note.history_of_present_illness.categories[].categoryId

string

Chart category for the section being written, from fetch-chart-catalog.

Example

"065822"

structured_note.history_of_present_illness.categories[].name

string

Display label for this illness history grouping.

Example

"Jane Doe"

structured_note.history_of_present_illness.categories[].notes

string

Narrative annotation attached to this illness history grouping.

Example

"Symptoms started three days ago."

structured_note.history_of_present_illness.categories[].fields

array

Structured source records within this illness history grouping.

structured_note.history_of_present_illness.categories[].fields[].id

string

Source identifier for the normalized section record.

Example

"38243"

structured_note.history_of_present_illness.categories[].fields[].categoryId

string

Chart category for the section being written, from fetch-chart-catalog.

Example

"065822"

structured_note.history_of_present_illness.categories[].fields[].propertyId

string

Structured HPI property for the field being answered, from structuredFields.

Example

"900201"

structured_note.history_of_present_illness.categories[].fields[].name

string

Display label returned for the source record.

Example

"Jane Doe"

structured_note.history_of_present_illness.categories[].fields[].value

string

Recorded answer or content from the source record.

Example

"Example"

structured_note.history_of_present_illness.categories[].fields[].notes

string

Opaque source note. It is preserved for encounter parity and must not be parsed to invent structured writer fields.

Example

"Symptoms began after travel."

structured_note.history_of_present_illness.categories[].fields[].status

string

Source disposition associated with the normalized section record.

Example

"Active"

structured_note.history_of_present_illness.categories[].fields[].extra

object

Additional source data preserved without HTML or XML.

structured_note.history_of_present_illness.categories[].extra

object

Additional source data retained with this history grouping.

structured_note.current_medications

object

Current medications section text as it reads in the note.

structured_note.current_medications.notes

string

Opaque direct section note. It is display/copy data, not a writer-ready structured record.

Example

"Symptoms reviewed with the patient."

structured_note.current_medications.extra

object

Additional section data retained from the source response.

structured_note.current_medications.medications

array

List of medications.

structured_note.current_medications.medications[].status

string

Recorded usage disposition for the historical medication.

Example

"Taking"

structured_note.current_medications.medications[].name

string

Drug display label read from the source record.

Example

"Folic Acid"

structured_note.current_medications.medications[].strength

string

Medication strength as the catalog spells it, paired with name.

Example

"1 MG"

structured_note.current_medications.medications[].formulation

string

Dose form, needed unless name and strength match one dose.

Example

"Tablet"

structured_note.current_medications.medications[].sourceText

string

Original medication text, echoed back in the write result.

Example

"folic acid (folic acid 1 mg oral tablet)"

structured_note.current_medications.medications[].extra

object

Additional source data retained with the medication record.

structured_note.medical_history

object

Past Medical History lines split into separate entries.

structured_note.medical_history.notes

string

Opaque direct section note. It is display/copy data, not a writer-ready structured record.

Example

"Symptoms reviewed with the patient."

structured_note.medical_history.extra

object

Additional section data retained from the source response.

structured_note.medical_history.historyItems

array

List of history Items.

structured_note.medical_history.historyItems[].text

string

Recorded condition wording from the patient's medical history.

Example

"Example text."

structured_note.medical_history.historyItems[].icd10

string

ICD-10 codes added to or looked up in the Assessment section.

Example

"A36.13"

structured_note.medical_history.historyItems[].icdId

string

Catalog item for the diagnosis, from search-icd10's itemId.

Example

"900401"

structured_note.medical_history.historyItems[].problemListId

string

Identifier linking the condition to a longitudinal problem record.

Example

"541901"

structured_note.medical_history.historyItems[].extra

object

Additional source data retained with the historical condition.

structured_note.allergies

object

Allergies section text copied from the progress note.

structured_note.allergies.notes

string

Opaque direct section note. It is display/copy data, not a writer-ready structured record.

Example

"Symptoms reviewed with the patient."

structured_note.allergies.extra

object

Additional section data retained from the source response.

structured_note.allergies.noKnownDrugAllergies

boolean

No known drug allergies

Example

false

structured_note.allergies.allergyItems

array

List of allergy Items.

structured_note.allergies.allergyItems[].allergy

string

Allergen or drug name, from search-allergy results.

Example

"Penicillin"

structured_note.allergies.allergyItems[].reaction

string

Reaction saved as the description text on the allergy row.

Example

"hives"

structured_note.allergies.allergyItems[].allergyType

string

Whether this is a true allergy, side effect, or contraindication.

Example

"Allergy"

structured_note.allergies.allergyItems[].status

string

Recorded activity disposition of the allergen entry.

Example

"Active"

structured_note.allergies.allergyItems[].criticality

string

Severity recorded for the allergy on the chart.

Example

"High"

structured_note.allergies.allergyItems[].onsetDate

string

Date the allergy was first noted on the chart.

Example

"03/14/2026"

structured_note.allergies.allergyItems[].rxId

string

eCW allergy record id created by the write.

Example

"9000301"

structured_note.allergies.allergyItems[].displayIndex

integer

Row position, either the smart form's order or the allergy's.

Example

1

structured_note.allergies.allergyItems[].extra

object

Additional source data retained with the allergen entry.

structured_note.surgical_history

object

Surgical History lines split into separate entries.

structured_note.surgical_history.notes

string

Opaque direct section note. It is display/copy data, not a writer-ready structured record.

Example

"Symptoms reviewed with the patient."

structured_note.surgical_history.extra

object

Additional section data retained from the source response.

structured_note.surgical_history.surgeries

array

List of surgeries.

structured_note.surgical_history.surgeries[].surgery

string

Surgery title, required when writeMode is free_text, else matched to catalog.

Example

"Appendectomy"

structured_note.surgical_history.surgeries[].cptCode

string

CPT code resolved against the catalog instead of the surgery title.

Example

"44950"

structured_note.surgical_history.surgeries[].date

string

Recorded timing of the historical surgical procedure.

Example

"05/2022"

structured_note.surgical_history.surgeries[].displayIndex

integer

Row position, either the smart form's order or the allergy's.

Example

1

structured_note.surgical_history.surgeries[].extra

object

Additional source data retained with the historical operation.

structured_note.hospitalization

object

Source-backed hospital admissions with associated section annotations.

structured_note.hospitalization.notes

string

Opaque direct section note. It is display/copy data, not a writer-ready structured record.

Example

"Symptoms reviewed with the patient."

structured_note.hospitalization.extra

object

Additional section data retained from the source response.

structured_note.hospitalization.hospitalizations

array

List of hospitalizations.

structured_note.hospitalization.hospitalizations[].reason

string

Why the call or hospitalization happened, saved as row text.

Example

"Pneumonia"

structured_note.hospitalization.hospitalizations[].date

string

Recorded timing of the previous hospital admission.

Example

"06/2022"

structured_note.hospitalization.hospitalizations[].displayIndex

integer

Row position, either the smart form's order or the allergy's.

Example

1

structured_note.hospitalization.hospitalizations[].extra

object

Additional source data retained with the hospital admission.

structured_note.family_history

object

Family history section text as it reads in the note.

structured_note.family_history.notes

string

Opaque direct section note. It is display/copy data, not a writer-ready structured record.

Example

"Symptoms reviewed with the patient."

structured_note.family_history.extra

object

Additional section data retained from the source response.

structured_note.family_history.relatives

array

List of relatives.

structured_note.family_history.relatives[].id

string

Source record identifier for the documented relative.

Example

"9000501"

structured_note.family_history.relatives[].relative

string

Family relationship recorded for this history entry.

Example

"Father"

structured_note.family_history.relatives[].notes

string

Narrative information recorded about the family member.

Example

"History of hypertension."

structured_note.family_history.relatives[].status

string

Source disposition recorded for the family member.

Example

"Alive"

structured_note.family_history.relatives[].extra

object

Additional source data retained with the family record.

structured_note.family_history.nonContributory

string

Non contributory

structured_note.social_history

object

Source-backed lifestyle records grouped by chart category.

structured_note.social_history.notes

string

Opaque direct section note. It is display/copy data, not a writer-ready structured record.

Example

"Symptoms reviewed with the patient."

structured_note.social_history.extra

object

Additional section data retained from the source response.

structured_note.social_history.categories

array

List of categories.

structured_note.social_history.categories[].id

string

Source node identifier for this section grouping.

Example

"900101"

structured_note.social_history.categories[].name

string

Display label returned for this section grouping.

Example

"General"

structured_note.social_history.categories[].parentId

string

Identifier of the enclosing source category node.

Example

"900100"

structured_note.social_history.categories[].items

array

Normalized source records within this section grouping.

structured_note.social_history.categories[].items[].id

string

Source identifier for the normalized section record.

Example

"38243"

structured_note.social_history.categories[].items[].categoryId

string

Chart category for the section being written, from fetch-chart-catalog.

Example

"065822"

structured_note.social_history.categories[].items[].propertyId

string

Structured HPI property for the field being answered, from structuredFields.

Example

"900201"

structured_note.social_history.categories[].items[].name

string

Display label returned for the source record.

Example

"Jane Doe"

structured_note.social_history.categories[].items[].value

string

Recorded answer or content from the source record.

Example

"Example"

structured_note.social_history.categories[].items[].notes

string

Opaque source note. It is preserved for encounter parity and must not be parsed to invent structured writer fields.

Example

"Symptoms began after travel."

structured_note.social_history.categories[].items[].status

string

Source disposition associated with the normalized section record.

Example

"Active"

structured_note.social_history.categories[].items[].extra

object

Additional source data preserved without HTML or XML.

structured_note.social_history.categories[].extra

object

Additional source data retained with this section grouping.

structured_note.review_of_systems

object

Review of Systems text from the progress note.

structured_note.review_of_systems.notes

string

Opaque direct section note. It is display/copy data, not a writer-ready structured record.

Example

"Symptoms reviewed with the patient."

structured_note.review_of_systems.extra

object

Additional section data retained from the source response.

structured_note.review_of_systems.categories

array

List of categories.

structured_note.review_of_systems.categories[].id

string

Source node identifier for this section grouping.

Example

"900101"

structured_note.review_of_systems.categories[].name

string

Display label returned for this section grouping.

Example

"General"

structured_note.review_of_systems.categories[].parentId

string

Identifier of the enclosing source category node.

Example

"900100"

structured_note.review_of_systems.categories[].items

array

Normalized source records within this section grouping.

structured_note.review_of_systems.categories[].items[].id

string

Source identifier for the normalized section record.

Example

"38243"

structured_note.review_of_systems.categories[].items[].categoryId

string

Chart category for the section being written, from fetch-chart-catalog.

Example

"065822"

structured_note.review_of_systems.categories[].items[].propertyId

string

Structured HPI property for the field being answered, from structuredFields.

Example

"900201"

structured_note.review_of_systems.categories[].items[].name

string

Display label returned for the source record.

Example

"Jane Doe"

structured_note.review_of_systems.categories[].items[].value

string

Recorded answer or content from the source record.

Example

"Example"

structured_note.review_of_systems.categories[].items[].notes

string

Opaque source note. It is preserved for encounter parity and must not be parsed to invent structured writer fields.

Example

"Symptoms began after travel."

structured_note.review_of_systems.categories[].items[].status

string

Source disposition associated with the normalized section record.

Example

"Active"

structured_note.review_of_systems.categories[].items[].extra

object

Additional source data preserved without HTML or XML.

structured_note.review_of_systems.categories[].extra

object

Additional source data retained with this section grouping.

section_status

object

Unavailable or invalid reader outcomes, omitted when none exist.

curl --request POST \
  --url https://preview.ontross.com/api/integrations/ecw/fetch-notes \
  --header 'X-API-Key: REPLACE_KEY_VALUE' \
  --header 'content-type: application/json' \
  --data '{"input":{"patientId":"348144","encounterId":"9620412","date":"10/06/2026","toProviderId":"6086","gd":"3b81df0c54a74e1d9c6f20ab7e4d15c9","cip":"9f2c4b7ae1d9154fa05c71be2d9f3a68","formData":"471,478,475,1,5,2,3,4","clientTimezone":"America/New_York"},"auth_id":"auth_uuid_here"}'

Request BODY

{
  "input": {
    "patientId": "348144",
    "encounterId": "9620412",
    "date": "10/06/2026",
    "toProviderId": "6086",
    "gd": "3b81df0c54a74e1d9c6f20ab7e4d15c9",
    "cip": "9f2c4b7ae1d9154fa05c71be2d9f3a68",
    "formData": "471,478,475,1,5,2,3,4",
    "clientTimezone": "America/New_York"
  },
  "auth_id": "auth_uuid_here"
}

Response BODY

{
  "id": "string",
  "workflow_id": "string",
  "auth_id": "string",
  "status": "string",
  "input": {},
  "output": {
    "current_medications": "Taking Folic Acid 1 MG Tablet daily.",
    "past_medical_history": "Hypertension. Father has hypertension. Never smoked.",
    "allergies": "Penicillin: hives.",
    "review_of_systems": "No fever or chills.",
    "vital_signs": "BP 120/80, HR 72.",
    "reason_for_appointment": "Sore throat for three days.",
    "history_of_present_illness": "Example text.",
    "examination": "Alert and in no acute distress.",
    "assessments": "Acute pharyngitis.",
    "treatment": "Supportive care and adequate hydration.",
    "procedure_codes": [
      {
        "code": "93000",
        "description": "Electrocardiogram"
      }
    ],
    "visit_codes": "99213",
    "follow_up": "Follow up in 2 Weeks.",
    "medical_history": [
      "string"
    ],
    "surgical_history": [
      "string"
    ],
    "hospitalization_history": "Pneumonia 06/2022.",
    "hospitalization": [
      "string"
    ],
    "family_history": "Father has hypertension.",
    "social_history": "Never smoked. Exercises three times weekly.",
    "preventive_medicine": "Discussed routine exercise and balanced nutrition.",
    "structured_note": {
      "chief_complaints": {
        "notes": "Symptoms reviewed with the patient.",
        "items": [
          {
            "id": "38243",
            "categoryId": "065822",
            "propertyId": "900201",
            "name": "Jane Doe",
            "value": "Example",
            "notes": "Symptoms began after travel.",
            "status": "Active",
            "extra": {}
          }
        ],
        "extra": {}
      },
      "history_of_present_illness": {
        "notes": "Symptoms reviewed with the patient.",
        "extra": {},
        "categories": [
          {
            "categoryId": "065822",
            "name": "Jane Doe",
            "notes": "Symptoms started three days ago.",
            "fields": [
              {
                "id": "38243",
                "categoryId": "065822",
                "propertyId": "900201",
                "name": "Jane Doe",
                "value": "Example",
                "notes": "Symptoms began after travel.",
                "status": "Active",
                "extra": {}
              }
            ],
            "extra": {}
          }
        ]
      },
      "current_medications": {
        "notes": "Symptoms reviewed with the patient.",
        "extra": {},
        "medications": [
          {
            "status": "Taking",
            "name": "Folic Acid",
            "strength": "1 MG",
            "formulation": "Tablet",
            "sourceText": "folic acid (folic acid 1 mg oral tablet)",
            "extra": {}
          }
        ]
      },
      "medical_history": {
        "notes": "Symptoms reviewed with the patient.",
        "extra": {},
        "historyItems": [
          {
            "text": "Example text.",
            "icd10": "A36.13",
            "icdId": "900401",
            "problemListId": "541901",
            "extra": {}
          }
        ]
      },
      "allergies": {
        "notes": "Symptoms reviewed with the patient.",
        "extra": {},
        "noKnownDrugAllergies": false,
        "allergyItems": [
          {
            "allergy": "Penicillin",
            "reaction": "hives",
            "allergyType": "Allergy",
            "status": "Active",
            "criticality": "High",
            "onsetDate": "03/14/2026",
            "rxId": "9000301",
            "displayIndex": 1,
            "extra": {}
          }
        ]
      },
      "surgical_history": {
        "notes": "Symptoms reviewed with the patient.",
        "extra": {},
        "surgeries": [
          {
            "surgery": "Appendectomy",
            "cptCode": "44950",
            "date": "05/2022",
            "displayIndex": 1,
            "extra": {}
          }
        ]
      },
      "hospitalization": {
        "notes": "Symptoms reviewed with the patient.",
        "extra": {},
        "hospitalizations": [
          {
            "reason": "Pneumonia",
            "date": "06/2022",
            "displayIndex": 1,
            "extra": {}
          }
        ]
      },
      "family_history": {
        "notes": "Symptoms reviewed with the patient.",
        "extra": {},
        "relatives": [
          {
            "id": "9000501",
            "relative": "Father",
            "notes": "History of hypertension.",
            "status": "Alive",
            "extra": {}
          }
        ],
        "nonContributory": ""
      },
      "social_history": {
        "notes": "Symptoms reviewed with the patient.",
        "extra": {},
        "categories": [
          {
            "id": "900101",
            "name": "General",
            "parentId": "900100",
            "items": [
              {
                "id": "38243",
                "categoryId": "065822",
                "propertyId": "900201",
                "name": "Jane Doe",
                "value": "Example",
                "notes": "Symptoms began after travel.",
                "status": "Active",
                "extra": {}
              }
            ],
            "extra": {}
          }
        ]
      },
      "review_of_systems": {
        "notes": "Symptoms reviewed with the patient.",
        "extra": {},
        "categories": [
          {
            "id": "900101",
            "name": "General",
            "parentId": "900100",
            "items": [
              {
                "id": "38243",
                "categoryId": "065822",
                "propertyId": "900201",
                "name": "Jane Doe",
                "value": "Example",
                "notes": "Symptoms began after travel.",
                "status": "Active",
                "extra": {}
              }
            ],
            "extra": {}
          }
        ]
      }
    },
    "section_status": {
      "property1": {
        "state": "unavailable",
        "error": "Section response unavailable"
      },
      "property2": {
        "state": "unavailable",
        "error": "Section response unavailable"
      }
    }
  },
  "files": null,
  "created_at": "2019-08-24T14:15:22Z",
  "started_at": "2019-08-24T14:15:22Z",
  "completed_at": "2019-08-24T14:15:22Z"
}