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

# Create Or Update Patient

> Documentation for the Create Or Update Patient 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**

**ID** `string`

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

**Email** `string` *required*

`PII`
This field maps to the destination API `emailAddresses[]` field.

**First Name** `string`

`PII`
This field maps to the destination API `names[].given` field.

**Last Name** `string`

`PII`
This field maps to the destination API `names[].family` field.

**Phone** `string`

`PII`
This field maps to the destination API `phoneNumbers[]` field.

**Address Line 1** `string`

`PII`
This field maps to the destination API `addresses[].usAddress.line1` field.

**City** `string`

`PII`
This field maps to the destination API `addresses[].usAddress.city` field.

**State** `string`

This field maps to the destination API `addresses[].usAddress.state` field.

**Zip Code** `string`

`PII`
This field maps to the destination API `addresses[].usAddress.zipCode` field.

**Date Of Birth** `values.v1.Date` *required*

`PII`
This field maps to the destination API `dateOfBirth` field.

```json Result Object Example theme={null}
{
  "$result_object_key": {
    "active": true,
    "addresses": [
      {
        "international_address": {
          "city_state_county_or_districts": [],
          "country": null,
          "lines": [],
          "postal_code": null
        },
        "us_address": {
          "city": null,
          "line1": null,
          "line2": null,
          "state": null,
          "zip_code": null
        }
      }
    ],
    "contacts": [
      {
        "address": {
          "international_address": {
            "city_state_county_or_districts": [],
            "country": null,
            "lines": [],
            "postal_code": null
          },
          "us_address": {
            "city": null,
            "line1": null,
            "line2": null,
            "state": null,
            "zip_code": null
          }
        },
        "email_addresses": [
          "person2@example.com"
        ],
        "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
          }
        ],
        "gender": "female",
        "id": "636c5cd8-ad62-48d6-b9f2-fe44d442a9fd",
        "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
          }
        ],
        "name": {
          "family": "Smith",
          "given": "John",
          "period": {
            "end": "2025-08-13T18:41:44.263+00:00",
            "start": "2025-08-13T17:41:44.263+00:00"
          },
          "prefixes": "Mr.",
          "suffixes": "Jr.",
          "text": "John Smith",
          "use": "official"
        },
        "organization": {
          "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"
        },
        "period": {
          "end": "2025-08-13T18:41:44.263+00:00",
          "start": "2025-08-13T17:41:44.263+00:00"
        },
        "phone_numbers": [
          "+15559213014"
        ]
      }
    ],
    "date_of_birth": "1999-12-31",
    "email_addresses": [
      "patient@zero.org"
    ],
    "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
      }
    ],
    "gender": "male",
    "general_practitioners": [
      {
        "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"
      }
    ],
    "id": "636c5cd8-ad62-48d6-b9f2-fe44d442a9fd",
    "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"
      }
    ],
    "languages": [
      {
        "language": "English",
        "preferred": true
      }
    ],
    "managing_organization": {
      "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"
    },
    "marital_status": {
      "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"
    },
    "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"
    },
    "names": [
      {
        "family": "Smith",
        "given": "John",
        "period": {
          "end": "2025-08-13T18:41:44.263+00:00",
          "start": "2025-08-13T17:41:44.263+00:00"
        },
        "prefixes": "Mr.",
        "suffixes": "Jr.",
        "text": "John Smith",
        "use": "official"
      }
    ],
    "phone_numbers": [
      "+15559213014"
    ]
  }
}
```

```json Result Object Description theme={null}
{
  "$result_object_key": {
    "active": "Whether this Patient's record is in active use",
    "addresses": {
      "international_address": {
        "city_state_county_or_districts": null,
        "country": null,
        "lines": null,
        "postal_code": null
      },
      "us_address": {
        "city": null,
        "line1": null,
        "line2": null,
        "state": null,
        "zip_code": null
      }
    },
    "contacts": {
      "address": {
        "international_address": {
          "city_state_county_or_districts": null,
          "country": null,
          "lines": null,
          "postal_code": null
        },
        "us_address": {
          "city": null,
          "line1": null,
          "line2": null,
          "state": null,
          "zip_code": null
        }
      },
      "email_addresses": "Email addresses registered for the Contact",
      "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
      },
      "gender": "The Contact's administrative gender",
      "id": "ID of the Patient's Contact",
      "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
      },
      "name": {
        "family": "Family name (often called 'Surname' or 'Last name')",
        "given": "Given names (not always 'first'). Includes middle names",
        "period": {
          "end": "Optional end of the period - inclusive, missing denotes ongoing",
          "start": "The beginning of the period - inclusive"
        },
        "prefixes": "Parts that come before the name",
        "suffixes": "Parts that come after the name",
        "text": "Text representation of the full name",
        "use": "The name's usage"
      },
      "organization": {
        "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"
      },
      "period": {
        "end": "Optional end of the period - inclusive, missing denotes ongoing",
        "start": "The beginning of the period - inclusive"
      },
      "phone_numbers": "Phone numbers registered for the Contact"
    },
    "date_of_birth": "The Patient's birth date",
    "email_addresses": "Email addresses registered for the Patient",
    "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
    },
    "gender": "The Patient's administrative gender",
    "general_practitioners": {
      "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"
    },
    "id": "ID of the Patient 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"
    },
    "languages": {
      "language": "Language with which to communicate",
      "preferred": "Is this the preferred language"
    },
    "managing_organization": {
      "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"
    },
    "marital_status": {
      "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"
    },
    "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"
    },
    "names": {
      "family": "Family name (often called 'Surname' or 'Last name')",
      "given": "Given names (not always 'first'). Includes middle names",
      "period": {
        "end": "Optional end of the period - inclusive, missing denotes ongoing",
        "start": "The beginning of the period - inclusive"
      },
      "prefixes": "Parts that come before the name",
      "suffixes": "Parts that come after the name",
      "text": "Text representation of the full name",
      "use": "The name's usage"
    },
    "phone_numbers": "Phone numbers registered for the Patient"
  }
}
```

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

**Patient** `Fetch Action Response Object`

**fields**

**id** `string` *required*

`ID` ID of the Patient object

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

```json Example theme={null}
"636c5cd8-ad62-48d6-b9f2-fe44d442a9fd"
```

**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 Patient

```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"
}
]
```

**active** `bool` *required*

Whether this Patient's record is in active use

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

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

**names** `[]object` *required*

Patient names

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

```json Example theme={null}
[
{
"family": "Smith",
"given": "John",
"period": {
"end": "2025-08-13T18:41:44.263+00:00",
"start": "2025-08-13T17:41:44.263+00:00"
},
"prefixes": "Mr.",
"suffixes": "Jr.",
"text": "John Smith",
"use": "official"
}
]
```

**use** `fhir.v4.codes.NameUse`

Mapped array of: The name's usage

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

```json Example theme={null}
fhir.v4.codes.NameUse.NAME_USE_USUAL
fhir.v4.codes.NameUse.NAME_USE_OFFICIAL
fhir.v4.codes.NameUse.NAME_USE_TEMP
fhir.v4.codes.NameUse.NAME_USE_NICKNAME
fhir.v4.codes.NameUse.NAME_USE_ANONYMOUS
fhir.v4.codes.NameUse.NAME_USE_OLD
fhir.v4.codes.NameUse.NAME_USE_MAIDEN
```

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

`PII` Mapped array of: Text representation of the full name

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

```json Example theme={null}
[
"John Smith"
]
```

**names.map(x, x.family)** `[]string` *required*

`PII` Mapped array of: Family name (often called 'Surname' or 'Last name')

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

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

**names.map(x, x.given)** `[]bool` *required*

`PII` Mapped array of: Given names (not always 'first'). Includes middle names

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

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

**names.map(x, x.prefixes)** `[]bool` *required*

`PII` Mapped array of: Parts that come before the name

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

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

**names.map(x, x.suffixes)** `[]bool` *required*

`PII` Mapped array of: Parts that come after the name

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

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

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

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

```json CEL theme={null}
$result_object_key.names.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"
}
]
```

**phone\_numbers** `[]string` *required*

`PII` Phone numbers registered for the Patient

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

```json Example theme={null}
[
"+15559213014"
]
```

**email\_addresses** `[]string` *required*

`PII` Email addresses registered for the Patient

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

```json Example theme={null}
[
"patient@zero.org"
]
```

**gender** `fhir.v4.codes.Gender`

`HI` The Patient's administrative gender

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

```json Example theme={null}
fhir.v4.codes.Gender.GENDER_MALE
fhir.v4.codes.Gender.GENDER_FEMALE
fhir.v4.codes.Gender.GENDER_OTHER
fhir.v4.codes.Gender.GENDER_UNKNOWN
```

**date\_of\_birth** `values.v1.Date`

`PII` The Patient's birth date

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

```json Example theme={null}
"1999-12-31"
```

**addresses** `[]object` *required*

`PII` The Patient's address(es)

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

```json Example theme={null}
[
{
"international_address": {
"city_state_county_or_districts": [],
"country": null,
"lines": [],
"postal_code": null
},
"us_address": {
"city": null,
"line1": null,
"line2": null,
"state": null,
"zip_code": null
}
}
]
```

**addresses.map(x, x.us\_address)** `[]bool` *required*

*Description coming soon*

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

```json Example theme={null}
[
{
"city": null,
"line1": null,
"line2": null,
"state": null,
"zip_code": null
}
]
```

**addresses.map(x, x.international\_address)** `[]bool` *required*

*Description coming soon*

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

```json Example theme={null}
[
{
"city_state_county_or_districts": [],
"country": null,
"lines": [],
"postal_code": null
}
]
```

**marital\_status** `object`

The Patient's marital status

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

```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"
}
```

**marital\_status.extensions** `[]object`

Additional content defined by implementations

```json CEL theme={null}
$result_object_key.marital_status.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
}
]
```

**marital\_status.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.marital_status.extensions.map(x, x.url)
```

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

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

*Description coming soon*

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

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

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

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

```json CEL theme={null}
$result_object_key.marital_status.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
```

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

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

```json CEL theme={null}
$result_object_key.marital_status.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
}
]
]
```

**marital\_status.codings** `[]object`

Codings defined by terminology system(s)

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

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

**marital\_status.codings.map(x, x.system)** `[]string` *required*

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

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

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

**marital\_status.codings.map(x, x.version)** `[]string` *required*

Mapped array of: Version of the system - if relevant

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

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

**marital\_status.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.marital_status.codings.map(x, x.code)
```

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

**marital\_status.codings.map(x, x.display)** `[]string` *required*

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

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

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

**marital\_status.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.marital_status.codings.map(x, x.user_selected)
```

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

**marital\_status.text** `string`

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

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

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

**contacts** `[]object` *required*

The Patient's Contacts

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

```json Example theme={null}
[
{
"address": {
"international_address": {
  "city_state_county_or_districts": [],
  "country": null,
  "lines": [],
  "postal_code": null
},
"us_address": {
  "city": null,
  "line1": null,
  "line2": null,
  "state": null,
  "zip_code": null
}
},
"email_addresses": [
"person2@example.com"
],
"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
}
],
"gender": "female",
"id": "636c5cd8-ad62-48d6-b9f2-fe44d442a9fd",
"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
}
],
"name": {
"family": "Smith",
"given": "John",
"period": {
  "end": "2025-08-13T18:41:44.263+00:00",
  "start": "2025-08-13T17:41:44.263+00:00"
},
"prefixes": "Mr.",
"suffixes": "Jr.",
"text": "John Smith",
"use": "official"
},
"organization": {
"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"
},
"period": {
"end": "2025-08-13T18:41:44.263+00:00",
"start": "2025-08-13T17:41:44.263+00:00"
},
"phone_numbers": [
"+15559213014"
]
}
]
```

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

`ID` Mapped array of: ID of the Patient's Contact

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

```json Example theme={null}
[
"636c5cd8-ad62-48d6-b9f2-fe44d442a9fd"
]
```

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

Mapped array of: Additional content defined by implementations

```json CEL theme={null}
$result_object_key.contacts.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
```

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

Mapped array of: Unignorable additional content defined by implementations

```json CEL theme={null}
$result_object_key.contacts.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
```

**contacts.map(x, x.name)** `[]bool` *required*

Mapped array of: The contact's name

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

```json Example theme={null}
[
{
"family": "Smith",
"given": "John",
"period": {
"end": "2025-08-13T18:41:44.263+00:00",
"start": "2025-08-13T17:41:44.263+00:00"
},
"prefixes": "Mr.",
"suffixes": "Jr.",
"text": "John Smith",
"use": "official"
}
]
```

**name.use** `fhir.v4.codes.NameUse`

Mapped array of: The contact's name

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

```json Example theme={null}
fhir.v4.codes.NameUse.NAME_USE_USUAL
fhir.v4.codes.NameUse.NAME_USE_OFFICIAL
fhir.v4.codes.NameUse.NAME_USE_TEMP
fhir.v4.codes.NameUse.NAME_USE_NICKNAME
fhir.v4.codes.NameUse.NAME_USE_ANONYMOUS
fhir.v4.codes.NameUse.NAME_USE_OLD
fhir.v4.codes.NameUse.NAME_USE_MAIDEN
```

**contacts.map(x, x.phone\_numbers)** `[]bool` *required*

`PII` Mapped array of: Phone numbers registered for the Contact

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

```json Example theme={null}
[
[
"+15559213014"
]
]
```

**contacts.map(x, x.email\_addresses)** `[]bool` *required*

`PII` Mapped array of: Email addresses registered for the Contact

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

```json Example theme={null}
[
[
"person2@example.com"
]
]
```

**contacts.map(x, x.address)** `[]bool` *required*

`PII` Mapped array of: The Contact's address

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

```json Example theme={null}
[
{
"international_address": {
"city_state_county_or_districts": [],
"country": null,
"lines": [],
"postal_code": null
},
"us_address": {
"city": null,
"line1": null,
"line2": null,
"state": null,
"zip_code": null
}
}
]
```

**gender** `fhir.v4.codes.Gender`

Mapped array of: The Contact's administrative gender

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

```json Example theme={null}
fhir.v4.codes.Gender.GENDER_MALE
fhir.v4.codes.Gender.GENDER_FEMALE
fhir.v4.codes.Gender.GENDER_OTHER
fhir.v4.codes.Gender.GENDER_UNKNOWN
```

**contacts.map(x, x.organization)** `[]bool` *required*

Mapped array of: The Organization that is associated with the Contact

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

```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"
}
]
```

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

Mapped array of: The Organization that is associated with the Contact

```json CEL theme={null}
organization.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
```

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

Mapped array of: The period during which this Contact person or organization is valid to be contacted relating to this Patient

```json CEL theme={null}
$result_object_key.contacts.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"
}
]
```

**languages** `[]object` *required*

`PII` The Patient's communication languages

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

```json Example theme={null}
[
{
"language": "English",
"preferred": true
}
]
```

**languages.map(x, x.language)** `[]string` *required*

Mapped array of: Language with which to communicate

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

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

**languages.map(x, x.preferred)** `[]bool` *required*

Mapped array of: Is this the preferred language

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

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

**general\_practitioners** `[]object` *required*

Patient's nominated primary care provider(s)

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

```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"
}
]
```

**general\_practitioners.map(x, x.reference)** `[]bool` *required*

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

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

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

**general\_practitioners.map(x, x.type)** `[]string` *required*

Mapped array of: Type the reference refers

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

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

**general\_practitioners.map(x, x.identifier)** `[]bool` *required*

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

```json CEL theme={null}
$result_object_key.general_practitioners.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
```

**general\_practitioners.map(x, x.display)** `[]string` *required*

Mapped array of: Text alternative for the resource

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

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

**managing\_organization** `object`

Organization that is the custodian of the Patient record

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

```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"
}
```

**managing\_organization.reference** `object`

Literal reference, relative, internal or absolute URL

```json CEL theme={null}
$result_object_key.managing_organization.reference
```

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

**managing\_organization.reference.value** `string`

Reference ID value

```json CEL theme={null}
$result_object_key.managing_organization.reference.value
```

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

**managing\_organization.reference.type** `string`

Reference ID type

```json CEL theme={null}
$result_object_key.managing_organization.reference.type
```

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

**managing\_organization.type** `string`

Type the reference refers

```json CEL theme={null}
$result_object_key.managing_organization.type
```

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

**managing\_organization.identifier** `object`

Logical reference when literal reference is not known

```json CEL theme={null}
$result_object_key.managing_organization.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"
}
```

**managing\_organization.identifier.use** `fhir.v4.codes.IdentifierUse`

The identifier's usage

```json CEL theme={null}
$result_object_key.managing_organization.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
```

**managing\_organization.identifier.system** `string`

The identifier's namespace

```json CEL theme={null}
$result_object_key.managing_organization.identifier.system
```

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

**managing\_organization.identifier.value** `string`

`ID` The identifier value

```json CEL theme={null}
$result_object_key.managing_organization.identifier.value
```

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

**managing\_organization.identifier.period** `object`

Time period the identifier was / is in use

```json CEL theme={null}
$result_object_key.managing_organization.identifier.period
```

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

**managing\_organization.identifier.period.start** `timing.v1.Timestamp`

The beginning of the period - inclusive

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

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

**managing\_organization.identifier.period.end** `timing.v1.Timestamp`

Optional end of the period - inclusive, missing denotes ongoing

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

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

**managing\_organization.display** `string`

Text alternative for the resource

```json CEL theme={null}
$result_object_key.managing_organization.display
```

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

**meta** `object`

Metadata about the Patient 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
]
```


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