EncounterPage

  • items
    Type: array object[] · Encounter[]
    required

    Encounter returned by the encounter read endpoints.

    • benefits_assigned_to_provider
      Type: boolean
      required
    • billable_status
      Type: stringenum
      required
      values
      • BILLABLE
      • NOT_BILLABLE
    • billing_provider
      Type: object
      required
    • claims
      Type: array object[] · EncounterClaim[]
      required

      Claims attached to the encounter. Branches currently returns the latest claim.

    • clinical_notes
      Type: array object[]
      required
    • created_at
      Type: stringFormat: date-time
      required

      Encounter creation timestamp.

    • diagnoses
      Type: array object[]
      required
    • encounter_id
      Type: string
      required

      Branches encounter id.

    • external_id
      Type: string
      min length:  
      1
      required

      Caller-provided stable encounter identifier. Use a non-PHI value such as an internal encounter or appointment id.

    • owner_of_next_action
      Type: stringenum
      required

      Branches-compatible owner of next action.

      values
      • CANDID
      • CUSTOMER
      • CODER
      • NONE
    • patient
      Type: object
      required
    • patient_authorized_release
      Type: boolean
      required
    • patient_histories
      Type: array object[]
      required
    • patient_payments
      Type: array object[]
      required
    • provider_accepts_assignment
      Type: boolean
      required
    • rendering_provider
      Type: object
      required
    • responsible_party
      Type: stringenum
      required
      values
      • INSURANCE_PAY
      • SELF_PAY
      • UNKNOWN
    • schema_instances
      Type: array object[]
      required
    • service_facility
      Type: object
      required
    • submission_origin
      Type: stringenum
      required

      Branches-compatible submission origin.

      values
      • CANDID
      • EXTERNAL
    • tags
      Type: array object[]
      required
    • url
      Type: string
      required

      API path for retrieving this encounter.

    • accident_date
      Type: string
    • accident_state_or_province_code
      Type: stringenum
      values
      • AA
      • AE
      • AP
      • AL
      • AK
    • additional_information
      Type: string
    • admission_date
      Type: string
    • admission_hour
      Type: number
    • admission_source_code
      Type: stringenum
      values
      • 1
      • 2
      • 4
      • 5
      • 6
    • admission_type_code
      Type: stringenum
      values
      • 1
      • 2
      • 3
      • 4
      • 5
      • 9
    • appointment_type
      Type: string
    • attending_provider
      Type: object
    • billing_notes
      Type: array object[] | null
    • claim_creation_id
      Type: string
    • claim_supplemental_information
      Type: array object[] | null
    • coding_attribution
      Type: string | nullenum
      values
      • CANDID
      • CUSTOMER
      • TCN
      • PJF
      • null
    • date_of_service
      Type: string
    • delay_reason_code
      Type: string | nullenum
      values
      • 1
      • 2
      • 3
      • 4
      • 5
    • discharge_date
      Type: string
    • discharge_hour
      Type: number
    • discharge_status
      Type: stringenum
      values
      • 20
      • 21
      • 30
      • 40
      • 41
    • end_date_of_service
      Type: string
    • epsdt_referral
      Type: object | null
    • existing_medications
      Type: array object[] | null
    • guarantor
      Type: object | null
    • initial_referring_provider
      Type: object
    • interventions
      Type: array object[] | null
    • last_menstrual_period_date
      Type: string
    • last_submitted_at
      Type: string
    • next_responsible_party
      Type: string | nullenum
      values
      • primary
      • secondary
      • tertiary
      • patient
      • non_insurance
      • none
      • null
    • onset_of_current_illness_or_symptom_date
      Type: string
    • operating_provider
      Type: object
    • organization_id
      Type: string
    • other_operating_provider
      Type: object
    • patient_control_number
      Type: string | null

      Patient control number for the latest claim, when present.

    • pay_to_address
      Type: object | null
    • place_of_service_code
      Type: stringenum
      values
      • 10
      • 11
      • 12
      • 13
      • 14
    • place_of_service_code_as_submitted
      Type: stringenum
      values
      • 10
      • 11
      • 12
      • 13
      • 14
    • prior_authorization_number
      Type: string
    • property_casualty_claim_number
      Type: string
    • property_casualty_patient_identifier
      Type: object | null
    • referral_number
      Type: string
    • referring_provider
      Type: object
    • related_causes_information
      Type: object | null
    • secondary_payer_carrier_code
      Type: string
    • service_authorization_exception_code
      Type: string | nullenum
      values
      • 1
      • 2
      • 3
      • 4
      • 5
      • 6
      • 7
      • null
    • submission_expectation
      Type: string | nullenum
      values
      • TARGET_PROFESSIONAL
      • TARGET_INSTITUTIONAL
      • null
    • subscriber_primary
      Type: object
    • subscriber_secondary
      Type: object
    • subscriber_tertiary
      Type: object
    • supervising_provider
      Type: object
    • synchronicity
      Type: string | nullenum
      values
      • Synchronous
      • Asynchronous
      • null
    • treating_provider
      Type: object
    • type_of_bill
      Type: object
    • vitals
      Type: object | null
    • work_queue_id
      Type: string
    • work_queue_membership_activated_at
      Type: string
  • next_page_token
    Type: string | null

    Token for the next page, or null when there is no next page.

  • prev_page_token
    Type: string | null

    Token for the previous page. Currently always null for this endpoint.