Hint Health · Example Payload
Membership Showmembership Response 200
Direct Primary CareDPCHealthcareMembership ManagementPatient EnrollmentMedical BillingEMRHealth Plans
Membership Showmembership Response 200 is an example object payload from Hint Health, with 6 top-level fields. It illustrates the shape of data this provider's APIs accept or return.
Top-level fields
operationIdmethodpathstatusmediaTypeexample
Example Payload
{
"operationId": "Membership.ShowMembership",
"method": "GET",
"path": "/provider/memberships/{id}",
"status": "200",
"mediaType": "application/json",
"example": {
"id": "mem-ab12C345DeF6",
"bill_date": "2017-03-05",
"billed_through_date": "2017-03-05",
"billing_start_date": "2016-08-05",
"bills_at_end_of_period": false,
"contract_expiration_action": "auto-renew",
"contract_expires": true,
"contract_period_in_months": 12,
"created_at": "2017-02-05T06:23:00.000000-08:00",
"end_date": null,
"enrollment_status": "active",
"fixed_period_rate_in_cents": null,
"fixed_registration_fee_in_cents": null,
"group_code": null,
"is_confirmed": true,
"is_current": true,
"is_processing": false,
"is_restartable": false,
"list_price_in_cents": 5000,
"next_bill_date": "2017-03-05",
"period_in_months": 1,
"period_rate_in_cents": 5000,
"rate_in_cents": 5000,
"source_status": null,
"start_date": "2016-08-05",
"status": "unpaid",
"updated_at": "2017-02-05T06:23:00.000000-08:00",
"coupon": null,
"membership_patients": [
{
"id": "mp-ab12C345DeF6",
"member_type": "spouse",
"fixed_period_rate_in_cents": null,
"list_price_in_cents": 5000,
"period_rate_in_cents": 5000,
"revenue_in_cents": 5000,
"start_date": "2016-08-05",
"uses_tobacco": false,
"end_date": null,
"patient": {
"id": "pat-ab12C345DeF6",
"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": 65,
"chosen_first_name": null,
"chosen_last_name": null,
"chosen_middle_name": null,
"chosen_suffix": null,
"chosen_title": null,
"created_at": "2017-02-05T06:23:00.000000-08:00",
"dob": "1952-01-01",
"electronic_communication_consent_accepted": true,
"electronic_communication_consent_accepted_at": "2017-01-29T06:23:00.000000-08:00",
"email": "bass_man@bumblebeeinc.com",
"engaged": false,
"external_link_id": null,
"first_name": "Gordon",
"gender": "male",
"gender_identity": "man",
"gender_other": null,
"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": "2017-01-29T06:23:00.000000-08:00",
"import_id": null,
"import_source": null,
"joined_practice_date": "2017-02-05",
"last_engagement_date": null,
"last_name": "Sumner",
"lead_source_other": "Downtown marketing event",
"master_record_sponsor": null,
"membership_status": "unpaid",
"middle_name": "Thomas",
"name": "Gordon Thomas Sumner",
"patient_agreement_accepted": false,
"patient_agreement_accepted_at": null,
"preferred_language": "en",
"pronouns": null,
"provider_web_link": "https://app.hint.com/patients/pat-ab12C345DeF6",
"sex": "male",
"suffix": null,
"terms_accepted": false,
"terms_accepted_at": null,
"updated_at": "2017-02-05T06:23:00.000000-08:00",
"uses_tobacco": false,
"lead_source": {
"id": "lds-ab12C345DeF6",
"name": "Other",
"created_at": "2017-02-05T06:23:00.000000-08:00",
"updated_at": "2017-02-05T06:23:00.000000-08:00"
},
"phones": [],
"sponsorships": [
{
"id": "creg-ab12C345DeF6",
"external_id": "ext_id_from_another_system012345",
"is_subscriber": true,
"type": "spouse",
"company": {
"id": "com-ab12C345DeF6",
"name": "Schmoogle Inc."
},
"family": {
"id": "cac-ab12C345DeF6"
}
}
],
"integration_error_message": null,
"integration_last_synced_at": null,
"integration_record_id": "ABCD0012030",
"integration_sync_status": "enabled",
"integration_web_link": null
}
}
],
"owner": {
"id": "pat-ab12C345DeF6",
"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": 65,
"chosen_first_name": null,
"chosen_last_name": null,
"chosen_middle_name": null,
"chosen_suffix": null,
"chosen_title": null,
"created_at": "2017-02-05T06:23:00.000000-08:00",
"dob": "1952-01-01",
"electronic_communication_consent_accepted": true,
"electronic_communication_consent_accepted_at": "2017-01-29T06:23:00.000000-08:00",
"email": "bass_man@bumblebeeinc.com",
"engaged": false,
"external_link_id": null,
"first_name": "Gordon",
"gender": "male",
"gender_identity": "man",
"gender_other": null,
"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": "2017-01-29T06:23:00.000000-08:00",
"import_id": null,
"import_source": null,
"joined_practice_date": "2017-02-05",
"last_engagement_date": null,
"last_name": "Sumner",
"lead_source_other": "Downtown marketing event",
"master_record_sponsor": null,
"membership_status": "unpaid",
"middle_name": "Thomas",
"name": "Gordon Thomas Sumner",
"patient_agreement_accepted": false,
"patient_agreement_accepted_at": null,
"preferred_language": "en",
"pronouns": null,
"provider_web_link": "https://app.hint.com/patients/pat-ab12C345DeF6",
"sex": "male",
"suffix": null,
"terms_accepted": false,
"terms_accepted_at": null,
"updated_at": "2017-02-05T06:23:00.000000-08:00",
"uses_tobacco": false,
"lead_source": {
"id": "lds-ab12C345DeF6",
"name": "Other",
"created_at": "2017-02-05T06:23:00.000000-08:00",
"updated_at": "2017-02-05T06:23:00.000000-08:00"
},
"phones": [],
"sponsorships": [
{
"id": "creg-ab12C345DeF6",
"external_id": "ext_id_from_another_system012345",
"is_subscriber": true,
"type": "spouse",
"company": {
"id": "com-ab12C345DeF6",
"name": "Schmoogle Inc."
},
"family": {
"id": "cac-ab12C345DeF6"
}
}
],
"integration_error_message": null,
"integration_last_synced_at": null,
"integration_record_id": "ABCD0012030",
"integration_sync_status": "enabled",
"integration_web_link": null
},
"plan": {
"id": "pln-ab12C345DeF6",
"name": "Membership",
"plan_type": "retail"
},
"sponsorship": null,
"upcoming_bills": [
{
"amount_in_cents": 5000,
"charges_amount_in_cents": 0,
"coupon_discount_in_cents": 0,
"coupon_discount_months": null,
"coupon_percent_off": null,
"date": "2017-03-05",
"end_date": "2017-04-05",
"list_price_in_cents": 5000,
"membership_amount_in_cents": 5000,
"period_in_months": 1,
"rate_in_cents": 5000,
"registration_fee_in_cents": null,
"start_date": "2017-03-05",
"customer_invoice": null
},
{
"amount_in_cents": 5000,
"charges_amount_in_cents": 0,
"coupon_discount_in_cents": 0,
"coupon_discount_months": null,
"coupon_percent_off": null,
"date": "2017-04-05",
"end_date": "2017-05-05",
"list_price_in_cents": 5000,
"membership_amount_in_cents": 5000,
"period_in_months": 1,
"rate_in_cents": 5000,
"registration_fee_in_cents": null,
"start_date": "2017-04-05",
"customer_invoice": null
}
]
}
}