Events
Triggering Webhook Types
The following event types are associated with the Appointment event payload from Mod Med.Mod Med Appointment Created
{
"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
Event Payload
Hide fields
Hide fields
string
required
ID ID of the Appointment objectCEL
id
Example
"e5eb4711-75e7-46f1-b36e-6e869c02926d"
string
ID ID of the associated Patient participating in the appointment - parsed from the participants setCEL
patient_id
Example
"c98e27e4-18c2-4e01-bd86-eca13db78889"
string
HI ID PII Text summary of the Appointment, for human interpretationCEL
text
Example
"Intake Appointment with Dr. Jenner"
[]object
required
Additional content defined by implementations
CEL
extensions
Example
[
{
"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
}
]
[]string
required
HI PII Mapped array of: The URL giving the meaning of the extensionCEL
extensions.map(x, x.url)
Example
[
"https://morf.health/fhir/r4/extensions/formats"
]
[]string
required
Description coming soon
CEL
extensions.map(x, x.value_field_label)
Example
[
null
]
[]bool
required
HI PII Mapped array of: The extension’s valueCEL
extensions.map(x, x.value)
Example
[
"arbitrary value of any type (i.e. not necessarily a string)"
]
google.protobuf.NullValue
HI PII Mapped array of: The extension’s valueCEL
value.null_value
Example
[]bool
required
HI PII Mapped array of: Sub-extensions (recursive)CEL
extensions.map(x, x.extension)
Example
[
[
{
"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
}
]
]
[]object
required
Associated Identifiers for the Appointment
CEL
identifiers
Example
[
{
"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"
}
]
fhir.v4.codes.IdentifierUse
Mapped array of: The identifier’s usage
CEL
use
Example
fhir.v4.codes.IdentifierUse.IDENTIFIER_USE_USUAL
fhir.v4.codes.IdentifierUse.IDENTIFIER_USE_OFFICIAL
fhir.v4.codes.IdentifierUse.IDENTIFIER_USE_TEMP
fhir.v4.codes.IdentifierUse.IDENTIFIER_USE_SECONDARY
fhir.v4.codes.IdentifierUse.IDENTIFIER_USE_OLD
[]string
required
Mapped array of: The identifier’s namespace
CEL
identifiers.map(x, x.system)
Example
[
"https://morf.health/fhir/r4/identifier_types/healthie"
]
[]string
required
ID Mapped array of: The identifier valueCEL
identifiers.map(x, x.value)
Example
[
"401421231"
]
[]bool
required
Mapped array of: Time period the identifier was / is in use
CEL
identifiers.map(x, x.period)
Example
[
{
"end": "2025-08-13T18:41:44.263+00:00",
"start": "2025-08-13T17:41:44.263+00:00"
}
]
fhir.v4.codes.AppointmentStatusCode
required
Appointment status
CEL
status
Example
fhir.v4.codes.AppointmentStatusCode.APPOINTMENT_STATUS_CODE_PROPOSED
fhir.v4.codes.AppointmentStatusCode.APPOINTMENT_STATUS_CODE_PENDING
fhir.v4.codes.AppointmentStatusCode.APPOINTMENT_STATUS_CODE_BOOKED
fhir.v4.codes.AppointmentStatusCode.APPOINTMENT_STATUS_CODE_ARRIVED
fhir.v4.codes.AppointmentStatusCode.APPOINTMENT_STATUS_CODE_FULFILLED
fhir.v4.codes.AppointmentStatusCode.APPOINTMENT_STATUS_CODE_CANCELLED
fhir.v4.codes.AppointmentStatusCode.APPOINTMENT_STATUS_CODE_NOSHOW
fhir.v4.codes.AppointmentStatusCode.APPOINTMENT_STATUS_CODE_ENTERED_IN_ERROR
fhir.v4.codes.AppointmentStatusCode.APPOINTMENT_STATUS_CODE_CHECKED_IN
fhir.v4.codes.AppointmentStatusCode.APPOINTMENT_STATUS_CODE_WAITLIST
[]object
required
A broad categorization of the service that is to be performed during this appointment
CEL
service_categories
Example
[
{
"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"
}
]
[]bool
required
Mapped array of: Additional content defined by implementations
CEL
service_categories.map(x, x.extensions)
Example
[
[
{
"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
}
]
]
google.protobuf.NullValue
Mapped array of: Additional content defined by implementations
CEL
value.null_value
Example
[]bool
required
Mapped array of: Codings defined by terminology system(s)
CEL
service_categories.map(x, x.codings)
Example
[
[
{
"code": "X",
"display": "Arbitrary string",
"system": "Jr.",
"user_selected": true,
"version": "r4"
}
]
]
[]string
required
HI PII Mapped array of: Plain text representation of the conceptCEL
service_categories.map(x, x.text)
Example
[
"Arbitrary concept string value"
]
[]object
required
The specific service(s) that is/are to be performed during this appointment
CEL
service_types
Example
[
{
"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"
}
]
[]bool
required
Mapped array of: Additional content defined by implementations
CEL
service_types.map(x, x.extensions)
Example
[
[
{
"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
}
]
]
google.protobuf.NullValue
Mapped array of: Additional content defined by implementations
CEL
value.null_value
Example
[]bool
required
Mapped array of: Codings defined by terminology system(s)
CEL
service_types.map(x, x.codings)
Example
[
[
{
"code": "X",
"display": "Arbitrary string",
"system": "Jr.",
"user_selected": true,
"version": "r4"
}
]
]
[]string
required
HI PII Mapped array of: Plain text representation of the conceptCEL
service_types.map(x, x.text)
Example
[
"Arbitrary concept string value"
]
[]object
required
The specialty of a practitioner that would be required to perform the service requested in this appointment
CEL
specialities
Example
[
{
"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"
}
]
[]bool
required
Mapped array of: Additional content defined by implementations
CEL
specialities.map(x, x.extensions)
Example
[
[
{
"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
}
]
]
google.protobuf.NullValue
Mapped array of: Additional content defined by implementations
CEL
value.null_value
Example
[]bool
required
Mapped array of: Codings defined by terminology system(s)
CEL
specialities.map(x, x.codings)
Example
[
[
{
"code": "X",
"display": "Arbitrary string",
"system": "Jr.",
"user_selected": true,
"version": "r4"
}
]
]
[]string
required
HI PII Mapped array of: Plain text representation of the conceptCEL
specialities.map(x, x.text)
Example
[
"Arbitrary concept string value"
]
object
Appointment Type
CEL
appointment_type
Example
{
"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"
}
[]object
Additional content defined by implementations
CEL
appointment_type.extensions
Example
[
{
"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
}
]
[]string
required
HI PII Mapped array of: The URL giving the meaning of the extensionCEL
appointment_type.extensions.map(x, x.url)
Example
[
"https://morf.health/fhir/r4/extensions/formats"
]
[]string
required
Description coming soon
CEL
appointment_type.extensions.map(x, x.value_field_label)
Example
[
null
]
[]bool
required
HI PII Mapped array of: The extension’s valueCEL
appointment_type.extensions.map(x, x.value)
Example
[
"arbitrary value of any type (i.e. not necessarily a string)"
]
google.protobuf.NullValue
HI PII Mapped array of: The extension’s valueCEL
value.null_value
Example
[]bool
required
HI PII Mapped array of: Sub-extensions (recursive)CEL
appointment_type.extensions.map(x, x.extension)
Example
[
[
{
"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
}
]
]
[]object
Codings defined by terminology system(s)
CEL
appointment_type.codings
Example
[
{
"code": "X",
"display": "Arbitrary string",
"system": "Jr.",
"user_selected": true,
"version": "r4"
}
]
[]string
required
HI Mapped array of: Identity of the terminology systemCEL
appointment_type.codings.map(x, x.system)
Example
[
"Jr."
]
[]string
required
Mapped array of: Version of the system - if relevant
CEL
appointment_type.codings.map(x, x.version)
Example
[
"r4"
]
[]string
required
HI PII Mapped array of: Symbol in syntax defined by the systemCEL
appointment_type.codings.map(x, x.code)
Example
[
"X"
]
[]string
required
HI PII Mapped array of: Representation defined by the systemCEL
appointment_type.codings.map(x, x.display)
Example
[
"Arbitrary string"
]
[]bool
required
Mapped array of: Coding was chosen directly by the user
CEL
appointment_type.codings.map(x, x.user_selected)
Example
[
true
]
string
HI PII Plain text representation of the conceptCEL
appointment_type.text
Example
"Arbitrary concept string value"
[]object
required
Coded reason this appointment is scheduled
CEL
reason_code
Example
[
{
"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"
}
]
[]bool
required
Mapped array of: Additional content defined by implementations
CEL
reason_code.map(x, x.extensions)
Example
[
[
{
"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
}
]
]
google.protobuf.NullValue
Mapped array of: Additional content defined by implementations
CEL
value.null_value
Example
[]bool
required
Mapped array of: Codings defined by terminology system(s)
CEL
reason_code.map(x, x.codings)
Example
[
[
{
"code": "X",
"display": "Arbitrary string",
"system": "Jr.",
"user_selected": true,
"version": "r4"
}
]
]
[]string
required
HI PII Mapped array of: Plain text representation of the conceptCEL
reason_code.map(x, x.text)
Example
[
"Arbitrary concept string value"
]
uint64
Used to make informed decisions if needing to re-prioritize
CEL
priority
Example
1
string
HI PII Appointment descriptionCEL
description
Example
"Intake Appointment"
timing.v1.Timestamp
Start time of the Appointment
CEL
start
Example
"2024-05-01T14:00:00+05:00"
timing.v1.Timestamp
End time of the Appointment
CEL
end
Example
"2024-05-01T14:30:00+05:00"
uint64
Length of the Appointment in minutes
CEL
length_minutes
Example
30
timing.v1.Timestamp
Appointment created at timestamp
CEL
created_at
Example
"2024-04-30T13:12:09+00:00"
string
Comment about the Appointment
CEL
comment
Example
"Intake forms are complete for patient."
string
Instructions for the Patient re: Appointment
CEL
patient_instruction
Example
"Please bring your insurance ID card and your medications and arrive 10 minutes early. Thank you."
[]object
required
Participants (invitees) to the Appointment
CEL
participants
Example
[
{
"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"
}
]
}
]
[]string
required
ID Mapped array of: ID of the Participant objectCEL
participants.map(x, x.id)
Example
[
"e5eb4711-75e7-46f1-b36e-6e869c02926d"
]
[]bool
required
Mapped array of: Additional content defined by implementations
CEL
participants.map(x, x.extensions)
Example
[
[
{
"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
}
]
]
google.protobuf.NullValue
Mapped array of: Additional content defined by implementations
CEL
value.null_value
Example
[]bool
required
Mapped array of: Unignorable additional content defined by implementations
CEL
participants.map(x, x.modifier_extensions)
Example
[
[
{
"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
}
]
]
google.protobuf.NullValue
Mapped array of: Unignorable additional content defined by implementations
CEL
value.null_value
Example
[]bool
required
Mapped array of: Participant types
CEL
participants.map(x, x.types)
Example
[
[
{
"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"
}
]
]
google.protobuf.NullValue
Mapped array of: Participant types
CEL
value.null_value
Example
fhir.v4.codes.ParticipantRequiredCode
Mapped array of: Participant’s required status
CEL
required
Example
fhir.v4.codes.ParticipantRequiredCode.PARTICIPANT_REQUIRED_CODE_REQUIRED
fhir.v4.codes.ParticipantRequiredCode.PARTICIPANT_REQUIRED_CODE_OPTIONAL
fhir.v4.codes.ParticipantRequiredCode.PARTICIPANT_REQUIRED_CODE_INFORMATION_ONLY
fhir.v4.codes.ParticipantStatusCode
Mapped array of: The acceptance status of the Participant
CEL
status
Example
fhir.v4.codes.ParticipantStatusCode.PARTICIPANT_STATUS_CODE_ACCEPTED
fhir.v4.codes.ParticipantStatusCode.PARTICIPANT_STATUS_CODE_DECLINED
fhir.v4.codes.ParticipantStatusCode.PARTICIPANT_STATUS_CODE_TENTATIVE
fhir.v4.codes.ParticipantStatusCode.PARTICIPANT_STATUS_CODE_NEEDS_ACTION
[]bool
required
Mapped array of: The period of time of the Appointment the Participant is participating
CEL
participants.map(x, x.period)
Example
[
{
"end": "2025-08-13T18:41:44.263+00:00",
"start": "2025-08-13T17:41:44.263+00:00"
}
]
[]bool
required
Mapped array of: Person, location, healthcare service or device reference
CEL
participants.map(x, x.actor)
Example
[
{
"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"
}
]
fhir.v4.codes.IdentifierUse
Mapped array of: Person, location, healthcare service or device reference
CEL
actor.identifier.use
Example
fhir.v4.codes.IdentifierUse.IDENTIFIER_USE_USUAL
fhir.v4.codes.IdentifierUse.IDENTIFIER_USE_OFFICIAL
fhir.v4.codes.IdentifierUse.IDENTIFIER_USE_TEMP
fhir.v4.codes.IdentifierUse.IDENTIFIER_USE_SECONDARY
fhir.v4.codes.IdentifierUse.IDENTIFIER_USE_OLD
[]object
required
Potential date/time interval(s) requested to allocate the appointment within
CEL
periods
Example
[
{
"end": "2025-08-13T18:41:44.263+00:00",
"start": "2025-08-13T17:41:44.263+00:00"
}
]
[]timing.v1.Timestamp
required
Mapped array of: The beginning of the period - inclusive
CEL
periods.map(x, x.start)
Example
[
"2025-08-13T17:41:44.263+00:00"
]
[]timing.v1.Timestamp
required
Mapped array of: Optional end of the period - inclusive, missing denotes ongoing
CEL
periods.map(x, x.end)
Example
[
"2025-08-13T18:41:44.263+00:00"
]
object
Metadata about the Appointment record
CEL
meta
Example
{
"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"
}
string
ID of the Meta element
CEL
meta.id
Example
"20002"
[]object
Additional content defined by implementations
CEL
meta.extensions
Example
[
{
"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
}
]
[]string
required
HI PII Mapped array of: The URL giving the meaning of the extensionCEL
meta.extensions.map(x, x.url)
Example
[
"https://morf.health/fhir/r4/extensions/formats"
]
[]string
required
Description coming soon
CEL
meta.extensions.map(x, x.value_field_label)
Example
[
null
]
[]bool
required
HI PII Mapped array of: The extension’s valueCEL
meta.extensions.map(x, x.value)
Example
[
"arbitrary value of any type (i.e. not necessarily a string)"
]
google.protobuf.NullValue
HI PII Mapped array of: The extension’s valueCEL
value.null_value
Example
[]bool
required
HI PII Mapped array of: Sub-extensions (recursive)CEL
meta.extensions.map(x, x.extension)
Example
[
[
{
"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
}
]
]
string
Version ID of the Meta element
CEL
meta.version_id
Example
"1"
timing.v1.Timestamp
Last updated timestamp for the corresponding Resource object
CEL
meta.last_updated
Example
"2025-02-11T17:17:41.101+00:00"
string
The source of the corresponding Resource object
CEL
meta.source
Example
"1"
[]string
Profiles this Resource claims to conform to
CEL
meta.profiles
Example
"Profile 1"
[]object
Security Labels applied to this resource
CEL
meta.security_labels
Example
[
{
"code": "X",
"display": "Arbitrary string",
"system": "Jr.",
"user_selected": true,
"version": "r4"
}
]
[]string
required
HI Mapped array of: Identity of the terminology systemCEL
meta.security_labels.map(x, x.system)
Example
[
"Jr."
]
[]string
required
Mapped array of: Version of the system - if relevant
CEL
meta.security_labels.map(x, x.version)
Example
[
"r4"
]
[]string
required
HI PII Mapped array of: Symbol in syntax defined by the systemCEL
meta.security_labels.map(x, x.code)
Example
[
"X"
]
[]string
required
HI PII Mapped array of: Representation defined by the systemCEL
meta.security_labels.map(x, x.display)
Example
[
"Arbitrary string"
]
[]bool
required
Mapped array of: Coding was chosen directly by the user
CEL
meta.security_labels.map(x, x.user_selected)
Example
[
true
]
[]object
Tags applied to this resource
CEL
meta.tags
Example
[
{
"code": "X",
"display": "Arbitrary string",
"system": "Jr.",
"user_selected": true,
"version": "r4"
}
]
[]string
required
HI Mapped array of: Identity of the terminology systemCEL
meta.tags.map(x, x.system)
Example
[
"Jr."
]
[]string
required
Mapped array of: Version of the system - if relevant
CEL
meta.tags.map(x, x.version)
Example
[
"r4"
]
[]string
required
HI PII Mapped array of: Symbol in syntax defined by the systemCEL
meta.tags.map(x, x.code)
Example
[
"X"
]
[]string
required
HI PII Mapped array of: Representation defined by the systemCEL
meta.tags.map(x, x.display)
Example
[
"Arbitrary string"
]
[]bool
required
Mapped array of: Coding was chosen directly by the user
CEL
meta.tags.map(x, x.user_selected)
Example
[
true
]
[]object
required
Additional information to support the Appointment
CEL
supporting_information_references
Example
[
{
"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"
}
]
[]bool
required
Mapped array of: Literal reference, relative, internal or absolute URL
CEL
supporting_information_references.map(x, x.reference)
Example
[
{
"type": "Patient",
"value": "1234"
}
]
[]string
required
Mapped array of: Type the reference refers
CEL
supporting_information_references.map(x, x.type)
Example
[
"Patient"
]
[]bool
required
Mapped array of: Logical reference when literal reference is not known
CEL
supporting_information_references.map(x, x.identifier)
Example
[
{
"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"
}
]
fhir.v4.codes.IdentifierUse
Mapped array of: Logical reference when literal reference is not known
CEL
identifier.use
Example
fhir.v4.codes.IdentifierUse.IDENTIFIER_USE_USUAL
fhir.v4.codes.IdentifierUse.IDENTIFIER_USE_OFFICIAL
fhir.v4.codes.IdentifierUse.IDENTIFIER_USE_TEMP
fhir.v4.codes.IdentifierUse.IDENTIFIER_USE_SECONDARY
fhir.v4.codes.IdentifierUse.IDENTIFIER_USE_OLD
[]string
required
Mapped array of: Text alternative for the resource
CEL
supporting_information_references.map(x, x.display)
Example
[
"PatientX"
]
[]object
required
Reasons the Appointment is to take place
CEL
reason_references
Example
[
{
"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"
}
]
[]bool
required
Mapped array of: Literal reference, relative, internal or absolute URL
CEL
reason_references.map(x, x.reference)
Example
[
{
"type": "Patient",
"value": "1234"
}
]
[]string
required
Mapped array of: Type the reference refers
CEL
reason_references.map(x, x.type)
Example
[
"Patient"
]
[]bool
required
Mapped array of: Logical reference when literal reference is not known
CEL
reason_references.map(x, x.identifier)
Example
[
{
"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"
}
]
fhir.v4.codes.IdentifierUse
Mapped array of: Logical reference when literal reference is not known
CEL
identifier.use
Example
fhir.v4.codes.IdentifierUse.IDENTIFIER_USE_USUAL
fhir.v4.codes.IdentifierUse.IDENTIFIER_USE_OFFICIAL
fhir.v4.codes.IdentifierUse.IDENTIFIER_USE_TEMP
fhir.v4.codes.IdentifierUse.IDENTIFIER_USE_SECONDARY
fhir.v4.codes.IdentifierUse.IDENTIFIER_USE_OLD
[]string
required
Mapped array of: Text alternative for the resource
CEL
reason_references.map(x, x.display)
Example
[
"PatientX"
]
[]object
required
The slots that this Appointment is filling
CEL
slots
Example
[
{
"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"
}
]
[]bool
required
Mapped array of: Literal reference, relative, internal or absolute URL
CEL
slots.map(x, x.reference)
Example
[
{
"type": "Patient",
"value": "1234"
}
]
[]string
required
Mapped array of: Type the reference refers
CEL
slots.map(x, x.type)
Example
[
"Patient"
]
[]bool
required
Mapped array of: Logical reference when literal reference is not known
CEL
slots.map(x, x.identifier)
Example
[
{
"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"
}
]
fhir.v4.codes.IdentifierUse
Mapped array of: Logical reference when literal reference is not known
CEL
identifier.use
Example
fhir.v4.codes.IdentifierUse.IDENTIFIER_USE_USUAL
fhir.v4.codes.IdentifierUse.IDENTIFIER_USE_OFFICIAL
fhir.v4.codes.IdentifierUse.IDENTIFIER_USE_TEMP
fhir.v4.codes.IdentifierUse.IDENTIFIER_USE_SECONDARY
fhir.v4.codes.IdentifierUse.IDENTIFIER_USE_OLD
[]string
required
Mapped array of: Text alternative for the resource
CEL
slots.map(x, x.display)
Example
[
"PatientX"
]
[]object
required
The service requests this Appointment is allocated to assess
CEL
based_on_service_requests
Example
[
{
"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"
}
]
[]bool
required
Mapped array of: Literal reference, relative, internal or absolute URL
CEL
based_on_service_requests.map(x, x.reference)
Example
[
{
"type": "Patient",
"value": "1234"
}
]
[]string
required
Mapped array of: Type the reference refers
CEL
based_on_service_requests.map(x, x.type)
Example
[
"Patient"
]
[]bool
required
Mapped array of: Logical reference when literal reference is not known
CEL
based_on_service_requests.map(x, x.identifier)
Example
[
{
"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"
}
]
fhir.v4.codes.IdentifierUse
Mapped array of: Logical reference when literal reference is not known
CEL
identifier.use
Example
fhir.v4.codes.IdentifierUse.IDENTIFIER_USE_USUAL
fhir.v4.codes.IdentifierUse.IDENTIFIER_USE_OFFICIAL
fhir.v4.codes.IdentifierUse.IDENTIFIER_USE_TEMP
fhir.v4.codes.IdentifierUse.IDENTIFIER_USE_SECONDARY
fhir.v4.codes.IdentifierUse.IDENTIFIER_USE_OLD
[]string
required
Mapped array of: Text alternative for the resource
CEL
based_on_service_requests.map(x, x.display)
Example
[
"PatientX"
]