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