{ "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"}
Mod Med
Patient
Event payload details and trigger documentation for Patient data from Mod Med
{ "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.
{ "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
HIPII Mapped array of: The URL giving the meaning of the extension
["arbitrary value of any type (i.e. not necessarily a string)"]
google.protobuf.NullValue
HIPII Mapped array of: The extension’s value
CEL
value.null_value
Example
[]bool
required
HIPII 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}]]
{"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
HIPII Mapped array of: The URL giving the meaning of the extension
["arbitrary value of any type (i.e. not necessarily a string)"]
google.protobuf.NullValue
HIPII Mapped array of: The extension’s value
CEL
value.null_value
Example
[]bool
required
HIPII 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}]]
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
HIPII Mapped array of: Symbol in syntax defined by the system
CEL
marital_status.codings.map(x, x.code)
Example
["X"]
[]string
required
HIPII 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
HIPII 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
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
HIPII Mapped array of: The URL giving the meaning of the extension
["arbitrary value of any type (i.e. not necessarily a string)"]
google.protobuf.NullValue
HIPII Mapped array of: The extension’s value
CEL
value.null_value
Example
[]bool
required
HIPII 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