Patient presented for annual wellness exam. All vitals within normal range.
patient_id: pat-123456 signed: true status: completed text: Patient presented for annual wellness exam. All vitals within normal range. title: Visit Note – Annual Physical type: note integration_error_message: null integration_last_synced_at: null integration_record_id: null integration_sync_status: enabled integration_web_link: null requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/Interaction.ClinicalNoteSanitizer' /provider/patients/{patient_id}/interactions/clinical_note/{id}: get: tags: - ClinicalNoteInteraction operationId: ClinicalNoteInteraction.ShowClinicalNoteInteraction summary: Show Clinical Note Interaction description: '' parameters: - name: patient_id in: path required: true description: Unique Patient ID schema: type: string - name: id in: path required: true description: Unique Clinical Note Interaction ID schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/Public.Interaction.ClinicalNoteBlueprint_one' example: id: inter-cN12x345AbC6 author: Dr. Jane Smith event_timestamp: '2017-02-05T14:23:00Z' files: [] formatted_text:Patient presented for annual wellness exam. All vitals within normal range.
patient_id: pat-123456 signed: true status: completed text: Patient presented for annual wellness exam. All vitals within normal range. title: Visit Note – Annual Physical type: note integration_error_message: null integration_last_synced_at: null integration_record_id: null integration_sync_status: enabled integration_web_link: null patch: tags: - ClinicalNoteInteraction operationId: ClinicalNoteInteraction.UpdateClinicalNoteInteraction summary: Update Clinical Note Interaction description: '' parameters: - name: patient_id in: path required: true description: Unique Patient ID schema: type: string - name: id in: path required: true description: Unique Clinical Note Interaction ID schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/Public.Interaction.ClinicalNoteBlueprint_one' example: id: inter-cN12x345AbC6 author: Dr. Jane Smith event_timestamp: '2017-02-05T14:23:00Z' files: [] formatted_text:Patient presented for annual wellness exam. All vitals within normal range.
patient_id: pat-123456 signed: true status: completed text: Patient presented for annual wellness exam. All vitals within normal range. title: Visit Note – Annual Physical type: note integration_error_message: null integration_last_synced_at: null integration_record_id: null integration_sync_status: enabled integration_web_link: null requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/Interaction.ClinicalNoteSanitizer' /provider/companies: post: tags: - Company operationId: Company.CreateCompany summary: Create Company description: '' parameters: [] responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/Public.CompanyBlueprint_one' example: id: com-ab12C345DeF6 employee_divisions_count: 0 name: Schmoogle Inc. status: active address: id: add-ab12C345DeF6 city: New York country: United States line1: 157 E Houston St line2: Suite 2402 state: NY zip: '10002' latitude: 40.7227998 longitude: -73.9892241 default_location: null default_plan: id: pln-ab12C345DeF6 name: Membership plan_type: company default_practitioner: null phones: - number: '5553050005' type: mobile requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CompanyCreateSanitizer' get: tags: - Company operationId: Company.ListAllCompanies summary: List All Companies description: '' parameters: [] responses: '200': description: Successful response content: application/json: schema: type: array items: $ref: '#/components/schemas/Public.CompanyBlueprint_all' example: - id: com-ab12C345DeF6 employee_divisions_count: 0 name: Schmoogle Inc. status: active address: id: add-ab12C345DeF6 city: New York country: United States line1: 157 E Houston St line2: Suite 2402 state: NY zip: '10002' latitude: 40.7227998 longitude: -73.9892241 default_location: null default_plan: id: pln-ab12C345DeF6 name: Membership plan_type: company default_practitioner: null phones: - number: '5553050004' type: mobile /provider/companies/{id}/deactivate: post: tags: - Company operationId: Company.DeactivateCompany summary: Deactivate Company description: '' parameters: - name: id in: path required: true description: Unique Company ID schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/Public.CompanyBlueprint_one' example: id: com-ab12C345DeF6 employee_divisions_count: 0 name: Schmoogle Inc. status: active address: id: add-ab12C345DeF6 city: New York country: United States line1: 157 E Houston St line2: Suite 2402 state: NY zip: '10002' latitude: 40.7227998 longitude: -73.9892241 default_location: null default_plan: id: pln-ab12C345DeF6 name: Membership plan_type: company default_practitioner: null phones: - number: '5553050005' type: mobile /provider/companies/{company_id}/company_plans: post: tags: - CompanyPlan operationId: CompanyPlan.CreateCompanyPlan summary: Create Company Plan description: '' parameters: - name: company_id in: path required: true description: Unique Company ID schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/Public.CompanyPlanBlueprint_one' example: id: cmpl-ab12C345DeF6 available_for_enrollment: true is_default: false plan: id: pln-ab12C345DeF6 name: Memberships plan_type: company requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/Provider.CompanyPlansController.create_body' get: tags: - CompanyPlan operationId: CompanyPlan.ListCompanyPlans summary: List All Company Plans description: '' parameters: - name: company_id in: path required: true description: Unique Company ID schema: type: string responses: '200': description: Successful response content: application/json: schema: type: array items: $ref: '#/components/schemas/Public.CompanyPlanBlueprint_all' example: - id: cmpl-ab12C345DeF6 available_for_enrollment: true is_default: false plan: id: pln-ab12C345DeF6 name: Memberships plan_type: company /provider/companies/{company_id}/company_plans/{id}: delete: tags: - CompanyPlan operationId: CompanyPlan.DestroyCompanyPlan summary: Destroy CompanyPlan description: '' parameters: - name: company_id in: path required: true description: Unique Company ID schema: type: string - name: id in: path required: true description: Unique Company Plan ID schema: type: string responses: '200': description: Successful response content: application/json: example: id: cmpl-ab12C345DeF6 available_for_enrollment: true is_default: false plan: id: pln-ab12C345DeF6 name: Memberships plan_type: company patch: tags: - CompanyPlan operationId: CompanyPlan.UpdateCompanyPlan summary: Update Company Plan description: '' parameters: - name: company_id in: path required: true description: Unique Company ID schema: type: string - name: id in: path required: true description: Unique Company Plan ID schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/Public.CompanyPlanBlueprint_one' example: id: cmpl-ab12C345DeF6 available_for_enrollment: true is_default: false plan: id: pln-ab12C345DeF6 name: Memberships plan_type: company requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/Provider.CompanyPlansController.update_body' /provider/companies/{id}: get: tags: - Company operationId: Company.ShowCompany summary: Show Company description: '' parameters: - name: id in: path required: true description: Unique Company ID schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/Public.CompanyBlueprint_one' example: id: com-ab12C345DeF6 employee_divisions_count: 0 name: Schmoogle Inc. status: active address: id: add-ab12C345DeF6 city: New York country: United States line1: 157 E Houston St line2: Suite 2402 state: NY zip: '10002' latitude: 40.7227998 longitude: -73.9892241 default_location: null default_plan: id: pln-ab12C345DeF6 name: Membership plan_type: company default_practitioner: null phones: - number: '5553050005' type: mobile patch: tags: - Company operationId: Company.UpdateCompany summary: Update Company description: '' parameters: - name: id in: path required: true description: Unique Company ID schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/Public.CompanyBlueprint_one' example: id: com-ab12C345DeF6 employee_divisions_count: 0 name: Schmoogle Inc. status: active address: id: add-ab12C345DeF6 city: New York country: United States line1: 157 E Houston St line2: Suite 2402 state: NY zip: '10002' latitude: 40.7227998 longitude: -73.9892241 default_location: null default_plan: id: pln-ab12C345DeF6 name: Membership plan_type: company default_practitioner: null phones: - number: '5553050005' type: mobile requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CompanyUpdateSanitizer' /provider/coupons: get: tags: - Coupon operationId: Coupon.ListAllCoupons summary: List All Coupons description: '' parameters: - name: archived in: query required: false description: Allows filtering by archived status. May be "true" to show only archived coupons, "false" to show only unarchived coupons. If not given all resources will be returned. schema: type: string - name: redeemable in: query required: false description: Allows filtering by redeemable status. May be "true" to show only currently redeemable coupons. If not given all resources will be returned. schema: type: string responses: '200': description: Successful response content: application/json: schema: type: array items: $ref: '#/components/schemas/Public.CouponBlueprint_all' example: - id: cou-ab12C345DeF6 amount_off_in_cents: null apply_to_each_patient: true code: GETHEALTHYNOWFORCHEAPER1 created_at: '2017-02-05T06:23:00.000000-08:00' description: null duration_in_months: null is_archived: false is_redeemable: false percent_off: '15.0' redeemable_from: '2020-01-01' redeemable_until: null updated_at: '2017-02-05T06:23:00.000000-08:00' headers: X-Count: description: The number of resources returned in this request schema: type: integer X-Total-Count: description: The total number of resources available (scoped to query params) schema: type: integer /provider/coupons/{id}: get: tags: - Coupon operationId: Coupon.ShowCoupon summary: Show Coupon description: '' parameters: - name: id in: path required: true description: Unique Coupon ID schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/Public.CouponBlueprint_one' example: id: cou-ab12C345DeF6 code: GETHEALTHYNOWFORCHEAPER2 description: null amount_off_in_cents: null apply_to_each_patient: true created_at: '2017-02-05T06:23:00.000000-08:00' duration_in_months: null percent_off: '15.0' updated_at: '2017-02-05T06:23:00.000000-08:00' is_redeemable: false is_archived: false redeemable_from: '2020-01-01' redeemable_until: null /provider/credit_categories: post: tags: - CreditCategory operationId: CreditCategory.CreateCreditCategory summary: Create Credit Category description: '' parameters: [] responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/Public.CreditCategoryBlueprint_one' example: id: cct-ab12C345DeF6 created_at: '2017-02-05T06:23:00.000000-08:00' name: Credit Category 2 updated_at: '2017-02-05T06:23:00.000000-08:00' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/Provider.CreditCategoriesController.create_body' get: tags: - CreditCategory operationId: CreditCategory.ListCreditCategories summary: List All Credit Categories description: '' parameters: [] responses: '200': description: Successful response content: application/json: schema: type: array items: $ref: '#/components/schemas/Public.CreditCategoryBlueprint_all' example: - id: cct-ab12C345DeF6 created_at: '2017-02-05T06:23:00.000000-08:00' name: Credit Category 1 updated_at: '2017-02-05T06:23:00.000000-08:00' /provider/credit_categories/{id}: delete: tags: - CreditCategory operationId: CreditCategory.DeleteCreditCategory summary: Delete Credit Category description: '' parameters: - name: id in: path required: true description: Unique Credit Category ID schema: type: string responses: '204': description: No content get: tags: - CreditCategory operationId: CreditCategory.ShowCreditCategory summary: Show Credit Category description: '' parameters: - name: id in: path required: true description: Unique Credit Category ID schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/Public.CreditCategoryBlueprint_one' example: id: cct-ab12C345DeF6 created_at: '2017-02-05T06:23:00.000000-08:00' name: Credit Category 2 updated_at: '2017-02-05T06:23:00.000000-08:00' patch: tags: - CreditCategory operationId: CreditCategory.UpdateCreditCategory summary: Update Credit Category description: '' parameters: - name: id in: path required: true description: Unique Credit Category ID schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/Public.CreditCategoryBlueprint_one' example: id: cct-ab12C345DeF6 created_at: '2017-02-05T06:23:00.000000-08:00' name: Credit Category 2 updated_at: '2017-02-05T06:23:00.000000-08:00' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/Provider.CreditCategoriesController.update_body' /provider/patients/{patient_id}/credits: post: tags: - Credit operationId: Credit.CreateCredit summary: Create Credit description: '' parameters: - name: patient_id in: path required: true description: Unique Patient ID schema: type: string responses: '201': description: Successful response content: application/json: schema: $ref: '#/components/schemas/Public.CreditBlueprint_one' example: id: crd-ab12C345DeF6 amount_in_cents: 1500 balance_in_cents: 1500 created_at: '2017-02-05T06:23:00.000000-08:00' integration_record_id: null reason: null updated_at: '2017-02-05T06:23:00.000000-08:00' credit_category: id: cct-ab12C345DeF6 name: Credit Category 4 requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/Provider.CreditsController.create_body' get: tags: - Credit operationId: Credit.ListAllCredits summary: List All Credits description: '' parameters: - name: patient_id in: path required: true description: Unique Patient ID schema: type: string responses: '200': description: Successful response content: application/json: schema: type: array items: $ref: '#/components/schemas/Public.CreditBlueprint_all' example: - id: crd-ab12C345DeF6 amount_in_cents: 1500 balance_in_cents: 1500 created_at: '2017-02-05T06:23:00.000000-08:00' integration_record_id: null reason: null updated_at: '2017-02-05T06:23:00.000000-08:00' credit_category: id: cct-ab12C345DeF6 name: Credit Category 3 /provider/credit_lines: get: tags: - CreditLine operationId: CreditLine.ListCreditLines summary: List All Credit Lines description: '' parameters: - name: credit in: query required: false description: '' schema: type: string - name: credit_category in: query required: false description: '' schema: type: string responses: '200': description: Successful response content: application/json: schema: type: array items: $ref: '#/components/schemas/Public.CreditLineBlueprint_all' example: - id: cln-ab12C345DeF6 amount_in_cents: -1000 created_at: '2017-02-05T06:23:00.000000-08:00' transaction_date: '2017-02-05' type: applied credit: id: crd-ab12C345DeF6 invoice: id: inv-ab12C345DeF6 invoice_number: 1 type: customer_invoice owner: id: pat-ab12C345DeF6 type: patient /provider/patients/{patient_id}/credits/{id}: patch: tags: - Credit operationId: Credit.UpdateCredit summary: Update Credit description: '' parameters: - name: patient_id in: path required: true description: Unique Patient ID schema: type: string - name: id in: path required: true description: Unique Credit ID schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/Public.CreditBlueprint_one' example: id: crd-ab12C345DeF6 amount_in_cents: 1500 balance_in_cents: 1500 created_at: '2017-02-05T06:23:00.000000-08:00' integration_record_id: null reason: null updated_at: '2017-02-05T06:23:00.000000-08:00' credit_category: id: cct-ab12C345DeF6 name: Credit Category 4 requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/Provider.CreditsController.update_body' /provider/customer_invoices/{customer_invoice_id}/charges: post: tags: - CustomerInvoiceCharge operationId: CustomerInvoiceCharge.CreateCustomerInvoiceCharge summary: Create CustomerInvoiceCharge description: '' parameters: - name: customer_invoice_id in: path required: true description: Unique Customer Invoice ID schema: type: string responses: '201': description: Successful response content: application/json: example: id: cha-ab12C345DeF6 amount_in_cents: 1000 created_at: '2017-02-05T06:23:00.000000-08:00' description: '' is_persisted: true name: Lab fee price_in_cents: 1000 quantity: 1 service_date: '2017-02-05' status: draft subtotal_in_cents: 1000 tax_in_cents: 0 total_in_cents: 1000 updated_at: '2017-02-05T06:23:00.000000-08:00' category: null charge_item: null location: id: loc-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' name: San Francisco HQ 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: i_heart_rufus@chaka.com engaged: false external_link_id: null first_name: Yvette 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: Stevens lead_source_other: Downtown marketing event master_record_sponsor: null membership_status: active middle_name: Thomas name: Yvette Thomas Stevens 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 account: name: Yvette Thomas Stevens past_due_in_cents: 0 company: id: com-ab12C345DeF6 name: Schmoogle Inc. emergency_contact: id: emc-ab12C345DeF6 first_name: Eliot last_name: Sumner email: bass_eliot@iblamecoco.com name: Eliot Sumner relationship: sibling phone: number: '5553050051' type: mobile us_formattable: true external_records: [] known_practice: null 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' location: id: loc-ab12C345DeF6 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: null name: San Francisco HQ phone_number: null virtual: false location_group: id: prg-ab12C345DeF6 created_at: '2017-02-05T06:23:00.000000-08:00' integration_record_id: null name: Downtown Location Group updated_at: '2017-02-05T06:23:00.000000-08:00' location_group: id: prg-ab12C345DeF6 created_at: '2017-02-05T06:23:00.000000-08:00' integration_record_id: null name: Downtown Location Group updated_at: '2017-02-05T06:23:00.000000-08:00' membership_members: [] memberships: [] merged_into: null phones: [] practitioner: id: pct-ab12C345DeF6 accepts_enrollments_from_employer: true accepts_enrollments_from_retail: true bio: Reginalds biography... created_at: '2017-02-05T06:23:00.000000-08:00' education: - The University of Hint email: rocket_man@emi.com gender: male gender_other: null integration_record_id: null max_patient_age: 50 min_patient_age: 0 name: Reginald Dwight online_signup_visibility: true panel_size: 150 panel_size_limit: 200 photo_url: practitioners/000/000/115/photos/original.png updated_at: '2017-02-05T06:23:00.000000-08:00' locations: - id: loc-ab12C345DeF6 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: null name: San Francisco HQ phone_number: '5553050019' virtual: false location_group: id: prg-ab12C345DeF6 created_at: '2017-02-05T06:23:00.000000-08:00' integration_record_id: null name: Downtown Location Group updated_at: '2017-02-05T06:23:00.000000-08:00' npi: first_name: REGINALD last_name: DWIGHT number: 0123456879 organization_name: HINT HEALTH type: individual specialties: - id: spe-ab12C345DeF6 name: Internal Medicine practitioner_group: id: prg-ab12C345DeF6 created_at: '2017-02-05T06:23:00.000000-08:00' integration_record_id: null name: Downtown Location Group updated_at: '2017-02-05T06:23:00.000000-08:00' sponsorships: - id: creg-ab12C345DeF6 external_id: ext_id_from_another_system012345 is_subscriber: true type: employee company: id: com-ab12C345DeF6 name: Schmoogle Inc. family: id: cac-ab12C345DeF6 ssn: masked_number: '***-**-1234' integration_error_message: null integration_last_synced_at: null integration_record_id: null integration_sync_status: enabled integration_web_link: null practitioner: null requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/Provider.CustomerInvoices.ChargesController.create_body' /provider/customer_invoices/{customer_invoice_id}/charges/{id}: delete: tags: - CustomerInvoiceCharge operationId: CustomerInvoiceCharge.DeleteCustomerInvoiceCharge summary: Delete CustomerInvoiceCharge description: '' parameters: - name: customer_invoice_id in: path required: true description: Unique Customer Invoice ID schema: type: string - name: id in: path required: true description: Unique Customer Invoice Charge ID schema: type: string responses: '204': description: No content patch: tags: - CustomerInvoiceCharge operationId: CustomerInvoiceCharge.UpdateCustomerInvoiceCharge summary: Update CustomerInvoiceCharge description: '' parameters: - name: customer_invoice_id in: path required: true description: Unique Customer Invoice ID schema: type: string - name: id in: path required: true description: Unique Customer Invoice Charge ID schema: type: string responses: '200': description: Successful response content: application/json: example: id: cha-ab12C345DeF6 amount_in_cents: 1000 created_at: '2017-02-05T06:23:00.000000-08:00' description: '' is_persisted: true name: Lab fee price_in_cents: 1000 quantity: 1 service_date: '2017-02-05' status: draft subtotal_in_cents: 1000 tax_in_cents: 0 total_in_cents: 1000 updated_at: '2017-02-05T06:23:00.000000-08:00' category: null charge_item: null location: id: loc-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' name: San Francisco HQ 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: i_heart_rufus@chaka.com engaged: false external_link_id: null first_name: Yvette 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: Stevens lead_source_other: Downtown marketing event master_record_sponsor: null membership_status: active middle_name: Thomas name: Yvette Thomas Stevens 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 account: name: Yvette Thomas Stevens past_due_in_cents: 0 company: id: com-ab12C345DeF6 name: Schmoogle Inc. emergency_contact: id: emc-ab12C345DeF6 first_name: Eliot last_name: Sumner email: bass_eliot@iblamecoco.com name: Eliot Sumner relationship: sibling phone: number: '5553050051' type: mobile us_formattable: true external_records: [] known_practice: null 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' location: id: loc-ab12C345DeF6 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: null name: San Francisco HQ phone_number: null virtual: false location_group: id: prg-ab12C345DeF6 created_at: '2017-02-05T06:23:00.000000-08:00' integration_record_id: null name: Downtown Location Group updated_at: '2017-02-05T06:23:00.000000-08:00' location_group: id: prg-ab12C345DeF6 created_at: '2017-02-05T06:23:00.000000-08:00' integration_record_id: null name: Downtown Location Group updated_at: '2017-02-05T06:23:00.000000-08:00' membership_members: [] memberships: [] merged_into: null phones: [] practitioner: id: pct-ab12C345DeF6 accepts_enrollments_from_employer: true accepts_enrollments_from_retail: true bio: Reginalds biography... created_at: '2017-02-05T06:23:00.000000-08:00' education: - The University of Hint email: rocket_man@emi.com gender: male gender_other: null integration_record_id: null max_patient_age: 50 min_patient_age: 0 name: Reginald Dwight online_signup_visibility: true panel_size: 150 panel_size_limit: 200 photo_url: practitioners/000/000/115/photos/original.png updated_at: '2017-02-05T06:23:00.000000-08:00' locations: - id: loc-ab12C345DeF6 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: null name: San Francisco HQ phone_number: '5553050019' virtual: false location_group: id: prg-ab12C345DeF6 created_at: '2017-02-05T06:23:00.000000-08:00' integration_record_id: null name: Downtown Location Group updated_at: '2017-02-05T06:23:00.000000-08:00' npi: first_name: REGINALD last_name: DWIGHT number: 0123456879 organization_name: HINT HEALTH type: individual specialties: - id: spe-ab12C345DeF6 name: Internal Medicine practitioner_group: id: prg-ab12C345DeF6 created_at: '2017-02-05T06:23:00.000000-08:00' integration_record_id: null name: Downtown Location Group updated_at: '2017-02-05T06:23:00.000000-08:00' sponsorships: - id: creg-ab12C345DeF6 external_id: ext_id_from_another_system012345 is_subscriber: true type: employee company: id: com-ab12C345DeF6 name: Schmoogle Inc. family: id: cac-ab12C345DeF6 ssn: masked_number: '***-**-1234' integration_error_message: null integration_last_synced_at: null integration_record_id: null integration_sync_status: enabled integration_web_link: null practitioner: null requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/Provider.CustomerInvoices.ChargesController.update_body' /provider/customer_invoices: post: tags: - CustomerInvoice operationId: CustomerInvoice.CreateCustomerInvoice summary: Create Customer Invoice description: '' parameters: [] responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/Public.CustomerInvoiceBlueprint_one' example: id: inv-ab12C345DeF6 amount_in_cents: 4999 charges_count: 1 created_at: '2017-02-05T06:23:00.000000-08:00' date: '2017-02-05' due_in_cents: 4999 human_status: draft integration_record_id: ABCD0012016 invoice_number: 1 last_sent_at: null last_viewed_at: null paid_at: null paid_in_cents: 0 payment_status: null payments_count: 0 provider_web_link: https://app.hint.com/patients/pat-ab12C345DeF6/charges/inv-ab12C345DeF6 received_in_cents: 0 status: draft subtotal_in_cents: 4999 tax_in_cents: 0 total_in_cents: 4999 updated_at: '2017-02-05T06:23:00.000000-08:00' 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: active 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 account: name: Gordon Thomas Sumner past_due_in_cents: 0 company: id: com-ab12C345DeF6 name: Schmoogle Inc. emergency_contact: id: emc-ab12C345DeF6 first_name: Eliot last_name: Sumner email: bass_eliot@iblamecoco.com name: Eliot Sumner relationship: sibling phone: number: '5553050051' type: mobile us_formattable: true external_records: [] known_practice: null 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' location: id: loc-ab12C345DeF6 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: null name: San Francisco HQ phone_number: null virtual: false location_group: id: prg-ab12C345DeF6 created_at: '2017-02-05T06:23:00.000000-08:00' integration_record_id: null name: Downtown Location Group updated_at: '2017-02-05T06:23:00.000000-08:00' location_group: id: prg-ab12C345DeF6 created_at: '2017-02-05T06:23:00.000000-08:00' integration_record_id: null name: Downtown Location Group updated_at: '2017-02-05T06:23:00.000000-08:00' membership_members: [] memberships: [] merged_into: null phones: [] practitioner: id: pct-ab12C345DeF6 accepts_enrollments_from_employer: true accepts_enrollments_from_retail: true bio: Reginalds biography... created_at: '2017-02-05T06:23:00.000000-08:00' education: - The University of Hint email: rocket_man@emi.com gender: male gender_other: null integration_record_id: null max_patient_age: 50 min_patient_age: 0 name: Reginald Dwight online_signup_visibility: true panel_size: 150 panel_size_limit: 200 photo_url: practitioners/000/000/115/photos/original.png updated_at: '2017-02-05T06:23:00.000000-08:00' locations: - id: loc-ab12C345DeF6 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: null name: San Francisco HQ phone_number: '5553050019' virtual: false location_group: id: prg-ab12C345DeF6 created_at: '2017-02-05T06:23:00.000000-08:00' integration_record_id: null name: Downtown Location Group updated_at: '2017-02-05T06:23:00.000000-08:00' npi: first_name: REGINALD last_name: DWIGHT number: 0123456879 organization_name: HINT HEALTH type: individual specialties: - id: spe-ab12C345DeF6 name: Internal Medicine practitioner_group: id: prg-ab12C345DeF6 created_at: '2017-02-05T06:23:00.000000-08:00' integration_record_id: null name: Downtown Location Group updated_at: '2017-02-05T06:23:00.000000-08:00' sponsorships: - id: creg-ab12C345DeF6 external_id: ext_id_from_another_system012345 is_subscriber: true type: employee company: id: com-ab12C345DeF6 name: Schmoogle Inc. family: id: cac-ab12C345DeF6 ssn: masked_number: '***-**-1234' integration_error_message: null integration_last_synced_at: null integration_record_id: null integration_sync_status: enabled integration_web_link: null requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/Provider.CustomerInvoicesController.create_body' get: tags: - CustomerInvoice operationId: CustomerInvoice.ListAllCustomerInvoices summary: List All Customer Invoices description: '' parameters: - name: updated_at in: query required: false description: Allows filtering by date or time. Accepts an object with allowed keys of [gte, gt, lte, lt] and a value of the date or time in iso8601 format. See [advanced querying](https://developers.hint.com/reference/making-requests#advanced-querying) for more information. schema: type: string format: date-time - name: created_at in: query required: false description: Allows filtering by date or time. Accepts an object with allowed keys of [gte, gt, lte, lt] and a value of the date or time in iso8601 format. See [advanced querying](https://developers.hint.com/reference/making-requests#advanced-querying) for more information. schema: type: string format: date-time responses: '200': description: Successful response content: application/json: schema: type: array items: $ref: '#/components/schemas/Public.CustomerInvoiceBlueprint_all' example: - id: inv-ab12C345DeF6 amount_in_cents: 4999 charges_count: 1 created_at: '2017-02-05T06:23:00.000000-08:00' date: '2017-02-05' due_in_cents: 4999 human_status: draft integration_record_id: ABCD0012011 invoice_number: 1 last_sent_at: null last_viewed_at: null paid_at: null paid_in_cents: 0 payment_status: null payments_count: 0 provider_web_link: https://app.hint.com/patients/pat-ab12C345DeF6/charges/inv-ab12C345DeF6 received_in_cents: 0 status: draft subtotal_in_cents: 4999 tax_in_cents: 0 total_in_cents: 4999 updated_at: '2017-02-05T06:23:00.000000-08:00' 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: active 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 account: name: Gordon Thomas Sumner past_due_in_cents: 0 company: id: com-ab12C345DeF6 name: Schmoogle Inc. emergency_contact: id: emc-ab12C345DeF6 first_name: Eliot last_name: Sumner email: bass_eliot@iblamecoco.com name: Eliot Sumner relationship: sibling phone: number: '5553050051' type: mobile us_formattable: true external_records: [] known_practice: null 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' location: id: loc-ab12C345DeF6 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: null name: San Francisco HQ phone_number: null virtual: false location_group: id: prg-ab12C345DeF6 created_at: '2017-02-05T06:23:00.000000-08:00' integration_record_id: null name: Downtown Location Group updated_at: '2017-02-05T06:23:00.000000-08:00' location_group: id: prg-ab12C345DeF6 created_at: '2017-02-05T06:23:00.000000-08:00' integration_record_id: null name: Downtown Location Group updated_at: '2017-02-05T06:23:00.000000-08:00' membership_members: [] memberships: [] merged_into: null phones: [] practitioner: id: pct-ab12C345DeF6 accepts_enrollments_from_employer: true accepts_enrollments_from_retail: true bio: Reginalds biography... created_at: '2017-02-05T06:23:00.000000-08:00' education: - The University of Hint email: rocket_man@emi.com gender: male gender_other: null integration_record_id: null max_patient_age: 50 min_patient_age: 0 name: Reginald Dwight online_signup_visibility: true panel_size: 150 panel_size_limit: 200 photo_url: practitioners/000/000/115/photos/original.png updated_at: '2017-02-05T06:23:00.000000-08:00' locations: - id: loc-ab12C345DeF6 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: null name: San Francisco HQ phone_number: '5553050019' virtual: false location_group: id: prg-ab12C345DeF6 created_at: '2017-02-05T06:23:00.000000-08:00' integration_record_id: null name: Downtown Location Group updated_at: '2017-02-05T06:23:00.000000-08:00' npi: first_name: REGINALD last_name: DWIGHT number: 0123456879 organization_name: HINT HEALTH type: individual specialties: - id: spe-ab12C345DeF6 name: Internal Medicine practitioner_group: id: prg-ab12C345DeF6 created_at: '2017-02-05T06:23:00.000000-08:00' integration_record_id: null name: Downtown Location Group updated_at: '2017-02-05T06:23:00.000000-08:00' sponsorships: - id: creg-ab12C345DeF6 external_id: ext_id_from_another_system012345 is_subscriber: true type: employee company: id: com-ab12C345DeF6 name: Schmoogle Inc. family: id: cac-ab12C345DeF6 ssn: masked_number: '***-**-1234' integration_error_message: null integration_last_synced_at: null integration_record_id: null integration_sync_status: enabled integration_web_link: null headers: X-Count: description: The number of resources returned in this request schema: type: integer X-Total-Count: description: The total number of resources available (scoped to query params) schema: type: integer /provider/customer_invoices/{customer_invoice_id}/pdf: post: tags: - CustomerInvoice operationId: CustomerInvoice.CreatePDF summary: Generate PDF for Customer Invoice description: "## Usage Instructions and Security Best Practices\n - **Link Expiration:**\ \ Links expire after 15 minutes.\n - **Authenticate Users:** Only generate\ \ pdf links for authenticated users.\n - **On-Demand Links:** Generate the\ \ link only when a user requests to view or download a pdf.\n - **New Windows/Tabs:**\ \ Automatically redirect users to the URL provided, instead of showing them\ \ the link\n directly.\n - **Avoid Caching:** Do not cache or store pdf links\ \ in your application.\n - **Avoid Email Transmission:** Never send pdf links\ \ via email due to link expiry and security concerns.\n## Example Workflow\n\ \ 1. **Request Access:** User logs into your system and requests to view a\ \ pdf.\n 2. **Generate Link:** Your system makes a POST request to the pdf\ \ endpoint.\n 3. **Provide Link:** Your application receives the URL and automatically\ \ redirects the user to the URL in a new\n window or tab." parameters: - name: customer_invoice_id in: path required: true description: Unique Customer Invoice ID schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/Public.PdfBlueprint_one' example: url: https://api.hint.com/api/files/0jlsWoWWS2M6?account_token=example_token /provider/customer_invoices/{id}: delete: tags: - CustomerInvoice operationId: CustomerInvoice.DeleteCustomerInvoice summary: Delete Customer Invoice description: '' parameters: - name: id in: path required: true description: Unique Customer Invoice ID schema: type: string responses: '204': description: No content get: tags: - CustomerInvoice operationId: CustomerInvoice.ShowCustomerInvoice summary: Show Customer Invoice description: '**Status Options:** draft, issued, sent, cancelled, retrying, bad_debt, paid, disputed **Human Status Options:** draft, issued, sent, cancelled, bank_not_verified, needs_payment_info, retrying, bad_debt, paid, disputed' parameters: - name: id in: path required: true description: Unique Customer Invoice ID schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/Public.CustomerInvoiceBlueprint_one' example: id: inv-ab12C345DeF6 amount_in_cents: 4999 charges_count: 1 created_at: '2017-02-05T06:23:00.000000-08:00' date: '2017-02-05' due_in_cents: 4999 human_status: draft integration_record_id: ABCD0012016 invoice_number: 1 last_sent_at: null last_viewed_at: null paid_at: null paid_in_cents: 0 payment_status: null payments_count: 0 provider_web_link: https://app.hint.com/patients/pat-ab12C345DeF6/charges/inv-ab12C345DeF6 received_in_cents: 0 status: draft subtotal_in_cents: 4999 tax_in_cents: 0 total_in_cents: 4999 updated_at: '2017-02-05T06:23:00.000000-08:00' 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: active 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 account: name: Gordon Thomas Sumner past_due_in_cents: 0 company: id: com-ab12C345DeF6 name: Schmoogle Inc. emergency_contact: id: emc-ab12C345DeF6 first_name: Eliot last_name: Sumner email: bass_eliot@iblamecoco.com name: Eliot Sumner relationship: sibling phone: number: '5553050051' type: mobile us_formattable: true external_records: [] known_practice: null 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' location: id: loc-ab12C345DeF6 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: null name: San Francisco HQ phone_number: null virtual: false location_group: id: prg-ab12C345DeF6 created_at: '2017-02-05T06:23:00.000000-08:00' integration_record_id: null name: Downtown Location Group updated_at: '2017-02-05T06:23:00.000000-08:00' location_group: id: prg-ab12C345DeF6 created_at: '2017-02-05T06:23:00.000000-08:00' integration_record_id: null name: Downtown Location Group updated_at: '2017-02-05T06:23:00.000000-08:00' membership_members: [] memberships: [] merged_into: null phones: [] practitioner: id: pct-ab12C345DeF6 accepts_enrollments_from_employer: true accepts_enrollments_from_retail: true bio: Reginalds biography... created_at: '2017-02-05T06:23:00.000000-08:00' education: - The University of Hint email: rocket_man@emi.com gender: male gender_other: null integration_record_id: null max_patient_age: 50 min_patient_age: 0 name: Reginald Dwight online_signup_visibility: true panel_size: 150 panel_size_limit: 200 photo_url: practitioners/000/000/115/photos/original.png updated_at: '2017-02-05T06:23:00.000000-08:00' locations: - id: loc-ab12C345DeF6 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: null name: San Francisco HQ phone_number: '5553050019' virtual: false location_group: id: prg-ab12C345DeF6 created_at: '2017-02-05T06:23:00.000000-08:00' integration_record_id: null name: Downtown Location Group updated_at: '2017-02-05T06:23:00.000000-08:00' npi: first_name: REGINALD last_name: DWIGHT number: 0123456879 organization_name: HINT HEALTH type: individual specialties: - id: spe-ab12C345DeF6 name: Internal Medicine practitioner_group: id: prg-ab12C345DeF6 created_at: '2017-02-05T06:23:00.000000-08:00' integration_record_id: null name: Downtown Location Group updated_at: '2017-02-05T06:23:00.000000-08:00' sponsorships: - id: creg-ab12C345DeF6 external_id: ext_id_from_another_system012345 is_subscriber: true type: employee company: id: com-ab12C345DeF6 name: Schmoogle Inc. family: id: cac-ab12C345DeF6 ssn: masked_number: '***-**-1234' integration_error_message: null integration_last_synced_at: null integration_record_id: null integration_sync_status: enabled integration_web_link: null patch: tags: - CustomerInvoice operationId: CustomerInvoice.UpdateCustomerInvoice summary: Update Customer Invoice description: '' parameters: - name: id in: path required: true description: Unique Customer Invoice ID schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/Public.CustomerInvoiceBlueprint_one' example: id: inv-ab12C345DeF6 amount_in_cents: 4999 charges_count: 1 created_at: '2017-02-05T06:23:00.000000-08:00' date: '2017-02-05' due_in_cents: 4999 human_status: draft integration_record_id: ABCD0012016 invoice_number: 1 last_sent_at: null last_viewed_at: null paid_at: null paid_in_cents: 0 payment_status: null payments_count: 0 provider_web_link: https://app.hint.com/patients/pat-ab12C345DeF6/charges/inv-ab12C345DeF6 received_in_cents: 0 status: draft subtotal_in_cents: 4999 tax_in_cents: 0 total_in_cents: 4999 updated_at: '2017-02-05T06:23:00.000000-08:00' 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: active 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 account: name: Gordon Thomas Sumner past_due_in_cents: 0 company: id: com-ab12C345DeF6 name: Schmoogle Inc. emergency_contact: id: emc-ab12C345DeF6 first_name: Eliot last_name: Sumner email: bass_eliot@iblamecoco.com name: Eliot Sumner relationship: sibling phone: number: '5553050051' type: mobile us_formattable: true external_records: [] known_practice: null 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' location: id: loc-ab12C345DeF6 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: null name: San Francisco HQ phone_number: null virtual: false location_group: id: prg-ab12C345DeF6 created_at: '2017-02-05T06:23:00.000000-08:00' integration_record_id: null name: Downtown Location Group updated_at: '2017-02-05T06:23:00.000000-08:00' location_group: id: prg-ab12C345DeF6 created_at: '2017-02-05T06:23:00.000000-08:00' integration_record_id: null name: Downtown Location Group updated_at: '2017-02-05T06:23:00.000000-08:00' membership_members: [] memberships: [] merged_into: null phones: [] practitioner: id: pct-ab12C345DeF6 accepts_enrollments_from_employer: true accepts_enrollments_from_retail: true bio: Reginalds biography... created_at: '2017-02-05T06:23:00.000000-08:00' education: - The University of Hint email: rocket_man@emi.com gender: male gender_other: null integration_record_id: null max_patient_age: 50 min_patient_age: 0 name: Reginald Dwight online_signup_visibility: true panel_size: 150 panel_size_limit: 200 photo_url: practitioners/000/000/115/photos/original.png updated_at: '2017-02-05T06:23:00.000000-08:00' locations: - id: loc-ab12C345DeF6 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: null name: San Francisco HQ phone_number: '5553050019' virtual: false location_group: id: prg-ab12C345DeF6 created_at: '2017-02-05T06:23:00.000000-08:00' integration_record_id: null name: Downtown Location Group updated_at: '2017-02-05T06:23:00.000000-08:00' npi: first_name: REGINALD last_name: DWIGHT number: 0123456879 organization_name: HINT HEALTH type: individual specialties: - id: spe-ab12C345DeF6 name: Internal Medicine practitioner_group: id: prg-ab12C345DeF6 created_at: '2017-02-05T06:23:00.000000-08:00' integration_record_id: null name: Downtown Location Group updated_at: '2017-02-05T06:23:00.000000-08:00' sponsorships: - id: creg-ab12C345DeF6 external_id: ext_id_from_another_system012345 is_subscriber: true type: employee company: id: com-ab12C345DeF6 name: Schmoogle Inc. family: id: cac-ab12C345DeF6 ssn: masked_number: '***-**-1234' integration_error_message: null integration_last_synced_at: null integration_record_id: null integration_sync_status: enabled integration_web_link: null requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/Provider.CustomerInvoicesController.update_body' /provider/customer_invoices/{id}/issue: post: tags: - CustomerInvoice operationId: CustomerInvoice.IssueCustomerInvoice summary: Issue Customer Invoice description: '' parameters: - name: id in: path required: true description: Unique Customer Invoice ID schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/Public.CustomerInvoiceBlueprint_one' example: id: inv-ab12C345DeF6 amount_in_cents: 4999 charges_count: 1 created_at: '2017-02-05T06:23:00.000000-08:00' date: '2017-02-05' due_in_cents: 4999 human_status: needs_payment_info integration_record_id: ABCD0012021 invoice_number: 1 last_sent_at: null last_viewed_at: null paid_at: null paid_in_cents: 0 payment_status: null payments_count: 0 provider_web_link: https://app.hint.com/patients/pat-ab12C345DeF6/charges/inv-ab12C345DeF6 received_in_cents: 0 status: issued subtotal_in_cents: 4999 tax_in_cents: 0 total_in_cents: 4999 updated_at: '2017-02-05T06:23:00.000000-08:00' 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: active 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 account: name: Gordon Thomas Sumner past_due_in_cents: 4999 company: id: com-ab12C345DeF6 name: Schmoogle Inc. emergency_contact: id: emc-ab12C345DeF6 first_name: Eliot last_name: Sumner email: bass_eliot@iblamecoco.com name: Eliot Sumner relationship: sibling phone: number: '5553050051' type: mobile us_formattable: true external_records: [] known_practice: null 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' location: id: loc-ab12C345DeF6 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: null name: San Francisco HQ phone_number: null virtual: false location_group: id: prg-ab12C345DeF6 created_at: '2017-02-05T06:23:00.000000-08:00' integration_record_id: null name: Downtown Location Group updated_at: '2017-02-05T06:23:00.000000-08:00' location_group: id: prg-ab12C345DeF6 created_at: '2017-02-05T06:23:00.000000-08:00' integration_record_id: null name: Downtown Location Group updated_at: '2017-02-05T06:23:00.000000-08:00' membership_members: [] memberships: [] merged_into: null phones: [] practitioner: id: pct-ab12C345DeF6 accepts_enrollments_from_employer: true accepts_enrollments_from_retail: true bio: Reginalds biography... created_at: '2017-02-05T06:23:00.000000-08:00' education: - The University of Hint email: rocket_man@emi.com gender: male gender_other: null integration_record_id: null max_patient_age: 50 min_patient_age: 0 name: Reginald Dwight online_signup_visibility: true panel_size: 150 panel_size_limit: 200 photo_url: practitioners/000/000/115/photos/original.png updated_at: '2017-02-05T06:23:00.000000-08:00' locations: - id: loc-ab12C345DeF6 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: null name: San Francisco HQ phone_number: '5553050019' virtual: false location_group: id: prg-ab12C345DeF6 created_at: '2017-02-05T06:23:00.000000-08:00' integration_record_id: null name: Downtown Location Group updated_at: '2017-02-05T06:23:00.000000-08:00' npi: first_name: REGINALD last_name: DWIGHT number: 0123456879 organization_name: HINT HEALTH type: individual specialties: - id: spe-ab12C345DeF6 name: Internal Medicine practitioner_group: id: prg-ab12C345DeF6 created_at: '2017-02-05T06:23:00.000000-08:00' integration_record_id: null name: Downtown Location Group updated_at: '2017-02-05T06:23:00.000000-08:00' sponsorships: - id: creg-ab12C345DeF6 external_id: ext_id_from_another_system012345 is_subscriber: true type: employee company: id: com-ab12C345DeF6 name: Schmoogle Inc. family: id: cac-ab12C345DeF6 ssn: masked_number: '***-**-1234' integration_error_message: null integration_last_synced_at: null integration_record_id: null integration_sync_status: enabled integration_web_link: null /provider/customer_invoices/{customer_invoice_id}/payments: post: tags: - CustomerInvoicePayment operationId: CustomerInvoicePayment.CreatePayment summary: Create Payment description: '' parameters: - name: customer_invoice_id in: path required: true description: Unique Customer Invoice ID schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/Public.PaymentBlueprint_one' example: id: pmt-ab12C345DeF6 error_message: null memo: null status: unattempted date: '2017-02-05T06:23:00.000000-08:00' amount_in_cents: 4999 source: id: card-ab12C345DeF6 type: Card requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/Provider.PaymentsController.create_body' get: tags: - CustomerInvoicePayment operationId: CustomerInvoicePayment.ListAllPayments summary: List All Payments description: '' parameters: - name: customer_invoice_id in: path required: true description: Unique Customer Invoice ID schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/Public.PaymentBlueprint_all' example: - id: pmt-ab12C345DeF6 amount_in_cents: 4999 date: '2017-02-05T06:23:00.000000-08:00' error_message: null memo: null status: unattempted source: id: card-ab12C345DeF6 type: Card /provider/customer_invoices/{customer_invoice_id}/payments/{id}: get: tags: - CustomerInvoicePayment operationId: CustomerInvoicePayment.ShowPayment summary: Show Payment description: '' parameters: - name: customer_invoice_id in: path required: true description: Unique Customer Invoice ID schema: type: string - name: id in: path required: true description: Unique Customer Invoice Payment ID schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/Public.PaymentBlueprint_one' example: id: pmt-ab12C345DeF6 error_message: null memo: null status: unattempted date: '2017-02-05T06:23:00.000000-08:00' amount_in_cents: 4999 source: id: card-ab12C345DeF6 type: Card /provider/customer_invoices/{id}/return_to_draft: post: tags: - CustomerInvoice operationId: CustomerInvoice.ReturnToDraft summary: Return Customer Invoice To Draft description: 'Return to draft removes the financial information including revenue from all reports. This action is not possible if the invoice is in a locked reporting period or has any payments.' parameters: - name: id in: path required: true description: Unique Customer Invoice ID schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/Public.CustomerInvoiceBlueprint_one' example: id: inv-ab12C345DeF6 amount_in_cents: 4999 charges_count: 1 created_at: '2017-02-05T06:23:00.000000-08:00' date: '2017-02-05' due_in_cents: 4999 human_status: draft integration_record_id: ABCD0012016 invoice_number: 1 last_sent_at: null last_viewed_at: null paid_at: null paid_in_cents: 0 payment_status: null payments_count: 0 provider_web_link: https://app.hint.com/patients/pat-ab12C345DeF6/charges/inv-ab12C345DeF6 received_in_cents: 0 status: draft subtotal_in_cents: 4999 tax_in_cents: 0 total_in_cents: 4999 updated_at: '2017-02-05T06:23:00.000000-08:00' 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: active 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 account: name: Gordon Thomas Sumner past_due_in_cents: 0 company: id: com-ab12C345DeF6 name: Schmoogle Inc. emergency_contact: id: emc-ab12C345DeF6 first_name: Eliot last_name: Sumner email: bass_eliot@iblamecoco.com name: Eliot Sumner relationship: sibling phone: number: '5553050051' type: mobile us_formattable: true external_records: [] known_practice: null 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' location: id: loc-ab12C345DeF6 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: null name: San Francisco HQ phone_number: null virtual: false location_group: id: prg-ab12C345DeF6 created_at: '2017-02-05T06:23:00.000000-08:00' integration_record_id: null name: Downtown Location Group updated_at: '2017-02-05T06:23:00.000000-08:00' location_group: id: prg-ab12C345DeF6 created_at: '2017-02-05T06:23:00.000000-08:00' integration_record_id: null name: Downtown Location Group updated_at: '2017-02-05T06:23:00.000000-08:00' membership_members: [] memberships: [] merged_into: null phones: [] practitioner: id: pct-ab12C345DeF6 accepts_enrollments_from_employer: true accepts_enrollments_from_retail: true bio: Reginalds biography... created_at: '2017-02-05T06:23:00.000000-08:00' education: - The University of Hint email: rocket_man@emi.com gender: male gender_other: null integration_record_id: null max_patient_age: 50 min_patient_age: 0 name: Reginald Dwight online_signup_visibility: true panel_size: 150 panel_size_limit: 200 photo_url: practitioners/000/000/115/photos/original.png updated_at: '2017-02-05T06:23:00.000000-08:00' locations: - id: loc-ab12C345DeF6 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: null name: San Francisco HQ phone_number: '5553050019' virtual: false location_group: id: prg-ab12C345DeF6 created_at: '2017-02-05T06:23:00.000000-08:00' integration_record_id: null name: Downtown Location Group updated_at: '2017-02-05T06:23:00.000000-08:00' npi: first_name: REGINALD last_name: DWIGHT number: 0123456879 organization_name: HINT HEALTH type: individual specialties: - id: spe-ab12C345DeF6 name: Internal Medicine practitioner_group: id: prg-ab12C345DeF6 created_at: '2017-02-05T06:23:00.000000-08:00' integration_record_id: null name: Downtown Location Group updated_at: '2017-02-05T06:23:00.000000-08:00' sponsorships: - id: creg-ab12C345DeF6 external_id: ext_id_from_another_system012345 is_subscriber: true type: employee company: id: com-ab12C345DeF6 name: Schmoogle Inc. family: id: cac-ab12C345DeF6 ssn: masked_number: '***-**-1234' integration_error_message: null integration_last_synced_at: null integration_record_id: null integration_sync_status: enabled integration_web_link: null /provider/customer_invoices/{id}/void: post: tags: - CustomerInvoice operationId: CustomerInvoice.VoidCustomerInvoice summary: Void Customer Invoice description: '' parameters: - name: id in: path required: true description: Unique Customer Invoice ID schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/Public.CustomerInvoiceBlueprint_one' example: id: inv-ab12C345DeF6 amount_in_cents: 4999 charges_count: 1 created_at: '2017-02-05T06:23:00.000000-08:00' date: '2017-02-05' due_in_cents: 4999 human_status: cancelled integration_record_id: ABCD0012026 invoice_number: 1 last_sent_at: null last_viewed_at: null paid_at: null paid_in_cents: 0 payment_status: null payments_count: 0 provider_web_link: https://app.hint.com/patients/pat-ab12C345DeF6/charges/inv-ab12C345DeF6 received_in_cents: 0 status: cancelled subtotal_in_cents: 4999 tax_in_cents: 0 total_in_cents: 4999 updated_at: '2017-02-05T06:23:00.000000-08:00' 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: active 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 account: name: Gordon Thomas Sumner past_due_in_cents: 0 company: id: com-ab12C345DeF6 name: Schmoogle Inc. emergency_contact: id: emc-ab12C345DeF6 first_name: Eliot last_name: Sumner email: bass_eliot@iblamecoco.com name: Eliot Sumner relationship: sibling phone: number: '5553050051' type: mobile us_formattable: true external_records: [] known_practice: null 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' location: id: loc-ab12C345DeF6 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: null name: San Francisco HQ phone_number: null virtual: false location_group: id: prg-ab12C345DeF6 created_at: '2017-02-05T06:23:00.000000-08:00' integration_record_id: null name: Downtown Location Group updated_at: '2017-02-05T06:23:00.000000-08:00' location_group: id: prg-ab12C345DeF6 created_at: '2017-02-05T06:23:00.000000-08:00' integration_record_id: null name: Downtown Location Group updated_at: '2017-02-05T06:23:00.000000-08:00' membership_members: [] memberships: [] merged_into: null phones: [] practitioner: id: pct-ab12C345DeF6 accepts_enrollments_from_employer: true accepts_enrollments_from_retail: true bio: Reginalds biography... created_at: '2017-02-05T06:23:00.000000-08:00' education: - The University of Hint email: rocket_man@emi.com gender: male gender_other: null integration_record_id: null max_patient_age: 50 min_patient_age: 0 name: Reginald Dwight online_signup_visibility: true panel_size: 150 panel_size_limit: 200 photo_url: practitioners/000/000/115/photos/original.png updated_at: '2017-02-05T06:23:00.000000-08:00' locations: - id: loc-ab12C345DeF6 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: null name: San Francisco HQ phone_number: '5553050019' virtual: false location_group: id: prg-ab12C345DeF6 created_at: '2017-02-05T06:23:00.000000-08:00' integration_record_id: null name: Downtown Location Group updated_at: '2017-02-05T06:23:00.000000-08:00' npi: first_name: REGINALD last_name: DWIGHT number: 0123456879 organization_name: HINT HEALTH type: individual specialties: - id: spe-ab12C345DeF6 name: Internal Medicine practitioner_group: id: prg-ab12C345DeF6 created_at: '2017-02-05T06:23:00.000000-08:00' integration_record_id: null name: Downtown Location Group updated_at: '2017-02-05T06:23:00.000000-08:00' sponsorships: - id: creg-ab12C345DeF6 external_id: ext_id_from_another_system012345 is_subscriber: true type: employee company: id: com-ab12C345DeF6 name: Schmoogle Inc. family: id: cac-ab12C345DeF6 ssn: masked_number: '***-**-1234' integration_error_message: null integration_last_synced_at: null integration_record_id: null integration_sync_status: enabled integration_web_link: null /provider/patients/{patient_id}/interactions/document: post: tags: - DocumentInteraction operationId: DocumentInteraction.CreateDocumentInteraction summary: Create Document Interaction description: '' parameters: - name: patient_id in: path required: true description: Unique Patient ID schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/Public.InteractionBlueprint_one' example: id: inter-ab12C345DeF6 body: This is a test body patient_id: pat-123456 status: draft title: 'Lab #123456' type: partner integration_error_message: null integration_last_synced_at: null integration_record_id: null integration_sync_status: enabled integration_web_link: null requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/Provider.Patients.Interactions.DocumentController.create_body' /provider/patients/{patient_id}/interactions/document/{id}: get: tags: - DocumentInteraction operationId: DocumentInteraction.ShowDocumentInteraction summary: Show Document Interaction description: '' parameters: - name: patient_id in: path required: true description: Unique Patient ID schema: type: string - name: id in: path required: true description: Unique Document Interaction ID schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/Public.InteractionBlueprint_one' example: id: inter-ab12C345DeF6 body: This is a test body patient_id: pat-123456 status: draft title: 'Lab #123456' type: partner integration_error_message: null integration_last_synced_at: null integration_record_id: null integration_sync_status: enabled integration_web_link: null patch: tags: - DocumentInteraction operationId: DocumentInteraction.UpdateDocumentInteraction summary: Update Interaction description: '' parameters: - name: patient_id in: path required: true description: Unique Patient ID schema: type: string - name: id in: path required: true description: Unique Document Interaction ID schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/Public.InteractionBlueprint_one' example: id: inter-ab12C345DeF6 body: This is a test body patient_id: pat-123456 status: draft title: 'Lab #123456' type: partner integration_error_message: null integration_last_synced_at: null integration_record_id: null integration_sync_status: enabled integration_web_link: null requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/Provider.Patients.Interactions.DocumentController.update_body' /provider/companies/{company_id}/employee_divisions: get: tags: - EmployeeDivision operationId: EmployeeDivision.ListAllEmployeeDivisions summary: List All Employee Divisions description: '' parameters: - name: company_id in: path required: true description: Unique Company ID schema: type: string responses: '200': description: Successful response content: application/json: schema: type: array items: $ref: '#/components/schemas/Public.EmployeeDivisionBlueprint_all' example: - id: div-ab12C345DeF6 name: Accounting /provider/patients/{patient_id}/form_responses: get: tags: - FormResponse operationId: FormResponse.ListAllFormResponses summary: List All Form Responses description: '' parameters: - name: patient_id in: path required: true description: Unique Patient ID schema: type: string responses: '200': description: Successful response content: application/json: schema: type: array items: $ref: '#/components/schemas/Public.FormResponseBlueprint_all' example: - id: frmr-ab12C345DeF6 created_at: '2017-02-05T06:23:00.000000-08:00' form: id: form-ab12C345DeF6 description: null name: Form 1 created_at: '2017-02-05T06:23:00.000000-08:00' form_items: - id: frmi-ab12C345DeF6 description: null help_text: null item_type: string title: Question 1 form_response_items: - id: frmri-ab12C345DeF6 answer: Answer 1 respondent: id: pat-ab12C345DeF6 subject: id: pat-ab12C345DeF6 /provider/patients/{patient_id}/form_responses/{id}: get: tags: - FormResponse operationId: FormResponse.ShowFormResponse summary: Show Form Response description: '' parameters: - name: patient_id in: path required: true description: Unique Patient ID schema: type: string - name: id in: path required: true description: Unique Form Response ID schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/Public.FormResponseBlueprint_one' example: id: frmr-ab12C345DeF6 created_at: '2017-02-05T06:23:00.000000-08:00' form: id: form-ab12C345DeF6 description: null name: Form 2 created_at: '2017-02-05T06:23:00.000000-08:00' form_items: - id: frmi-ab12C345DeF6 description: null help_text: null item_type: string title: Question 2 form_response_items: - id: frmri-ab12C345DeF6 answer: Answer 2 respondent: id: pat-ab12C345DeF6 subject: id: pat-ab12C345DeF6 /global_webhook_endpoints: post: tags: - GlobalWebhookEndpoint operationId: GlobalWebhookEndpoint.CreateWebhookEndpointLegacy summary: Create Webhook Endpoint description: '' parameters: [] responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/Platform.WebhookEndpointBlueprint_one' example: id: whep-ab12C345DeF6 created_at: '2017-02-05T06:23:00.000000-08:00' last_delivered_at: null localhost_webhook_url: http://localhost:3000/hint/webhook updated_at: '2017-02-05T06:23:00.000000-08:00' webhook_url: https://api.partner/webhook_endpoint_url partner_backend: id: pbnd-ab12C345DeF6 name: Default requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/Platform.WebhookEndpointsController.create_body' get: tags: - GlobalWebhookEndpoint operationId: GlobalWebhookEndpoint.WebhookEndpointsLegacy summary: List All Webhook Endpoints description: '' parameters: [] responses: '200': description: Successful response content: application/json: schema: type: array items: $ref: '#/components/schemas/Platform.WebhookEndpointBlueprint_all' example: - id: whep-ab12C345DeF6 created_at: '2017-02-05T06:23:00.000000-08:00' last_delivered_at: null localhost_webhook_url: http://localhost:3000/hint/webhook updated_at: '2017-02-05T06:23:00.000000-08:00' webhook_url: https://api.partner/webhook_endpoint_url partner_backend: id: pbnd-ab12C345DeF6 name: Default - id: whep-ab12C345DeF6 created_at: '2017-02-05T06:23:00.000000-08:00' last_delivered_at: null localhost_webhook_url: http://localhost:3000/hint/webhook updated_at: '2017-02-05T06:23:00.000000-08:00' webhook_url: https://api.partner/webhook_endpoint_url partner_backend: id: pbnd-ab12C345DeF6 name: Default - id: whep-ab12C345DeF6 created_at: '2017-02-05T06:23:00.000000-08:00' last_delivered_at: null localhost_webhook_url: http://localhost:3000/hint/webhook updated_at: '2017-02-05T06:23:00.000000-08:00' webhook_url: https://api.partner/webhook_endpoint_url partner_backend: id: pbnd-ab12C345DeF6 name: Default /global_webhook_endpoints/{id}: delete: tags: - GlobalWebhookEndpoint operationId: GlobalWebhookEndpoint.DeleteWebhookEndpointLegacy summary: Delete Webhook Endpoint description: This operation will take effect immediately and cancel all pending and retrying webhooks. parameters: - name: id in: path required: true description: Unique Global Webhook Endpoint ID schema: type: string responses: '204': description: No content get: tags: - GlobalWebhookEndpoint operationId: GlobalWebhookEndpoint.ShowWebhookEndpointLegacy summary: Show Webhook Endpoint description: '' parameters: - name: id in: path required: true description: Unique Global Webhook Endpoint ID schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/Platform.WebhookEndpointBlueprint_one' example: id: whep-ab12C345DeF6 created_at: '2017-02-05T06:23:00.000000-08:00' last_delivered_at: null localhost_webhook_url: http://localhost:3000/hint/webhook updated_at: '2017-02-05T06:23:00.000000-08:00' webhook_url: https://api.partner/webhook_endpoint_url partner_backend: id: pbnd-ab12C345DeF6 name: Default patch: tags: - GlobalWebhookEndpoint operationId: GlobalWebhookEndpoint.UpdateWebhookEndpointLegacy summary: Update Webhook Endpoint description: '' parameters: - name: id in: path required: true description: Unique Global Webhook Endpoint ID schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/Platform.WebhookEndpointBlueprint_one' example: id: whep-ab12C345DeF6 created_at: '2017-02-05T06:23:00.000000-08:00' last_delivered_at: null localhost_webhook_url: http://localhost:3000/hint/webhook updated_at: '2017-02-05T06:23:00.000000-08:00' webhook_url: https://api.partner/webhook_endpoint_url partner_backend: id: pbnd-ab12C345DeF6 name: Default requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/Platform.WebhookEndpointsController.update_body' /integrations/{id}/activate: post: tags: - Integration operationId: Integration.ActivateIntegration summary: Activate Integration description: '' parameters: - name: id in: path required: true description: Unique Integration ID schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/Platform.IntegrationBlueprint_one' example: id: int-ab12C345DeF6 expires_in: null refresh_token: null status: requested token_type: bearer webhook_url_default: null webhook_url_override: https://integration.example.hint.com practice: id: pra-ab12C345DeF6 name: Dr. Phil /integrations/{id}/deactivate: post: tags: - Integration operationId: Integration.DeactivateIntegration summary: Deactivate Integration description: '' parameters: - name: id in: path required: true description: Unique Integration ID schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/Platform.IntegrationBlueprint_one' example: id: int-ab12C345DeF6 expires_in: null refresh_token: null status: inactive token_type: bearer webhook_url_default: null webhook_url_override: https://integration.example.hint.com practice: id: pra-ab12C345DeF6 name: Dr. Phil /integrations: get: tags: - Integration operationId: Integration.ListAllIntegrations summary: List All Integrations description: '' parameters: [] responses: '200': description: Successful response content: application/json: schema: type: array items: $ref: '#/components/schemas/Platform.IntegrationBlueprint_all' example: - id: int-ab12C345DeF6 expires_in: null refresh_token: null status: requested token_type: bearer webhook_url_default: null webhook_url_override: https://integration.example.hint.com practice: id: pra-ab12C345DeF6 name: Dr. Phil /provider/patients/{patient_id}/integration_records: get: tags: - IntegrationRecord operationId: IntegrationRecord.ListAllIntegrationRecords summary: List all IntegrationRecords for a Patient description: '' parameters: - name: patient_id in: path required: true description: Unique Patient ID schema: type: string responses: '200': description: Successful response content: application/json: example: - integration_record_id: ABCD0012027 partner: id: ptr-ab12C345DeF6 name: HealthifyEMR24 /integrations/{id}: get: tags: - Integration operationId: Integration.ShowIntegration summary: Show Integration description: '' parameters: - name: id in: path required: true description: Unique Integration ID schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/Platform.IntegrationBlueprint_one' example: id: int-ab12C345DeF6 expires_in: null refresh_token: null status: requested token_type: bearer webhook_url_default: null webhook_url_override: https://integration.example.hint.com practice: id: pra-ab12C345DeF6 name: Dr. Phil patch: tags: - Integration operationId: Integration.UpdateIntegration summary: Update Integration description: '' parameters: - name: id in: path required: true description: Unique Integration ID schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/Platform.IntegrationBlueprint_one' example: id: int-ab12C345DeF6 expires_in: null refresh_token: null status: requested token_type: bearer webhook_url_default: null webhook_url_override: https://integration.example.hint.com practice: id: pra-ab12C345DeF6 name: Dr. Phil requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/Platform.IntegrationsController.update_body' /provider/interactions: get: tags: - Interaction operationId: Interaction.ListAllInteractions summary: List All Interactions description: '' parameters: - name: patient_id in: query required: false description: Allows filtering interactions by patient id. schema: type: array items: type: string - name: status in: query required: false description: ' Allows filtering interactions by status.' schema: type: array items: type: string enum: - draft - signed - addended - deleted - failed - name: type in: query required: false description: ' Allows filtering interactions by type.' schema: type: array items: type: string enum: - note - phone_call - email - lab - fax - rx - rx_veradigm - rx_dosespot - vitals - document - name: limit in: query required: false description: Allows limiting the number of interactions returned. schema: type: integer format: int32 - name: offset in: query required: false description: Allows offsetting the number of interactions returned. schema: type: integer format: int32 - name: created_at in: query required: false description: Allows filtering by date or time. Accepts an object with allowed keys of [gte, gt, lte, lt] and a value of the date or time in iso8601 format. See [advanced querying](https://developers.hint.com/reference/making-requests#advanced-querying) for more information. schema: type: string format: date-time - name: updated_at in: query required: false description: Allows filtering by date or time. Accepts an object with allowed keys of [gte, gt, lte, lt] and a value of the date or time in iso8601 format. See [advanced querying](https://developers.hint.com/reference/making-requests#advanced-querying) for more information. schema: type: string format: date-time responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/Public.InteractionBlueprint_all' example: - id: inter-ab12C345DeF6 body: This is a test body patient_id: pat-123456 status: draft title: 'Lab #123456' type: partner integration_error_message: null integration_last_synced_at: null integration_record_id: null integration_sync_status: enabled integration_web_link: null - id: inter-ab12C345DeF6 body: This is a test body patient_id: pat-123456 status: draft title: 'Lab #123456' type: partner integration_error_message: null integration_last_synced_at: null integration_record_id: null integration_sync_status: enabled integration_web_link: null - id: inter-ab12C345DeF6 body: This is a test body patient_id: pat-123456 status: draft title: 'Lab #123456' type: partner integration_error_message: null integration_last_synced_at: null integration_record_id: null integration_sync_status: enabled integration_web_link: null headers: X-Count: description: The number of resources returned in this request schema: type: integer X-Total-Count: description: The total number of resources available (scoped to query params) schema: type: integer /provider/interactions/{interaction_id}/notifications: post: tags: - InteractionNotifications operationId: InteractionNotifications.CreateInteractionNotification summary: Create Interaction Notification description: '' parameters: - name: interaction_id in: path required: true description: Unique Interaction ID schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/Public.InteractionNotificationBlueprint_one' example: id: inter-ab12C345DeF6 title: 'Lab #123456' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/Provider.Interactions.NotificationsController.create_body' /provider/companies/{company_id}/invoices: get: tags: - Invoice operationId: Invoice.ListAllInvoices summary: List All Invoices description: '' parameters: - name: company_id in: path required: true description: Unique Company ID schema: type: string responses: '200': description: Successful response content: application/json: example: - id: inv-ab12C345DeF6 amount_in_cents: 20000 human_status: issued invoice_date: '2017-02-01' invoice_number: 1 paid_at: null paid_in_cents: 0 company: id: com-ab12C345DeF6 name: Schmoogle Inc. owner: id: user-ab12C345DeF6 email: fixture@example.com first_name: Joe last_name: Blogs name: Joe Blogs phones: [] /provider/companies/{company_id}/invoices/{invoice_id}/payments: post: tags: - InvoicePayment operationId: InvoicePayment.CreatePayment summary: Create Payment description: '' parameters: - name: company_id in: path required: true description: Unique Company ID schema: type: string - name: invoice_id in: path required: true description: Unique Invoice ID schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/Public.PaymentBlueprint_one' example: id: pmt-ab12C345DeF6 error_message: null memo: null status: unattempted date: '2017-02-05T06:23:00.000000-08:00' amount_in_cents: 4999 source: id: card-ab12C345DeF6 type: Card requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/Provider.PaymentsController.create_body' get: tags: - InvoicePayment operationId: InvoicePayment.ListAllPayments summary: List All Payments description: '' parameters: - name: company_id in: path required: true description: Unique Company ID schema: type: string - name: invoice_id in: path required: true description: Unique Invoice ID schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/Public.PaymentBlueprint_all' example: - id: pmt-ab12C345DeF6 amount_in_cents: 4999 date: '2017-02-05T06:23:00.000000-08:00' error_message: null memo: null status: unattempted source: id: card-ab12C345DeF6 type: Card /provider/companies/{company_id}/invoices/{invoice_id}/payments/{id}: get: tags: - InvoicePayment operationId: InvoicePayment.ShowPayment summary: Show Payment description: '' parameters: - name: company_id in: path required: true description: Unique Company ID schema: type: string - name: invoice_id in: path required: true description: Unique Invoice ID schema: type: string - name: id in: path required: true description: Unique Invoice Payment ID schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/Public.PaymentBlueprint_one' example: id: pmt-ab12C345DeF6 error_message: null memo: null status: unattempted date: '2017-02-05T06:23:00.000000-08:00' amount_in_cents: 4999 source: id: card-ab12C345DeF6 type: Card /provider/companies/{company_id}/invoices/{id}: get: tags: - Invoice operationId: Invoice.ShowInvoice summary: Show Invoice description: '' parameters: - name: company_id in: path required: true description: Unique Company ID schema: type: string - name: id in: path required: true description: Unique Invoice ID schema: type: string responses: '200': description: Successful response content: application/json: example: id: inv-ab12C345DeF6 amount_in_cents: 20000 human_status: issued invoice_date: '2017-02-01' invoice_number: 1 paid_at: null paid_in_cents: 0 company: id: com-ab12C345DeF6 name: Schmoogle Inc. owner: id: user-ab12C345DeF6 email: fixture@example.com first_name: Joe last_name: Blogs name: Joe Blogs phones: [] /provider/patients/{patient_id}/interactions/lab: post: tags: - LabInteraction operationId: LabInteraction.CreateLabInteraction summary: Create Lab Interaction description: '' parameters: - name: patient_id in: path required: true description: Unique Patient ID schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/Public.Interaction.LabBlueprint_one' example: id: inter-2f93f9da35eb293f event_timestamp: '2017-02-05T14:23:00Z' status: fulfilled type: lab vendor_order_id: '123456' order: lab_reference_id: ord-ref-123456 ordered_from: San Francisco Lab authored_on: '2017-02-05T14:23:00Z' collected_at: '2017-02-05T14:23:00Z' author: John Doe author_reference: aut-ref-123456 intent: diagnostic lab_account_id: lab-acc-123456 actions: - reference: act-ref-123 display: LabCorp subject: reference: sub-ref-456 display: John Doe report: issued: '2017-02-05T14:23:00Z' status: final lab_reference_id: lab-ref-123456 order_reference: order-ref-123456 results: - id: res-id-123 code_text: lab-code-text-123 issued: '2017-02-05T14:23:00Z' value_string: 100 mg/dL text: Normal interpretation: - normal subject: John Doe code: - code: lab-code-123 display: lab-code-display-123 value_quantity: value: 100 unit: mg/dL ranges: - text: 120-140 mg/dL low: value: 120 unit: mg/dL high: value: 140 unit: mg/dL - id: res-id-456 code_text: lab-code-text-456 issued: '2017-02-05T14:23:00Z' value_string: 110 mg/dL text: Normal interpretation: - normal subject: John Doe code: - code: lab-code-456 display: lab-code-display-456 value_quantity: value: 110 unit: mg/dL ranges: - text: 100-120 mg/dL low: value: 100 unit: mg/dL high: value: 120 unit: mg/dL integration_error_message: null integration_last_synced_at: null integration_record_id: null integration_sync_status: enabled integration_web_link: null requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/Interaction.LabSanitizer' /provider/patients/{patient_id}/interactions/lab/{id}: get: tags: - LabInteraction operationId: LabInteraction.ShowLabInteraction summary: Show Lab Interaction description: '' parameters: - name: patient_id in: path required: true description: Unique Patient ID schema: type: string - name: id in: path required: true description: Unique Lab Interaction ID schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/Public.Interaction.LabBlueprint_one' example: id: inter-2f93f9da35eb293f event_timestamp: '2017-02-05T14:23:00Z' status: fulfilled type: lab vendor_order_id: '123456' order: lab_reference_id: ord-ref-123456 ordered_from: San Francisco Lab authored_on: '2017-02-05T14:23:00Z' collected_at: '2017-02-05T14:23:00Z' author: John Doe author_reference: aut-ref-123456 intent: diagnostic lab_account_id: lab-acc-123456 actions: - reference: act-ref-123 display: LabCorp subject: reference: sub-ref-456 display: John Doe report: issued: '2017-02-05T14:23:00Z' status: final lab_reference_id: lab-ref-123456 order_reference: order-ref-123456 results: - id: res-id-123 code_text: lab-code-text-123 issued: '2017-02-05T14:23:00Z' value_string: 100 mg/dL text: Normal interpretation: - normal subject: John Doe code: - code: lab-code-123 display: lab-code-display-123 value_quantity: value: 100 unit: mg/dL ranges: - text: 120-140 mg/dL low: value: 120 unit: mg/dL high: value: 140 unit: mg/dL - id: res-id-456 code_text: lab-code-text-456 issued: '2017-02-05T14:23:00Z' value_string: 110 mg/dL text: Normal interpretation: - normal subject: John Doe code: - code: lab-code-456 display: lab-code-display-456 value_quantity: value: 110 unit: mg/dL ranges: - text: 100-120 mg/dL low: value: 100 unit: mg/dL high: value: 120 unit: mg/dL integration_error_message: null integration_last_synced_at: null integration_record_id: null integration_sync_status: enabled integration_web_link: null patch: tags: - LabInteraction operationId: LabInteraction.UpdateLabInteraction summary: Update Lab Interaction description: '' parameters: - name: patient_id in: path required: true description: Unique Patient ID schema: type: string - name: id in: path required: true description: Unique Lab Interaction ID schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/Public.Interaction.LabBlueprint_one' example: id: inter-2f93f9da35eb293f event_timestamp: '2017-02-05T14:23:00Z' status: fulfilled type: lab vendor_order_id: '123456' order: lab_reference_id: ord-ref-123456 ordered_from: San Francisco Lab authored_on: '2017-02-05T14:23:00Z' collected_at: '2017-02-05T14:23:00Z' author: John Doe author_reference: aut-ref-123456 intent: diagnostic lab_account_id: lab-acc-123456 actions: - reference: act-ref-123 display: LabCorp subject: reference: sub-ref-456 display: John Doe report: issued: '2017-02-05T14:23:00Z' status: final lab_reference_id: lab-ref-123456 order_reference: order-ref-123456 results: - id: res-id-123 code_text: lab-code-text-123 issued: '2017-02-05T14:23:00Z' value_string: 100 mg/dL text: Normal interpretation: - normal subject: John Doe code: - code: lab-code-123 display: lab-code-display-123 value_quantity: value: 100 unit: mg/dL ranges: - text: 120-140 mg/dL low: value: 120 unit: mg/dL high: value: 140 unit: mg/dL - id: res-id-456 code_text: lab-code-text-456 issued: '2017-02-05T14:23:00Z' value_string: 110 mg/dL text: Normal interpretation: - normal subject: John Doe code: - code: lab-code-456 display: lab-code-display-456 value_quantity: value: 110 unit: mg/dL ranges: - text: 100-120 mg/dL low: value: 100 unit: mg/dL high: value: 120 unit: mg/dL integration_error_message: null integration_last_synced_at: null integration_record_id: null integration_sync_status: enabled integration_web_link: null requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/Interaction.LabSanitizer' /provider/lead_sources/{id}: delete: tags: - LeadSource operationId: LeadSource.DeleteLeadSource summary: Delete Lead Source description: '' parameters: - name: id in: path required: true description: Unique Lead Source ID schema: type: string responses: '204': description: No content patch: tags: - LeadSource operationId: LeadSource.UpdateLeadSource summary: Update Lead Source description: '' parameters: - name: id in: path required: true description: Unique Lead Source ID schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/Public.LeadSourceBlueprint_one' example: id: lds-ab12C345DeF6 name: Online Ad2 created_at: '2017-02-05T06:23:00.000000-08:00' updated_at: '2017-02-05T06:23:00.000000-08:00' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/Provider.LeadSourcesController.update_body' /provider/lead_sources: post: tags: - LeadSource operationId: LeadSource.LeadSource summary: Create LeadSource description: '' parameters: [] responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/Public.LeadSourceBlueprint_one' example: id: lds-ab12C345DeF6 name: Online Ad2 created_at: '2017-02-05T06:23:00.000000-08:00' updated_at: '2017-02-05T06:23:00.000000-08:00' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/Provider.LeadSourcesController.create_body' get: tags: - LeadSource operationId: LeadSource.LeadSources summary: List All Lead Sources description: '' parameters: [] responses: '200': description: Successful response content: application/json: schema: type: array items: $ref: '#/components/schemas/Public.LeadSourceBlueprint_all' example: - id: lds-ab12C345DeF6 created_at: '2017-02-05T06:23:00.000000-08:00' name: Online Ad1 updated_at: '2017-02-05T06:23:00.000000-08:00' /provider/locations: post: tags: - Location operationId: Location.CreateLocation summary: Create Location description: '' parameters: [] responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/Public.LocationBlueprint_one' example: id: loc-ab12C345DeF6 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: null name: San Francisco HQ phone_number: '5553050019' virtual: false location_group: id: prg-ab12C345DeF6 created_at: '2017-02-05T06:23:00.000000-08:00' integration_record_id: null name: Downtown Location Group updated_at: '2017-02-05T06:23:00.000000-08:00' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/Provider.LocationsController.create_body' get: tags: - Location operationId: Location.ListLocations summary: List All Locations description: '' parameters: - name: near_zip in: query required: false description: The zip code in the centre of your search schema: type: string - name: distance in: query required: false description: The search radius in miles. Defaults to 20 if near_zip is not blank schema: type: integer format: int32 responses: '200': description: Successful response content: application/json: schema: type: array items: $ref: '#/components/schemas/Public.LocationBlueprint_all' example: - id: loc-ab12C345DeF6 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: null name: San Francisco HQ phone_number: '5553050019' virtual: false location_group: id: prg-ab12C345DeF6 created_at: '2017-02-05T06:23:00.000000-08:00' integration_record_id: null name: Downtown Location Group updated_at: '2017-02-05T06:23:00.000000-08:00' /provider/locations/{id}: delete: tags: - Location operationId: Location.DeleteLocation summary: Delete Location description: '' parameters: - name: id in: path required: true description: Unique Location ID schema: type: string responses: '204': description: No content get: tags: - Location operationId: Location.ShowLocation summary: Show Location description: '' parameters: - name: id in: path required: true description: Unique Location ID schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/Public.LocationBlueprint_one' example: id: loc-ab12C345DeF6 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: null name: San Francisco HQ phone_number: '5553050019' virtual: false location_group: id: prg-ab12C345DeF6 created_at: '2017-02-05T06:23:00.000000-08:00' integration_record_id: null name: Downtown Location Group updated_at: '2017-02-05T06:23:00.000000-08:00' patch: tags: - Location operationId: Location.UpdateLocation summary: Update Location description: '' parameters: - name: id in: path required: true description: Unique Location ID schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/Public.LocationBlueprint_one' example: id: loc-ab12C345DeF6 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: null name: San Francisco HQ phone_number: '5553050019' virtual: false location_group: id: prg-ab12C345DeF6 created_at: '2017-02-05T06:23:00.000000-08:00' integration_record_id: null name: Downtown Location Group updated_at: '2017-02-05T06:23:00.000000-08:00' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/Provider.LocationsController.update_body' /provider/memberships/{id}/bill: post: tags: - Membership operationId: Membership.BillMembership summary: Bill Membership description: '' parameters: - name: id in: path required: true description: Unique Membership ID schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/Public.MembershipBlueprint_one' 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 requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/Provider.MembershipsController.bill_body' /provider/memberships/{id}/cancel: post: tags: - Membership operationId: Membership.CancelMembership summary: Cancel Membership description: '' parameters: - name: id in: path required: true description: Unique Membership ID schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/Public.MembershipBlueprint_one' example: id: mem-ab12C345DeF6 bill_date: '2017-03-05' billed_through_date: '2017-03-05' billing_start_date: '2016-12-05' bills_at_end_of_period: false contract_expiration_action: null contract_expires: false contract_period_in_months: null created_at: '2017-02-05T06:23:00.000000-08:00' end_date: '2017-01-05' enrollment_status: inactive fixed_period_rate_in_cents: null fixed_registration_fee_in_cents: null group_code: null is_confirmed: true is_current: false is_processing: false is_restartable: false list_price_in_cents: 5000 next_bill_date: null period_in_months: 1 period_rate_in_cents: 5000 rate_in_cents: 5000 source_status: null start_date: '2016-12-05' status: ended 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: null start_date: '2016-12-05' uses_tobacco: false end_date: '2017-01-05' 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: inactive 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: ABCD0012028 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: inactive 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: ABCD0012028 integration_sync_status: enabled integration_web_link: null plan: id: pln-ab12C345DeF6 name: Membership plan_type: retail sponsorship: null upcoming_bills: [] requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/Provider.MembershipsController.cancel_body' /provider/memberships/{id}/confirm: post: tags: - Membership operationId: Membership.ConfirmMembership summary: Confirm Membership description: '' parameters: - name: id in: path required: true description: Unique Membership ID schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/Public.MembershipBlueprint_one' 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 /provider/memberships/{membership_id}/contracts: get: tags: - MembershipContract operationId: MembershipContract.ListAllMembershipContracts summary: List all Membership Contracts description: '' parameters: - name: membership_id in: path required: true description: Unique Membership ID schema: type: string responses: '200': description: Successful response content: application/json: schema: type: array items: $ref: '#/components/schemas/Public.MembershipContractBlueprint_all' example: - id: cntr-ab12C345DeF6 end_date: '2018-02-05' memo: null start_date: '2016-08-05' /provider/memberships/{membership_id}/contracts/renew: post: tags: - MembershipContract operationId: MembershipContract.RenewMembershipContract summary: Renew Membership Contract description: '' parameters: - name: membership_id in: path required: true description: Unique Membership ID schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/Public.MembershipContractBlueprint_one' example: id: cntr-ab12C345DeF6 end_date: '2018-02-05' memo: null start_date: '2016-08-05' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/Provider.MembershipContractsController.renew_body' /provider/memberships/{membership_id}/contracts/{id}: patch: tags: - MembershipContract operationId: MembershipContract.UpdateMembershipContract summary: Update Membership Contract description: '' parameters: - name: membership_id in: path required: true description: Unique Membership ID schema: type: string - name: id in: path required: true description: Unique Membership Contract ID schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/Public.MembershipContractBlueprint_one' example: id: cntr-ab12C345DeF6 end_date: '2018-02-05' memo: null start_date: '2016-08-05' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/Provider.MembershipContractsController.update_body' /provider/memberships: post: tags: - Membership operationId: Membership.CreateMembership summary: Create Membership description: '' parameters: [] responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/Public.MembershipBlueprint_one' 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 requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/MembershipCreateSanitizer' get: tags: - Membership operationId: Membership.ListAllMemberships summary: List All Memberships description: '' parameters: - name: updated_at in: query required: false description: Allows filtering by date or time. Accepts an object with allowed keys of [gte, gt, lte, lt] and a value of the date or time in iso8601 format. See [advanced querying](https://developers.hint.com/reference/making-requests#advanced-querying) for more information. schema: type: string format: date-time - name: created_at in: query required: false description: Allows filtering by date or time. Accepts an object with allowed keys of [gte, gt, lte, lt] and a value of the date or time in iso8601 format. See [advanced querying](https://developers.hint.com/reference/making-requests#advanced-querying) for more information. schema: type: string format: date-time responses: '200': description: Successful response content: application/json: schema: type: array items: $ref: '#/components/schemas/Public.MembershipBlueprint_all' example: - id: mem-ab12C345DeF6 bill_date: '2017-02-05' billed_through_date: '2017-02-05' billing_start_date: '2017-02-05' bills_at_end_of_period: false contract_expiration_action: null contract_expires: false contract_period_in_months: null 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: true is_restartable: false last_bill_amount_in_cents: null last_bill_date: null list_price_in_cents: 5000 never_been_billed: true next_bill_date: '2017-02-05' period_in_months: 1 period_rate_in_cents: 5000 rate_in_cents: 5000 source_status: null start_date: '2017-02-05' status: active updated_at: '2017-02-05T06:23:00.000000-08:00' coupon: null membership_patients: - end_date: null enrollment_requested_on: '2017-02-05' enrollment_status: active member_type: spouse start_date: '2017-02-05' status: active uses_tobacco: false patient: id: pat-ab12C345DeF6 name: Gordon Thomas Sumner 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: active 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: ABCD0012032 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-02-05' end_date: '2017-03-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-02-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-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 /provider/memberships/{id}: delete: tags: - Membership operationId: Membership.DeleteMembership summary: Delete Membership description: '' parameters: - name: id in: path required: true description: Unique Membership ID schema: type: string responses: '204': description: No content get: tags: - Membership operationId: Membership.ShowMembership summary: Show Membership description: '**Status Options:** pending, unconfirmed, active, unpaid, ended **Enrollment Status Options:** pending, unconfirmed, active, inactive' parameters: - name: id in: path required: true description: Unique Membership ID schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/Public.MembershipBlueprint_one' 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 patch: tags: - Membership operationId: Membership.UpdateMembership summary: Update Membership description: '' parameters: - name: id in: path required: true description: Unique Membership ID schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/Public.MembershipBlueprint_one' 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 requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/MembershipUpdateSanitizer' /provider/memberships/{membership_id}/members/{id}/cancel: post: tags: - MembershipMember operationId: MembershipMember.CancelMembershipMember summary: Cancel MembershipMember description: '' parameters: - name: membership_id in: path required: true description: Unique Membership ID schema: type: string - name: id in: path required: true description: Unique Membership Member ID schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/Public.MembershipMemberBlueprint_one' example: id: mp-ab12C345DeF6 member_type: spouse status: unpaid fixed_period_rate_in_cents: null list_price_in_cents: null period_rate_in_cents: null revenue_in_cents: null start_date: '2017-02-05' 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: null integration_sync_status: enabled integration_web_link: null requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/Provider.MembersController.cancel_body' /provider/memberships/{membership_id}/members: post: tags: - MembershipMember operationId: MembershipMember.CreateMembershipMember summary: Create MembershipMember description: '' parameters: - name: membership_id in: path required: true description: Unique Membership ID schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/Public.MembershipMemberBlueprint_one' example: id: mp-ab12C345DeF6 member_type: spouse status: unpaid fixed_period_rate_in_cents: null list_price_in_cents: null period_rate_in_cents: null revenue_in_cents: null start_date: '2017-02-05' 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: null integration_sync_status: enabled integration_web_link: null requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/MembershipPatientSanitizer' get: tags: - MembershipMember operationId: MembershipMember.ListMembershipMembers summary: List All MembershipMembers description: '' parameters: - name: membership_id in: path required: true description: Unique Membership ID schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/Public.MembershipMemberBlueprint_all' example: - id: mp-ab12C345DeF6 end_date: null fixed_period_rate_in_cents: null list_price_in_cents: null member_type: spouse period_rate_in_cents: null revenue_in_cents: null start_date: '2017-02-05' status: unpaid 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: null integration_sync_status: enabled integration_web_link: null headers: X-Count: description: The number of resources returned in this request schema: type: integer X-Total-Count: description: The total number of resources available (scoped to query params) schema: type: integer /provider/memberships/{membership_id}/members/{id}: delete: tags: - MembershipMember operationId: MembershipMember.DestroyMembershipMember summary: Destroy MembershipMember description: '' parameters: - name: membership_id in: path required: true description: Unique Membership ID schema: type: string - name: id in: path required: true description: Unique Membership Member ID schema: type: string responses: '200': description: Successful response content: application/json: example: id: mp-ab12C345DeF6 member_type: spouse status: unpaid fixed_period_rate_in_cents: null list_price_in_cents: null period_rate_in_cents: null revenue_in_cents: null start_date: '2017-02-05' 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: null integration_sync_status: enabled integration_web_link: null get: tags: - MembershipMember operationId: MembershipMember.ShowMembershipMember summary: Show MembershipMember description: '' parameters: - name: membership_id in: path required: true description: Unique Membership ID schema: type: string - name: id in: path required: true description: Unique Membership Member ID schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/Public.MembershipMemberBlueprint_one' example: id: mp-ab12C345DeF6 member_type: spouse status: unpaid fixed_period_rate_in_cents: null list_price_in_cents: null period_rate_in_cents: null revenue_in_cents: null start_date: '2017-02-05' 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: null integration_sync_status: enabled integration_web_link: null patch: tags: - MembershipMember operationId: MembershipMember.UpdateMembershipMember summary: Update Member description: '' parameters: - name: membership_id in: path required: true description: Unique Membership ID schema: type: string - name: id in: path required: true description: Unique Membership Member ID schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/Public.MembershipMemberBlueprint_one' example: id: mp-ab12C345DeF6 member_type: spouse status: unpaid fixed_period_rate_in_cents: null list_price_in_cents: null period_rate_in_cents: null revenue_in_cents: null start_date: '2017-02-05' 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: null integration_sync_status: enabled integration_web_link: null requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/MembershipPatientSanitizer' /provider/memberships/new: get: tags: - Membership operationId: Membership.NewMembership summary: New Membership description: Builds a default membership parameters: - name: owner in: query required: true description: '' schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/Public.MembershipBlueprint_one' 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 /oauth/tokens: post: tags: - OAuth operationId: OAuth.OauthTokens summary: Exchange Code for Access Token description: '' parameters: [] responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/Platform.IntegrationBlueprint_one_with_access_token' example: id: int-ab12C345DeF6 access_token: i22X3eTjsV9kfNapfpuKYPrFU0hINpK9tVG3 expires_in: null refresh_token: null status: active token_type: bearer webhook_url_default: null webhook_url_override: https://integration.example.hint.com activated_by: id: user-ab12C345DeF6 name: Joe Blogs email: joe_170@example.com api_keys: - deactivated_at: null description: Hint-Partner EMR last_used_at: null token: i22X3eTjsV9kfNapfpuKYPrFU0hINpK9tVG3 practice: id: pra-ab12C345DeF6 name: Dr. Phil product: id: ppro-ab12C345DeF6 name: Hint-Partner EMR slug: hint-partner-emr-oauth-example requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/Platform.OauthsController.tokens_body' /provider/partner_charges: post: tags: - PartnerCharge operationId: PartnerCharge.CreatePartnerCharge summary: Create Partner Charge description: '**Workflows:** Charging a patient: Set the payer to the be the patient. Charging a patient: Set the payer to the be practice.' parameters: [] responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/Public.PartnerChargeBlueprint_one' example: id: ptrchg-ab12C345DeF6 amount_in_cents: 1000 description: Partner charge requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/Provider.PartnerChargesController.create_body' get: tags: - PartnerCharge operationId: PartnerCharge.ListAllPartnerCharges summary: List All Partner Charges description: '' parameters: [] responses: '200': description: Successful response content: application/json: schema: type: array items: $ref: '#/components/schemas/Public.PartnerChargeBlueprint_all' headers: X-Count: description: The number of resources returned in this request schema: type: integer X-Total-Count: description: The total number of resources available (scoped to query params) schema: type: integer /provider/partner_charges/{id}: get: tags: - PartnerCharge operationId: PartnerCharge.ShowPartnerCharge summary: Show Partner Charge description: '' parameters: - name: id in: path required: true description: Unique Partner Charge ID schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/Public.PartnerChargeBlueprint_one' example: id: ptrchg-ab12C345DeF6 amount_in_cents: 1000 description: Partner charge /provider/patients/{patient_id}/interactions/partner: post: tags: - PartnerInteraction operationId: PartnerInteraction.CreatePartnerInteraction summary: Create Partner Interaction description: '' parameters: - name: patient_id in: path required: true description: Unique Patient ID schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/Public.InteractionBlueprint_one' example: id: inter-ab12C345DeF6 body: This is a test body patient_id: pat-123456 status: draft title: 'Lab #123456' type: partner integration_error_message: null integration_last_synced_at: null integration_record_id: null integration_sync_status: enabled integration_web_link: null requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/Provider.Patients.Interactions.PartnerController.create_body' /provider/patients/{patient_id}/interactions/partner/{id}: get: tags: - PartnerInteraction operationId: PartnerInteraction.ShowPartnerInteraction summary: Show Partner Interaction description: '' parameters: - name: patient_id in: path required: true description: Unique Patient ID schema: type: string - name: id in: path required: true description: Unique Partner Interaction ID schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/Public.InteractionBlueprint_one' example: id: inter-ab12C345DeF6 body: This is a test body patient_id: pat-123456 status: draft title: 'Lab #123456' type: partner integration_error_message: null integration_last_synced_at: null integration_record_id: null integration_sync_status: enabled integration_web_link: null patch: tags: - PartnerInteraction operationId: PartnerInteraction.UpdatePartnerInteraction summary: Update Partner Interaction description: '' parameters: - name: patient_id in: path required: true description: Unique Patient ID schema: type: string - name: id in: path required: true description: Unique Partner Interaction ID schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/Public.InteractionBlueprint_one' example: id: inter-ab12C345DeF6 body: This is a test body patient_id: pat-123456 status: draft title: 'Lab #123456' type: partner integration_error_message: null integration_last_synced_at: null integration_record_id: null integration_sync_status: enabled integration_web_link: null requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/Provider.Patients.Interactions.PartnerController.update_body' /partner: get: tags: - Partner operationId: Partner.ShowPartnerLegacy summary: Show Partner description: '' parameters: [] responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/Platform.PartnerBlueprint_one' example: id: ptr-ab12C345DeF6 email: jane.doe@hint-partner-emr.com logo_url: null name: Hint-Partner EMR webhook_url: https://hint-partner-emr.com/webhooks/hint patch: tags: - Partner operationId: Partner.UpdatePartnerLegacy summary: Update Partner description: '' parameters: [] responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/Platform.PartnerBlueprint_one' example: id: ptr-ab12C345DeF6 email: jane.doe@hint-partner-emr.com logo_url: null name: Hint-Partner EMR webhook_url: https://hint-partner-emr.com/webhooks/hint requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/Platform.PartnersController.update_body' /provider/patients: post: tags: - Patient operationId: Patient.CreatePatient summary: Create Patient description: '' parameters: [] responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/Public.PatientBlueprint_one' example: 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: 60 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: '1956-04-24' 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: active 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 account: name: Gordon Thomas Sumner past_due_in_cents: 0 company: id: com-ab12C345DeF6 name: Schmoogle Inc. emergency_contact: id: emc-ab12C345DeF6 first_name: Eliot last_name: Sumner email: bass_eliot@iblamecoco.com name: Eliot Sumner relationship: sibling phone: number: '5553050051' type: mobile us_formattable: true external_records: [] known_practice: null 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' location: id: loc-ab12C345DeF6 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: null name: San Francisco HQ phone_number: null virtual: false location_group: id: prg-ab12C345DeF6 created_at: '2017-02-05T06:23:00.000000-08:00' integration_record_id: null name: Downtown Location Group updated_at: '2017-02-05T06:23:00.000000-08:00' location_group: id: prg-ab12C345DeF6 created_at: '2017-02-05T06:23:00.000000-08:00' integration_record_id: null name: Downtown Location Group updated_at: '2017-02-05T06:23:00.000000-08:00' membership_members: - id: mp-ab12C345DeF6 enrollment_status: active member_type: spouse status: active enrollment_requested_on: '2017-02-05' start_date: '2017-02-01' end_date: null membership: id: mem-ab12C345DeF6 memberships: - end_date: null enrollment_requested_on: '2017-02-05' enrollment_status: active member_type: spouse start_date: '2017-02-01' status: active uses_tobacco: false company: id: com-ab12C345DeF6 name: Schmoogle Inc. division: id: div-ab12C345DeF6 name: division 20 payer: id: pat-ab12C345DeF6 name: Gordon Thomas Sumner plan: id: pln-ab12C345DeF6 name: Membership plan_type: retail merged_into: null phones: [] practitioner: id: pct-ab12C345DeF6 accepts_enrollments_from_employer: true accepts_enrollments_from_retail: true bio: Reginalds biography... created_at: '2017-02-05T06:23:00.000000-08:00' education: - The University of Hint email: rocket_man@emi.com gender: male gender_other: null integration_record_id: null max_patient_age: 50 min_patient_age: 0 name: Reginald Dwight online_signup_visibility: true panel_size: 150 panel_size_limit: 200 photo_url: practitioners/000/000/115/photos/original.png updated_at: '2017-02-05T06:23:00.000000-08:00' locations: - id: loc-ab12C345DeF6 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: null name: San Francisco HQ phone_number: '5553050019' virtual: false location_group: id: prg-ab12C345DeF6 created_at: '2017-02-05T06:23:00.000000-08:00' integration_record_id: null name: Downtown Location Group updated_at: '2017-02-05T06:23:00.000000-08:00' npi: first_name: REGINALD last_name: DWIGHT number: 0123456879 organization_name: HINT HEALTH type: individual specialties: - id: spe-ab12C345DeF6 name: Internal Medicine practitioner_group: id: prg-ab12C345DeF6 created_at: '2017-02-05T06:23:00.000000-08:00' integration_record_id: null name: Downtown Location Group updated_at: '2017-02-05T06:23:00.000000-08:00' 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 - id: creg-ab12C345DeF6 external_id: ext_id_from_another_system012345 is_subscriber: true type: employee company: id: com-ab12C345DeF6 name: Schmoogle Inc. family: id: cac-ab12C345DeF6 ssn: masked_number: '***-**-1234' integration_error_message: null integration_last_synced_at: null integration_record_id: null integration_sync_status: enabled integration_web_link: null requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/Provider.PatientsController.create_body' get: tags: - Patient operationId: Patient.ListAllPatients summary: List All Patients description: '**Note:** Archived patients are excluded from responses by default. Use `filter=archived` to return only archived patients.' parameters: - name: limit in: query required: false description: Allows limiting the number of patients returned. schema: type: integer format: int32 - name: offset in: query required: false description: Allows offsetting the number of patients returned. schema: type: integer format: int32 - name: filter in: query required: false description: Show only archived patients. schema: type: string enum: - archived responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/Public.PatientBlueprint_all' example: - 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: active 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 account: name: Gordon Thomas Sumner past_due_in_cents: 0 company: id: com-ab12C345DeF6 name: Schmoogle Inc. emergency_contact: id: emc-ab12C345DeF6 first_name: Eliot last_name: Sumner email: bass_eliot@iblamecoco.com name: Eliot Sumner relationship: sibling phone: number: '5553050051' type: mobile us_formattable: true external_records: [] known_practice: null 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' location: id: loc-ab12C345DeF6 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: null name: San Francisco HQ phone_number: null virtual: false location_group: id: prg-ab12C345DeF6 created_at: '2017-02-05T06:23:00.000000-08:00' integration_record_id: null name: Downtown Location Group updated_at: '2017-02-05T06:23:00.000000-08:00' location_group: id: prg-ab12C345DeF6 created_at: '2017-02-05T06:23:00.000000-08:00' integration_record_id: null name: Downtown Location Group updated_at: '2017-02-05T06:23:00.000000-08:00' membership_members: [] memberships: [] merged_into: null phones: [] practitioner: id: pct-ab12C345DeF6 accepts_enrollments_from_employer: true accepts_enrollments_from_retail: true bio: Reginalds biography... created_at: '2017-02-05T06:23:00.000000-08:00' education: - The University of Hint email: rocket_man@emi.com gender: male gender_other: null integration_record_id: null max_patient_age: 50 min_patient_age: 0 name: Reginald Dwight online_signup_visibility: true panel_size: 150 panel_size_limit: 200 photo_url: practitioners/000/000/115/photos/original.png updated_at: '2017-02-05T06:23:00.000000-08:00' locations: - id: loc-ab12C345DeF6 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: null name: San Francisco HQ phone_number: '5553050019' virtual: false location_group: id: prg-ab12C345DeF6 created_at: '2017-02-05T06:23:00.000000-08:00' integration_record_id: null name: Downtown Location Group updated_at: '2017-02-05T06:23:00.000000-08:00' npi: first_name: REGINALD last_name: DWIGHT number: 0123456879 organization_name: HINT HEALTH type: individual specialties: - id: spe-ab12C345DeF6 name: Internal Medicine practitioner_group: id: prg-ab12C345DeF6 created_at: '2017-02-05T06:23:00.000000-08:00' integration_record_id: null name: Downtown Location Group updated_at: '2017-02-05T06:23:00.000000-08:00' sponsorships: - id: creg-ab12C345DeF6 external_id: ext_id_from_another_system012345 is_subscriber: true type: employee company: id: com-ab12C345DeF6 name: Schmoogle Inc. family: id: cac-ab12C345DeF6 ssn: masked_number: '***-**-1234' integration_error_message: null integration_last_synced_at: null integration_record_id: null integration_sync_status: enabled integration_web_link: null headers: X-Count: description: The number of resources returned in this request schema: type: integer X-Total-Count: description: The total number of resources available (scoped to query params) schema: type: integer /provider/patients/{id}: delete: tags: - Patient operationId: Patient.DeletePatient summary: Delete Patient description: '' parameters: - name: id in: path required: true description: Unique Patient ID schema: type: string responses: '204': description: No content get: tags: - Patient operationId: Patient.ShowPatient summary: Show Patient description: '**Membership Status Options:** unconfirmed, pending, active, unpaid, inactive, archived' parameters: - name: id in: path required: true description: Unique Patient ID schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/Public.PatientBlueprint_one' example: 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: 60 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: '1956-04-24' 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: active 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 account: name: Gordon Thomas Sumner past_due_in_cents: 0 company: id: com-ab12C345DeF6 name: Schmoogle Inc. emergency_contact: id: emc-ab12C345DeF6 first_name: Eliot last_name: Sumner email: bass_eliot@iblamecoco.com name: Eliot Sumner relationship: sibling phone: number: '5553050051' type: mobile us_formattable: true external_records: [] known_practice: null 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' location: id: loc-ab12C345DeF6 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: null name: San Francisco HQ phone_number: null virtual: false location_group: id: prg-ab12C345DeF6 created_at: '2017-02-05T06:23:00.000000-08:00' integration_record_id: null name: Downtown Location Group updated_at: '2017-02-05T06:23:00.000000-08:00' location_group: id: prg-ab12C345DeF6 created_at: '2017-02-05T06:23:00.000000-08:00' integration_record_id: null name: Downtown Location Group updated_at: '2017-02-05T06:23:00.000000-08:00' membership_members: - id: mp-ab12C345DeF6 enrollment_status: active member_type: spouse status: active enrollment_requested_on: '2017-02-05' start_date: '2017-02-01' end_date: null membership: id: mem-ab12C345DeF6 memberships: - end_date: null enrollment_requested_on: '2017-02-05' enrollment_status: active member_type: spouse start_date: '2017-02-01' status: active uses_tobacco: false company: id: com-ab12C345DeF6 name: Schmoogle Inc. division: id: div-ab12C345DeF6 name: division 20 payer: id: pat-ab12C345DeF6 name: Gordon Thomas Sumner plan: id: pln-ab12C345DeF6 name: Membership plan_type: retail merged_into: null phones: [] practitioner: id: pct-ab12C345DeF6 accepts_enrollments_from_employer: true accepts_enrollments_from_retail: true bio: Reginalds biography... created_at: '2017-02-05T06:23:00.000000-08:00' education: - The University of Hint email: rocket_man@emi.com gender: male gender_other: null integration_record_id: null max_patient_age: 50 min_patient_age: 0 name: Reginald Dwight online_signup_visibility: true panel_size: 150 panel_size_limit: 200 photo_url: practitioners/000/000/115/photos/original.png updated_at: '2017-02-05T06:23:00.000000-08:00' locations: - id: loc-ab12C345DeF6 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: null name: San Francisco HQ phone_number: '5553050019' virtual: false location_group: id: prg-ab12C345DeF6 created_at: '2017-02-05T06:23:00.000000-08:00' integration_record_id: null name: Downtown Location Group updated_at: '2017-02-05T06:23:00.000000-08:00' npi: first_name: REGINALD last_name: DWIGHT number: 0123456879 organization_name: HINT HEALTH type: individual specialties: - id: spe-ab12C345DeF6 name: Internal Medicine practitioner_group: id: prg-ab12C345DeF6 created_at: '2017-02-05T06:23:00.000000-08:00' integration_record_id: null name: Downtown Location Group updated_at: '2017-02-05T06:23:00.000000-08:00' 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 - id: creg-ab12C345DeF6 external_id: ext_id_from_another_system012345 is_subscriber: true type: employee company: id: com-ab12C345DeF6 name: Schmoogle Inc. family: id: cac-ab12C345DeF6 ssn: masked_number: '***-**-1234' integration_error_message: null integration_last_synced_at: null integration_record_id: null integration_sync_status: enabled integration_web_link: null patch: tags: - Patient operationId: Patient.UpdatePatient summary: Update Patient description: '' parameters: - name: id in: path required: true description: Unique Patient ID schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/Public.PatientBlueprint_one' example: 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: 60 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: '1956-04-24' 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: active 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 account: name: Gordon Thomas Sumner past_due_in_cents: 0 company: id: com-ab12C345DeF6 name: Schmoogle Inc. emergency_contact: id: emc-ab12C345DeF6 first_name: Eliot last_name: Sumner email: bass_eliot@iblamecoco.com name: Eliot Sumner relationship: sibling phone: number: '5553050051' type: mobile us_formattable: true external_records: [] known_practice: null 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' location: id: loc-ab12C345DeF6 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: null name: San Francisco HQ phone_number: null virtual: false location_group: id: prg-ab12C345DeF6 created_at: '2017-02-05T06:23:00.000000-08:00' integration_record_id: null name: Downtown Location Group updated_at: '2017-02-05T06:23:00.000000-08:00' location_group: id: prg-ab12C345DeF6 created_at: '2017-02-05T06:23:00.000000-08:00' integration_record_id: null name: Downtown Location Group updated_at: '2017-02-05T06:23:00.000000-08:00' membership_members: - id: mp-ab12C345DeF6 enrollment_status: active member_type: spouse status: active enrollment_requested_on: '2017-02-05' start_date: '2017-02-01' end_date: null membership: id: mem-ab12C345DeF6 memberships: - end_date: null enrollment_requested_on: '2017-02-05' enrollment_status: active member_type: spouse start_date: '2017-02-01' status: active uses_tobacco: false company: id: com-ab12C345DeF6 name: Schmoogle Inc. division: id: div-ab12C345DeF6 name: division 20 payer: id: pat-ab12C345DeF6 name: Gordon Thomas Sumner plan: id: pln-ab12C345DeF6 name: Membership plan_type: retail merged_into: null phones: [] practitioner: id: pct-ab12C345DeF6 accepts_enrollments_from_employer: true accepts_enrollments_from_retail: true bio: Reginalds biography... created_at: '2017-02-05T06:23:00.000000-08:00' education: - The University of Hint email: rocket_man@emi.com gender: male gender_other: null integration_record_id: null max_patient_age: 50 min_patient_age: 0 name: Reginald Dwight online_signup_visibility: true panel_size: 150 panel_size_limit: 200 photo_url: practitioners/000/000/115/photos/original.png updated_at: '2017-02-05T06:23:00.000000-08:00' locations: - id: loc-ab12C345DeF6 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: null name: San Francisco HQ phone_number: '5553050019' virtual: false location_group: id: prg-ab12C345DeF6 created_at: '2017-02-05T06:23:00.000000-08:00' integration_record_id: null name: Downtown Location Group updated_at: '2017-02-05T06:23:00.000000-08:00' npi: first_name: REGINALD last_name: DWIGHT number: 0123456879 organization_name: HINT HEALTH type: individual specialties: - id: spe-ab12C345DeF6 name: Internal Medicine practitioner_group: id: prg-ab12C345DeF6 created_at: '2017-02-05T06:23:00.000000-08:00' integration_record_id: null name: Downtown Location Group updated_at: '2017-02-05T06:23:00.000000-08:00' 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 - id: creg-ab12C345DeF6 external_id: ext_id_from_another_system012345 is_subscriber: true type: employee company: id: com-ab12C345DeF6 name: Schmoogle Inc. family: id: cac-ab12C345DeF6 ssn: masked_number: '***-**-1234' integration_error_message: null integration_last_synced_at: null integration_record_id: null integration_sync_status: enabled integration_web_link: null requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/Provider.PatientsController.update_body' /provider/patients/matching: post: tags: - Patient operationId: Patient.MatchPatients summary: Match Patients description: '' parameters: [] responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/Public.PatientBlueprint_all' example: - 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: active 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 account: name: Gordon Thomas Sumner past_due_in_cents: 0 company: id: com-ab12C345DeF6 name: Schmoogle Inc. emergency_contact: id: emc-ab12C345DeF6 first_name: Eliot last_name: Sumner email: bass_eliot@iblamecoco.com name: Eliot Sumner relationship: sibling phone: number: '5553050051' type: mobile us_formattable: true external_records: [] known_practice: null 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' location: id: loc-ab12C345DeF6 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: null name: San Francisco HQ phone_number: null virtual: false location_group: id: prg-ab12C345DeF6 created_at: '2017-02-05T06:23:00.000000-08:00' integration_record_id: null name: Downtown Location Group updated_at: '2017-02-05T06:23:00.000000-08:00' location_group: id: prg-ab12C345DeF6 created_at: '2017-02-05T06:23:00.000000-08:00' integration_record_id: null name: Downtown Location Group updated_at: '2017-02-05T06:23:00.000000-08:00' membership_members: [] memberships: [] merged_into: null phones: [] practitioner: id: pct-ab12C345DeF6 accepts_enrollments_from_employer: true accepts_enrollments_from_retail: true bio: Reginalds biography... created_at: '2017-02-05T06:23:00.000000-08:00' education: - The University of Hint email: rocket_man@emi.com gender: male gender_other: null integration_record_id: null max_patient_age: 50 min_patient_age: 0 name: Reginald Dwight online_signup_visibility: true panel_size: 150 panel_size_limit: 200 photo_url: practitioners/000/000/115/photos/original.png updated_at: '2017-02-05T06:23:00.000000-08:00' locations: - id: loc-ab12C345DeF6 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: null name: San Francisco HQ phone_number: '5553050019' virtual: false location_group: id: prg-ab12C345DeF6 created_at: '2017-02-05T06:23:00.000000-08:00' integration_record_id: null name: Downtown Location Group updated_at: '2017-02-05T06:23:00.000000-08:00' npi: first_name: REGINALD last_name: DWIGHT number: 0123456879 organization_name: HINT HEALTH type: individual specialties: - id: spe-ab12C345DeF6 name: Internal Medicine practitioner_group: id: prg-ab12C345DeF6 created_at: '2017-02-05T06:23:00.000000-08:00' integration_record_id: null name: Downtown Location Group updated_at: '2017-02-05T06:23:00.000000-08:00' sponsorships: - id: creg-ab12C345DeF6 external_id: ext_id_from_another_system012345 is_subscriber: true type: employee company: id: com-ab12C345DeF6 name: Schmoogle Inc. family: id: cac-ab12C345DeF6 ssn: masked_number: '***-**-1234' integration_error_message: null integration_last_synced_at: null integration_record_id: null integration_sync_status: enabled integration_web_link: null requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/Provider.PatientsController.matching_body' /provider/patients/{patient_id}/payment_methods: post: tags: - PaymentMethod operationId: PaymentMethod.CreatePaymentMethod summary: Create Payment Method description: 'Exactly one of `rainforest_id` or `stripe_id` must be provided. Practices on Hint Payments (Rainforest) submit a `rainforest_id`; practices on Stripe submit a `stripe_id`.' parameters: - name: patient_id in: path required: true description: Unique Patient ID schema: type: string responses: '201': description: Successful response content: application/json: example: id: bnk-ab12C345DeF6 default: true last_four: '4242' name: Bank of America NA type: bank_account bank_account: id: bnk-ab12C345DeF6 last_four: '4242' name: Bank of America NA stripe_token: tok_1234 type: BankAccount card: null requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/Provider.Patients.PaymentMethodsController.create_body' get: tags: - PaymentMethod operationId: PaymentMethod.ListAllPaymentMethods summary: List All Payment Methods description: '' parameters: - name: patient_id in: path required: true description: Unique Patient ID schema: type: string responses: '200': description: Successful response content: application/json: example: - id: card-ab12C345DeF6 default: false last_four: '4242' name: Visa type: card bank_account: null card: id: card-ab12C345DeF6 card_type: visa last_four: '4242' name: Visa type: Card exp_month: 7 exp_year: 2017 - id: card-ab12C345DeF6 default: false last_four: '4242' name: Visa type: card bank_account: null card: id: card-ab12C345DeF6 card_type: visa last_four: '4242' name: Visa type: Card exp_month: 7 exp_year: 2017 - id: bnk-ab12C345DeF6 default: true last_four: '4242' name: Bank of America NA type: bank_account bank_account: id: bnk-ab12C345DeF6 last_four: '4242' name: Bank of America NA stripe_token: tok_1234 type: BankAccount card: null /provider/patients/{patient_id}/payment_methods/setup: post: tags: - PaymentMethod operationId: PaymentMethod.CreateSetupIntent summary: Create Setup Intent description: 'The response shape depends on the practice''s payment processor (`payment_processor` in the response): - When `rainforest`: `payment_method_config_id`, `session_key`, and `allowed_methods` are returned. - When `stripe`: `stripe_client_secret` is returned instead. The example below shows the `rainforest` variant.' parameters: - name: patient_id in: path required: true description: Unique Patient ID schema: type: string responses: '201': description: Successful response content: application/json: example: payment_processor: rainforest payment_method_config_id: pmc_1234567890 session_key: skey_1234 allowed_methods: ACH,CARD requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/Provider.Patients.PaymentMethods.SetupController.create_body' /provider/patients/{patient_id}/payment_methods/{id}: delete: tags: - PaymentMethod operationId: PaymentMethod.DeletePaymentMethod summary: Delete Payment Method description: '' parameters: - name: patient_id in: path required: true description: Unique Patient ID schema: type: string - name: id in: path required: true description: Unique Payment Method ID schema: type: string responses: '204': description: No content get: tags: - PaymentMethod operationId: PaymentMethod.ShowPaymentMethod summary: Show Payment Method description: '' parameters: - name: patient_id in: path required: true description: Unique Patient ID schema: type: string - name: id in: path required: true description: Unique Payment Method ID schema: type: string responses: '200': description: Successful response content: application/json: example: id: bnk-ab12C345DeF6 default: true last_four: '4242' name: Bank of America NA type: bank_account bank_account: id: bnk-ab12C345DeF6 last_four: '4242' name: Bank of America NA stripe_token: tok_1234 type: BankAccount card: null /provider/plans: get: tags: - Plan operationId: Plan.ListAllPlans summary: List All Plans description: '' parameters: - name: plan_type in: query required: false description: Allows filtering by plan_type. May be one of "company", "retail" or "sponsor_fixed_fee". If not given all resources will be returned. schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/Public.PlanBlueprint_all' example: - id: pln-ab12C345DeF6 name: Memberships plan_type: retail headers: X-Count: description: The number of resources returned in this request schema: type: integer X-Total-Count: description: The total number of resources available (scoped to query params) schema: type: integer /provider/practice: get: tags: - Practice operationId: Practice.GetPractice summary: Get Practice description: '' parameters: [] responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/Public.PracticeBlueprint_one' example: id: pra-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' email: hintclinic@example.com name: Hint Health Clinic url: https://www.hint.com logo_url: https://www.hint.com/logo.png integration_record_id: null phones: - number: '4158546466' type: mobile us_formattable: true patch: tags: - Practice operationId: Practice.UpdatePractice summary: Update Practice description: '' parameters: [] responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/Public.PracticeBlueprint_one' example: id: pra-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' email: hintclinic@example.com name: Hint Health Clinic url: https://www.hint.com logo_url: https://www.hint.com/logo.png integration_record_id: null phones: - number: '4158546466' type: mobile us_formattable: true requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/Provider.PracticesController.update_body' /provider/practitioners: post: tags: - Practitioner operationId: Practitioner.CreatePractitioner summary: Create Practitioner description: '' parameters: [] responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/Public.PractitionerBlueprint_one' example: id: pct-ab12C345DeF6 accepts_enrollments_from_employer: true accepts_enrollments_from_retail: true bio: Reginalds biography... created_at: '2017-02-05T06:23:00.000000-08:00' education: - The University of Hint email: rocket_man@emi.com gender: male gender_other: null integration_record_id: ABCD0012051 max_patient_age: 50 min_patient_age: 0 name: Reginald Dwight online_signup_visibility: true panel_size: 150 panel_size_limit: 200 photo_url: practitioners/000/000/115/photos/original.png updated_at: '2017-02-05T06:23:00.000000-08:00' locations: - id: loc-ab12C345DeF6 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: null name: San Francisco HQ phone_number: '5553050019' virtual: false location_group: id: prg-ab12C345DeF6 created_at: '2017-02-05T06:23:00.000000-08:00' integration_record_id: null name: Downtown Location Group updated_at: '2017-02-05T06:23:00.000000-08:00' npi: first_name: REGINALD last_name: DWIGHT number: 0123456879 organization_name: HINT HEALTH type: individual specialties: - id: spe-ab12C345DeF6 name: Internal Medicine requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/Provider.PractitionersController.create_body' get: tags: - Practitioner operationId: Practitioner.ProviderPractitioners summary: List All Practitioners description: '' parameters: - name: near_zip in: query required: false description: The zip code in the centre of your search schema: type: string - name: distance in: query required: false description: The search radius in miles. Defaults to 20 if near_zip is not blank schema: type: integer format: int32 responses: '200': description: Successful response content: application/json: schema: type: array items: $ref: '#/components/schemas/Public.PractitionerBlueprint_all' example: - id: pct-ab12C345DeF6 accepts_enrollments_from_employer: true accepts_enrollments_from_retail: true bio: Reginalds biography... created_at: '2017-02-05T06:23:00.000000-08:00' education: - The University of Hint email: rocket_man@emi.com gender: male gender_other: null integration_record_id: ABCD0012050 max_patient_age: 50 min_patient_age: 0 name: Reginald Dwight online_signup_visibility: true panel_size: 150 panel_size_limit: 200 photo_url: practitioners/000/000/115/photos/original.png updated_at: '2017-02-05T06:23:00.000000-08:00' locations: - id: loc-ab12C345DeF6 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: null name: San Francisco HQ phone_number: '5553050019' virtual: false location_group: id: prg-ab12C345DeF6 created_at: '2017-02-05T06:23:00.000000-08:00' integration_record_id: null name: Downtown Location Group updated_at: '2017-02-05T06:23:00.000000-08:00' npi: first_name: REGINALD last_name: DWIGHT number: 0123456879 organization_name: HINT HEALTH type: individual specialties: - id: spe-ab12C345DeF6 name: Internal Medicine /provider/practitioners/{id}: delete: tags: - Practitioner operationId: Practitioner.DeletePractitioner summary: Delete Practitioner description: '' parameters: - name: id in: path required: true description: Unique Practitioner ID schema: type: string responses: '204': description: No content get: tags: - Practitioner operationId: Practitioner.ShowPractitioner summary: Show Practitioner description: '' parameters: - name: id in: path required: true description: Unique Practitioner ID schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/Public.PractitionerBlueprint_one' example: id: pct-ab12C345DeF6 accepts_enrollments_from_employer: true accepts_enrollments_from_retail: true bio: Reginalds biography... created_at: '2017-02-05T06:23:00.000000-08:00' education: - The University of Hint email: rocket_man@emi.com gender: male gender_other: null integration_record_id: ABCD0012051 max_patient_age: 50 min_patient_age: 0 name: Reginald Dwight online_signup_visibility: true panel_size: 150 panel_size_limit: 200 photo_url: practitioners/000/000/115/photos/original.png updated_at: '2017-02-05T06:23:00.000000-08:00' locations: - id: loc-ab12C345DeF6 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: null name: San Francisco HQ phone_number: '5553050019' virtual: false location_group: id: prg-ab12C345DeF6 created_at: '2017-02-05T06:23:00.000000-08:00' integration_record_id: null name: Downtown Location Group updated_at: '2017-02-05T06:23:00.000000-08:00' npi: first_name: REGINALD last_name: DWIGHT number: 0123456879 organization_name: HINT HEALTH type: individual specialties: - id: spe-ab12C345DeF6 name: Internal Medicine patch: tags: - Practitioner operationId: Practitioner.UpdatePractitioner summary: Update Practitioner description: '' parameters: - name: id in: path required: true description: Unique Practitioner ID schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/Public.PractitionerBlueprint_one' example: id: pct-ab12C345DeF6 accepts_enrollments_from_employer: true accepts_enrollments_from_retail: true bio: Reginalds biography... created_at: '2017-02-05T06:23:00.000000-08:00' education: - The University of Hint email: rocket_man@emi.com gender: male gender_other: null integration_record_id: ABCD0012051 max_patient_age: 50 min_patient_age: 0 name: Reginald Dwight online_signup_visibility: true panel_size: 150 panel_size_limit: 200 photo_url: practitioners/000/000/115/photos/original.png updated_at: '2017-02-05T06:23:00.000000-08:00' locations: - id: loc-ab12C345DeF6 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: null name: San Francisco HQ phone_number: '5553050019' virtual: false location_group: id: prg-ab12C345DeF6 created_at: '2017-02-05T06:23:00.000000-08:00' integration_record_id: null name: Downtown Location Group updated_at: '2017-02-05T06:23:00.000000-08:00' npi: first_name: REGINALD last_name: DWIGHT number: 0123456879 organization_name: HINT HEALTH type: individual specialties: - id: spe-ab12C345DeF6 name: Internal Medicine requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/Provider.PractitionersController.update_body' /provider/quotes: post: tags: - Quote operationId: Quote.CreateQuote summary: Create Quote description: '' parameters: [] responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/Public.QuoteBlueprint_one' example: billing_period: month members: - type: primary age: 27 uses_tobacco: true dob: null start_date: null rate_in_cents: 1100 - type: spouse age: 23 uses_tobacco: false dob: null start_date: null rate_in_cents: 1100 - type: child age: 4 uses_tobacco: false dob: null start_date: null rate_in_cents: 1100 coupon_discount_in_cents: null ongoing_amount_in_cents: 3300 registration_fee_in_cents: 5034 plan: id: pln-ab12C345DeF6 name: Membership plan_type: retail coupon: null requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/QuoteSanitizer' /provider/signup_attempts: get: tags: - SignupAttempt operationId: SignupAttempt.ListSignupAttempts summary: List All Signup Attempts description: '' parameters: - name: signup_page in: query required: false description: '' schema: type: string - name: lead_source in: query required: false description: '' schema: type: string - name: status in: query required: false description: '' schema: type: string - name: updated_at in: query required: false description: Allows filtering by date or time. Accepts an object with allowed keys of [gte, gt, lte, lt] and a value of the date or time in iso8601 format. See [advanced querying](https://developers.hint.com/reference/making-requests#advanced-querying) for more information. schema: type: string format: date-time - name: created_at in: query required: false description: Allows filtering by date or time. Accepts an object with allowed keys of [gte, gt, lte, lt] and a value of the date or time in iso8601 format. See [advanced querying](https://developers.hint.com/reference/making-requests#advanced-querying) for more information. schema: type: string format: date-time responses: '200': description: Successful response content: application/json: schema: type: array items: $ref: '#/components/schemas/Public.SignupAttemptBlueprint_all' example: - id: sat-ab12C345DeF6 created_at: '2017-02-05T06:23:00.000000-08:00' email: john@doe.com first_name: John last_name: Doe lead_source_other: null phone_number: 555-555-5555 status: pending updated_at: '2017-02-05T06:23:00.000000-08:00' zip: '11009' lead_source: id: lds-ab12C345DeF6 name: Online ad signup_page: id: spg-ab12C345DeF6 slug: annual-membership - id: sat-ab12C345DeF6 created_at: '2017-02-05T06:23:00.000000-08:00' email: john@doe.com first_name: John last_name: Doe lead_source_other: null phone_number: 555-555-5555 status: pending updated_at: '2017-02-05T06:23:00.000000-08:00' zip: '11009' lead_source: id: lds-ab12C345DeF6 name: Online ad signup_page: id: spg-ab12C345DeF6 slug: annual-membership - id: sat-ab12C345DeF6 created_at: '2017-02-05T06:23:00.000000-08:00' email: john@doe.com first_name: John last_name: Doe lead_source_other: null phone_number: 555-555-5555 status: pending updated_at: '2017-02-05T06:23:00.000000-08:00' zip: '11009' lead_source: id: lds-ab12C345DeF6 name: Online ad signup_page: id: spg-ab12C345DeF6 slug: annual-membership headers: X-Count: description: The number of resources returned in this request schema: type: integer X-Total-Count: description: The total number of resources available (scoped to query params) schema: type: integer /provider/signup_attempts/{id}: get: tags: - SignupAttempt operationId: SignupAttempt.ShowSignupAttempt summary: Show Signup Attempt description: '' parameters: - name: id in: path required: true description: Unique Signup Attempt ID schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/Public.SignupAttemptBlueprint_one' example: id: sat-ab12C345DeF6 created_at: '2017-02-05T06:23:00.000000-08:00' email: john@doe.com first_name: John last_name: Doe lead_source_other: null phone_number: 555-555-5555 status: pending updated_at: '2017-02-05T06:23:00.000000-08:00' zip: '11009' lead_source: id: lds-ab12C345DeF6 name: Online ad signup_page: id: spg-ab12C345DeF6 slug: annual-membership /provider/patients/{patient_id}/social_security_number: get: tags: - SocialSecurityNumber operationId: SocialSecurityNumber.ShowSocialSecurityNumber summary: Show Social Security Number description: '' parameters: - name: patient_id in: path required: true description: Unique Patient ID schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/Public.SocialSecurityNumberBlueprint_one' example: formatted_number: 808-56-1234 number: '808561234' /provider/companies/{company_id}/sponsorships: post: tags: - Sponsorship operationId: Sponsorship.CreateSponsorship summary: Create Sponsorship description: '' parameters: - name: company_id in: path required: true description: Unique Company ID schema: type: string responses: '200': description: Successful response content: application/json: example: id: creg-ab12C345DeF6 external_id: ext_id_from_another_system012345 is_subscriber: false type: spouse family: id: cac-ab12C345DeF6 patient: id: pat-ab12C345DeF6 name: oxana renquist requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/Provider.CompanySponsorshipsController.create_body' get: tags: - Sponsorship operationId: Sponsorship.ListSponsorships summary: List All Sponsorhips description: '' parameters: - name: company_id in: path required: true description: Unique Company ID schema: type: string - name: family_id in: query required: false description: '' schema: type: string responses: '200': description: Successful response content: application/json: example: - id: creg-ab12C345DeF6 external_id: ext_id_from_another_system012345 is_subscriber: false type: spouse family: id: cac-ab12C345DeF6 patient: id: pat-ab12C345DeF6 name: oxana renquist headers: X-Count: description: The number of resources returned in this request schema: type: integer X-Total-Count: description: The total number of resources available (scoped to query params) schema: type: integer /provider/companies/{company_id}/sponsorships/{id}: delete: tags: - Sponsorship operationId: Sponsorship.DestroySponsorship summary: Destroy Sponsorship description: If the subscriber is destroyed all dependents will be destroyed. parameters: - name: company_id in: path required: true description: Unique Company ID schema: type: string - name: id in: path required: true description: Unique Sponsorship ID schema: type: string responses: '200': description: Successful response content: application/json: example: id: creg-ab12C345DeF6 external_id: ext_id_from_another_system012345 is_subscriber: false type: spouse family: id: cac-ab12C345DeF6 patient: id: pat-ab12C345DeF6 name: oxana renquist get: tags: - Sponsorship operationId: Sponsorship.ShowSponsorhip summary: Show Sponsorship description: '' parameters: - name: company_id in: path required: true description: Unique Company ID schema: type: string - name: id in: path required: true description: Unique Sponsorship ID schema: type: string responses: '200': description: Successful response content: application/json: example: id: creg-ab12C345DeF6 external_id: ext_id_from_another_system012345 is_subscriber: false type: spouse family: id: cac-ab12C345DeF6 patient: id: pat-ab12C345DeF6 name: oxana renquist patch: tags: - Sponsorship operationId: Sponsorship.UpdateSponsorship summary: Update Sponsorship description: '' parameters: - name: company_id in: path required: true description: Unique Company ID schema: type: string - name: id in: path required: true description: Unique Sponsorship ID schema: type: string responses: '200': description: Successful response content: application/json: example: id: creg-ab12C345DeF6 external_id: ext_id_from_another_system012345 is_subscriber: false type: spouse family: id: cac-ab12C345DeF6 patient: id: pat-ab12C345DeF6 name: oxana renquist requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/Provider.CompanySponsorshipsController.update_body' /provider/patients/{patient_id}/supplements: post: tags: - Supplements operationId: Supplements.CreateSupplement summary: Create Patient Supplement description: '' parameters: - name: patient_id in: path required: true description: Unique Patient ID schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/Public.SupplementBlueprint_one' example: id: med-e548304 product_name: Product Name quantity: 1 sig_text: Take 1 capsule daily with food strength: '100' strength_uom: mg integration_error_message: null integration_last_synced_at: null integration_record_id: null integration_sync_status: enabled integration_web_link: null requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/Provider.Patients.SupplementsController.create_body' get: tags: - Supplements operationId: Supplements.ListAllPatientSupplements summary: List Patient Supplements description: '' parameters: - name: patient_id in: path required: true description: Unique Patient ID schema: type: string - name: limit in: query required: false description: Allows limiting the number of supplements returned. schema: type: integer format: int32 - name: offset in: query required: false description: Allows offsetting the number of supplements returned. schema: type: integer format: int32 responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/Public.SupplementBlueprint_all' example: - id: med-e548301 product_name: Product Name quantity: 1 sig_text: Take 1 capsule daily with food strength: '100' strength_uom: mg integration_error_message: null integration_last_synced_at: null integration_record_id: null integration_sync_status: enabled integration_web_link: null - id: med-e548302 product_name: Product Name quantity: 1 sig_text: Take 1 capsule daily with food strength: '100' strength_uom: mg integration_error_message: null integration_last_synced_at: null integration_record_id: null integration_sync_status: enabled integration_web_link: null - id: med-e548303 product_name: Product Name quantity: 1 sig_text: Take 1 capsule daily with food strength: '100' strength_uom: mg integration_error_message: null integration_last_synced_at: null integration_record_id: null integration_sync_status: enabled integration_web_link: null headers: X-Count: description: The number of resources returned in this request schema: type: integer X-Total-Count: description: The total number of resources available (scoped to query params) schema: type: integer /provider/patients/{patient_id}/supplements/{id}: delete: tags: - Supplements operationId: Supplements.DeleteSupplement summary: Delete Patient Supplement description: '' parameters: - name: patient_id in: path required: true description: Unique Patient ID schema: type: string - name: id in: path required: true description: Unique Supplements ID schema: type: string responses: '204': description: No content get: tags: - Supplements operationId: Supplements.ShowSupplement summary: Show Patient Supplement description: '' parameters: - name: patient_id in: path required: true description: Unique Patient ID schema: type: string - name: id in: path required: true description: Unique Supplements ID schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/Public.SupplementBlueprint_one' example: id: med-e548304 product_name: Product Name quantity: 1 sig_text: Take 1 capsule daily with food strength: '100' strength_uom: mg integration_error_message: null integration_last_synced_at: null integration_record_id: null integration_sync_status: enabled integration_web_link: null patch: tags: - Supplements operationId: Supplements.UpdateSupplement summary: Update Patient Supplement description: '' parameters: - name: patient_id in: path required: true description: Unique Patient ID schema: type: string - name: id in: path required: true description: Unique Supplements ID schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/Public.SupplementBlueprint_one' example: id: med-e548304 product_name: Product Name quantity: 1 sig_text: Take 1 capsule daily with food strength: '100' strength_uom: mg integration_error_message: null integration_last_synced_at: null integration_record_id: null integration_sync_status: enabled integration_web_link: null requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/Provider.Patients.SupplementsController.update_body' /provider/users: get: tags: - User operationId: User.ListUsers summary: List Users description: '' parameters: - name: limit in: query required: false description: Maximum number of results (default 10, min 1, max 100) schema: type: integer format: int32 - name: offset in: query required: false description: Pagination offset (default 0) schema: type: integer format: int32 - name: sort in: query required: false description: Sort field (e.g. +first_name+, +-first_name+ for descending) schema: type: string responses: '200': description: Successful response content: application/json: schema: type: array items: $ref: '#/components/schemas/Public.UserBlueprint_all' example: - id: user-ab12C345DeF6 email: joe_372@example.com first_name: Joe last_name: Blogs name: Joe Blogs phones: [] product_users: [] headers: X-Count: description: The number of resources returned in this request schema: type: integer X-Total-Count: description: The total number of resources available schema: type: integer /integrations/{integration_id}/webhook_endpoints: post: tags: - WebhookEndpoint operationId: WebhookEndpoint.CreateWebhookEndpointLegacy summary: Create Webhook Endpoint description: '' parameters: - name: integration_id in: path required: true description: Unique Integration ID schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/Platform.WebhookEndpointBlueprint_one' example: id: whep-ab12C345DeF6 created_at: '2017-02-05T06:23:00.000000-08:00' last_delivered_at: null localhost_webhook_url: http://localhost:3000/hint/webhook updated_at: '2017-02-05T06:23:00.000000-08:00' webhook_url: https://api.partner/webhook_endpoint_url partner_backend: id: pbnd-ab12C345DeF6 name: Default requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/Platform.WebhookEndpointsController.create_body' get: tags: - WebhookEndpoint operationId: WebhookEndpoint.WebhookEndpointsLegacy summary: List All Webhook Endpoints description: '' parameters: - name: integration_id in: path required: true description: Unique Integration ID schema: type: string responses: '200': description: Successful response content: application/json: schema: type: array items: $ref: '#/components/schemas/Platform.WebhookEndpointBlueprint_all' example: - id: whep-ab12C345DeF6 created_at: '2017-02-05T06:23:00.000000-08:00' last_delivered_at: null localhost_webhook_url: http://localhost:3000/hint/webhook updated_at: '2017-02-05T06:23:00.000000-08:00' webhook_url: https://api.partner/webhook_endpoint_url partner_backend: id: pbnd-ab12C345DeF6 name: Default - id: whep-ab12C345DeF6 created_at: '2017-02-05T06:23:00.000000-08:00' last_delivered_at: null localhost_webhook_url: http://localhost:3000/hint/webhook updated_at: '2017-02-05T06:23:00.000000-08:00' webhook_url: https://api.partner/webhook_endpoint_url partner_backend: id: pbnd-ab12C345DeF6 name: Default - id: whep-ab12C345DeF6 created_at: '2017-02-05T06:23:00.000000-08:00' last_delivered_at: null localhost_webhook_url: http://localhost:3000/hint/webhook updated_at: '2017-02-05T06:23:00.000000-08:00' webhook_url: https://api.partner/webhook_endpoint_url partner_backend: id: pbnd-ab12C345DeF6 name: Default /integrations/{integration_id}/webhook_endpoints/{id}: delete: tags: - WebhookEndpoint operationId: WebhookEndpoint.DeleteWebhookEndpointLegacy summary: Delete Webhook Endpoint description: This operation will take effect immediately and cancel all pending and retrying webhooks. parameters: - name: integration_id in: path required: true description: Unique Integration ID schema: type: string - name: id in: path required: true description: Unique Webhook Endpoint ID schema: type: string responses: '204': description: No content get: tags: - WebhookEndpoint operationId: WebhookEndpoint.ShowWebhookEndpointLegacy summary: Show Webhook Endpoint description: '' parameters: - name: integration_id in: path required: true description: Unique Integration ID schema: type: string - name: id in: path required: true description: Unique Webhook Endpoint ID schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/Platform.WebhookEndpointBlueprint_one' example: id: whep-ab12C345DeF6 created_at: '2017-02-05T06:23:00.000000-08:00' last_delivered_at: null localhost_webhook_url: http://localhost:3000/hint/webhook updated_at: '2017-02-05T06:23:00.000000-08:00' webhook_url: https://api.partner/webhook_endpoint_url partner_backend: id: pbnd-ab12C345DeF6 name: Default patch: tags: - WebhookEndpoint operationId: WebhookEndpoint.UpdateWebhookEndpointLegacy summary: Update Webhook Endpoint description: '' parameters: - name: integration_id in: path required: true description: Unique Integration ID schema: type: string - name: id in: path required: true description: Unique Webhook Endpoint ID schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/Platform.WebhookEndpointBlueprint_one' example: id: whep-ab12C345DeF6 created_at: '2017-02-05T06:23:00.000000-08:00' last_delivered_at: null localhost_webhook_url: http://localhost:3000/hint/webhook updated_at: '2017-02-05T06:23:00.000000-08:00' webhook_url: https://api.partner/webhook_endpoint_url partner_backend: id: pbnd-ab12C345DeF6 name: Default requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/Platform.WebhookEndpointsController.update_body' tags: - name: AccountAccessToken - name: Affiliate - name: AffiliateBill - name: AffiliatePatient - name: CancellationReason - name: Charge - name: ChargeItem - name: ClinicalNoteInteraction - name: Company - name: CompanyPlan - name: Coupon - name: Credit - name: CreditCategory - name: CreditLine - name: CustomerInvoice - name: CustomerInvoiceCharge - name: CustomerInvoicePayment - name: DocumentInteraction - name: EmployeeDivision - name: FormResponse - name: GlobalWebhookEndpoint - name: Integration - name: IntegrationRecord - name: Interaction - name: InteractionNotifications - name: Invoice - name: InvoicePayment - name: LabInteraction - name: LeadSource - name: Location - name: Membership - name: MembershipContract - name: MembershipMember - name: OAuth - name: Partner - name: PartnerCharge - name: PartnerInteraction - name: Patient - name: PaymentMethod - name: Plan - name: Practice - name: Practitioner - name: Quote - name: SignupAttempt - name: SocialSecurityNumber - name: Sponsorship - name: Supplements - name: User - name: WebhookEndpoint