> ## 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.

# Get Appointment

> Documentation for the Get Appointment action for Mod Med

![images/mod\_med.svg](https://mintlify.s3.us-west-1.amazonaws.com/morfhealth/images/mod_med.svg)

# Parameters

**Action** `Parameters`

**parameters**

**Appointment ID** `string` *required*

This field maps to the destination API `id` field.

```json Result Object Example theme={null}
{
  "$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"
  }
}
```

```json Result Object Description theme={null}
{
  "$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 an object name, which nests the action's result data inside the downstream data context in the workflow. See [Passing Data Between Actions](https://docs.morf.health/docs/knowledge_base/passing_data_between_actions.md) for how to set it and reference the result from downstream nodes.

Here we demonstrate how to refer to this data using the prefix `$result_object_key`.

**Appointment** `Fetch Action Response Object`

**fields**

**id** `string` *required*

`ID` ID of the Appointment object

```json CEL theme={null}
$result_object_key.id
```

```json Example theme={null}
"e5eb4711-75e7-46f1-b36e-6e869c02926d"
```

**patient\_id** `string`

`ID` ID of the associated Patient participating in the appointment - parsed from the participants set

```json CEL theme={null}
$result_object_key.patient_id
```

```json Example theme={null}
"c98e27e4-18c2-4e01-bd86-eca13db78889"
```

**text** `string`

`HI` `ID` `PII` Text summary of the Appointment, for human interpretation

```json CEL theme={null}
$result_object_key.text
```

```json Example theme={null}
"Intake Appointment with Dr. Jenner"
```

**extensions** `[]object` *required*

Additional content defined by implementations

```json CEL theme={null}
$result_object_key.extensions
```

```json Example theme={null}
[
{
"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
}
]
```

**extensions.map(x, x.url)** `[]string` *required*

`HI` `PII` Mapped array of: The URL giving the meaning of the extension

```json CEL theme={null}
$result_object_key.extensions.map(x, x.url)
```

```json Example theme={null}
[
"https://morf.health/fhir/r4/extensions/formats"
]
```

**extensions.map(x, x.value\_field\_label)** `[]string` *required*

*Description coming soon*

```json CEL theme={null}
$result_object_key.extensions.map(x, x.value_field_label)
```

```json Example theme={null}
[
null
]
```

**extensions.map(x, x.value)** `[]bool` *required*

`HI` `PII` Mapped array of: The extension's value

```json CEL theme={null}
$result_object_key.extensions.map(x, x.value)
```

```json Example theme={null}
[
"arbitrary value of any type (i.e. not necessarily a string)"
]
```

**value.null\_value** `google.protobuf.NullValue`

`HI` `PII` Mapped array of: The extension's value

```json CEL theme={null}
value.null_value
```

**extensions.map(x, x.extension)** `[]bool` *required*

`HI` `PII` Mapped array of: Sub-extensions (recursive)

```json CEL theme={null}
$result_object_key.extensions.map(x, x.extension)
```

```json Example theme={null}
[
[
{
"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
}
]
]
```

**identifiers** `[]object` *required*

Associated Identifiers for the Appointment

```json CEL theme={null}
$result_object_key.identifiers
```

```json Example theme={null}
[
{
"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"
}
]
```

**use** `fhir.v4.codes.IdentifierUse`

Mapped array of: The identifier's usage

```json CEL theme={null}
use
```

```json Example theme={null}
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
```

**identifiers.map(x, x.system)** `[]string` *required*

Mapped array of: The identifier's namespace

```json CEL theme={null}
$result_object_key.identifiers.map(x, x.system)
```

```json Example theme={null}
[
"https://morf.health/fhir/r4/identifier_types/healthie"
]
```

**identifiers.map(x, x.value)** `[]string` *required*

`ID` Mapped array of: The identifier value

```json CEL theme={null}
$result_object_key.identifiers.map(x, x.value)
```

```json Example theme={null}
[
"401421231"
]
```

**identifiers.map(x, x.period)** `[]bool` *required*

Mapped array of: Time period the identifier was / is in use

```json CEL theme={null}
$result_object_key.identifiers.map(x, x.period)
```

```json Example theme={null}
[
{
"end": "2025-08-13T18:41:44.263+00:00",
"start": "2025-08-13T17:41:44.263+00:00"
}
]
```

**status** `fhir.v4.codes.AppointmentStatusCode` *required*

Appointment status

```json CEL theme={null}
$result_object_key.status
```

```json Example theme={null}
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
```

**service\_categories** `[]object` *required*

A broad categorization of the service that is to be performed during this appointment

```json CEL theme={null}
$result_object_key.service_categories
```

```json Example theme={null}
[
{
"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\_categories.map(x, x.extensions)** `[]bool` *required*

Mapped array of: Additional content defined by implementations

```json CEL theme={null}
$result_object_key.service_categories.map(x, x.extensions)
```

```json Example theme={null}
[
[
{
"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
}
]
]
```

**value.null\_value** `google.protobuf.NullValue`

Mapped array of: Additional content defined by implementations

```json CEL theme={null}
value.null_value
```

**service\_categories.map(x, x.codings)** `[]bool` *required*

Mapped array of: Codings defined by terminology system(s)

```json CEL theme={null}
$result_object_key.service_categories.map(x, x.codings)
```

```json Example theme={null}
[
[
{
"code": "X",
"display": "Arbitrary string",
"system": "Jr.",
"user_selected": true,
"version": "r4"
}
]
]
```

**service\_categories.map(x, x.text)** `[]string` *required*

`HI` `PII` Mapped array of: Plain text representation of the concept

```json CEL theme={null}
$result_object_key.service_categories.map(x, x.text)
```

```json Example theme={null}
[
"Arbitrary concept string value"
]
```

**service\_types** `[]object` *required*

The specific service(s) that is/are to be performed during this appointment

```json CEL theme={null}
$result_object_key.service_types
```

```json Example theme={null}
[
{
"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.map(x, x.extensions)** `[]bool` *required*

Mapped array of: Additional content defined by implementations

```json CEL theme={null}
$result_object_key.service_types.map(x, x.extensions)
```

```json Example theme={null}
[
[
{
"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
}
]
]
```

**value.null\_value** `google.protobuf.NullValue`

Mapped array of: Additional content defined by implementations

```json CEL theme={null}
value.null_value
```

**service\_types.map(x, x.codings)** `[]bool` *required*

Mapped array of: Codings defined by terminology system(s)

```json CEL theme={null}
$result_object_key.service_types.map(x, x.codings)
```

```json Example theme={null}
[
[
{
"code": "X",
"display": "Arbitrary string",
"system": "Jr.",
"user_selected": true,
"version": "r4"
}
]
]
```

**service\_types.map(x, x.text)** `[]string` *required*

`HI` `PII` Mapped array of: Plain text representation of the concept

```json CEL theme={null}
$result_object_key.service_types.map(x, x.text)
```

```json Example theme={null}
[
"Arbitrary concept string value"
]
```

**specialities** `[]object` *required*

The specialty of a practitioner that would be required to perform the service requested in this appointment

```json CEL theme={null}
$result_object_key.specialities
```

```json Example theme={null}
[
{
"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"
}
]
```

**specialities.map(x, x.extensions)** `[]bool` *required*

Mapped array of: Additional content defined by implementations

```json CEL theme={null}
$result_object_key.specialities.map(x, x.extensions)
```

```json Example theme={null}
[
[
{
"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
}
]
]
```

**value.null\_value** `google.protobuf.NullValue`

Mapped array of: Additional content defined by implementations

```json CEL theme={null}
value.null_value
```

**specialities.map(x, x.codings)** `[]bool` *required*

Mapped array of: Codings defined by terminology system(s)

```json CEL theme={null}
$result_object_key.specialities.map(x, x.codings)
```

```json Example theme={null}
[
[
{
"code": "X",
"display": "Arbitrary string",
"system": "Jr.",
"user_selected": true,
"version": "r4"
}
]
]
```

**specialities.map(x, x.text)** `[]string` *required*

`HI` `PII` Mapped array of: Plain text representation of the concept

```json CEL theme={null}
$result_object_key.specialities.map(x, x.text)
```

```json Example theme={null}
[
"Arbitrary concept string value"
]
```

**appointment\_type** `object`

Appointment Type

```json CEL theme={null}
$result_object_key.appointment_type
```

```json Example theme={null}
{
"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"
}
```

**appointment\_type.extensions** `[]object`

Additional content defined by implementations

```json CEL theme={null}
$result_object_key.appointment_type.extensions
```

```json Example theme={null}
[
{
"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
}
]
```

**appointment\_type.extensions.map(x, x.url)** `[]string` *required*

`HI` `PII` Mapped array of: The URL giving the meaning of the extension

```json CEL theme={null}
$result_object_key.appointment_type.extensions.map(x, x.url)
```

```json Example theme={null}
[
"https://morf.health/fhir/r4/extensions/formats"
]
```

**appointment\_type.extensions.map(x, x.value\_field\_label)** `[]string` *required*

*Description coming soon*

```json CEL theme={null}
$result_object_key.appointment_type.extensions.map(x, x.value_field_label)
```

```json Example theme={null}
[
null
]
```

**appointment\_type.extensions.map(x, x.value)** `[]bool` *required*

`HI` `PII` Mapped array of: The extension's value

```json CEL theme={null}
$result_object_key.appointment_type.extensions.map(x, x.value)
```

```json Example theme={null}
[
"arbitrary value of any type (i.e. not necessarily a string)"
]
```

**value.null\_value** `google.protobuf.NullValue`

`HI` `PII` Mapped array of: The extension's value

```json CEL theme={null}
value.null_value
```

**appointment\_type.extensions.map(x, x.extension)** `[]bool` *required*

`HI` `PII` Mapped array of: Sub-extensions (recursive)

```json CEL theme={null}
$result_object_key.appointment_type.extensions.map(x, x.extension)
```

```json Example theme={null}
[
[
{
"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
}
]
]
```

**appointment\_type.codings** `[]object`

Codings defined by terminology system(s)

```json CEL theme={null}
$result_object_key.appointment_type.codings
```

```json Example theme={null}
[
{
"code": "X",
"display": "Arbitrary string",
"system": "Jr.",
"user_selected": true,
"version": "r4"
}
]
```

**appointment\_type.codings.map(x, x.system)** `[]string` *required*

`HI` Mapped array of: Identity of the terminology system

```json CEL theme={null}
$result_object_key.appointment_type.codings.map(x, x.system)
```

```json Example theme={null}
[
"Jr."
]
```

**appointment\_type.codings.map(x, x.version)** `[]string` *required*

Mapped array of: Version of the system - if relevant

```json CEL theme={null}
$result_object_key.appointment_type.codings.map(x, x.version)
```

```json Example theme={null}
[
"r4"
]
```

**appointment\_type.codings.map(x, x.code)** `[]string` *required*

`HI` `PII` Mapped array of: Symbol in syntax defined by the system

```json CEL theme={null}
$result_object_key.appointment_type.codings.map(x, x.code)
```

```json Example theme={null}
[
"X"
]
```

**appointment\_type.codings.map(x, x.display)** `[]string` *required*

`HI` `PII` Mapped array of: Representation defined by the system

```json CEL theme={null}
$result_object_key.appointment_type.codings.map(x, x.display)
```

```json Example theme={null}
[
"Arbitrary string"
]
```

**appointment\_type.codings.map(x, x.user\_selected)** `[]bool` *required*

Mapped array of: Coding was chosen directly by the user

```json CEL theme={null}
$result_object_key.appointment_type.codings.map(x, x.user_selected)
```

```json Example theme={null}
[
true
]
```

**appointment\_type.text** `string`

`HI` `PII` Plain text representation of the concept

```json CEL theme={null}
$result_object_key.appointment_type.text
```

```json Example theme={null}
"Arbitrary concept string value"
```

**reason\_code** `[]object` *required*

Coded reason this appointment is scheduled

```json CEL theme={null}
$result_object_key.reason_code
```

```json Example theme={null}
[
{
"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\_code.map(x, x.extensions)** `[]bool` *required*

Mapped array of: Additional content defined by implementations

```json CEL theme={null}
$result_object_key.reason_code.map(x, x.extensions)
```

```json Example theme={null}
[
[
{
"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
}
]
]
```

**value.null\_value** `google.protobuf.NullValue`

Mapped array of: Additional content defined by implementations

```json CEL theme={null}
value.null_value
```

**reason\_code.map(x, x.codings)** `[]bool` *required*

Mapped array of: Codings defined by terminology system(s)

```json CEL theme={null}
$result_object_key.reason_code.map(x, x.codings)
```

```json Example theme={null}
[
[
{
"code": "X",
"display": "Arbitrary string",
"system": "Jr.",
"user_selected": true,
"version": "r4"
}
]
]
```

**reason\_code.map(x, x.text)** `[]string` *required*

`HI` `PII` Mapped array of: Plain text representation of the concept

```json CEL theme={null}
$result_object_key.reason_code.map(x, x.text)
```

```json Example theme={null}
[
"Arbitrary concept string value"
]
```

**priority** `uint64`

Used to make informed decisions if needing to re-prioritize

```json CEL theme={null}
$result_object_key.priority
```

```json Example theme={null}
1
```

**description** `string`

`HI` `PII` Appointment description

```json CEL theme={null}
$result_object_key.description
```

```json Example theme={null}
"Intake Appointment"
```

**start** `timing.v1.Timestamp`

Start time of the Appointment

```json CEL theme={null}
$result_object_key.start
```

```json Example theme={null}
"2024-05-01T14:00:00+05:00"
```

**end** `timing.v1.Timestamp`

End time of the Appointment

```json CEL theme={null}
$result_object_key.end
```

```json Example theme={null}
"2024-05-01T14:30:00+05:00"
```

**length\_minutes** `uint64`

Length of the Appointment in minutes

```json CEL theme={null}
$result_object_key.length_minutes
```

```json Example theme={null}
30
```

**created\_at** `timing.v1.Timestamp`

Appointment created at timestamp

```json CEL theme={null}
$result_object_key.created_at
```

```json Example theme={null}
"2024-04-30T13:12:09+00:00"
```

**comment** `string`

Comment about the Appointment

```json CEL theme={null}
$result_object_key.comment
```

```json Example theme={null}
"Intake forms are complete for patient."
```

**patient\_instruction** `string`

Instructions for the Patient re: Appointment

```json CEL theme={null}
$result_object_key.patient_instruction
```

```json Example theme={null}
"Please bring your insurance ID card and your medications and arrive 10 minutes early. Thank you."
```

**participants** `[]object` *required*

Participants (invitees) to the Appointment

```json CEL theme={null}
$result_object_key.participants
```

```json Example theme={null}
[
{
"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"
}
]
}
]
```

**participants.map(x, x.id)** `[]string` *required*

`ID` Mapped array of: ID of the Participant object

```json CEL theme={null}
$result_object_key.participants.map(x, x.id)
```

```json Example theme={null}
[
"e5eb4711-75e7-46f1-b36e-6e869c02926d"
]
```

**participants.map(x, x.extensions)** `[]bool` *required*

Mapped array of: Additional content defined by implementations

```json CEL theme={null}
$result_object_key.participants.map(x, x.extensions)
```

```json Example theme={null}
[
[
{
"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
}
]
]
```

**value.null\_value** `google.protobuf.NullValue`

Mapped array of: Additional content defined by implementations

```json CEL theme={null}
value.null_value
```

**participants.map(x, x.modifier\_extensions)** `[]bool` *required*

Mapped array of: Unignorable additional content defined by implementations

```json CEL theme={null}
$result_object_key.participants.map(x, x.modifier_extensions)
```

```json Example theme={null}
[
[
{
"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
}
]
]
```

**value.null\_value** `google.protobuf.NullValue`

Mapped array of: Unignorable additional content defined by implementations

```json CEL theme={null}
value.null_value
```

**participants.map(x, x.types)** `[]bool` *required*

Mapped array of: Participant types

```json CEL theme={null}
$result_object_key.participants.map(x, x.types)
```

```json Example theme={null}
[
[
{
"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"
}
]
]
```

**value.null\_value** `google.protobuf.NullValue`

Mapped array of: Participant types

```json CEL theme={null}
value.null_value
```

**required** `fhir.v4.codes.ParticipantRequiredCode`

Mapped array of: Participant's required status

```json CEL theme={null}
required
```

```json Example theme={null}
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
```

**status** `fhir.v4.codes.ParticipantStatusCode`

Mapped array of: The acceptance status of the Participant

```json CEL theme={null}
status
```

```json Example theme={null}
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
```

**participants.map(x, x.period)** `[]bool` *required*

Mapped array of: The period of time of the Appointment the Participant is participating

```json CEL theme={null}
$result_object_key.participants.map(x, x.period)
```

```json Example theme={null}
[
{
"end": "2025-08-13T18:41:44.263+00:00",
"start": "2025-08-13T17:41:44.263+00:00"
}
]
```

**participants.map(x, x.actor)** `[]bool` *required*

Mapped array of: Person, location, healthcare service or device reference

```json CEL theme={null}
$result_object_key.participants.map(x, x.actor)
```

```json Example theme={null}
[
{
"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"
}
]
```

**actor.identifier.use** `fhir.v4.codes.IdentifierUse`

Mapped array of: Person, location, healthcare service or device reference

```json CEL theme={null}
actor.identifier.use
```

```json Example theme={null}
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
```

**periods** `[]object` *required*

Potential date/time interval(s) requested to allocate the appointment within

```json CEL theme={null}
$result_object_key.periods
```

```json Example theme={null}
[
{
"end": "2025-08-13T18:41:44.263+00:00",
"start": "2025-08-13T17:41:44.263+00:00"
}
]
```

**periods.map(x, x.start)** `[]timing.v1.Timestamp` *required*

Mapped array of: The beginning of the period - inclusive

```json CEL theme={null}
$result_object_key.periods.map(x, x.start)
```

```json Example theme={null}
[
"2025-08-13T17:41:44.263+00:00"
]
```

**periods.map(x, x.end)** `[]timing.v1.Timestamp` *required*

Mapped array of: Optional end of the period - inclusive, missing denotes ongoing

```json CEL theme={null}
$result_object_key.periods.map(x, x.end)
```

```json Example theme={null}
[
"2025-08-13T18:41:44.263+00:00"
]
```

**meta** `object`

Metadata about the Appointment record

```json CEL theme={null}
$result_object_key.meta
```

```json Example theme={null}
{
"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"
}
```

**meta.id** `string`

ID of the Meta element

```json CEL theme={null}
$result_object_key.meta.id
```

```json Example theme={null}
"20002"
```

**meta.extensions** `[]object`

Additional content defined by implementations

```json CEL theme={null}
$result_object_key.meta.extensions
```

```json Example theme={null}
[
{
"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
}
]
```

**meta.extensions.map(x, x.url)** `[]string` *required*

`HI` `PII` Mapped array of: The URL giving the meaning of the extension

```json CEL theme={null}
$result_object_key.meta.extensions.map(x, x.url)
```

```json Example theme={null}
[
"https://morf.health/fhir/r4/extensions/formats"
]
```

**meta.extensions.map(x, x.value\_field\_label)** `[]string` *required*

*Description coming soon*

```json CEL theme={null}
$result_object_key.meta.extensions.map(x, x.value_field_label)
```

```json Example theme={null}
[
null
]
```

**meta.extensions.map(x, x.value)** `[]bool` *required*

`HI` `PII` Mapped array of: The extension's value

```json CEL theme={null}
$result_object_key.meta.extensions.map(x, x.value)
```

```json Example theme={null}
[
"arbitrary value of any type (i.e. not necessarily a string)"
]
```

**value.null\_value** `google.protobuf.NullValue`

`HI` `PII` Mapped array of: The extension's value

```json CEL theme={null}
value.null_value
```

**meta.extensions.map(x, x.extension)** `[]bool` *required*

`HI` `PII` Mapped array of: Sub-extensions (recursive)

```json CEL theme={null}
$result_object_key.meta.extensions.map(x, x.extension)
```

```json Example theme={null}
[
[
{
"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
}
]
]
```

**meta.version\_id** `string`

Version ID of the Meta element

```json CEL theme={null}
$result_object_key.meta.version_id
```

```json Example theme={null}
"1"
```

**meta.last\_updated** `timing.v1.Timestamp`

Last updated timestamp for the corresponding Resource object

```json CEL theme={null}
$result_object_key.meta.last_updated
```

```json Example theme={null}
"2025-02-11T17:17:41.101+00:00"
```

**meta.source** `string`

The source of the corresponding Resource object

```json CEL theme={null}
$result_object_key.meta.source
```

```json Example theme={null}
"1"
```

**meta.profiles** `[]string`

Profiles this Resource claims to conform to

```json CEL theme={null}
$result_object_key.meta.profiles
```

```json Example theme={null}
"Profile 1"
```

**meta.security\_labels** `[]object`

Security Labels applied to this resource

```json CEL theme={null}
$result_object_key.meta.security_labels
```

```json Example theme={null}
[
{
"code": "X",
"display": "Arbitrary string",
"system": "Jr.",
"user_selected": true,
"version": "r4"
}
]
```

**meta.security\_labels.map(x, x.system)** `[]string` *required*

`HI` Mapped array of: Identity of the terminology system

```json CEL theme={null}
$result_object_key.meta.security_labels.map(x, x.system)
```

```json Example theme={null}
[
"Jr."
]
```

**meta.security\_labels.map(x, x.version)** `[]string` *required*

Mapped array of: Version of the system - if relevant

```json CEL theme={null}
$result_object_key.meta.security_labels.map(x, x.version)
```

```json Example theme={null}
[
"r4"
]
```

**meta.security\_labels.map(x, x.code)** `[]string` *required*

`HI` `PII` Mapped array of: Symbol in syntax defined by the system

```json CEL theme={null}
$result_object_key.meta.security_labels.map(x, x.code)
```

```json Example theme={null}
[
"X"
]
```

**meta.security\_labels.map(x, x.display)** `[]string` *required*

`HI` `PII` Mapped array of: Representation defined by the system

```json CEL theme={null}
$result_object_key.meta.security_labels.map(x, x.display)
```

```json Example theme={null}
[
"Arbitrary string"
]
```

**meta.security\_labels.map(x, x.user\_selected)** `[]bool` *required*

Mapped array of: Coding was chosen directly by the user

```json CEL theme={null}
$result_object_key.meta.security_labels.map(x, x.user_selected)
```

```json Example theme={null}
[
true
]
```

**meta.tags** `[]object`

Tags applied to this resource

```json CEL theme={null}
$result_object_key.meta.tags
```

```json Example theme={null}
[
{
"code": "X",
"display": "Arbitrary string",
"system": "Jr.",
"user_selected": true,
"version": "r4"
}
]
```

**meta.tags.map(x, x.system)** `[]string` *required*

`HI` Mapped array of: Identity of the terminology system

```json CEL theme={null}
$result_object_key.meta.tags.map(x, x.system)
```

```json Example theme={null}
[
"Jr."
]
```

**meta.tags.map(x, x.version)** `[]string` *required*

Mapped array of: Version of the system - if relevant

```json CEL theme={null}
$result_object_key.meta.tags.map(x, x.version)
```

```json Example theme={null}
[
"r4"
]
```

**meta.tags.map(x, x.code)** `[]string` *required*

`HI` `PII` Mapped array of: Symbol in syntax defined by the system

```json CEL theme={null}
$result_object_key.meta.tags.map(x, x.code)
```

```json Example theme={null}
[
"X"
]
```

**meta.tags.map(x, x.display)** `[]string` *required*

`HI` `PII` Mapped array of: Representation defined by the system

```json CEL theme={null}
$result_object_key.meta.tags.map(x, x.display)
```

```json Example theme={null}
[
"Arbitrary string"
]
```

**meta.tags.map(x, x.user\_selected)** `[]bool` *required*

Mapped array of: Coding was chosen directly by the user

```json CEL theme={null}
$result_object_key.meta.tags.map(x, x.user_selected)
```

```json Example theme={null}
[
true
]
```

**supporting\_information\_references** `[]object` *required*

Additional information to support the Appointment

```json CEL theme={null}
$result_object_key.supporting_information_references
```

```json Example theme={null}
[
{
"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"
}
]
```

**supporting\_information\_references.map(x, x.reference)** `[]bool` *required*

Mapped array of: Literal reference, relative, internal or absolute URL

```json CEL theme={null}
$result_object_key.supporting_information_references.map(x, x.reference)
```

```json Example theme={null}
[
{
"type": "Patient",
"value": "1234"
}
]
```

**supporting\_information\_references.map(x, x.type)** `[]string` *required*

Mapped array of: Type the reference refers

```json CEL theme={null}
$result_object_key.supporting_information_references.map(x, x.type)
```

```json Example theme={null}
[
"Patient"
]
```

**supporting\_information\_references.map(x, x.identifier)** `[]bool` *required*

Mapped array of: Logical reference when literal reference is not known

```json CEL theme={null}
$result_object_key.supporting_information_references.map(x, x.identifier)
```

```json Example theme={null}
[
{
"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"
}
]
```

**identifier.use** `fhir.v4.codes.IdentifierUse`

Mapped array of: Logical reference when literal reference is not known

```json CEL theme={null}
identifier.use
```

```json Example theme={null}
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
```

**supporting\_information\_references.map(x, x.display)** `[]string` *required*

Mapped array of: Text alternative for the resource

```json CEL theme={null}
$result_object_key.supporting_information_references.map(x, x.display)
```

```json Example theme={null}
[
"PatientX"
]
```

**reason\_references** `[]object` *required*

Reasons the Appointment is to take place

```json CEL theme={null}
$result_object_key.reason_references
```

```json Example theme={null}
[
{
"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"
}
]
```

**reason\_references.map(x, x.reference)** `[]bool` *required*

Mapped array of: Literal reference, relative, internal or absolute URL

```json CEL theme={null}
$result_object_key.reason_references.map(x, x.reference)
```

```json Example theme={null}
[
{
"type": "Patient",
"value": "1234"
}
]
```

**reason\_references.map(x, x.type)** `[]string` *required*

Mapped array of: Type the reference refers

```json CEL theme={null}
$result_object_key.reason_references.map(x, x.type)
```

```json Example theme={null}
[
"Patient"
]
```

**reason\_references.map(x, x.identifier)** `[]bool` *required*

Mapped array of: Logical reference when literal reference is not known

```json CEL theme={null}
$result_object_key.reason_references.map(x, x.identifier)
```

```json Example theme={null}
[
{
"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"
}
]
```

**identifier.use** `fhir.v4.codes.IdentifierUse`

Mapped array of: Logical reference when literal reference is not known

```json CEL theme={null}
identifier.use
```

```json Example theme={null}
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
```

**reason\_references.map(x, x.display)** `[]string` *required*

Mapped array of: Text alternative for the resource

```json CEL theme={null}
$result_object_key.reason_references.map(x, x.display)
```

```json Example theme={null}
[
"PatientX"
]
```

**slots** `[]object` *required*

The slots that this Appointment is filling

```json CEL theme={null}
$result_object_key.slots
```

```json Example theme={null}
[
{
"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"
}
]
```

**slots.map(x, x.reference)** `[]bool` *required*

Mapped array of: Literal reference, relative, internal or absolute URL

```json CEL theme={null}
$result_object_key.slots.map(x, x.reference)
```

```json Example theme={null}
[
{
"type": "Patient",
"value": "1234"
}
]
```

**slots.map(x, x.type)** `[]string` *required*

Mapped array of: Type the reference refers

```json CEL theme={null}
$result_object_key.slots.map(x, x.type)
```

```json Example theme={null}
[
"Patient"
]
```

**slots.map(x, x.identifier)** `[]bool` *required*

Mapped array of: Logical reference when literal reference is not known

```json CEL theme={null}
$result_object_key.slots.map(x, x.identifier)
```

```json Example theme={null}
[
{
"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"
}
]
```

**identifier.use** `fhir.v4.codes.IdentifierUse`

Mapped array of: Logical reference when literal reference is not known

```json CEL theme={null}
identifier.use
```

```json Example theme={null}
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
```

**slots.map(x, x.display)** `[]string` *required*

Mapped array of: Text alternative for the resource

```json CEL theme={null}
$result_object_key.slots.map(x, x.display)
```

```json Example theme={null}
[
"PatientX"
]
```

**based\_on\_service\_requests** `[]object` *required*

The service requests this Appointment is allocated to assess

```json CEL theme={null}
$result_object_key.based_on_service_requests
```

```json Example theme={null}
[
{
"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"
}
]
```

**based\_on\_service\_requests.map(x, x.reference)** `[]bool` *required*

Mapped array of: Literal reference, relative, internal or absolute URL

```json CEL theme={null}
$result_object_key.based_on_service_requests.map(x, x.reference)
```

```json Example theme={null}
[
{
"type": "Patient",
"value": "1234"
}
]
```

**based\_on\_service\_requests.map(x, x.type)** `[]string` *required*

Mapped array of: Type the reference refers

```json CEL theme={null}
$result_object_key.based_on_service_requests.map(x, x.type)
```

```json Example theme={null}
[
"Patient"
]
```

**based\_on\_service\_requests.map(x, x.identifier)** `[]bool` *required*

Mapped array of: Logical reference when literal reference is not known

```json CEL theme={null}
$result_object_key.based_on_service_requests.map(x, x.identifier)
```

```json Example theme={null}
[
{
"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"
}
]
```

**identifier.use** `fhir.v4.codes.IdentifierUse`

Mapped array of: Logical reference when literal reference is not known

```json CEL theme={null}
identifier.use
```

```json Example theme={null}
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
```

**based\_on\_service\_requests.map(x, x.display)** `[]string` *required*

Mapped array of: Text alternative for the resource

```json CEL theme={null}
$result_object_key.based_on_service_requests.map(x, x.display)
```

```json Example theme={null}
[
"PatientX"
]
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.