Skip to main content
images/medplum.svg

Events

Triggering Webhook Types

The following event types are associated with the Patient event payload from Medplum.
  • Medplum Patient Created
  • Medplum 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

Patient
Event Payload