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.
Events
Triggering Webhook Types
The following event types are associated with the Patient event payload from Medplum.Medplum Patient CreatedMedplum 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
Hide fields
Hide fields
ID ID of the Patient objectCEL
id
Example
"636c5cd8-ad62-48d6-b9f2-fe44d442a9fd"
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
}
]
HI PII Mapped array of: The URL giving the meaning of the extensionCEL
extensions.map(x, x.url)
Example
[
"https://morf.health/fhir/r4/extensions/formats"
]
Description coming soon
CEL
extensions.map(x, x.value_field_label)
Example
[
null
]
HI PII Mapped array of: The extension’s valueCEL
extensions.map(x, x.value)
Example
[
"arbitrary value of any type (i.e. not necessarily a string)"
]
HI PII Mapped array of: The extension’s valueCEL
value.null_value
Example
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
}
]
]
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"
}
]
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
Mapped array of: The identifier’s namespace
CEL
identifiers.map(x, x.system)
Example
[
"https://morf.health/fhir/r4/identifier_types/healthie"
]
ID Mapped array of: The identifier valueCEL
identifiers.map(x, x.value)
Example
[
"401421231"
]
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"
}
]
Whether this Patient’s record is in active use
CEL
active
Example
true
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"
}
]
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
PII Mapped array of: Text representation of the full nameCEL
names.map(x, x.text)
Example
[
"John Smith"
]
PII Mapped array of: Family name (often called ‘Surname’ or ‘Last name’)CEL
names.map(x, x.family)
Example
[
"Smith"
]
PII Mapped array of: Given names (not always ‘first’). Includes middle namesCEL
names.map(x, x.given)
Example
[
"John"
]
PII Mapped array of: Parts that come before the nameCEL
names.map(x, x.prefixes)
Example
[
"Mr."
]
PII Mapped array of: Parts that come after the nameCEL
names.map(x, x.suffixes)
Example
[
"Jr."
]
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"
}
]
PII Phone numbers registered for the PatientCEL
phone_numbers
Example
[
"+15559213014"
]
PII Email addresses registered for the PatientCEL
email_addresses
Example
[
"patient@zero.org"
]
HI The Patient’s administrative genderCEL
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
PII The Patient’s birth dateCEL
date_of_birth
Example
"1999-12-31"
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
}
}
]
Description coming soon
CEL
addresses.map(x, x.us_address)
Example
[
{
"city": null,
"line1": null,
"line2": null,
"state": null,
"zip_code": null
}
]
Description coming soon
CEL
addresses.map(x, x.international_address)
Example
[
{
"city_state_county_or_districts": [],
"country": null,
"lines": [],
"postal_code": null
}
]
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"
}
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
}
]
HI PII Mapped array of: The URL giving the meaning of the extensionCEL
marital_status.extensions.map(x, x.url)
Example
[
"https://morf.health/fhir/r4/extensions/formats"
]
Description coming soon
CEL
marital_status.extensions.map(x, x.value_field_label)
Example
[
null
]
HI PII Mapped array of: The extension’s valueCEL
marital_status.extensions.map(x, x.value)
Example
[
"arbitrary value of any type (i.e. not necessarily a string)"
]
HI PII Mapped array of: The extension’s valueCEL
value.null_value
Example
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
}
]
]
Codings defined by terminology system(s)
CEL
marital_status.codings
Example
[
{
"code": "X",
"display": "Arbitrary string",
"system": "Jr.",
"user_selected": true,
"version": "r4"
}
]
HI Mapped array of: Identity of the terminology systemCEL
marital_status.codings.map(x, x.system)
Example
[
"Jr."
]
Mapped array of: Version of the system - if relevant
CEL
marital_status.codings.map(x, x.version)
Example
[
"r4"
]
HI PII Mapped array of: Symbol in syntax defined by the systemCEL
marital_status.codings.map(x, x.code)
Example
[
"X"
]
HI PII Mapped array of: Representation defined by the systemCEL
marital_status.codings.map(x, x.display)
Example
[
"Arbitrary string"
]
Mapped array of: Coding was chosen directly by the user
CEL
marital_status.codings.map(x, x.user_selected)
Example
[
true
]
HI PII Plain text representation of the conceptCEL
marital_status.text
Example
"Arbitrary concept string value"
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"
]
}
]
ID Mapped array of: ID of the Patient’s ContactCEL
contacts.map(x, x.id)
Example
[
"636c5cd8-ad62-48d6-b9f2-fe44d442a9fd"
]
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
}
]
]
Mapped array of: Additional content defined by implementations
CEL
value.null_value
Example
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
}
]
]
Mapped array of: Unignorable additional content defined by implementations
CEL
value.null_value
Example
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"
}
]
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
PII Mapped array of: Phone numbers registered for the ContactCEL
contacts.map(x, x.phone_numbers)
Example
[
[
"+15559213014"
]
]
PII Mapped array of: Email addresses registered for the ContactCEL
contacts.map(x, x.email_addresses)
Example
[
[
"person2@example.com"
]
]
PII Mapped array of: The Contact’s addressCEL
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
}
}
]
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
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"
}
]
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
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"
}
]
PII The Patient’s communication languagesCEL
languages
Example
[
{
"language": "English",
"preferred": true
}
]
Mapped array of: Language with which to communicate
CEL
languages.map(x, x.language)
Example
[
"English"
]
Mapped array of: Is this the preferred language
CEL
languages.map(x, x.preferred)
Example
[
true
]
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"
}
]
Mapped array of: Literal reference, relative, internal or absolute URL
CEL
general_practitioners.map(x, x.reference)
Example
[
{
"type": "Patient",
"value": "1234"
}
]
Mapped array of: Type the reference refers
CEL
general_practitioners.map(x, x.type)
Example
[
"Patient"
]
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"
}
]
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
Mapped array of: Text alternative for the resource
CEL
general_practitioners.map(x, x.display)
Example
[
"PatientX"
]
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"
}
Literal reference, relative, internal or absolute URL
CEL
managing_organization.reference
Example
{
"type": "Patient",
"value": "1234"
}
Reference ID value
CEL
managing_organization.reference.value
Example
"1234"
Reference ID type
CEL
managing_organization.reference.type
Example
"Patient"
Type the reference refers
CEL
managing_organization.type
Example
"Patient"
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"
}
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
The identifier’s namespace
CEL
managing_organization.identifier.system
Example
"https://morf.health/fhir/r4/identifier_types/healthie"
ID The identifier valueCEL
managing_organization.identifier.value
Example
"401421231"
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"
}
The beginning of the period - inclusive
CEL
managing_organization.identifier.period.start
Example
"2025-08-13T17:41:44.263+00:00"
Optional end of the period - inclusive, missing denotes ongoing
CEL
managing_organization.identifier.period.end
Example
"2025-08-13T18:41:44.263+00:00"
Text alternative for the resource
CEL
managing_organization.display
Example
"PatientX"
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"
}
ID of the Meta element
CEL
meta.id
Example
"20002"
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
}
]
HI PII Mapped array of: The URL giving the meaning of the extensionCEL
meta.extensions.map(x, x.url)
Example
[
"https://morf.health/fhir/r4/extensions/formats"
]
Description coming soon
CEL
meta.extensions.map(x, x.value_field_label)
Example
[
null
]
HI PII Mapped array of: The extension’s valueCEL
meta.extensions.map(x, x.value)
Example
[
"arbitrary value of any type (i.e. not necessarily a string)"
]
HI PII Mapped array of: The extension’s valueCEL
value.null_value
Example
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
}
]
]
Version ID of the Meta element
CEL
meta.version_id
Example
"1"
Last updated timestamp for the corresponding Resource object
CEL
meta.last_updated
Example
"2025-02-11T17:17:41.101+00:00"
The source of the corresponding Resource object
CEL
meta.source
Example
"1"
Profiles this Resource claims to conform to
CEL
meta.profiles
Example
"Profile 1"
Security Labels applied to this resource
CEL
meta.security_labels
Example
[
{
"code": "X",
"display": "Arbitrary string",
"system": "Jr.",
"user_selected": true,
"version": "r4"
}
]
HI Mapped array of: Identity of the terminology systemCEL
meta.security_labels.map(x, x.system)
Example
[
"Jr."
]
Mapped array of: Version of the system - if relevant
CEL
meta.security_labels.map(x, x.version)
Example
[
"r4"
]
HI PII Mapped array of: Symbol in syntax defined by the systemCEL
meta.security_labels.map(x, x.code)
Example
[
"X"
]
HI PII Mapped array of: Representation defined by the systemCEL
meta.security_labels.map(x, x.display)
Example
[
"Arbitrary string"
]
Mapped array of: Coding was chosen directly by the user
CEL
meta.security_labels.map(x, x.user_selected)
Example
[
true
]
Tags applied to this resource
CEL
meta.tags
Example
[
{
"code": "X",
"display": "Arbitrary string",
"system": "Jr.",
"user_selected": true,
"version": "r4"
}
]
HI Mapped array of: Identity of the terminology systemCEL
meta.tags.map(x, x.system)
Example
[
"Jr."
]
Mapped array of: Version of the system - if relevant
CEL
meta.tags.map(x, x.version)
Example
[
"r4"
]
HI PII Mapped array of: Symbol in syntax defined by the systemCEL
meta.tags.map(x, x.code)
Example
[
"X"
]
HI PII Mapped array of: Representation defined by the systemCEL
meta.tags.map(x, x.display)
Example
[
"Arbitrary string"
]
Mapped array of: Coding was chosen directly by the user
CEL
meta.tags.map(x, x.user_selected)
Example
[
true
]
