Documentation Index
Fetch the complete documentation index at: https://docs.morf.health/docs/llms.txt
Use this file to discover all available pages before exploring further.
Parameters
Hide parameters
Hide parameters
This field maps to the destination API
status field.Allowed Enumeration Values
APPOINTMENT_STATUS_ARRIVED
APPOINTMENT_STATUS_CANCELLED
APPOINTMENT_STATUS_CHECKED_IN
APPOINTMENT_STATUS_CHECKED_IN_ONLINE
APPOINTMENT_STATUS_COMPLETE
APPOINTMENT_STATUS_CONFIRMED
APPOINTMENT_STATUS_EMPTY
APPOINTMENT_STATUS_IN_ROOM
APPOINTMENT_STATUS_IN_SESSION
APPOINTMENT_STATUS_NO_SHOW
APPOINTMENT_STATUS_NOT_CONFIRMED
APPOINTMENT_STATUS_RESCHEDULED
ID
This field maps to the destination API patient field.ID
This field maps to the destination API doctor field.This field maps to the destination API
since field.This field maps to the destination API
date field.{
"$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": "admin@clinic.com",
"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.
Hide fields
Hide fields
Bypass overlap check
CEL
$result_object_key[*].allow_overlapping
Example
false
Whether the appointment is a break
CEL
$result_object_key[*].appt_is_break
Example
false
ID of base appointment of a recurring series
CEL
$result_object_key[*].base_recurring_appointment
Example
"123456"
Billing notes of the appointment
CEL
$result_object_key[*].billing_notes
Example
[
{
"appointment": 123456,
"created_at": "2024-01-15T10:30:00Z",
"created_by": "Dr. Smith",
"id": 789,
"text": "Patient copay collected"
}
]
Mapped array of: ID of the appointment this billing note belongs to
CEL
$result_object_key[*].billing_notes.map(x, x.appointment)
Example
[
123456
]
Mapped array of: Timestamp when the billing note was created
CEL
$result_object_key[*].billing_notes.map(x, x.created_at)
Example
[
"2024-01-15T10:30:00Z"
]
Mapped array of: User who created the billing note
CEL
$result_object_key[*].billing_notes.map(x, x.created_by)
Example
[
"Dr. Smith"
]
Mapped array of: ID of the billing note
CEL
$result_object_key[*].billing_notes.map(x, x.id)
Example
[
789
]
Mapped array of: Content of the note
CEL
$result_object_key[*].billing_notes.map(x, x.text)
Example
[
"Patient copay collected"
]
Billing provider for the appointment
CEL
$result_object_key[*].billing_provider
Example
"Dr. Smith"
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)
CEL
$result_object_key[*].billing_status
Example
"Bill Insurance"
Associated clinical note object
CEL
$result_object_key[*].clinical_note
Example
{
"locked": false,
"pdf": "https://example.com/notes/12345.pdf",
"updated_at": "2024-01-15T10:30:00Z"
}
Whether the clinical note is locked
CEL
$result_object_key[*].clinical_note.locked
Example
false
URL to the clinical note PDF
CEL
$result_object_key[*].clinical_note.pdf
Example
"https://example.com/notes/12345.pdf"
Timestamp when the clinical note was last updated
CEL
$result_object_key[*].clinical_note.updated_at
Example
"2024-01-15T10:30:00Z"
ID of the original appointment which this appointment cloned from. Null if not cloned.
CEL
$result_object_key[*].cloned_from
Example
789
Color of the appointment
CEL
$result_object_key[*].color
Example
"#FF5733"
Timestamp when the appointment was created
CEL
$result_object_key[*].created_at
Example
"2024-01-15T10:30:00Z"
User who created the appointment
CEL
$result_object_key[*].created_by
Example
"admin@clinic.com"
Custom appointment fields
CEL
$result_object_key[*].custom_fields
Example
[
{
"created_at": "2024-01-15T10:30:00Z",
"field_type": 5,
"field_value": "Custom value",
"updated_at": "2024-01-15T10:30:00Z"
}
]
Mapped array of: Timestamp when the custom field was created
CEL
$result_object_key[*].custom_fields.map(x, x.created_at)
Example
[
"2024-01-15T10:30:00Z"
]
Mapped array of: ID of the custom field type
CEL
$result_object_key[*].custom_fields.map(x, x.field_type)
Example
[
5
]
Mapped array of: Value of the custom field
CEL
$result_object_key[*].custom_fields.map(x, x.field_value)
Example
[
"Custom value"
]
Mapped array of: Timestamp when the custom field was last updated
CEL
$result_object_key[*].custom_fields.map(x, x.updated_at)
Example
[
"2024-01-15T10:30:00Z"
]
Custom appointment status name
CEL
$result_object_key[*].custom_status
Example
"Waiting for Lab Results"
Custom vitals associated with this appointment
CEL
$result_object_key[*].custom_vitals
Example
[
{
"value": "120",
"vital_type": 3
}
]
Mapped array of: Value of the custom vital
CEL
$result_object_key[*].custom_vitals.map(x, x.value)
Example
[
"120"
]
Mapped array of: ID of the custom vital type
CEL
$result_object_key[*].custom_vitals.map(x, x.vital_type)
Example
[
3
]
Whether the appointment is deleted
CEL
$result_object_key[*].deleted_flag
Example
false
Doctor ID
CEL
$result_object_key[*].doctor
Example
12345
Length of the appointment in minutes. Optional if profile is provided.
CEL
$result_object_key[*].duration
Example
30
Index of the exam room that this appointment occurs in
CEL
$result_object_key[*].exam_room
Example
3
The most recent update time among appointment itself, its vitals and its custom vitals
CEL
$result_object_key[*].extended_updated_at
Example
"2024-01-15T10:30:00Z"
Date the appointment was first billed
CEL
$result_object_key[*].first_billed_date
Example
"2024-01-16"
Date of first EDI submission
CEL
$result_object_key[*].first_edi_date
Example
"2024-01-16"
ICD-10 diagnosis codes
CEL
$result_object_key[*].icd10_codes
Example
[]
ICD-9 diagnosis codes
CEL
$result_object_key[*].icd9_codes
Example
[]
Unique identifier. Usually numeric, but not always
CEL
$result_object_key[*].id
Example
"123456"
Billing status of primary insurer
CEL
$result_object_key[*].ins1_status
Example
"Pending"
Billing status of secondary insurer
CEL
$result_object_key[*].ins2_status
Example
"Not Billed"
Whether this is a virtual base appointment
CEL
$result_object_key[*].is_virtual_base
Example
false
Whether the appointment is a walk-in appointment
CEL
$result_object_key[*].is_walk_in
Example
false
Date the appointment was last billed
CEL
$result_object_key[*].last_billed_date
Example
"2024-01-20"
Date of last EDI submission
CEL
$result_object_key[*].last_edi_date
Example
"2024-01-20"
Appointment notes
CEL
$result_object_key[*].notes
Example
"Patient requested early morning slot"
Office ID
CEL
$result_object_key[*].office
Example
100
ID of this appointment’s patient. Breaks have a null patient field.
CEL
$result_object_key[*].patient
Example
54321
Appointment payment profile
CEL
$result_object_key[*].payment_profile
Example
"Insurance"
Primary insurance ID number
CEL
$result_object_key[*].primary_insurance_id_number
Example
"INS123456"
Primary insurer name
CEL
$result_object_key[*].primary_insurer_name
Example
"Blue Cross Blue Shield"
Primary insurer payer ID
CEL
$result_object_key[*].primary_insurer_payer_id
Example
"BCBS001"
ID of an appointment profile. Sets default values for color, duration, and reason on creation.
CEL
$result_object_key[*].profile
Example
10
Reason for the appointment. Default to empty string.
CEL
$result_object_key[*].reason
Example
"Annual checkup"
For recurring appointments, the end date of the recurring series
CEL
$result_object_key[*].recur_end_date
Example
"2024-12-31"
For recurring appointments, the start date of the recurring series
CEL
$result_object_key[*].recur_start_date
Example
"2024-01-01"
Whether the appointment is a recurring appointment or not
CEL
$result_object_key[*].recurring_appointment
Example
false
For recurring appointments, the number of weeks between recurrences
CEL
$result_object_key[*].recurs_every
Example
2
Write-only. ID of a reminder profile to apply to the appointment.
CEL
$result_object_key[*].reminder_profile
Example
"RP001"
Scheduled reminders of the appointment
CEL
$result_object_key[*].reminders
Example
[
{
"id": 456,
"scheduled_time": "2024-01-15T09:00:00Z",
"type": "email"
}
]
Mapped array of: ID of the reminder
CEL
$result_object_key[*].reminders.map(x, x.id)
Example
[
456
]
Mapped array of: Scheduled time for the reminder
CEL
$result_object_key[*].reminders.map(x, x.scheduled_time)
Example
[
"2024-01-15T09:00:00Z"
]
Mapped array of: Type of reminder (e.g., email, sms)
CEL
$result_object_key[*].reminders.map(x, x.type)
Example
[
"email"
]
ID of the original claim for resubmission
CEL
$result_object_key[*].resubmit_claim_original_id
Example
999
The starting time of the appointment
CEL
$result_object_key[*].scheduled_time
Example
"2024-01-15T10:00:00Z"
Secondary insurance ID number
CEL
$result_object_key[*].secondary_insurance_id_number
Example
"SEC789"
Secondary insurer name
CEL
$result_object_key[*].secondary_insurer_name
Example
"Aetna"
Secondary insurer payer ID
CEL
$result_object_key[*].secondary_insurer_payer_id
Example
"AETNA001"
Appointment status: Arrived, Checked In, In Room, Cancelled, Complete, Confirmed, In Session, No Show, Not Confirmed, Rescheduled, or a custom status
CEL
$result_object_key[*].status
Example
drchrono.v1.AppointmentStatus.APPOINTMENT_STATUS_ARRIVED
drchrono.v1.AppointmentStatus.APPOINTMENT_STATUS_CANCELLED
drchrono.v1.AppointmentStatus.APPOINTMENT_STATUS_CHECKED_IN
drchrono.v1.AppointmentStatus.APPOINTMENT_STATUS_CHECKED_IN_ONLINE
drchrono.v1.AppointmentStatus.APPOINTMENT_STATUS_COMPLETE
drchrono.v1.AppointmentStatus.APPOINTMENT_STATUS_CONFIRMED
drchrono.v1.AppointmentStatus.APPOINTMENT_STATUS_EMPTY
drchrono.v1.AppointmentStatus.APPOINTMENT_STATUS_IN_ROOM
drchrono.v1.AppointmentStatus.APPOINTMENT_STATUS_IN_SESSION
drchrono.v1.AppointmentStatus.APPOINTMENT_STATUS_NO_SHOW
drchrono.v1.AppointmentStatus.APPOINTMENT_STATUS_NOT_CONFIRMED
drchrono.v1.AppointmentStatus.APPOINTMENT_STATUS_RESCHEDULED
Status transition history
CEL
$result_object_key[*].status_transitions
Example
[
{
"appointment": "123456",
"datetime": "2024-01-15T10:30:00Z",
"from_status": "Confirmed",
"to_status": "Arrived"
}
]
Mapped array of: ID of the appointment
CEL
$result_object_key[*].status_transitions.map(x, x.appointment)
Example
[
"123456"
]
Mapped array of: Timestamp when the status transition occurred
CEL
$result_object_key[*].status_transitions.map(x, x.datetime)
Example
[
"2024-01-15T10:30:00Z"
]
Mapped array of: Previous status before the transition
CEL
$result_object_key[*].status_transitions.map(x, x.from_status)
Example
[
"Confirmed"
]
Mapped array of: New status after the transition
CEL
$result_object_key[*].status_transitions.map(x, x.to_status)
Example
[
"Arrived"
]
Supervising provider of appointment if set
CEL
$result_object_key[*].supervising_provider
Example
"Dr. Johnson"
Timestamp when the appointment was last updated
CEL
$result_object_key[*].updated_at
Example
"2024-01-15T10:30:00Z"
Clinical vitals associated with the appointment
CEL
$result_object_key[*].vitals
Example
{
"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"
}
Systolic blood pressure
CEL
$result_object_key[*].vitals.blood_pressure_1
Example
120
Diastolic blood pressure
CEL
$result_object_key[*].vitals.blood_pressure_2
Example
80
Body Mass Index
CEL
$result_object_key[*].vitals.bmi
Example
"24.5"
Head circumference measurement
CEL
$result_object_key[*].vitals.head_circumference
Example
35.5
Units for head circumference (e.g., cm, in)
CEL
$result_object_key[*].vitals.head_circumference_units
Example
"cm"
Patient height
CEL
$result_object_key[*].vitals.height
Example
170.5
Units for height (e.g., cm, in)
CEL
$result_object_key[*].vitals.height_units
Example
"cm"
Oxygen saturation percentage
CEL
$result_object_key[*].vitals.oxygen_saturation
Example
98.5
Pain level on 0-10 scale
CEL
$result_object_key[*].vitals.pain
Example
"3"
Heart rate in beats per minute
CEL
$result_object_key[*].vitals.pulse
Example
72
Respiratory rate in breaths per minute
CEL
$result_object_key[*].vitals.respiratory_rate
Example
16
Patient smoking status
CEL
$result_object_key[*].vitals.smoking_status
Example
"never"
Body temperature
CEL
$result_object_key[*].vitals.temperature
Example
98.6
Units for temperature (e.g., F, C)
CEL
$result_object_key[*].vitals.temperature_units
Example
"F"
Patient weight
CEL
$result_object_key[*].vitals.weight
Example
70.5
Units for weight (e.g., kg, lb)
CEL
$result_object_key[*].vitals.weight_units
Example
"kg"
