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 Hint Health.Hint Health Patient CreatedHint Health Patient UpdatedHint Health Patient DestroyedHint Health Patient Inactive
{
"account": {
"name": "Gordon Thomas Sumner",
"past_due_in_cents": 0
},
"address_city": "New York",
"address_country": "United States",
"address_line1": "157 E Houston St",
"address_line2": "Suite 2402",
"address_state": "NY",
"address_zip": "10002",
"age": 60,
"chosen_first_name": "Alex",
"chosen_last_name": "Smith",
"chosen_middle_name": "Jordan",
"chosen_suffix": "Jr.",
"chosen_title": "Dr.",
"company": {
"id": "com-ab12C345DeF6",
"name": "Schmoogle Inc."
},
"created_at": null,
"dob": null,
"electronic_communication_consent_accepted": true,
"electronic_communication_consent_accepted_at": null,
"email": "bass_man@bumblebeeinc.com",
"external_link_id": "ext-12345",
"external_records": [
{
"external_id": "ext-98765",
"source": "ehr_system"
}
],
"first_name": "Gordon",
"gender": "male",
"gender_identity": "man",
"gender_other": "non-binary",
"health_insurance_group_id": "12345",
"health_insurance_member_id": "A22222222",
"health_insurance_payer_id": "00039",
"health_insurance_payer_name": "Anthem Blue Cross California",
"hipaa_authorization_accepted": true,
"hipaa_authorization_accepted_at": null,
"id": "pat-ab12C345DeF6",
"import_id": "imp-ab12C345DeF6",
"import_source": "csv_upload",
"joined_practice_date": null,
"known_practice": {
"id": "prc-ab12C345DeF6",
"name": "Downtown Medical"
},
"last_name": "Sumner",
"lead_source": {
"created_at": null,
"id": "lds-ab12C345DeF6",
"name": "Other",
"updated_at": null
},
"lead_source_other": "Downtown marketing event",
"location": {
"address_city": "New York",
"address_country": "United States",
"address_latitude": "40.7227998",
"address_line1": "157 E Houston St",
"address_line2": "Suite 2402",
"address_longitude": "-73.9892241",
"address_state": "NY",
"address_zip": "10002",
"distance": "5.2 miles",
"id": "loc-ab12C345DeF6",
"location_group": {
"created_at": null,
"id": "prg-ab12C345DeF6",
"integration_record_id": "int-ab12C345DeF6",
"name": "Downtown Location Group",
"updated_at": null
},
"name": "San Francisco HQ",
"phone_number": "+15551234567",
"virtual": false
},
"location_group": {
"created_at": null,
"id": "prg-ab12C345DeF6",
"integration_record_id": "int-ab12C345DeF6",
"name": "Downtown Location Group",
"updated_at": null
},
"master_record_sponsor": "creg-ab12C345DeF6",
"membership_status": "active",
"memberships": [
{
"company": {
"id": "com-ab12C345DeF6",
"name": "Schmoogle Inc."
},
"division": {
"id": "div-ab12C345DeF6",
"name": "division 20"
},
"end_date": null,
"enrollment_requested_on": null,
"enrollment_status": "active",
"member_type": "spouse",
"payer": {
"id": "pat-ab12C345DeF6",
"name": "Gordon Thomas Sumner"
},
"plan": {
"id": "pln-ab12C345DeF6",
"name": "Membership"
},
"start_date": null,
"status": "active",
"uses_tobacco": false
}
],
"merged_into": {
"id": "pat-zz99Y888XwV7",
"name": "Gordon Thomas Sumner"
},
"middle_name": "Thomas",
"name": "Gordon Thomas Sumner",
"patient_agreement_accepted": false,
"patient_agreement_accepted_at": null,
"phones": [
{
"number": "+15553050051",
"type": "mobile"
}
],
"practitioner": {
"accepts_enrollments_from_employer": "yes",
"accepts_enrollments_from_retail": "yes",
"bio": "Board-certified family medicine physician with 15 years of experience.",
"created_at": null,
"education": "MD, Johns Hopkins University",
"email": "dr.smith@practice.com",
"gender": "female",
"gender_other": "non-binary",
"id": "doc-ab12C345DeF6",
"integration_record_id": "int-ab12C345DeF6",
"locations": [
{
"address_city": "New York",
"address_country": "United States",
"address_latitude": "40.7227998",
"address_line1": "157 E Houston St",
"address_line2": "Suite 2402",
"address_longitude": "-73.9892241",
"address_state": "NY",
"address_zip": "10002",
"distance": "5.2 miles",
"id": "loc-ab12C345DeF6",
"location_group": {
"created_at": null,
"id": "prg-ab12C345DeF6",
"integration_record_id": "int-ab12C345DeF6",
"name": "Downtown Location Group",
"updated_at": null
},
"name": "San Francisco HQ",
"phone_number": "+15551234567",
"virtual": false
}
],
"max_patient_age": "65",
"min_patient_age": "18",
"name": "Dr. Jane Smith",
"npi": {
"id": "1234567890",
"name": "Dr. Jane Smith"
},
"online_signup_visibility": "visible",
"panel_size": 250,
"panel_size_limit": 500,
"photo_url": "https://app.hint.com/photos/doc-ab12C345DeF6.jpg",
"specialties": [
{
"id": "spc-ab12C345DeF6",
"name": "Family Medicine"
}
],
"updated_at": null
},
"practitioner_group": {
"created_at": null,
"id": "prg-ab12C345DeF6",
"integration_record_id": "int-ab12C345DeF6",
"name": "Downtown Location Group",
"updated_at": null
},
"preferred_language": "en",
"pronouns": "he/him",
"provider_web_link": "https://app.hint.com/patients/pat-ab12C345DeF6",
"sex": "male",
"sponsorships": [
{
"company": {
"id": "com-ab12C345DeF6",
"name": "Schmoogle Inc."
},
"external_id": "ext_id_from_another_system012345",
"family": {
"id": "cac-ab12C345DeF6",
"name": "Sumner Family"
},
"id": "creg-ab12C345DeF6",
"is_subscriber": true,
"type": "spouse"
}
],
"suffix": "Jr.",
"terms_accepted": false,
"terms_accepted_at": null,
"updated_at": null,
"uses_tobacco": false
}
{
"account": {
"name": "Name on the billing account",
"past_due_in_cents": "Amount past due in cents"
},
"address_city": "City of the patient's address",
"address_country": "Country of the patient's address",
"address_line1": "First line of the patient's address",
"address_line2": "Second line of the patient's address",
"address_state": "State of the patient's address",
"address_zip": "ZIP code of the patient's address",
"age": "Age of the patient",
"chosen_first_name": "Patient's chosen or preferred first name",
"chosen_last_name": "Patient's chosen or preferred last name",
"chosen_middle_name": "Patient's chosen or preferred middle name",
"chosen_suffix": "Patient's chosen or preferred suffix",
"chosen_title": "Patient's chosen or preferred title",
"company": {
"id": "Unique identifier for the company",
"name": "Name of the company"
},
"created_at": "Timestamp when the patient record was created",
"dob": "Patient's date of birth",
"electronic_communication_consent_accepted": "Whether the patient accepted electronic communication consent",
"electronic_communication_consent_accepted_at": "Timestamp when the patient accepted electronic communication consent",
"email": "Patient's email address",
"external_link_id": "External link identifier for the patient",
"external_records": {
"external_id": "External identifier in the source system",
"source": "Source system of the external record"
},
"first_name": "Patient's first name",
"gender": "Patient's gender",
"gender_identity": "Patient's gender identity",
"gender_other": "Patient's gender if not covered by standard options",
"health_insurance_group_id": "Health insurance group ID",
"health_insurance_member_id": "Health insurance member ID",
"health_insurance_payer_id": "Health insurance payer ID",
"health_insurance_payer_name": "Health insurance payer name",
"hipaa_authorization_accepted": "Whether the patient accepted the HIPAA authorization",
"hipaa_authorization_accepted_at": "Timestamp when the patient accepted the HIPAA authorization",
"id": "Unique identifier for the patient",
"import_id": "Import batch identifier",
"import_source": "Source system of the import",
"joined_practice_date": "Date the patient joined the practice",
"known_practice": {
"id": "Unique identifier for the known practice",
"name": "Name of the known practice"
},
"last_name": "Patient's last name",
"lead_source": {
"created_at": "Timestamp when the lead source was created",
"id": "Unique identifier for the lead source",
"name": "Name of the lead source",
"updated_at": "Timestamp when the lead source was last updated"
},
"lead_source_other": "Description of the lead source when 'Other' is selected",
"location": {
"address_city": "City of the location's address",
"address_country": "Country of the location's address",
"address_latitude": "Latitude of the location's address",
"address_line1": "First line of the location's address",
"address_line2": "Second line of the location's address",
"address_longitude": "Longitude of the location's address",
"address_state": "State of the location's address",
"address_zip": "ZIP code of the location's address",
"distance": "Distance from the patient to the location",
"id": "Unique identifier for the location",
"location_group": {
"created_at": "Timestamp when the location group was created",
"id": "Unique identifier for the location group",
"integration_record_id": "Integration record identifier for the location group",
"name": "Name of the location group",
"updated_at": "Timestamp when the location group was last updated"
},
"name": "Name of the location",
"phone_number": "Phone number of the location",
"virtual": "Whether the location is virtual"
},
"location_group": {
"created_at": "Timestamp when the location group was created",
"id": "Unique identifier for the location group",
"integration_record_id": "Integration record identifier for the location group",
"name": "Name of the location group",
"updated_at": "Timestamp when the location group was last updated"
},
"master_record_sponsor": "Master record sponsor identifier",
"membership_status": "Current membership status of the patient",
"memberships": {
"company": {
"id": "Unique identifier for the company",
"name": "Name of the company"
},
"division": {
"id": "Unique identifier for the division",
"name": "Name of the division"
},
"end_date": "End date of the membership",
"enrollment_requested_on": "Date when enrollment was requested",
"enrollment_status": "Current enrollment status",
"member_type": "Type of membership (e.g., employee, spouse, dependent)",
"payer": {
"id": "Unique identifier for the payer",
"name": "Name of the payer"
},
"plan": {
"id": "Unique identifier for the plan",
"name": "Name of the plan"
},
"start_date": "Start date of the membership",
"status": "Current status of the membership",
"uses_tobacco": "Whether the member uses tobacco"
},
"merged_into": {
"id": "Unique identifier of the patient record this was merged into",
"name": "Name of the patient record this was merged into"
},
"middle_name": "Patient's middle name",
"name": "Patient's full name",
"patient_agreement_accepted": "Whether the patient accepted the patient agreement",
"patient_agreement_accepted_at": "Timestamp when the patient accepted the patient agreement",
"phones": {
"number": "Phone number",
"type": "Type of phone number (e.g., mobile, home, work)"
},
"practitioner": {
"accepts_enrollments_from_employer": "Whether the practitioner accepts enrollments from employers",
"accepts_enrollments_from_retail": "Whether the practitioner accepts enrollments from retail",
"bio": "Practitioner's biography",
"created_at": "Timestamp when the practitioner record was created",
"education": "Practitioner's education background",
"email": "Practitioner's email address",
"gender": "Practitioner's gender",
"gender_other": "Practitioner's gender if not covered by standard options",
"id": "Unique identifier for the practitioner",
"integration_record_id": "Integration record identifier for the practitioner",
"locations": {
"address_city": "City of the location's address",
"address_country": "Country of the location's address",
"address_latitude": "Latitude of the location's address",
"address_line1": "First line of the location's address",
"address_line2": "Second line of the location's address",
"address_longitude": "Longitude of the location's address",
"address_state": "State of the location's address",
"address_zip": "ZIP code of the location's address",
"distance": "Distance from the patient to the location",
"id": "Unique identifier for the location",
"location_group": {
"created_at": "Timestamp when the location group was created",
"id": "Unique identifier for the location group",
"integration_record_id": "Integration record identifier for the location group",
"name": "Name of the location group",
"updated_at": "Timestamp when the location group was last updated"
},
"name": "Name of the location",
"phone_number": "Phone number of the location",
"virtual": "Whether the location is virtual"
},
"max_patient_age": "Maximum patient age the practitioner serves",
"min_patient_age": "Minimum patient age the practitioner serves",
"name": "Practitioner's full name",
"npi": {
"id": "NPI number",
"name": "Name associated with the NPI"
},
"online_signup_visibility": "Practitioner's visibility for online signup",
"panel_size": "Current number of patients in the practitioner's panel",
"panel_size_limit": "Maximum number of patients allowed in the practitioner's panel",
"photo_url": "URL to the practitioner's photo",
"specialties": {
"id": "Unique identifier for the specialty",
"name": "Name of the specialty"
},
"updated_at": "Timestamp when the practitioner record was last updated"
},
"practitioner_group": {
"created_at": "Timestamp when the practitioner group was created",
"id": "Unique identifier for the practitioner group",
"integration_record_id": "Integration record identifier for the practitioner group",
"name": "Name of the practitioner group",
"updated_at": "Timestamp when the practitioner group was last updated"
},
"preferred_language": "Patient's preferred language",
"pronouns": "Patient's preferred pronouns",
"provider_web_link": "URL link to the patient's profile in the provider portal",
"sex": "Patient's biological sex",
"sponsorships": {
"company": {
"id": "Unique identifier for the company",
"name": "Name of the company"
},
"external_id": "External identifier from another system",
"family": {
"id": "Unique identifier for the family",
"name": "Name of the family"
},
"id": "Unique identifier for the sponsorship",
"is_subscriber": "Whether this person is the subscriber",
"type": "Type of sponsorship (e.g., employee, spouse, dependent)"
},
"suffix": "Patient's name suffix",
"terms_accepted": "Whether the patient accepted the terms of service",
"terms_accepted_at": "Timestamp when the patient accepted the terms of service",
"updated_at": "Timestamp when the patient record was last updated",
"uses_tobacco": "Whether the patient uses tobacco"
}
Payload Field Details
Hide fields
Hide fields
Unique identifier for the patient
CEL
id
Example
"pat-ab12C345DeF6"
City of the patient’s address
CEL
address_city
Example
"New York"
Country of the patient’s address
CEL
address_country
Example
"United States"
First line of the patient’s address
CEL
address_line1
Example
"157 E Houston St"
Second line of the patient’s address
CEL
address_line2
Example
"Suite 2402"
State of the patient’s address
CEL
address_state
Example
"NY"
ZIP code of the patient’s address
CEL
address_zip
Example
"10002"
Age of the patient
CEL
age
Example
60
Patient’s chosen or preferred first name
CEL
chosen_first_name
Example
"Alex"
Patient’s chosen or preferred last name
CEL
chosen_last_name
Example
"Smith"
Patient’s chosen or preferred middle name
CEL
chosen_middle_name
Example
"Jordan"
Patient’s chosen or preferred suffix
CEL
chosen_suffix
Example
"Jr."
Patient’s chosen or preferred title
CEL
chosen_title
Example
"Dr."
Timestamp when the patient record was created
CEL
created_at
Example
null
Patient’s date of birth
CEL
dob
Example
null
Whether the patient accepted electronic communication consent
CEL
electronic_communication_consent_accepted
Example
true
Timestamp when the patient accepted electronic communication consent
CEL
electronic_communication_consent_accepted_at
Example
null
Patient’s email address
CEL
email
Example
"bass_man@bumblebeeinc.com"
External link identifier for the patient
CEL
external_link_id
Example
"ext-12345"
Patient’s first name
CEL
first_name
Example
"Gordon"
Patient’s gender
CEL
gender
Example
"male"
Patient’s gender identity
CEL
gender_identity
Example
"man"
Patient’s gender if not covered by standard options
CEL
gender_other
Example
"non-binary"
Health insurance group ID
CEL
health_insurance_group_id
Example
"12345"
Health insurance member ID
CEL
health_insurance_member_id
Example
"A22222222"
Health insurance payer ID
CEL
health_insurance_payer_id
Example
"00039"
Health insurance payer name
CEL
health_insurance_payer_name
Example
"Anthem Blue Cross California"
Whether the patient accepted the HIPAA authorization
CEL
hipaa_authorization_accepted
Example
true
Timestamp when the patient accepted the HIPAA authorization
CEL
hipaa_authorization_accepted_at
Example
null
Import batch identifier
CEL
import_id
Example
"imp-ab12C345DeF6"
Source system of the import
CEL
import_source
Example
"csv_upload"
Date the patient joined the practice
CEL
joined_practice_date
Example
null
Patient’s last name
CEL
last_name
Example
"Sumner"
Description of the lead source when ‘Other’ is selected
CEL
lead_source_other
Example
"Downtown marketing event"
Master record sponsor identifier
CEL
master_record_sponsor
Example
"creg-ab12C345DeF6"
Current membership status of the patient
CEL
membership_status
Example
"active"
Patient’s middle name
CEL
middle_name
Example
"Thomas"
Patient’s full name
CEL
name
Example
"Gordon Thomas Sumner"
Whether the patient accepted the patient agreement
CEL
patient_agreement_accepted
Example
false
Timestamp when the patient accepted the patient agreement
CEL
patient_agreement_accepted_at
Example
null
Patient’s preferred language
CEL
preferred_language
Example
"en"
Patient’s preferred pronouns
CEL
pronouns
Example
"he/him"
URL link to the patient’s profile in the provider portal
CEL
provider_web_link
Example
"https://app.hint.com/patients/pat-ab12C345DeF6"
Patient’s biological sex
CEL
sex
Example
"male"
Patient’s name suffix
CEL
suffix
Example
"Jr."
Whether the patient accepted the terms of service
CEL
terms_accepted
Example
false
Timestamp when the patient accepted the terms of service
CEL
terms_accepted_at
Example
null
Timestamp when the patient record was last updated
CEL
updated_at
Example
null
Whether the patient uses tobacco
CEL
uses_tobacco
Example
false
Patient’s billing account information
CEL
account
Example
{
"name": "Gordon Thomas Sumner",
"past_due_in_cents": 0
}
Name on the billing account
CEL
account.name
Example
"Gordon Thomas Sumner"
Amount past due in cents
CEL
account.past_due_in_cents
Example
0
Company associated with the patient
CEL
company
Example
{
"id": "com-ab12C345DeF6",
"name": "Schmoogle Inc."
}
Unique identifier for the company
CEL
company.id
Example
"com-ab12C345DeF6"
Name of the company
CEL
company.name
Example
"Schmoogle Inc."
External records linked to this patient
CEL
external_records
Example
[
{
"external_id": "ext-98765",
"source": "ehr_system"
}
]
Mapped array of: Source system of the external record
CEL
external_records.map(x, x.source)
Example
[
"ehr_system"
]
Mapped array of: External identifier in the source system
CEL
external_records.map(x, x.external_id)
Example
[
"ext-98765"
]
Known practice associated with the patient
CEL
known_practice
Example
{
"id": "prc-ab12C345DeF6",
"name": "Downtown Medical"
}
Unique identifier for the known practice
CEL
known_practice.id
Example
"prc-ab12C345DeF6"
Name of the known practice
CEL
known_practice.name
Example
"Downtown Medical"
Lead source that referred the patient
CEL
lead_source
Example
{
"created_at": null,
"id": "lds-ab12C345DeF6",
"name": "Other",
"updated_at": null
}
Unique identifier for the lead source
CEL
lead_source.id
Example
"lds-ab12C345DeF6"
Name of the lead source
CEL
lead_source.name
Example
"Other"
Timestamp when the lead source was created
CEL
lead_source.created_at
Example
null
Timestamp when the lead source was last updated
CEL
lead_source.updated_at
Example
null
Primary location assigned to the patient
CEL
location
Example
{
"address_city": "New York",
"address_country": "United States",
"address_latitude": "40.7227998",
"address_line1": "157 E Houston St",
"address_line2": "Suite 2402",
"address_longitude": "-73.9892241",
"address_state": "NY",
"address_zip": "10002",
"distance": "5.2 miles",
"id": "loc-ab12C345DeF6",
"location_group": {
"created_at": null,
"id": "prg-ab12C345DeF6",
"integration_record_id": "int-ab12C345DeF6",
"name": "Downtown Location Group",
"updated_at": null
},
"name": "San Francisco HQ",
"phone_number": "+15551234567",
"virtual": false
}
Unique identifier for the location
CEL
location.id
Example
"loc-ab12C345DeF6"
City of the location’s address
CEL
location.address_city
Example
"New York"
Country of the location’s address
CEL
location.address_country
Example
"United States"
Latitude of the location’s address
CEL
location.address_latitude
Example
"40.7227998"
First line of the location’s address
CEL
location.address_line1
Example
"157 E Houston St"
Second line of the location’s address
CEL
location.address_line2
Example
"Suite 2402"
Longitude of the location’s address
CEL
location.address_longitude
Example
"-73.9892241"
State of the location’s address
CEL
location.address_state
Example
"NY"
ZIP code of the location’s address
CEL
location.address_zip
Example
"10002"
Distance from the patient to the location
CEL
location.distance
Example
"5.2 miles"
Name of the location
CEL
location.name
Example
"San Francisco HQ"
Phone number of the location
CEL
location.phone_number
Example
"+15551234567"
Whether the location is virtual
CEL
location.virtual
Example
false
Location group this location belongs to
CEL
location.location_group
Example
{
"created_at": null,
"id": "prg-ab12C345DeF6",
"integration_record_id": "int-ab12C345DeF6",
"name": "Downtown Location Group",
"updated_at": null
}
Unique identifier for the location group
CEL
location.location_group.id
Example
"prg-ab12C345DeF6"
Timestamp when the location group was created
CEL
location.location_group.created_at
Example
null
Integration record identifier for the location group
CEL
location.location_group.integration_record_id
Example
"int-ab12C345DeF6"
Name of the location group
CEL
location.location_group.name
Example
"Downtown Location Group"
Timestamp when the location group was last updated
CEL
location.location_group.updated_at
Example
null
Location group assigned to the patient
CEL
location_group
Example
{
"created_at": null,
"id": "prg-ab12C345DeF6",
"integration_record_id": "int-ab12C345DeF6",
"name": "Downtown Location Group",
"updated_at": null
}
Unique identifier for the location group
CEL
location_group.id
Example
"prg-ab12C345DeF6"
Timestamp when the location group was created
CEL
location_group.created_at
Example
null
Integration record identifier for the location group
CEL
location_group.integration_record_id
Example
"int-ab12C345DeF6"
Name of the location group
CEL
location_group.name
Example
"Downtown Location Group"
Timestamp when the location group was last updated
CEL
location_group.updated_at
Example
null
Patient’s membership enrollments
CEL
memberships
Example
[
{
"company": {
"id": "com-ab12C345DeF6",
"name": "Schmoogle Inc."
},
"division": {
"id": "div-ab12C345DeF6",
"name": "division 20"
},
"end_date": null,
"enrollment_requested_on": null,
"enrollment_status": "active",
"member_type": "spouse",
"payer": {
"id": "pat-ab12C345DeF6",
"name": "Gordon Thomas Sumner"
},
"plan": {
"id": "pln-ab12C345DeF6",
"name": "Membership"
},
"start_date": null,
"status": "active",
"uses_tobacco": false
}
]
Mapped array of: End date of the membership
CEL
memberships.map(x, x.end_date)
Example
[
null
]
Mapped array of: Date when enrollment was requested
CEL
memberships.map(x, x.enrollment_requested_on)
Example
[
null
]
Mapped array of: Current enrollment status
CEL
memberships.map(x, x.enrollment_status)
Example
[
"active"
]
Mapped array of: Type of membership (e.g., employee, spouse, dependent)
CEL
memberships.map(x, x.member_type)
Example
[
"spouse"
]
Mapped array of: Start date of the membership
CEL
memberships.map(x, x.start_date)
Example
[
null
]
Mapped array of: Current status of the membership
CEL
memberships.map(x, x.status)
Example
[
"active"
]
Mapped array of: Whether the member uses tobacco
CEL
memberships.map(x, x.uses_tobacco)
Example
[
false
]
Mapped array of: Company associated with the membership
CEL
memberships.map(x, x.company)
Example
[
{
"id": "com-ab12C345DeF6",
"name": "Schmoogle Inc."
}
]
Mapped array of: Division within the company
CEL
memberships.map(x, x.division)
Example
[
{
"id": "div-ab12C345DeF6",
"name": "division 20"
}
]
Mapped array of: Payer responsible for the membership
CEL
memberships.map(x, x.payer)
Example
[
{
"id": "pat-ab12C345DeF6",
"name": "Gordon Thomas Sumner"
}
]
Mapped array of: Plan associated with the membership
CEL
memberships.map(x, x.plan)
Example
[
{
"id": "pln-ab12C345DeF6",
"name": "Membership"
}
]
Patient record this patient was merged into
CEL
merged_into
Example
{
"id": "pat-zz99Y888XwV7",
"name": "Gordon Thomas Sumner"
}
Unique identifier of the patient record this was merged into
CEL
merged_into.id
Example
"pat-zz99Y888XwV7"
Name of the patient record this was merged into
CEL
merged_into.name
Example
"Gordon Thomas Sumner"
Phone numbers associated with the patient
CEL
phones
Example
[
{
"number": "+15553050051",
"type": "mobile"
}
]
Mapped array of: Phone number
CEL
phones.map(x, x.number)
Example
[
"+15553050051"
]
Mapped array of: Type of phone number (e.g., mobile, home, work)
CEL
phones.map(x, x.type)
Example
[
"mobile"
]
Primary practitioner assigned to the patient
CEL
practitioner
Example
{
"accepts_enrollments_from_employer": "yes",
"accepts_enrollments_from_retail": "yes",
"bio": "Board-certified family medicine physician with 15 years of experience.",
"created_at": null,
"education": "MD, Johns Hopkins University",
"email": "dr.smith@practice.com",
"gender": "female",
"gender_other": "non-binary",
"id": "doc-ab12C345DeF6",
"integration_record_id": "int-ab12C345DeF6",
"locations": [
{
"address_city": "New York",
"address_country": "United States",
"address_latitude": "40.7227998",
"address_line1": "157 E Houston St",
"address_line2": "Suite 2402",
"address_longitude": "-73.9892241",
"address_state": "NY",
"address_zip": "10002",
"distance": "5.2 miles",
"id": "loc-ab12C345DeF6",
"location_group": {
"created_at": null,
"id": "prg-ab12C345DeF6",
"integration_record_id": "int-ab12C345DeF6",
"name": "Downtown Location Group",
"updated_at": null
},
"name": "San Francisco HQ",
"phone_number": "+15551234567",
"virtual": false
}
],
"max_patient_age": "65",
"min_patient_age": "18",
"name": "Dr. Jane Smith",
"npi": {
"id": "1234567890",
"name": "Dr. Jane Smith"
},
"online_signup_visibility": "visible",
"panel_size": 250,
"panel_size_limit": 500,
"photo_url": "https://app.hint.com/photos/doc-ab12C345DeF6.jpg",
"specialties": [
{
"id": "spc-ab12C345DeF6",
"name": "Family Medicine"
}
],
"updated_at": null
}
Unique identifier for the practitioner
CEL
practitioner.id
Example
"doc-ab12C345DeF6"
Whether the practitioner accepts enrollments from employers
CEL
practitioner.accepts_enrollments_from_employer
Example
"yes"
Whether the practitioner accepts enrollments from retail
CEL
practitioner.accepts_enrollments_from_retail
Example
"yes"
Practitioner’s biography
CEL
practitioner.bio
Example
"Board-certified family medicine physician with 15 years of experience."
Timestamp when the practitioner record was created
CEL
practitioner.created_at
Example
null
Practitioner’s education background
CEL
practitioner.education
Example
"MD, Johns Hopkins University"
Practitioner’s email address
CEL
practitioner.email
Example
"dr.smith@practice.com"
Practitioner’s gender
CEL
practitioner.gender
Example
"female"
Practitioner’s gender if not covered by standard options
CEL
practitioner.gender_other
Example
"non-binary"
Integration record identifier for the practitioner
CEL
practitioner.integration_record_id
Example
"int-ab12C345DeF6"
Maximum patient age the practitioner serves
CEL
practitioner.max_patient_age
Example
"65"
Minimum patient age the practitioner serves
CEL
practitioner.min_patient_age
Example
"18"
Practitioner’s full name
CEL
practitioner.name
Example
"Dr. Jane Smith"
Practitioner’s visibility for online signup
CEL
practitioner.online_signup_visibility
Example
"visible"
Current number of patients in the practitioner’s panel
CEL
practitioner.panel_size
Example
250
Maximum number of patients allowed in the practitioner’s panel
CEL
practitioner.panel_size_limit
Example
500
URL to the practitioner’s photo
CEL
practitioner.photo_url
Example
"https://app.hint.com/photos/doc-ab12C345DeF6.jpg"
Timestamp when the practitioner record was last updated
CEL
practitioner.updated_at
Example
null
Locations where the practitioner practices
CEL
practitioner.locations
Example
[
{
"address_city": "New York",
"address_country": "United States",
"address_latitude": "40.7227998",
"address_line1": "157 E Houston St",
"address_line2": "Suite 2402",
"address_longitude": "-73.9892241",
"address_state": "NY",
"address_zip": "10002",
"distance": "5.2 miles",
"id": "loc-ab12C345DeF6",
"location_group": {
"created_at": null,
"id": "prg-ab12C345DeF6",
"integration_record_id": "int-ab12C345DeF6",
"name": "Downtown Location Group",
"updated_at": null
},
"name": "San Francisco HQ",
"phone_number": "+15551234567",
"virtual": false
}
]
Mapped array of: Unique identifier for the location
CEL
practitioner.locations.map(x, x.id)
Example
[
"loc-ab12C345DeF6"
]
Mapped array of: City of the location’s address
CEL
practitioner.locations.map(x, x.address_city)
Example
[
"New York"
]
Mapped array of: Country of the location’s address
CEL
practitioner.locations.map(x, x.address_country)
Example
[
"United States"
]
Mapped array of: Latitude of the location’s address
CEL
practitioner.locations.map(x, x.address_latitude)
Example
[
"40.7227998"
]
Mapped array of: First line of the location’s address
CEL
practitioner.locations.map(x, x.address_line1)
Example
[
"157 E Houston St"
]
Mapped array of: Second line of the location’s address
CEL
practitioner.locations.map(x, x.address_line2)
Example
[
"Suite 2402"
]
Mapped array of: Longitude of the location’s address
CEL
practitioner.locations.map(x, x.address_longitude)
Example
[
"-73.9892241"
]
Mapped array of: State of the location’s address
CEL
practitioner.locations.map(x, x.address_state)
Example
[
"NY"
]
Mapped array of: ZIP code of the location’s address
CEL
practitioner.locations.map(x, x.address_zip)
Example
[
"10002"
]
Mapped array of: Distance from the patient to the location
CEL
practitioner.locations.map(x, x.distance)
Example
[
"5.2 miles"
]
Mapped array of: Name of the location
CEL
practitioner.locations.map(x, x.name)
Example
[
"San Francisco HQ"
]
Mapped array of: Phone number of the location
CEL
practitioner.locations.map(x, x.phone_number)
Example
[
"+15551234567"
]
Mapped array of: Whether the location is virtual
CEL
practitioner.locations.map(x, x.virtual)
Example
[
false
]
Mapped array of: Location group this location belongs to
CEL
practitioner.locations.map(x, x.location_group)
Example
[
{
"created_at": null,
"id": "prg-ab12C345DeF6",
"integration_record_id": "int-ab12C345DeF6",
"name": "Downtown Location Group",
"updated_at": null
}
]
National Provider Identifier for the practitioner
CEL
practitioner.npi
Example
{
"id": "1234567890",
"name": "Dr. Jane Smith"
}
NPI number
CEL
practitioner.npi.id
Example
"1234567890"
Name associated with the NPI
CEL
practitioner.npi.name
Example
"Dr. Jane Smith"
Practitioner’s specialties
CEL
practitioner.specialties
Example
[
{
"id": "spc-ab12C345DeF6",
"name": "Family Medicine"
}
]
Mapped array of: Unique identifier for the specialty
CEL
practitioner.specialties.map(x, x.id)
Example
[
"spc-ab12C345DeF6"
]
Mapped array of: Name of the specialty
CEL
practitioner.specialties.map(x, x.name)
Example
[
"Family Medicine"
]
Practitioner group assigned to the patient
CEL
practitioner_group
Example
{
"created_at": null,
"id": "prg-ab12C345DeF6",
"integration_record_id": "int-ab12C345DeF6",
"name": "Downtown Location Group",
"updated_at": null
}
Unique identifier for the practitioner group
CEL
practitioner_group.id
Example
"prg-ab12C345DeF6"
Timestamp when the practitioner group was created
CEL
practitioner_group.created_at
Example
null
Integration record identifier for the practitioner group
CEL
practitioner_group.integration_record_id
Example
"int-ab12C345DeF6"
Name of the practitioner group
CEL
practitioner_group.name
Example
"Downtown Location Group"
Timestamp when the practitioner group was last updated
CEL
practitioner_group.updated_at
Example
null
Sponsorships associated with the patient
CEL
sponsorships
Example
[
{
"company": {
"id": "com-ab12C345DeF6",
"name": "Schmoogle Inc."
},
"external_id": "ext_id_from_another_system012345",
"family": {
"id": "cac-ab12C345DeF6",
"name": "Sumner Family"
},
"id": "creg-ab12C345DeF6",
"is_subscriber": true,
"type": "spouse"
}
]
Mapped array of: Unique identifier for the sponsorship
CEL
sponsorships.map(x, x.id)
Example
[
"creg-ab12C345DeF6"
]
Mapped array of: External identifier from another system
CEL
sponsorships.map(x, x.external_id)
Example
[
"ext_id_from_another_system012345"
]
Mapped array of: Whether this person is the subscriber
CEL
sponsorships.map(x, x.is_subscriber)
Example
[
true
]
Mapped array of: Type of sponsorship (e.g., employee, spouse, dependent)
CEL
sponsorships.map(x, x.type)
Example
[
"spouse"
]
Mapped array of: Company associated with the sponsorship
CEL
sponsorships.map(x, x.company)
Example
[
{
"id": "com-ab12C345DeF6",
"name": "Schmoogle Inc."
}
]
Mapped array of: Family associated with the sponsorship
CEL
sponsorships.map(x, x.family)
Example
[
{
"id": "cac-ab12C345DeF6",
"name": "Sumner Family"
}
]
