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 Membership event payload from Hint Health.Hint Health Membership CreatedHint Health Membership UpdatedHint Health Membership Destroyed
{
"bill_date": null,
"billed_through_date": null,
"billing_start_date": null,
"bills_at_end_of_period": false,
"contract_expiration_action": "auto-renew",
"contract_expires": true,
"contract_period_in_months": 12,
"coupon": {
"amount_off_in_cents": 1000,
"apply_to_each_patient": true,
"code": "SAVE20",
"created_at": null,
"description": "20% off first 3 months",
"duration_in_months": 3,
"id": "cpn-ab12C345DeF6",
"is_archived": false,
"is_redeemable": true,
"percent_off": 20,
"redeemable_from": null,
"redeemable_until": null,
"updated_at": null
},
"created_at": null,
"end_date": null,
"enrollment_status": "active",
"fixed_period_rate_in_cents": 6000,
"fixed_registration_fee_in_cents": 2500,
"group_code": "GRP-001",
"id": "mem-ab12C345DeF6",
"is_confirmed": true,
"is_current": true,
"is_processing": false,
"is_restartable": false,
"list_price_in_cents": 5000,
"membership_patients": [
{
"end_date": null,
"fixed_period_rate_in_cents": 6000,
"id": "mp-ab12C345DeF6",
"list_price_in_cents": 5000,
"member_type": "spouse",
"patient": {
"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
},
"period_rate_in_cents": 5000,
"revenue_in_cents": 5000,
"start_date": null,
"uses_tobacco": false
}
],
"next_bill_date": null,
"owner": {
"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
},
"period_in_months": 1,
"period_rate_in_cents": 5000,
"plan": {
"id": "pln-ab12C345DeF6",
"name": "Membership",
"plan_type": "retail"
},
"rate_in_cents": 5000,
"source_status": "active",
"sponsorship": {
"company": {
"id": "com-ab12C345DeF6",
"name": "Schmoogle Inc."
},
"id": "spon-ab12C345DeF6"
},
"start_date": null,
"status": "unpaid",
"upcoming_bills": [
{
"amount_in_cents": 5000,
"charges_amount_in_cents": 0,
"coupon_discount_in_cents": 0,
"coupon_discount_months": 3,
"coupon_percent_off": 20,
"customer_invoice": {
"id": "inv-ab12C345DeF6"
},
"date": null,
"end_date": null,
"list_price_in_cents": 5000,
"membership_amount_in_cents": 5000,
"period_in_months": 1,
"rate_in_cents": 5000,
"registration_fee_in_cents": 2500,
"start_date": null
}
],
"updated_at": null
}
{
"bill_date": "Date when the membership is billed",
"billed_through_date": "Date through which the membership has been billed",
"billing_start_date": "Date when billing started for the membership",
"bills_at_end_of_period": "Whether the membership bills at the end of the billing period",
"contract_expiration_action": "Action taken when the contract expires",
"contract_expires": "Whether the membership contract expires",
"contract_period_in_months": "Length of the contract period in months",
"coupon": {
"amount_off_in_cents": "Amount off in cents",
"apply_to_each_patient": "Whether the coupon applies to each patient on the membership",
"code": "Coupon code",
"created_at": "Timestamp when the coupon was created",
"description": "Description of the coupon",
"duration_in_months": "Duration of the coupon in months",
"id": "Unique identifier for the coupon",
"is_archived": "Whether the coupon is archived",
"is_redeemable": "Whether the coupon is redeemable",
"percent_off": "Percentage off provided by the coupon",
"redeemable_from": "Start date from which the coupon is redeemable",
"redeemable_until": "End date until which the coupon is redeemable",
"updated_at": "Timestamp when the coupon was last updated"
},
"created_at": "Timestamp when the membership was created",
"end_date": "End date of the membership",
"enrollment_status": "Current enrollment status of the membership",
"fixed_period_rate_in_cents": "Fixed period rate in cents",
"fixed_registration_fee_in_cents": "Fixed registration fee in cents",
"group_code": "Group code associated with the membership",
"id": "Unique identifier for the membership",
"is_confirmed": "Whether the membership is confirmed",
"is_current": "Whether the membership is currently active",
"is_processing": "Whether the membership is being processed",
"is_restartable": "Whether the membership can be restarted",
"list_price_in_cents": "List price of the membership in cents",
"membership_patients": {
"end_date": "End date for this patient on the membership",
"fixed_period_rate_in_cents": "Fixed period rate in cents for this patient",
"id": "Unique identifier for the membership patient",
"list_price_in_cents": "List price in cents for this patient",
"member_type": "Type of member (e.g., primary, spouse, dependent)",
"patient": {
"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"
},
"period_rate_in_cents": "Rate per billing period in cents for this patient",
"revenue_in_cents": "Revenue in cents for this patient",
"start_date": "Start date for this patient on the membership",
"uses_tobacco": "Whether the patient uses tobacco"
},
"next_bill_date": "Date of the next bill",
"owner": {
"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"
},
"period_in_months": "Billing period length in months",
"period_rate_in_cents": "Rate per billing period in cents",
"plan": {
"id": "Unique identifier for the plan",
"name": "Name of the plan",
"plan_type": "Type of plan (e.g., retail, employer)"
},
"rate_in_cents": "Rate in cents for the membership",
"source_status": "Status from the source system",
"sponsorship": {
"company": {
"id": "Unique identifier for the sponsor company",
"name": "Name of the sponsor company"
},
"id": "Unique identifier for the sponsorship"
},
"start_date": "Start date of the membership",
"status": "Current status of the membership",
"upcoming_bills": {
"amount_in_cents": "Total amount of the upcoming bill in cents",
"charges_amount_in_cents": "Charges amount in cents",
"coupon_discount_in_cents": "Coupon discount amount in cents",
"coupon_discount_months": "Number of months the coupon discount applies",
"coupon_percent_off": "Percentage off from the coupon",
"customer_invoice": {
"id": "Unique identifier for the invoice"
},
"date": "Date of the upcoming bill",
"end_date": "End date of the billing period",
"list_price_in_cents": "List price in cents",
"membership_amount_in_cents": "Membership amount in cents",
"period_in_months": "Billing period length in months",
"rate_in_cents": "Rate in cents",
"registration_fee_in_cents": "Registration fee in cents",
"start_date": "Start date of the billing period"
},
"updated_at": "Timestamp when the membership was last updated"
}
Payload Field Details
Hide fields
Hide fields
Unique identifier for the membership
CEL
id
Example
"mem-ab12C345DeF6"
Date when the membership is billed
CEL
bill_date
Example
null
Date through which the membership has been billed
CEL
billed_through_date
Example
null
Date when billing started for the membership
CEL
billing_start_date
Example
null
Whether the membership bills at the end of the billing period
CEL
bills_at_end_of_period
Example
false
Action taken when the contract expires
CEL
contract_expiration_action
Example
"auto-renew"
Whether the membership contract expires
CEL
contract_expires
Example
true
Length of the contract period in months
CEL
contract_period_in_months
Example
12
Timestamp when the membership was created
CEL
created_at
Example
null
End date of the membership
CEL
end_date
Example
null
Current enrollment status of the membership
CEL
enrollment_status
Example
"active"
Fixed period rate in cents
CEL
fixed_period_rate_in_cents
Example
6000
Fixed registration fee in cents
CEL
fixed_registration_fee_in_cents
Example
2500
Group code associated with the membership
CEL
group_code
Example
"GRP-001"
Whether the membership is confirmed
CEL
is_confirmed
Example
true
Whether the membership is currently active
CEL
is_current
Example
true
Whether the membership is being processed
CEL
is_processing
Example
false
Whether the membership can be restarted
CEL
is_restartable
Example
false
List price of the membership in cents
CEL
list_price_in_cents
Example
5000
Date of the next bill
CEL
next_bill_date
Example
null
Billing period length in months
CEL
period_in_months
Example
1
Rate per billing period in cents
CEL
period_rate_in_cents
Example
5000
Rate in cents for the membership
CEL
rate_in_cents
Example
5000
Status from the source system
CEL
source_status
Example
"active"
Start date of the membership
CEL
start_date
Example
null
Current status of the membership
CEL
status
Example
"unpaid"
Timestamp when the membership was last updated
CEL
updated_at
Example
null
Coupon applied to the membership
CEL
coupon
Example
{
"amount_off_in_cents": 1000,
"apply_to_each_patient": true,
"code": "SAVE20",
"created_at": null,
"description": "20% off first 3 months",
"duration_in_months": 3,
"id": "cpn-ab12C345DeF6",
"is_archived": false,
"is_redeemable": true,
"percent_off": 20,
"redeemable_from": null,
"redeemable_until": null,
"updated_at": null
}
Unique identifier for the coupon
CEL
coupon.id
Example
"cpn-ab12C345DeF6"
Coupon code
CEL
coupon.code
Example
"SAVE20"
Description of the coupon
CEL
coupon.description
Example
"20% off first 3 months"
Amount off in cents
CEL
coupon.amount_off_in_cents
Example
1000
Whether the coupon applies to each patient on the membership
CEL
coupon.apply_to_each_patient
Example
true
Timestamp when the coupon was created
CEL
coupon.created_at
Example
null
Duration of the coupon in months
CEL
coupon.duration_in_months
Example
3
Percentage off provided by the coupon
CEL
coupon.percent_off
Example
20
Timestamp when the coupon was last updated
CEL
coupon.updated_at
Example
null
Whether the coupon is redeemable
CEL
coupon.is_redeemable
Example
true
Whether the coupon is archived
CEL
coupon.is_archived
Example
false
Start date from which the coupon is redeemable
CEL
coupon.redeemable_from
Example
null
End date until which the coupon is redeemable
CEL
coupon.redeemable_until
Example
null
Patients associated with the membership
CEL
membership_patients
Example
[
{
"end_date": null,
"fixed_period_rate_in_cents": 6000,
"id": "mp-ab12C345DeF6",
"list_price_in_cents": 5000,
"member_type": "spouse",
"patient": {
"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
},
"period_rate_in_cents": 5000,
"revenue_in_cents": 5000,
"start_date": null,
"uses_tobacco": false
}
]
Mapped array of: Unique identifier for the membership patient
CEL
membership_patients.map(x, x.id)
Example
[
"mp-ab12C345DeF6"
]
Mapped array of: Type of member (e.g., primary, spouse, dependent)
CEL
membership_patients.map(x, x.member_type)
Example
[
"spouse"
]
Mapped array of: Fixed period rate in cents for this patient
CEL
membership_patients.map(x, x.fixed_period_rate_in_cents)
Example
[
6000
]
Mapped array of: List price in cents for this patient
CEL
membership_patients.map(x, x.list_price_in_cents)
Example
[
5000
]
Mapped array of: Rate per billing period in cents for this patient
CEL
membership_patients.map(x, x.period_rate_in_cents)
Example
[
5000
]
Mapped array of: Revenue in cents for this patient
CEL
membership_patients.map(x, x.revenue_in_cents)
Example
[
5000
]
Mapped array of: Start date for this patient on the membership
CEL
membership_patients.map(x, x.start_date)
Example
[
null
]
Mapped array of: Whether the patient uses tobacco
CEL
membership_patients.map(x, x.uses_tobacco)
Example
[
false
]
Mapped array of: End date for this patient on the membership
CEL
membership_patients.map(x, x.end_date)
Example
[
null
]
Mapped array of: Patient associated with this membership
CEL
membership_patients.map(x, x.patient)
Example
[
{
"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
}
]
Patient who owns the membership
CEL
owner
Example
{
"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
}
Unique identifier for the patient
CEL
owner.id
Example
"pat-ab12C345DeF6"
City of the patient’s address
CEL
owner.address_city
Example
"New York"
Country of the patient’s address
CEL
owner.address_country
Example
"United States"
First line of the patient’s address
CEL
owner.address_line1
Example
"157 E Houston St"
Second line of the patient’s address
CEL
owner.address_line2
Example
"Suite 2402"
State of the patient’s address
CEL
owner.address_state
Example
"NY"
ZIP code of the patient’s address
CEL
owner.address_zip
Example
"10002"
Age of the patient
CEL
owner.age
Example
60
Patient’s chosen or preferred first name
CEL
owner.chosen_first_name
Example
"Alex"
Patient’s chosen or preferred last name
CEL
owner.chosen_last_name
Example
"Smith"
Patient’s chosen or preferred middle name
CEL
owner.chosen_middle_name
Example
"Jordan"
Patient’s chosen or preferred suffix
CEL
owner.chosen_suffix
Example
"Jr."
Patient’s chosen or preferred title
CEL
owner.chosen_title
Example
"Dr."
Timestamp when the patient record was created
CEL
owner.created_at
Example
null
Patient’s date of birth
CEL
owner.dob
Example
null
Whether the patient accepted electronic communication consent
CEL
owner.electronic_communication_consent_accepted
Example
true
Timestamp when the patient accepted electronic communication consent
CEL
owner.electronic_communication_consent_accepted_at
Example
null
Patient’s email address
CEL
owner.email
Example
"bass_man@bumblebeeinc.com"
External link identifier for the patient
CEL
owner.external_link_id
Example
"ext-12345"
Patient’s first name
CEL
owner.first_name
Example
"Gordon"
Patient’s gender
CEL
owner.gender
Example
"male"
Patient’s gender identity
CEL
owner.gender_identity
Example
"man"
Patient’s gender if not covered by standard options
CEL
owner.gender_other
Example
"non-binary"
Health insurance group ID
CEL
owner.health_insurance_group_id
Example
"12345"
Health insurance member ID
CEL
owner.health_insurance_member_id
Example
"A22222222"
Health insurance payer ID
CEL
owner.health_insurance_payer_id
Example
"00039"
Health insurance payer name
CEL
owner.health_insurance_payer_name
Example
"Anthem Blue Cross California"
Whether the patient accepted the HIPAA authorization
CEL
owner.hipaa_authorization_accepted
Example
true
Timestamp when the patient accepted the HIPAA authorization
CEL
owner.hipaa_authorization_accepted_at
Example
null
Import batch identifier
CEL
owner.import_id
Example
"imp-ab12C345DeF6"
Source system of the import
CEL
owner.import_source
Example
"csv_upload"
Date the patient joined the practice
CEL
owner.joined_practice_date
Example
null
Patient’s last name
CEL
owner.last_name
Example
"Sumner"
Description of the lead source when ‘Other’ is selected
CEL
owner.lead_source_other
Example
"Downtown marketing event"
Master record sponsor identifier
CEL
owner.master_record_sponsor
Example
"creg-ab12C345DeF6"
Current membership status of the patient
CEL
owner.membership_status
Example
"active"
Patient’s middle name
CEL
owner.middle_name
Example
"Thomas"
Patient’s full name
CEL
owner.name
Example
"Gordon Thomas Sumner"
Whether the patient accepted the patient agreement
CEL
owner.patient_agreement_accepted
Example
false
Timestamp when the patient accepted the patient agreement
CEL
owner.patient_agreement_accepted_at
Example
null
Patient’s preferred language
CEL
owner.preferred_language
Example
"en"
Patient’s preferred pronouns
CEL
owner.pronouns
Example
"he/him"
URL link to the patient’s profile in the provider portal
CEL
owner.provider_web_link
Example
"https://app.hint.com/patients/pat-ab12C345DeF6"
Patient’s biological sex
CEL
owner.sex
Example
"male"
Patient’s name suffix
CEL
owner.suffix
Example
"Jr."
Whether the patient accepted the terms of service
CEL
owner.terms_accepted
Example
false
Timestamp when the patient accepted the terms of service
CEL
owner.terms_accepted_at
Example
null
Timestamp when the patient record was last updated
CEL
owner.updated_at
Example
null
Whether the patient uses tobacco
CEL
owner.uses_tobacco
Example
false
Patient’s billing account information
CEL
owner.account
Example
{
"name": "Gordon Thomas Sumner",
"past_due_in_cents": 0
}
Name on the billing account
CEL
owner.account.name
Example
"Gordon Thomas Sumner"
Amount past due in cents
CEL
owner.account.past_due_in_cents
Example
0
Company associated with the patient
CEL
owner.company
Example
{
"id": "com-ab12C345DeF6",
"name": "Schmoogle Inc."
}
Unique identifier for the company
CEL
owner.company.id
Example
"com-ab12C345DeF6"
Name of the company
CEL
owner.company.name
Example
"Schmoogle Inc."
External records linked to this patient
CEL
owner.external_records
Example
[
{
"external_id": "ext-98765",
"source": "ehr_system"
}
]
Mapped array of: Source system of the external record
CEL
owner.external_records.map(x, x.source)
Example
[
"ehr_system"
]
Mapped array of: External identifier in the source system
CEL
owner.external_records.map(x, x.external_id)
Example
[
"ext-98765"
]
Known practice associated with the patient
CEL
owner.known_practice
Example
{
"id": "prc-ab12C345DeF6",
"name": "Downtown Medical"
}
Unique identifier for the known practice
CEL
owner.known_practice.id
Example
"prc-ab12C345DeF6"
Name of the known practice
CEL
owner.known_practice.name
Example
"Downtown Medical"
Lead source that referred the patient
CEL
owner.lead_source
Example
{
"created_at": null,
"id": "lds-ab12C345DeF6",
"name": "Other",
"updated_at": null
}
Unique identifier for the lead source
CEL
owner.lead_source.id
Example
"lds-ab12C345DeF6"
Name of the lead source
CEL
owner.lead_source.name
Example
"Other"
Timestamp when the lead source was created
CEL
owner.lead_source.created_at
Example
null
Timestamp when the lead source was last updated
CEL
owner.lead_source.updated_at
Example
null
Primary location assigned to the patient
CEL
owner.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
owner.location.id
Example
"loc-ab12C345DeF6"
City of the location’s address
CEL
owner.location.address_city
Example
"New York"
Country of the location’s address
CEL
owner.location.address_country
Example
"United States"
Latitude of the location’s address
CEL
owner.location.address_latitude
Example
"40.7227998"
First line of the location’s address
CEL
owner.location.address_line1
Example
"157 E Houston St"
Second line of the location’s address
CEL
owner.location.address_line2
Example
"Suite 2402"
Longitude of the location’s address
CEL
owner.location.address_longitude
Example
"-73.9892241"
State of the location’s address
CEL
owner.location.address_state
Example
"NY"
ZIP code of the location’s address
CEL
owner.location.address_zip
Example
"10002"
Distance from the patient to the location
CEL
owner.location.distance
Example
"5.2 miles"
Name of the location
CEL
owner.location.name
Example
"San Francisco HQ"
Phone number of the location
CEL
owner.location.phone_number
Example
"+15551234567"
Whether the location is virtual
CEL
owner.location.virtual
Example
false
Location group this location belongs to
CEL
owner.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
owner.location.location_group.id
Example
"prg-ab12C345DeF6"
Timestamp when the location group was created
CEL
owner.location.location_group.created_at
Example
null
Integration record identifier for the location group
CEL
owner.location.location_group.integration_record_id
Example
"int-ab12C345DeF6"
Name of the location group
CEL
owner.location.location_group.name
Example
"Downtown Location Group"
Timestamp when the location group was last updated
CEL
owner.location.location_group.updated_at
Example
null
Location group assigned to the patient
CEL
owner.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
owner.location_group.id
Example
"prg-ab12C345DeF6"
Timestamp when the location group was created
CEL
owner.location_group.created_at
Example
null
Integration record identifier for the location group
CEL
owner.location_group.integration_record_id
Example
"int-ab12C345DeF6"
Name of the location group
CEL
owner.location_group.name
Example
"Downtown Location Group"
Timestamp when the location group was last updated
CEL
owner.location_group.updated_at
Example
null
Patient’s membership enrollments
CEL
owner.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
owner.memberships.map(x, x.end_date)
Example
[
null
]
Mapped array of: Date when enrollment was requested
CEL
owner.memberships.map(x, x.enrollment_requested_on)
Example
[
null
]
Mapped array of: Current enrollment status
CEL
owner.memberships.map(x, x.enrollment_status)
Example
[
"active"
]
Mapped array of: Type of membership (e.g., employee, spouse, dependent)
CEL
owner.memberships.map(x, x.member_type)
Example
[
"spouse"
]
Mapped array of: Start date of the membership
CEL
owner.memberships.map(x, x.start_date)
Example
[
null
]
Mapped array of: Current status of the membership
CEL
owner.memberships.map(x, x.status)
Example
[
"active"
]
Mapped array of: Whether the member uses tobacco
CEL
owner.memberships.map(x, x.uses_tobacco)
Example
[
false
]
Mapped array of: Company associated with the membership
CEL
owner.memberships.map(x, x.company)
Example
[
{
"id": "com-ab12C345DeF6",
"name": "Schmoogle Inc."
}
]
Mapped array of: Division within the company
CEL
owner.memberships.map(x, x.division)
Example
[
{
"id": "div-ab12C345DeF6",
"name": "division 20"
}
]
Mapped array of: Payer responsible for the membership
CEL
owner.memberships.map(x, x.payer)
Example
[
{
"id": "pat-ab12C345DeF6",
"name": "Gordon Thomas Sumner"
}
]
Mapped array of: Plan associated with the membership
CEL
owner.memberships.map(x, x.plan)
Example
[
{
"id": "pln-ab12C345DeF6",
"name": "Membership"
}
]
Patient record this patient was merged into
CEL
owner.merged_into
Example
{
"id": "pat-zz99Y888XwV7",
"name": "Gordon Thomas Sumner"
}
Unique identifier of the patient record this was merged into
CEL
owner.merged_into.id
Example
"pat-zz99Y888XwV7"
Name of the patient record this was merged into
CEL
owner.merged_into.name
Example
"Gordon Thomas Sumner"
Phone numbers associated with the patient
CEL
owner.phones
Example
[
{
"number": "+15553050051",
"type": "mobile"
}
]
Mapped array of: Phone number
CEL
owner.phones.map(x, x.number)
Example
[
"+15553050051"
]
Mapped array of: Type of phone number (e.g., mobile, home, work)
CEL
owner.phones.map(x, x.type)
Example
[
"mobile"
]
Primary practitioner assigned to the patient
CEL
owner.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
owner.practitioner.id
Example
"doc-ab12C345DeF6"
Whether the practitioner accepts enrollments from employers
CEL
owner.practitioner.accepts_enrollments_from_employer
Example
"yes"
Whether the practitioner accepts enrollments from retail
CEL
owner.practitioner.accepts_enrollments_from_retail
Example
"yes"
Practitioner’s biography
CEL
owner.practitioner.bio
Example
"Board-certified family medicine physician with 15 years of experience."
Timestamp when the practitioner record was created
CEL
owner.practitioner.created_at
Example
null
Practitioner’s education background
CEL
owner.practitioner.education
Example
"MD, Johns Hopkins University"
Practitioner’s email address
CEL
owner.practitioner.email
Example
"dr.smith@practice.com"
Practitioner’s gender
CEL
owner.practitioner.gender
Example
"female"
Practitioner’s gender if not covered by standard options
CEL
owner.practitioner.gender_other
Example
"non-binary"
Integration record identifier for the practitioner
CEL
owner.practitioner.integration_record_id
Example
"int-ab12C345DeF6"
Maximum patient age the practitioner serves
CEL
owner.practitioner.max_patient_age
Example
"65"
Minimum patient age the practitioner serves
CEL
owner.practitioner.min_patient_age
Example
"18"
Practitioner’s full name
CEL
owner.practitioner.name
Example
"Dr. Jane Smith"
Practitioner’s visibility for online signup
CEL
owner.practitioner.online_signup_visibility
Example
"visible"
Current number of patients in the practitioner’s panel
CEL
owner.practitioner.panel_size
Example
250
Maximum number of patients allowed in the practitioner’s panel
CEL
owner.practitioner.panel_size_limit
Example
500
URL to the practitioner’s photo
CEL
owner.practitioner.photo_url
Example
"https://app.hint.com/photos/doc-ab12C345DeF6.jpg"
Timestamp when the practitioner record was last updated
CEL
owner.practitioner.updated_at
Example
null
Locations where the practitioner practices
CEL
owner.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
owner.practitioner.locations.map(x, x.id)
Example
[
"loc-ab12C345DeF6"
]
Mapped array of: City of the location’s address
CEL
owner.practitioner.locations.map(x, x.address_city)
Example
[
"New York"
]
Mapped array of: Country of the location’s address
CEL
owner.practitioner.locations.map(x, x.address_country)
Example
[
"United States"
]
Mapped array of: Latitude of the location’s address
CEL
owner.practitioner.locations.map(x, x.address_latitude)
Example
[
"40.7227998"
]
Mapped array of: First line of the location’s address
CEL
owner.practitioner.locations.map(x, x.address_line1)
Example
[
"157 E Houston St"
]
Mapped array of: Second line of the location’s address
CEL
owner.practitioner.locations.map(x, x.address_line2)
Example
[
"Suite 2402"
]
Mapped array of: Longitude of the location’s address
CEL
owner.practitioner.locations.map(x, x.address_longitude)
Example
[
"-73.9892241"
]
Mapped array of: State of the location’s address
CEL
owner.practitioner.locations.map(x, x.address_state)
Example
[
"NY"
]
Mapped array of: ZIP code of the location’s address
CEL
owner.practitioner.locations.map(x, x.address_zip)
Example
[
"10002"
]
Mapped array of: Distance from the patient to the location
CEL
owner.practitioner.locations.map(x, x.distance)
Example
[
"5.2 miles"
]
Mapped array of: Name of the location
CEL
owner.practitioner.locations.map(x, x.name)
Example
[
"San Francisco HQ"
]
Mapped array of: Phone number of the location
CEL
owner.practitioner.locations.map(x, x.phone_number)
Example
[
"+15551234567"
]
Mapped array of: Whether the location is virtual
CEL
owner.practitioner.locations.map(x, x.virtual)
Example
[
false
]
Mapped array of: Location group this location belongs to
CEL
owner.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
owner.practitioner.npi
Example
{
"id": "1234567890",
"name": "Dr. Jane Smith"
}
NPI number
CEL
owner.practitioner.npi.id
Example
"1234567890"
Name associated with the NPI
CEL
owner.practitioner.npi.name
Example
"Dr. Jane Smith"
Practitioner’s specialties
CEL
owner.practitioner.specialties
Example
[
{
"id": "spc-ab12C345DeF6",
"name": "Family Medicine"
}
]
Mapped array of: Unique identifier for the specialty
CEL
owner.practitioner.specialties.map(x, x.id)
Example
[
"spc-ab12C345DeF6"
]
Mapped array of: Name of the specialty
CEL
owner.practitioner.specialties.map(x, x.name)
Example
[
"Family Medicine"
]
Practitioner group assigned to the patient
CEL
owner.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
owner.practitioner_group.id
Example
"prg-ab12C345DeF6"
Timestamp when the practitioner group was created
CEL
owner.practitioner_group.created_at
Example
null
Integration record identifier for the practitioner group
CEL
owner.practitioner_group.integration_record_id
Example
"int-ab12C345DeF6"
Name of the practitioner group
CEL
owner.practitioner_group.name
Example
"Downtown Location Group"
Timestamp when the practitioner group was last updated
CEL
owner.practitioner_group.updated_at
Example
null
Sponsorships associated with the patient
CEL
owner.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
owner.sponsorships.map(x, x.id)
Example
[
"creg-ab12C345DeF6"
]
Mapped array of: External identifier from another system
CEL
owner.sponsorships.map(x, x.external_id)
Example
[
"ext_id_from_another_system012345"
]
Mapped array of: Whether this person is the subscriber
CEL
owner.sponsorships.map(x, x.is_subscriber)
Example
[
true
]
Mapped array of: Type of sponsorship (e.g., employee, spouse, dependent)
CEL
owner.sponsorships.map(x, x.type)
Example
[
"spouse"
]
Mapped array of: Company associated with the sponsorship
CEL
owner.sponsorships.map(x, x.company)
Example
[
{
"id": "com-ab12C345DeF6",
"name": "Schmoogle Inc."
}
]
Mapped array of: Family associated with the sponsorship
CEL
owner.sponsorships.map(x, x.family)
Example
[
{
"id": "cac-ab12C345DeF6",
"name": "Sumner Family"
}
]
Plan associated with the membership
CEL
plan
Example
{
"id": "pln-ab12C345DeF6",
"name": "Membership",
"plan_type": "retail"
}
Unique identifier for the plan
CEL
plan.id
Example
"pln-ab12C345DeF6"
Name of the plan
CEL
plan.name
Example
"Membership"
Type of plan (e.g., retail, employer)
CEL
plan.plan_type
Example
"retail"
Sponsorship associated with the membership
CEL
sponsorship
Example
{
"company": {
"id": "com-ab12C345DeF6",
"name": "Schmoogle Inc."
},
"id": "spon-ab12C345DeF6"
}
Unique identifier for the sponsorship
CEL
sponsorship.id
Example
"spon-ab12C345DeF6"
Company associated with the sponsorship
CEL
sponsorship.company
Example
{
"id": "com-ab12C345DeF6",
"name": "Schmoogle Inc."
}
Unique identifier for the sponsor company
CEL
sponsorship.company.id
Example
"com-ab12C345DeF6"
Name of the sponsor company
CEL
sponsorship.company.name
Example
"Schmoogle Inc."
Upcoming bills for the membership
CEL
upcoming_bills
Example
[
{
"amount_in_cents": 5000,
"charges_amount_in_cents": 0,
"coupon_discount_in_cents": 0,
"coupon_discount_months": 3,
"coupon_percent_off": 20,
"customer_invoice": {
"id": "inv-ab12C345DeF6"
},
"date": null,
"end_date": null,
"list_price_in_cents": 5000,
"membership_amount_in_cents": 5000,
"period_in_months": 1,
"rate_in_cents": 5000,
"registration_fee_in_cents": 2500,
"start_date": null
}
]
Mapped array of: Total amount of the upcoming bill in cents
CEL
upcoming_bills.map(x, x.amount_in_cents)
Example
[
5000
]
Mapped array of: Charges amount in cents
CEL
upcoming_bills.map(x, x.charges_amount_in_cents)
Example
[
0
]
Mapped array of: Coupon discount amount in cents
CEL
upcoming_bills.map(x, x.coupon_discount_in_cents)
Example
[
0
]
Mapped array of: Number of months the coupon discount applies
CEL
upcoming_bills.map(x, x.coupon_discount_months)
Example
[
3
]
Mapped array of: Percentage off from the coupon
CEL
upcoming_bills.map(x, x.coupon_percent_off)
Example
[
20
]
Mapped array of: Date of the upcoming bill
CEL
upcoming_bills.map(x, x.date)
Example
[
null
]
Mapped array of: End date of the billing period
CEL
upcoming_bills.map(x, x.end_date)
Example
[
null
]
Mapped array of: List price in cents
CEL
upcoming_bills.map(x, x.list_price_in_cents)
Example
[
5000
]
Mapped array of: Membership amount in cents
CEL
upcoming_bills.map(x, x.membership_amount_in_cents)
Example
[
5000
]
Mapped array of: Billing period length in months
CEL
upcoming_bills.map(x, x.period_in_months)
Example
[
1
]
Mapped array of: Rate in cents
CEL
upcoming_bills.map(x, x.rate_in_cents)
Example
[
5000
]
Mapped array of: Registration fee in cents
CEL
upcoming_bills.map(x, x.registration_fee_in_cents)
Example
[
2500
]
Mapped array of: Start date of the billing period
CEL
upcoming_bills.map(x, x.start_date)
Example
[
null
]
Mapped array of: Customer invoice associated with the upcoming bill
CEL
upcoming_bills.map(x, x.customer_invoice)
Example
[
{
"id": "inv-ab12C345DeF6"
}
]
