BranchesEncounterClaim

  • benefits_assigned_to_provider
    Type: boolean
    required
  • billable_status
    Type: stringenum
    required
    values
    • BILLABLE
    • NOT_BILLABLE
  • billing_provider
    Type: object
    required
    • address
      Type: object
      required
    • npi
      Type: string
      min length:  
      1
      required
    • tax_id
      Type: string
      min length:  
      1
      required
    • first_name
      Type: string | null
    • last_name
      Type: string | null
    • organization_name
      Type: string | null
    • provider_commercial_license_type
      Type: string | null
    • secondary_identification
    • taxonomy_code
      Type: string | null
    • propertyName
      Type: anything
  • created_at
    Type: stringFormat: date-time
    required

    the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

  • date_of_service
    Type: string | null
    required
  • diagnoses
    Type: array object[]
    required
    • code
      Type: string
      min length:  
      1
      required
    • code_type
      Type: stringenum
      required
      values
      • ABF
      • ABJ
      • ABK
      • APR
      • BF
    • name
      Type: string
    • present_on_admission_indicator
      Type: stringenum
      values
      • YES
      • NO
      • UNKNOWN
      • NOT_APPLICABLE
    • propertyName
      Type: anything
  • id
    Type: string
    required
  • last_checked_at
    Type: string | nullFormat: date-time
    required

    the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

  • original_payer_claim_control_number
    Type: string | null
    required
  • patient
    Type: object
    required
    • address
      Type: object
      required
    • date_of_birth
      Type: string
      min length:  
      1
      required
    • external_id
      Type: string
      min length:  
      1
      required
    • first_name
      Type: string
      min length:  
      1
      required
    • gender
      Type: stringenum
      required
      values
      • male
      • female
      • other
      • not_given
      • unknown
    • last_name
      Type: string
      min length:  
      1
      required
    • auto_charge_consent
      Type: boolean
    • email
      Type: string
    • email_consent
      Type: boolean
    • non_insurance_payers
      Type: array string[]
    • non_insurance_payers_info
      Type: array
    • phone_consent
      Type: boolean
    • phone_numbers
      Type: array
    • propertyName
      Type: anything
  • patient_authorized_release
    Type: boolean
    required
  • patient_control_number
    Type: string
    required
  • payer_id
    Type: string | null
    required
  • payer_name
    Type: string | null
    required
  • place_of_service_code
    Type: string
    required
  • processing_ended_at
    Type: string | nullFormat: date-time
    required

    the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

  • processing_started_at
    Type: string | nullFormat: date-time
    required

    the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

  • provider_accepts_assignment
    Type: boolean
    required
  • rendering_provider
    Type: object
    required
    • npi
      Type: string
      min length:  
      1
      required
    • address
      Type: object | null
    • first_name
      Type: string | null
    • last_name
      Type: string | null
    • organization_name
      Type: string | null
    • secondary_identification
    • taxonomy_code
      Type: string | null
    • propertyName
      Type: anything
  • responsible_party
    Type: stringenum
    required
    values
    • INSURANCE_PAY
    • SELF_PAY
    • UNKNOWN
  • resubmission_action
    Type: string | null
    required
  • resubmission_original_claim_id
    Type: string | null
    required
  • service_facility
    Type: object | null
    required
    • address
      Type: object
      required
    • organization_name
      Type: string
      min length:  
      1
      required
    • mammography_certification_number
      Type: string
    • npi
      Type: string
    • secondary_identification
      Type: string
    • service_facility_id
      Type: string
    • propertyName
      Type: anything
  • service_lines
    Type: array object[]
    required
    • diagnosis_pointers
      Type: array integer[]
      required
    • procedure_code
      Type: string
      min length:  
      1
      required
    • quantity
      required
      • Type: number
    • units
      Type: stringenum
      required
      values
      • MJ
      • UN
    • charge_amount_cents
      Type: integer

      Integer numbers.

    • date_of_service
      Type: string
    • description
      Type: string
    • drug_identification
    • end_date_of_service
      Type: string
    • external_id
      Type: string
    • has_epsdt_indicator
      Type: boolean
    • has_family_planning_indicator
      Type: boolean
    • modifiers
      Type: array string[]
    • note
      Type: string
    • ordering_provider
    • place_of_service_code
      Type: stringenum
      values
      • 10
      • 11
      • 12
      • 13
      • 14
    • prior_authorization_number
      Type: string
    • test_results
      Type: array
    • propertyName
      Type: anything
  • status
    Type: string · BranchesEncounterClaimStatusenum
    required
    values
    • draft
    • submitted_to_payer
    • missing_information
    • submission_bounced
    • not_billable
  • status_changed_at
    Type: stringFormat: date-time
    required

    the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

  • stedi_transaction_ids
    Type: array string[]
    required
  • subscriber_primary
    Type: object | null
    required
    • first_name
      Type: string
      min length:  
      1
      required
    • gender
      Type: stringenum
      required
      values
      • male
      • female
      • other
      • not_given
      • unknown
    • insurance_card
      Type: object
      required
    • last_name
      Type: string
      min length:  
      1
      required
    • patient_relationship_to_subscriber_code
      Type: stringenum
      required
      values
      • 10
      • 15
      • 17
      • 18
      • 19
    • address
      Type: object
    • date_of_birth
      Type: string
    • propertyName
      Type: anything