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

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

Events

Triggering Webhook Types

The following event types are associated with the Patient event payload from Mod Med.

Mod Med Patient Created
Mod Med Patient Updated

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

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

Payload Field Details

Event Payload

Hide fields

string

required

ID ID of the Patient object

CEL

id

Example

"636c5cd8-ad62-48d6-b9f2-fe44d442a9fd"

[]object

required

Additional content defined by implementations

CEL

extensions

Example

[
{
"extension": null,
"url": "https://morf.health/fhir/r4/extensions/formats",
"value": "arbitrary value of any type (i.e. not necessarily a string)",
"value_field_label": null
}
]

[]string

required

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

CEL

extensions.map(x, x.url)

Example

[
"https://morf.health/fhir/r4/extensions/formats"
]

[]string

required

Description coming soon

CEL

extensions.map(x, x.value_field_label)

Example

[
null
]

[]bool

required

HI PII Mapped array of: The extension’s value

CEL

extensions.map(x, x.value)

Example

[
"arbitrary value of any type (i.e. not necessarily a string)"
]

google.protobuf.NullValue

HI PII Mapped array of: The extension’s value

CEL

value.null_value

Example

[]bool

required

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

CEL

extensions.map(x, x.extension)

Example

[
[
{
"extension": null,
"url": "https://morf.health/fhir/r4/extensions/formats",
"value": "arbitrary value of any type (i.e. not necessarily a string)",
"value_field_label": null
}
]
]

[]object

required

Associated Identifiers for the Patient

CEL

identifiers

Example

[
{
"period": {
"end": "2025-08-13T18:41:44.263+00:00",
"start": "2025-08-13T17:41:44.263+00:00"
},
"system": "https://morf.health/fhir/r4/identifier_types/healthie",
"use": "secondary",
"value": "401421231"
}
]

fhir.v4.codes.IdentifierUse

Mapped array of: The identifier’s usage

CEL

use

Example

fhir.v4.codes.IdentifierUse.IDENTIFIER_USE_USUAL
fhir.v4.codes.IdentifierUse.IDENTIFIER_USE_OFFICIAL
fhir.v4.codes.IdentifierUse.IDENTIFIER_USE_TEMP
fhir.v4.codes.IdentifierUse.IDENTIFIER_USE_SECONDARY
fhir.v4.codes.IdentifierUse.IDENTIFIER_USE_OLD

[]string

required

Mapped array of: The identifier’s namespace

CEL

identifiers.map(x, x.system)

Example

[
"https://morf.health/fhir/r4/identifier_types/healthie"
]

[]string

required

ID Mapped array of: The identifier value

CEL

identifiers.map(x, x.value)

Example

[
"401421231"
]

[]bool

required

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

CEL

identifiers.map(x, x.period)

Example

[
{
"end": "2025-08-13T18:41:44.263+00:00",
"start": "2025-08-13T17:41:44.263+00:00"
}
]

bool

required

Whether this Patient’s record is in active use

CEL

active

Example

true

[]object

required

Patient names

CEL

names

Example

[
{
"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"
}
]

fhir.v4.codes.NameUse

Mapped array of: The name’s usage

CEL

use

Example

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

[]string

required

PII Mapped array of: Text representation of the full name

CEL

names.map(x, x.text)

Example

[
"John Smith"
]

[]string

required

PII Mapped array of: Family name (often called ‘Surname’ or ‘Last name’)

CEL

names.map(x, x.family)

Example

[
"Smith"
]

[]bool

required

PII Mapped array of: Given names (not always ‘first’). Includes middle names

CEL

names.map(x, x.given)

Example

[
"John"
]

[]bool

required

PII Mapped array of: Parts that come before the name

CEL

names.map(x, x.prefixes)

Example

[
"Mr."
]

[]bool

required

PII Mapped array of: Parts that come after the name

CEL

names.map(x, x.suffixes)

Example

[
"Jr."
]

[]bool

required

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

CEL

names.map(x, x.period)

Example

[
{
"end": "2025-08-13T18:41:44.263+00:00",
"start": "2025-08-13T17:41:44.263+00:00"
}
]

[]string

required

PII Phone numbers registered for the Patient

CEL

phone_numbers

Example

[
"+15559213014"
]

[]string

required

PII Email addresses registered for the Patient

CEL

email_addresses

Example

[
"patient@zero.org"
]

fhir.v4.codes.Gender

HI The Patient’s administrative gender

CEL

gender

Example

fhir.v4.codes.Gender.GENDER_MALE
fhir.v4.codes.Gender.GENDER_FEMALE
fhir.v4.codes.Gender.GENDER_OTHER
fhir.v4.codes.Gender.GENDER_UNKNOWN

values.v1.Date

PII The Patient’s birth date

CEL

date_of_birth

Example

"1999-12-31"

[]object

required

PII The Patient’s address(es)

CEL

addresses

Example

[
{
"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
}
}
]

[]bool

required

Description coming soon

CEL

addresses.map(x, x.us_address)

Example

[
{
"city": null,
"line1": null,
"line2": null,
"state": null,
"zip_code": null
}
]

[]bool

required

Description coming soon

CEL

addresses.map(x, x.international_address)

Example

[
{
"city_state_county_or_districts": [],
"country": null,
"lines": [],
"postal_code": null
}
]

object

The Patient’s marital status

CEL

marital_status

Example

{
"codings": [
{
"code": "X",
"display": "Arbitrary string",
"system": "Jr.",
"user_selected": true,
"version": "r4"
}
],
"extensions": [
{
"extension": null,
"url": "https://morf.health/fhir/r4/extensions/formats",
"value": "arbitrary value of any type (i.e. not necessarily a string)",
"value_field_label": null
}
],
"text": "Arbitrary concept string value"
}

[]object

Additional content defined by implementations

CEL

marital_status.extensions

Example

[
{
"extension": null,
"url": "https://morf.health/fhir/r4/extensions/formats",
"value": "arbitrary value of any type (i.e. not necessarily a string)",
"value_field_label": null
}
]

[]string

required

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

CEL

marital_status.extensions.map(x, x.url)

Example

[
"https://morf.health/fhir/r4/extensions/formats"
]

[]string

required

Description coming soon

CEL

marital_status.extensions.map(x, x.value_field_label)

Example

[
null
]

[]bool

required

HI PII Mapped array of: The extension’s value

CEL

marital_status.extensions.map(x, x.value)

Example

[
"arbitrary value of any type (i.e. not necessarily a string)"
]

google.protobuf.NullValue

HI PII Mapped array of: The extension’s value

CEL

value.null_value

Example

[]bool

required

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

CEL

marital_status.extensions.map(x, x.extension)

Example

[
[
{
"extension": null,
"url": "https://morf.health/fhir/r4/extensions/formats",
"value": "arbitrary value of any type (i.e. not necessarily a string)",
"value_field_label": null
}
]
]

[]object

Codings defined by terminology system(s)

CEL

marital_status.codings

Example

[
{
"code": "X",
"display": "Arbitrary string",
"system": "Jr.",
"user_selected": true,
"version": "r4"
}
]

[]string

required

HI Mapped array of: Identity of the terminology system

CEL

marital_status.codings.map(x, x.system)

Example

[
"Jr."
]

[]string

required

Mapped array of: Version of the system - if relevant

CEL

marital_status.codings.map(x, x.version)

Example

[
"r4"
]

[]string

required

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

CEL

marital_status.codings.map(x, x.code)

Example

[
"X"
]

[]string

required

HI PII Mapped array of: Representation defined by the system

CEL

marital_status.codings.map(x, x.display)

Example

[
"Arbitrary string"
]

[]bool

required

Mapped array of: Coding was chosen directly by the user

CEL

marital_status.codings.map(x, x.user_selected)

Example

[
true
]

string

HI PII Plain text representation of the concept

CEL

marital_status.text

Example

"Arbitrary concept string value"

[]object

required

The Patient’s Contacts

CEL

contacts

Example

[
{
"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"
]
}
]

[]string

required

ID Mapped array of: ID of the Patient’s Contact

CEL

contacts.map(x, x.id)

Example

[
"636c5cd8-ad62-48d6-b9f2-fe44d442a9fd"
]

[]bool

required

Mapped array of: Additional content defined by implementations

CEL

contacts.map(x, x.extensions)

Example

[
[
{
"extension": null,
"url": "https://morf.health/fhir/r4/extensions/formats",
"value": "arbitrary value of any type (i.e. not necessarily a string)",
"value_field_label": null
}
]
]

google.protobuf.NullValue

Mapped array of: Additional content defined by implementations

CEL

value.null_value

Example

[]bool

required

Mapped array of: Unignorable additional content defined by implementations

CEL

contacts.map(x, x.modifier_extensions)

Example

[
[
{
"extension": null,
"url": "https://morf.health/fhir/r4/extensions/formats",
"value": "arbitrary value of any type (i.e. not necessarily a string)",
"value_field_label": null
}
]
]

google.protobuf.NullValue

Mapped array of: Unignorable additional content defined by implementations

CEL

value.null_value

Example

[]bool

required

Mapped array of: The contact’s name

CEL

contacts.map(x, x.name)

Example

[
{
"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"
}
]

fhir.v4.codes.NameUse

Mapped array of: The contact’s name

CEL

name.use

Example

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

[]bool

required

PII Mapped array of: Phone numbers registered for the Contact

CEL

contacts.map(x, x.phone_numbers)

Example

[
[
"+15559213014"
]
]

[]bool

required

PII Mapped array of: Email addresses registered for the Contact

CEL

contacts.map(x, x.email_addresses)

Example

[
[
"person2@example.com"
]
]

[]bool

required

PII Mapped array of: The Contact’s address

CEL

contacts.map(x, x.address)

Example

[
{
"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
}
}
]

fhir.v4.codes.Gender

Mapped array of: The Contact’s administrative gender

CEL

gender

Example

fhir.v4.codes.Gender.GENDER_MALE
fhir.v4.codes.Gender.GENDER_FEMALE
fhir.v4.codes.Gender.GENDER_OTHER
fhir.v4.codes.Gender.GENDER_UNKNOWN

[]bool

required

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

CEL

contacts.map(x, x.organization)

Example

[
{
"display": "PatientX",
"identifier": {
"period": {
  "end": "2025-08-13T18:41:44.263+00:00",
  "start": "2025-08-13T17:41:44.263+00:00"
},
"system": "https://morf.health/fhir/r4/identifier_types/healthie",
"use": "secondary",
"value": "401421231"
},
"reference": {
"type": "Patient",
"value": "1234"
},
"type": "Patient"
}
]

fhir.v4.codes.IdentifierUse

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

CEL

organization.identifier.use

Example

fhir.v4.codes.IdentifierUse.IDENTIFIER_USE_USUAL
fhir.v4.codes.IdentifierUse.IDENTIFIER_USE_OFFICIAL
fhir.v4.codes.IdentifierUse.IDENTIFIER_USE_TEMP
fhir.v4.codes.IdentifierUse.IDENTIFIER_USE_SECONDARY
fhir.v4.codes.IdentifierUse.IDENTIFIER_USE_OLD

[]bool

required

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

CEL

contacts.map(x, x.period)

Example

[
{
"end": "2025-08-13T18:41:44.263+00:00",
"start": "2025-08-13T17:41:44.263+00:00"
}
]

[]object

required

PII The Patient’s communication languages

CEL

languages

Example

[
{
"language": "English",
"preferred": true
}
]

[]string

required

Mapped array of: Language with which to communicate

CEL

languages.map(x, x.language)

Example

[
"English"
]

[]bool

required

Mapped array of: Is this the preferred language

CEL

languages.map(x, x.preferred)

Example

[
true
]

[]object

required

Patient’s nominated primary care provider(s)

CEL

general_practitioners

Example

[
{
"display": "PatientX",
"identifier": {
"period": {
  "end": "2025-08-13T18:41:44.263+00:00",
  "start": "2025-08-13T17:41:44.263+00:00"
},
"system": "https://morf.health/fhir/r4/identifier_types/healthie",
"use": "secondary",
"value": "401421231"
},
"reference": {
"type": "Patient",
"value": "1234"
},
"type": "Patient"
}
]

[]bool

required

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

CEL

general_practitioners.map(x, x.reference)

Example

[
{
"type": "Patient",
"value": "1234"
}
]

[]string

required

Mapped array of: Type the reference refers

CEL

general_practitioners.map(x, x.type)

Example

[
"Patient"
]

[]bool

required

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

CEL

general_practitioners.map(x, x.identifier)

Example

[
{
"period": {
"end": "2025-08-13T18:41:44.263+00:00",
"start": "2025-08-13T17:41:44.263+00:00"
},
"system": "https://morf.health/fhir/r4/identifier_types/healthie",
"use": "secondary",
"value": "401421231"
}
]

fhir.v4.codes.IdentifierUse

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

CEL

identifier.use

Example

fhir.v4.codes.IdentifierUse.IDENTIFIER_USE_USUAL
fhir.v4.codes.IdentifierUse.IDENTIFIER_USE_OFFICIAL
fhir.v4.codes.IdentifierUse.IDENTIFIER_USE_TEMP
fhir.v4.codes.IdentifierUse.IDENTIFIER_USE_SECONDARY
fhir.v4.codes.IdentifierUse.IDENTIFIER_USE_OLD

[]string

required

Mapped array of: Text alternative for the resource

CEL

general_practitioners.map(x, x.display)

Example

[
"PatientX"
]

object

Organization that is the custodian of the Patient record

CEL

managing_organization

Example

{
"display": "PatientX",
"identifier": {
"period": {
"end": "2025-08-13T18:41:44.263+00:00",
"start": "2025-08-13T17:41:44.263+00:00"
},
"system": "https://morf.health/fhir/r4/identifier_types/healthie",
"use": "secondary",
"value": "401421231"
},
"reference": {
"type": "Patient",
"value": "1234"
},
"type": "Patient"
}

object

Literal reference, relative, internal or absolute URL

CEL

managing_organization.reference

Example

{
"type": "Patient",
"value": "1234"
}

string

Reference ID value

CEL

managing_organization.reference.value

Example

"1234"

string

Reference ID type

CEL

managing_organization.reference.type

Example

"Patient"

string

Type the reference refers

CEL

managing_organization.type

Example

"Patient"

object

Logical reference when literal reference is not known

CEL

managing_organization.identifier

Example

{
"period": {
"end": "2025-08-13T18:41:44.263+00:00",
"start": "2025-08-13T17:41:44.263+00:00"
},
"system": "https://morf.health/fhir/r4/identifier_types/healthie",
"use": "secondary",
"value": "401421231"
}

fhir.v4.codes.IdentifierUse

The identifier’s usage

CEL

managing_organization.identifier.use

Example

fhir.v4.codes.IdentifierUse.IDENTIFIER_USE_USUAL
fhir.v4.codes.IdentifierUse.IDENTIFIER_USE_OFFICIAL
fhir.v4.codes.IdentifierUse.IDENTIFIER_USE_TEMP
fhir.v4.codes.IdentifierUse.IDENTIFIER_USE_SECONDARY
fhir.v4.codes.IdentifierUse.IDENTIFIER_USE_OLD

string

The identifier’s namespace

CEL

managing_organization.identifier.system

Example

"https://morf.health/fhir/r4/identifier_types/healthie"

string

ID The identifier value

CEL

managing_organization.identifier.value

Example

"401421231"

object

Time period the identifier was / is in use

CEL

managing_organization.identifier.period

Example

{
"end": "2025-08-13T18:41:44.263+00:00",
"start": "2025-08-13T17:41:44.263+00:00"
}

timing.v1.Timestamp

The beginning of the period - inclusive

CEL

managing_organization.identifier.period.start

Example

"2025-08-13T17:41:44.263+00:00"

timing.v1.Timestamp

Optional end of the period - inclusive, missing denotes ongoing

CEL

managing_organization.identifier.period.end

Example

"2025-08-13T18:41:44.263+00:00"

string

Text alternative for the resource

CEL

managing_organization.display

Example

"PatientX"

object

Metadata about the Patient record

CEL

meta

Example

{
"extensions": [
{
"extension": null,
"url": "https://morf.health/fhir/r4/extensions/formats",
"value": "arbitrary value of any type (i.e. not necessarily a string)",
"value_field_label": null
}
],
"id": "20002",
"last_updated": "2025-02-11T17:17:41.101+00:00",
"profiles": "Profile 1",
"security_labels": [
{
"code": "X",
"display": "Arbitrary string",
"system": "Jr.",
"user_selected": true,
"version": "r4"
}
],
"source": "1",
"tags": [
{
"code": "X",
"display": "Arbitrary string",
"system": "Jr.",
"user_selected": true,
"version": "r4"
}
],
"version_id": "1"
}

string

ID of the Meta element

CEL

meta.id

Example

"20002"

[]object

Additional content defined by implementations

CEL

meta.extensions

Example

[
{
"extension": null,
"url": "https://morf.health/fhir/r4/extensions/formats",
"value": "arbitrary value of any type (i.e. not necessarily a string)",
"value_field_label": null
}
]

[]string

required

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

CEL

meta.extensions.map(x, x.url)

Example

[
"https://morf.health/fhir/r4/extensions/formats"
]

[]string

required

Description coming soon

CEL

meta.extensions.map(x, x.value_field_label)

Example

[
null
]

[]bool

required

HI PII Mapped array of: The extension’s value

CEL

meta.extensions.map(x, x.value)

Example

[
"arbitrary value of any type (i.e. not necessarily a string)"
]

google.protobuf.NullValue

HI PII Mapped array of: The extension’s value

CEL

value.null_value

Example

[]bool

required

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

CEL

meta.extensions.map(x, x.extension)

Example

[
[
{
"extension": null,
"url": "https://morf.health/fhir/r4/extensions/formats",
"value": "arbitrary value of any type (i.e. not necessarily a string)",
"value_field_label": null
}
]
]

string

Version ID of the Meta element

CEL

meta.version_id

Example

"1"

timing.v1.Timestamp

Last updated timestamp for the corresponding Resource object

CEL

meta.last_updated

Example

"2025-02-11T17:17:41.101+00:00"

string

The source of the corresponding Resource object

CEL

meta.source

Example

"1"

[]string

Profiles this Resource claims to conform to

CEL

meta.profiles

Example

"Profile 1"

[]object

Security Labels applied to this resource

CEL

meta.security_labels

Example

[
{
"code": "X",
"display": "Arbitrary string",
"system": "Jr.",
"user_selected": true,
"version": "r4"
}
]

[]string

required

HI Mapped array of: Identity of the terminology system

CEL

meta.security_labels.map(x, x.system)

Example

[
"Jr."
]

[]string

required

Mapped array of: Version of the system - if relevant

CEL

meta.security_labels.map(x, x.version)

Example

[
"r4"
]

[]string

required

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

CEL

meta.security_labels.map(x, x.code)

Example

[
"X"
]

[]string

required

HI PII Mapped array of: Representation defined by the system

CEL

meta.security_labels.map(x, x.display)

Example

[
"Arbitrary string"
]

[]bool

required

Mapped array of: Coding was chosen directly by the user

CEL

meta.security_labels.map(x, x.user_selected)

Example

[
true
]

[]object

Tags applied to this resource

CEL

meta.tags

Example

[
{
"code": "X",
"display": "Arbitrary string",
"system": "Jr.",
"user_selected": true,
"version": "r4"
}
]

[]string

required

HI Mapped array of: Identity of the terminology system

CEL

meta.tags.map(x, x.system)

Example

[
"Jr."
]

[]string

required

Mapped array of: Version of the system - if relevant

CEL

meta.tags.map(x, x.version)

Example

[
"r4"
]

[]string

required

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

CEL

meta.tags.map(x, x.code)

Example

[
"X"
]

[]string

required

HI PII Mapped array of: Representation defined by the system

CEL

meta.tags.map(x, x.display)

Example

[
"Arbitrary string"
]

[]bool

required

Mapped array of: Coding was chosen directly by the user

CEL

meta.tags.map(x, x.user_selected)

Example

[
true
]

⌘I

​Events

​Triggering Webhook Types

​Payload Field Details

Events

Triggering Webhook Types

Payload Field Details