Skip to main content

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.

images/medplum.svg

​
Events

​
Triggering Webhook Types

The following event types are associated with the Appointment event payload from Medplum.
  • Medplum Appointment Proposed
  • Medplum Appointment Pending
  • Medplum Appointment Booked
  • Medplum Appointment Arrived
  • Medplum Appointment Fulfilled
  • Medplum Appointment Cancelled
  • Medplum Appointment Noshow
  • Medplum Appointment Entered In Error
  • Medplum Appointment Checked In
  • Medplum Appointment Waitlist
  • Medplum Appointment Updated Other
{
  "appointment_type": {
    "codings": [
      {
        "code": "X",
        "display": "Arbitrary string",
        "system": "Jr.",
        "user_selected": true,
        "version": "r4"
      }
    ],
    "extensions": [
      {
        "extension": null,
        "url": "https://morf.health/fhir/r4/extensions/formats",
        "value": "arbitrary value of any type (i.e. not necessarily a string)",
        "value_field_label": null
      }
    ],
    "text": "Arbitrary concept string value"
  },
  "based_on_service_requests": [
    {
      "display": "PatientX",
      "identifier": {
        "period": {
          "end": "2025-08-13T18:41:44.263+00:00",
          "start": "2025-08-13T17:41:44.263+00:00"
        },
        "system": "https://morf.health/fhir/r4/identifier_types/healthie",
        "use": "secondary",
        "value": "401421231"
      },
      "reference": {
        "type": "Patient",
        "value": "1234"
      },
      "type": "Patient"
    }
  ],
  "comment": "Intake forms are complete for patient.",
  "created_at": "2024-04-30T13:12:09+00:00",
  "description": "Intake Appointment",
  "end": "2024-05-01T14:30:00+05:00",
  "extensions": [
    {
      "extension": null,
      "url": "https://morf.health/fhir/r4/extensions/formats",
      "value": "arbitrary value of any type (i.e. not necessarily a string)",
      "value_field_label": null
    }
  ],
  "id": "e5eb4711-75e7-46f1-b36e-6e869c02926d",
  "identifiers": [
    {
      "period": {
        "end": "2025-08-13T18:41:44.263+00:00",
        "start": "2025-08-13T17:41:44.263+00:00"
      },
      "system": "https://morf.health/fhir/r4/identifier_types/healthie",
      "use": "secondary",
      "value": "401421231"
    }
  ],
  "length_minutes": 30,
  "meta": {
    "extensions": [
      {
        "extension": null,
        "url": "https://morf.health/fhir/r4/extensions/formats",
        "value": "arbitrary value of any type (i.e. not necessarily a string)",
        "value_field_label": null
      }
    ],
    "id": "20002",
    "last_updated": "2025-02-11T17:17:41.101+00:00",
    "profiles": "Profile 1",
    "security_labels": [
      {
        "code": "X",
        "display": "Arbitrary string",
        "system": "Jr.",
        "user_selected": true,
        "version": "r4"
      }
    ],
    "source": "1",
    "tags": [
      {
        "code": "X",
        "display": "Arbitrary string",
        "system": "Jr.",
        "user_selected": true,
        "version": "r4"
      }
    ],
    "version_id": "1"
  },
  "participants": [
    {
      "actor": {
        "display": "PatientX",
        "identifier": {
          "period": {
            "end": "2025-08-13T18:41:44.263+00:00",
            "start": "2025-08-13T17:41:44.263+00:00"
          },
          "system": "https://morf.health/fhir/r4/identifier_types/healthie",
          "use": "secondary",
          "value": "401421231"
        },
        "reference": {
          "type": "Patient",
          "value": "1234"
        },
        "type": "Patient"
      },
      "extensions": [
        {
          "extension": null,
          "url": "https://morf.health/fhir/r4/extensions/formats",
          "value": "arbitrary value of any type (i.e. not necessarily a string)",
          "value_field_label": null
        }
      ],
      "id": "e5eb4711-75e7-46f1-b36e-6e869c02926d",
      "modifier_extensions": [
        {
          "extension": null,
          "url": "https://morf.health/fhir/r4/extensions/formats",
          "value": "arbitrary value of any type (i.e. not necessarily a string)",
          "value_field_label": null
        }
      ],
      "period": {
        "end": "2025-08-13T18:41:44.263+00:00",
        "start": "2025-08-13T17:41:44.263+00:00"
      },
      "required": null,
      "status": null,
      "types": [
        {
          "codings": [
            {
              "code": "X",
              "display": "Arbitrary string",
              "system": "Jr.",
              "user_selected": true,
              "version": "r4"
            }
          ],
          "extensions": [
            {
              "extension": null,
              "url": "https://morf.health/fhir/r4/extensions/formats",
              "value": "arbitrary value of any type (i.e. not necessarily a string)",
              "value_field_label": null
            }
          ],
          "text": "Arbitrary concept string value"
        }
      ]
    }
  ],
  "patient_id": "c98e27e4-18c2-4e01-bd86-eca13db78889",
  "patient_instruction": "Please bring your insurance ID card and your medications and arrive 10 minutes early. Thank you.",
  "periods": [
    {
      "end": "2025-08-13T18:41:44.263+00:00",
      "start": "2025-08-13T17:41:44.263+00:00"
    }
  ],
  "priority": 1,
  "reason_code": [
    {
      "codings": [
        {
          "code": "X",
          "display": "Arbitrary string",
          "system": "Jr.",
          "user_selected": true,
          "version": "r4"
        }
      ],
      "extensions": [
        {
          "extension": null,
          "url": "https://morf.health/fhir/r4/extensions/formats",
          "value": "arbitrary value of any type (i.e. not necessarily a string)",
          "value_field_label": null
        }
      ],
      "text": "Arbitrary concept string value"
    }
  ],
  "reason_references": [
    {
      "display": "PatientX",
      "identifier": {
        "period": {
          "end": "2025-08-13T18:41:44.263+00:00",
          "start": "2025-08-13T17:41:44.263+00:00"
        },
        "system": "https://morf.health/fhir/r4/identifier_types/healthie",
        "use": "secondary",
        "value": "401421231"
      },
      "reference": {
        "type": "Patient",
        "value": "1234"
      },
      "type": "Patient"
    }
  ],
  "service_categories": [
    {
      "codings": [
        {
          "code": "X",
          "display": "Arbitrary string",
          "system": "Jr.",
          "user_selected": true,
          "version": "r4"
        }
      ],
      "extensions": [
        {
          "extension": null,
          "url": "https://morf.health/fhir/r4/extensions/formats",
          "value": "arbitrary value of any type (i.e. not necessarily a string)",
          "value_field_label": null
        }
      ],
      "text": "Arbitrary concept string value"
    }
  ],
  "service_types": [
    {
      "codings": [
        {
          "code": "X",
          "display": "Arbitrary string",
          "system": "Jr.",
          "user_selected": true,
          "version": "r4"
        }
      ],
      "extensions": [
        {
          "extension": null,
          "url": "https://morf.health/fhir/r4/extensions/formats",
          "value": "arbitrary value of any type (i.e. not necessarily a string)",
          "value_field_label": null
        }
      ],
      "text": "Arbitrary concept string value"
    }
  ],
  "slots": [
    {
      "display": "PatientX",
      "identifier": {
        "period": {
          "end": "2025-08-13T18:41:44.263+00:00",
          "start": "2025-08-13T17:41:44.263+00:00"
        },
        "system": "https://morf.health/fhir/r4/identifier_types/healthie",
        "use": "secondary",
        "value": "401421231"
      },
      "reference": {
        "type": "Patient",
        "value": "1234"
      },
      "type": "Patient"
    }
  ],
  "specialities": [
    {
      "codings": [
        {
          "code": "X",
          "display": "Arbitrary string",
          "system": "Jr.",
          "user_selected": true,
          "version": "r4"
        }
      ],
      "extensions": [
        {
          "extension": null,
          "url": "https://morf.health/fhir/r4/extensions/formats",
          "value": "arbitrary value of any type (i.e. not necessarily a string)",
          "value_field_label": null
        }
      ],
      "text": "Arbitrary concept string value"
    }
  ],
  "start": "2024-05-01T14:00:00+05:00",
  "status": null,
  "supporting_information_references": [
    {
      "display": "PatientX",
      "identifier": {
        "period": {
          "end": "2025-08-13T18:41:44.263+00:00",
          "start": "2025-08-13T17:41:44.263+00:00"
        },
        "system": "https://morf.health/fhir/r4/identifier_types/healthie",
        "use": "secondary",
        "value": "401421231"
      },
      "reference": {
        "type": "Patient",
        "value": "1234"
      },
      "type": "Patient"
    }
  ],
  "text": "Intake Appointment with Dr. Jenner"
}

{
  "appointment_type": {
    "codings": {
      "code": "Symbol in syntax defined by the system",
      "display": "Representation defined by the system",
      "system": "Identity of the terminology system",
      "user_selected": "Coding was chosen directly by the user",
      "version": "Version of the system - if relevant"
    },
    "extensions": {
      "extension": null,
      "url": "The URL giving the meaning of the extension",
      "value": {
        "bool_value": null,
        "list_value": {
          "values": null
        },
        "null_value": null,
        "number_value": null,
        "string_value": null,
        "struct_value": null
      },
      "value_field_label": null
    },
    "text": "Plain text representation of the concept"
  },
  "based_on_service_requests": {
    "display": "Text alternative for the resource",
    "identifier": {
      "period": {
        "end": "Optional end of the period - inclusive, missing denotes ongoing",
        "start": "The beginning of the period - inclusive"
      },
      "system": "The identifier's namespace",
      "use": "The identifier's usage",
      "value": "The identifier value"
    },
    "reference": {
      "type": "Reference ID type",
      "value": "Reference ID value"
    },
    "type": "Type the reference refers"
  },
  "comment": "Comment about the Appointment",
  "created_at": "Appointment created at timestamp",
  "description": "Appointment description",
  "end": "End time of the Appointment",
  "extensions": {
    "extension": null,
    "url": "The URL giving the meaning of the extension",
    "value": {
      "bool_value": null,
      "list_value": {
        "values": null
      },
      "null_value": null,
      "number_value": null,
      "string_value": null,
      "struct_value": null
    },
    "value_field_label": null
  },
  "id": "ID of the Appointment object",
  "identifiers": {
    "period": {
      "end": "Optional end of the period - inclusive, missing denotes ongoing",
      "start": "The beginning of the period - inclusive"
    },
    "system": "The identifier's namespace",
    "use": "The identifier's usage",
    "value": "The identifier value"
  },
  "length_minutes": "Length of the Appointment in minutes",
  "meta": {
    "extensions": {
      "extension": null,
      "url": "The URL giving the meaning of the extension",
      "value": {
        "bool_value": null,
        "list_value": {
          "values": null
        },
        "null_value": null,
        "number_value": null,
        "string_value": null,
        "struct_value": null
      },
      "value_field_label": null
    },
    "id": "ID of the Meta element",
    "last_updated": "Last updated timestamp for the corresponding Resource object",
    "profiles": "Profiles this Resource claims to conform to",
    "security_labels": {
      "code": "Symbol in syntax defined by the system",
      "display": "Representation defined by the system",
      "system": "Identity of the terminology system",
      "user_selected": "Coding was chosen directly by the user",
      "version": "Version of the system - if relevant"
    },
    "source": "The source of the corresponding Resource object",
    "tags": {
      "code": "Symbol in syntax defined by the system",
      "display": "Representation defined by the system",
      "system": "Identity of the terminology system",
      "user_selected": "Coding was chosen directly by the user",
      "version": "Version of the system - if relevant"
    },
    "version_id": "Version ID of the Meta element"
  },
  "participants": {
    "actor": {
      "display": "Text alternative for the resource",
      "identifier": {
        "period": {
          "end": "Optional end of the period - inclusive, missing denotes ongoing",
          "start": "The beginning of the period - inclusive"
        },
        "system": "The identifier's namespace",
        "use": "The identifier's usage",
        "value": "The identifier value"
      },
      "reference": {
        "type": "Reference ID type",
        "value": "Reference ID value"
      },
      "type": "Type the reference refers"
    },
    "extensions": {
      "extension": null,
      "url": "The URL giving the meaning of the extension",
      "value": {
        "bool_value": null,
        "list_value": {
          "values": null
        },
        "null_value": null,
        "number_value": null,
        "string_value": null,
        "struct_value": null
      },
      "value_field_label": null
    },
    "id": "ID of the Participant object",
    "modifier_extensions": {
      "extension": null,
      "url": "The URL giving the meaning of the extension",
      "value": {
        "bool_value": null,
        "list_value": {
          "values": null
        },
        "null_value": null,
        "number_value": null,
        "string_value": null,
        "struct_value": null
      },
      "value_field_label": null
    },
    "period": {
      "end": "Optional end of the period - inclusive, missing denotes ongoing",
      "start": "The beginning of the period - inclusive"
    },
    "required": "Participant's required status",
    "status": "The acceptance status of the Participant",
    "types": {
      "codings": {
        "code": "Symbol in syntax defined by the system",
        "display": "Representation defined by the system",
        "system": "Identity of the terminology system",
        "user_selected": "Coding was chosen directly by the user",
        "version": "Version of the system - if relevant"
      },
      "extensions": {
        "extension": null,
        "url": "The URL giving the meaning of the extension",
        "value": {
          "bool_value": null,
          "list_value": {
            "values": null
          },
          "null_value": null,
          "number_value": null,
          "string_value": null,
          "struct_value": null
        },
        "value_field_label": null
      },
      "text": "Plain text representation of the concept"
    }
  },
  "patient_id": "ID of the associated Patient participating in the appointment - parsed from the participants set",
  "patient_instruction": "Instructions for the Patient re: Appointment",
  "periods": {
    "end": "Optional end of the period - inclusive, missing denotes ongoing",
    "start": "The beginning of the period - inclusive"
  },
  "priority": "Used to make informed decisions if needing to re-prioritize",
  "reason_code": {
    "codings": {
      "code": "Symbol in syntax defined by the system",
      "display": "Representation defined by the system",
      "system": "Identity of the terminology system",
      "user_selected": "Coding was chosen directly by the user",
      "version": "Version of the system - if relevant"
    },
    "extensions": {
      "extension": null,
      "url": "The URL giving the meaning of the extension",
      "value": {
        "bool_value": null,
        "list_value": {
          "values": null
        },
        "null_value": null,
        "number_value": null,
        "string_value": null,
        "struct_value": null
      },
      "value_field_label": null
    },
    "text": "Plain text representation of the concept"
  },
  "reason_references": {
    "display": "Text alternative for the resource",
    "identifier": {
      "period": {
        "end": "Optional end of the period - inclusive, missing denotes ongoing",
        "start": "The beginning of the period - inclusive"
      },
      "system": "The identifier's namespace",
      "use": "The identifier's usage",
      "value": "The identifier value"
    },
    "reference": {
      "type": "Reference ID type",
      "value": "Reference ID value"
    },
    "type": "Type the reference refers"
  },
  "service_categories": {
    "codings": {
      "code": "Symbol in syntax defined by the system",
      "display": "Representation defined by the system",
      "system": "Identity of the terminology system",
      "user_selected": "Coding was chosen directly by the user",
      "version": "Version of the system - if relevant"
    },
    "extensions": {
      "extension": null,
      "url": "The URL giving the meaning of the extension",
      "value": {
        "bool_value": null,
        "list_value": {
          "values": null
        },
        "null_value": null,
        "number_value": null,
        "string_value": null,
        "struct_value": null
      },
      "value_field_label": null
    },
    "text": "Plain text representation of the concept"
  },
  "service_types": {
    "codings": {
      "code": "Symbol in syntax defined by the system",
      "display": "Representation defined by the system",
      "system": "Identity of the terminology system",
      "user_selected": "Coding was chosen directly by the user",
      "version": "Version of the system - if relevant"
    },
    "extensions": {
      "extension": null,
      "url": "The URL giving the meaning of the extension",
      "value": {
        "bool_value": null,
        "list_value": {
          "values": null
        },
        "null_value": null,
        "number_value": null,
        "string_value": null,
        "struct_value": null
      },
      "value_field_label": null
    },
    "text": "Plain text representation of the concept"
  },
  "slots": {
    "display": "Text alternative for the resource",
    "identifier": {
      "period": {
        "end": "Optional end of the period - inclusive, missing denotes ongoing",
        "start": "The beginning of the period - inclusive"
      },
      "system": "The identifier's namespace",
      "use": "The identifier's usage",
      "value": "The identifier value"
    },
    "reference": {
      "type": "Reference ID type",
      "value": "Reference ID value"
    },
    "type": "Type the reference refers"
  },
  "specialities": {
    "codings": {
      "code": "Symbol in syntax defined by the system",
      "display": "Representation defined by the system",
      "system": "Identity of the terminology system",
      "user_selected": "Coding was chosen directly by the user",
      "version": "Version of the system - if relevant"
    },
    "extensions": {
      "extension": null,
      "url": "The URL giving the meaning of the extension",
      "value": {
        "bool_value": null,
        "list_value": {
          "values": null
        },
        "null_value": null,
        "number_value": null,
        "string_value": null,
        "struct_value": null
      },
      "value_field_label": null
    },
    "text": "Plain text representation of the concept"
  },
  "start": "Start time of the Appointment",
  "status": "Appointment status",
  "supporting_information_references": {
    "display": "Text alternative for the resource",
    "identifier": {
      "period": {
        "end": "Optional end of the period - inclusive, missing denotes ongoing",
        "start": "The beginning of the period - inclusive"
      },
      "system": "The identifier's namespace",
      "use": "The identifier's usage",
      "value": "The identifier value"
    },
    "reference": {
      "type": "Reference ID type",
      "value": "Reference ID value"
    },
    "type": "Type the reference refers"
  },
  "text": "Text summary of the Appointment, for human interpretation"
}

​
Payload Field Details

​
Appointment
Event Payload