Skip to main content
images/dr_chrono.svg

Parameters

Action
Parameters
{
  "$result_object_key": [
    {
      "allow_overlapping": false,
      "appt_is_break": false,
      "base_recurring_appointment": "123456",
      "billing_notes": [
        {
          "appointment": 123456,
          "created_at": "2024-01-15T10:30:00Z",
          "created_by": "Dr. Smith",
          "id": 789,
          "text": "Patient copay collected"
        }
      ],
      "billing_provider": "Dr. Smith",
      "billing_status": "Bill Insurance",
      "clinical_note": {
        "locked": false,
        "pdf": "https://example.com/notes/12345.pdf",
        "updated_at": "2024-01-15T10:30:00Z"
      },
      "cloned_from": 789,
      "color": "#FF5733",
      "created_at": "2024-01-15T10:30:00Z",
      "created_by": "[email protected]",
      "custom_fields": [
        {
          "created_at": "2024-01-15T10:30:00Z",
          "field_type": 5,
          "field_value": "Custom value",
          "updated_at": "2024-01-15T10:30:00Z"
        }
      ],
      "custom_status": "Waiting for Lab Results",
      "custom_vitals": [
        {
          "value": "120",
          "vital_type": 3
        }
      ],
      "deleted_flag": false,
      "doctor": 12345,
      "duration": 30,
      "exam_room": 3,
      "extended_updated_at": "2024-01-15T10:30:00Z",
      "first_billed_date": "2024-01-16",
      "first_edi_date": "2024-01-16",
      "icd10_codes": [],
      "icd9_codes": [],
      "id": "123456",
      "ins1_status": "Pending",
      "ins2_status": "Not Billed",
      "is_virtual_base": false,
      "is_walk_in": false,
      "last_billed_date": "2024-01-20",
      "last_edi_date": "2024-01-20",
      "notes": "Patient requested early morning slot",
      "office": 100,
      "patient": 54321,
      "payment_profile": "Insurance",
      "primary_insurance_id_number": "INS123456",
      "primary_insurer_name": "Blue Cross Blue Shield",
      "primary_insurer_payer_id": "BCBS001",
      "profile": 10,
      "reason": "Annual checkup",
      "recur_end_date": "2024-12-31",
      "recur_start_date": "2024-01-01",
      "recurring_appointment": false,
      "recurs_every": 2,
      "reminder_profile": "RP001",
      "reminders": [
        {
          "id": 456,
          "scheduled_time": "2024-01-15T09:00:00Z",
          "type": "email"
        }
      ],
      "resubmit_claim_original_id": 999,
      "scheduled_time": "2024-01-15T10:00:00Z",
      "secondary_insurance_id_number": "SEC789",
      "secondary_insurer_name": "Aetna",
      "secondary_insurer_payer_id": "AETNA001",
      "status": "Confirmed",
      "status_transitions": [
        {
          "appointment": "123456",
          "datetime": "2024-01-15T10:30:00Z",
          "from_status": "Confirmed",
          "to_status": "Arrived"
        }
      ],
      "supervising_provider": "Dr. Johnson",
      "updated_at": "2024-01-15T10:30:00Z",
      "vitals": {
        "blood_pressure_1": 120,
        "blood_pressure_2": 80,
        "bmi": "24.5",
        "head_circumference": 35.5,
        "head_circumference_units": "cm",
        "height": 170.5,
        "height_units": "cm",
        "oxygen_saturation": 98.5,
        "pain": "3",
        "pulse": 72,
        "respiratory_rate": 16,
        "smoking_status": "never",
        "temperature": 98.6,
        "temperature_units": "F",
        "weight": 70.5,
        "weight_units": "kg"
      }
    }
  ]
}
{
  "$result_object_key": [
    {
      "allow_overlapping": "Bypass overlap check",
      "appt_is_break": "Whether the appointment is a break",
      "base_recurring_appointment": "ID of base appointment of a recurring series",
      "billing_notes": {
        "appointment": "ID of the appointment this billing note belongs to",
        "created_at": "Timestamp when the billing note was created",
        "created_by": "User who created the billing note",
        "id": "ID of the billing note",
        "text": "Content of the note"
      },
      "billing_provider": "Billing provider for the appointment",
      "billing_status": "Billing status (e.g., Auto Accident Claim, Balance Due, Bill Insurance, Bill Secondary Insurance, Durable Medical Equipment Claim, Internal Review, Paid In Full, Settled, Worker's Comp Claim)",
      "clinical_note": {
        "locked": "Whether the clinical note is locked",
        "pdf": "URL to the clinical note PDF",
        "updated_at": "Timestamp when the clinical note was last updated"
      },
      "cloned_from": "ID of the original appointment which this appointment cloned from. Null if not cloned.",
      "color": "Color of the appointment",
      "created_at": "Timestamp when the appointment was created",
      "created_by": "User who created the appointment",
      "custom_fields": {
        "created_at": "Timestamp when the custom field was created",
        "field_type": "ID of the custom field type",
        "field_value": "Value of the custom field",
        "updated_at": "Timestamp when the custom field was last updated"
      },
      "custom_status": "Custom appointment status name",
      "custom_vitals": {
        "value": "Value of the custom vital",
        "vital_type": "ID of the custom vital type"
      },
      "deleted_flag": "Whether the appointment is deleted",
      "doctor": "Doctor ID",
      "duration": "Length of the appointment in minutes. Optional if profile is provided.",
      "exam_room": "Index of the exam room that this appointment occurs in",
      "extended_updated_at": "The most recent update time among appointment itself, its vitals and its custom vitals",
      "first_billed_date": "Date the appointment was first billed",
      "first_edi_date": "Date of first EDI submission",
      "icd10_codes": "ICD-10 diagnosis codes",
      "icd9_codes": "ICD-9 diagnosis codes",
      "id": "Unique identifier. Usually numeric, but not always",
      "ins1_status": "Billing status of primary insurer",
      "ins2_status": "Billing status of secondary insurer",
      "is_virtual_base": "Whether this is a virtual base appointment",
      "is_walk_in": "Whether the appointment is a walk-in appointment",
      "last_billed_date": "Date the appointment was last billed",
      "last_edi_date": "Date of last EDI submission",
      "notes": "Appointment notes",
      "office": "Office ID",
      "patient": "ID of this appointment's patient. Breaks have a null patient field.",
      "payment_profile": "Appointment payment profile",
      "primary_insurance_id_number": "Primary insurance ID number",
      "primary_insurer_name": "Primary insurer name",
      "primary_insurer_payer_id": "Primary insurer payer ID",
      "profile": "ID of an appointment profile. Sets default values for color, duration, and reason on creation.",
      "reason": "Reason for the appointment. Default to empty string.",
      "recur_end_date": "For recurring appointments, the end date of the recurring series",
      "recur_start_date": "For recurring appointments, the start date of the recurring series",
      "recurring_appointment": "Whether the appointment is a recurring appointment or not",
      "recurs_every": "For recurring appointments, the number of weeks between recurrences",
      "reminder_profile": "Write-only. ID of a reminder profile to apply to the appointment.",
      "reminders": {
        "id": "ID of the reminder",
        "scheduled_time": "Scheduled time for the reminder",
        "type": "Type of reminder (e.g., email, sms)"
      },
      "resubmit_claim_original_id": "ID of the original claim for resubmission",
      "scheduled_time": "The starting time of the appointment",
      "secondary_insurance_id_number": "Secondary insurance ID number",
      "secondary_insurer_name": "Secondary insurer name",
      "secondary_insurer_payer_id": "Secondary insurer payer ID",
      "status": "Appointment status: Arrived, Checked In, In Room, Cancelled, Complete, Confirmed, In Session, No Show, Not Confirmed, Rescheduled, or a custom status",
      "status_transitions": {
        "appointment": "ID of the appointment",
        "datetime": "Timestamp when the status transition occurred",
        "from_status": "Previous status before the transition",
        "to_status": "New status after the transition"
      },
      "supervising_provider": "Supervising provider of appointment if set",
      "updated_at": "Timestamp when the appointment was last updated",
      "vitals": {
        "blood_pressure_1": "Systolic blood pressure",
        "blood_pressure_2": "Diastolic blood pressure",
        "bmi": "Body Mass Index",
        "head_circumference": "Head circumference measurement",
        "head_circumference_units": "Units for head circumference (e.g., cm, in)",
        "height": "Patient height",
        "height_units": "Units for height (e.g., cm, in)",
        "oxygen_saturation": "Oxygen saturation percentage",
        "pain": "Pain level on 0-10 scale",
        "pulse": "Heart rate in beats per minute",
        "respiratory_rate": "Respiratory rate in breaths per minute",
        "smoking_status": "Patient smoking status",
        "temperature": "Body temperature",
        "temperature_units": "Units for temperature (e.g., F, C)",
        "weight": "Patient weight",
        "weight_units": "Units for weight (e.g., kg, lb)"
      }
    }
  ]
}

Result Object Field Details

You can use the result of the action’s data as inputs to downstream workflow actions. Each fetch action requires a result object key to be specified which will nest the action’s result data inside the downstream data context in the Workflow. Here we demonstrate how to refer to this data using the prefix $result_object_key.
[]Appointment
Fetch Action Response Object