Encounter

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
- address
  Type: object
  required
- npi
  Type: string
  required
- provider_id
  Type: string
  required
- first_name
  Type: string
- last_name
  Type: string
- organization_name
  Type: string
- provider_commercial_license_type
  Type: stringenum
  values
  0
  A
  B
  C
  D
- qualifier
  Type: stringenum
  values
  DQ
  DN
  DK
  P3
- secondary_identification
  Type: object
- tax_id
  Type: string
- taxonomy_code
  Type: string
claims
Type: array object[] · EncounterClaim[]
required

Claims attached to the encounter. Branches currently returns the latest claim.
- claim_id
  Type: string
  required
  
  Branches claim id for the latest claim on the encounter.
- eras
  Type: array object[]
  required
  
  Electronic remittance advices associated with the claim.
- service_lines
  Type: array object[]
  required
  
  Service lines associated with the latest claim.
- status
  Type: string · EncounterClaimStatusenum
  required
  
  Claim status vocabulary accepted by claim_status and returned on claims.
  
  values
  biller_received
  coded
  submitted_to_payer
  missing_information
  not_billable
- clearinghouse
  Type: string
- clearinghouse_claim_id
  Type: string
- clia_number
  Type: string
- payer_claim_id
  Type: string
clinical_notes
Type: array object[]
required
- category
  Type: stringenum
  required
  values
  clinical
  care_plan
  diagnoses
  vitals
  physical_exam
- notes
  Type: array string[]
  required
- notes_structured
  Type: array object[]
created_at
Type: stringFormat: date-time
required

Encounter creation timestamp.
diagnoses
Type: array object[]
required
- code
  Type: string
  required
- code_type
  Type: stringenum
  required
  values
  ABF
  ABJ
  ABK
  APR
  BF
- created_at
  Type: string
  required
- diagnosis_id
  Type: string
  required
- encounter_id
  Type: string
  required
- updated_at
  Type: string
  required
- name
  Type: string
- present_on_admission_indicator
  Type: stringenum
  values
  YES
  NO
  UNKNOWN
  NOT_APPLICABLE
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
- address
  Type: object
  required
- auto_charge_consent
  Type: boolean
  required
- date_of_birth
  Type: string
  required
- email_consent
  Type: boolean
  required
- external_id
  Type: string
  required
- first_name
  Type: string
  required
- gender
  Type: stringenum
  required
  values
  male
  female
  other
  not_given
  unknown
- individual_id
  Type: string
  required
- last_name
  Type: string
  required
- non_insurance_payers
  Type: array object[]
  required
- non_insurance_payers_info
  Type: array object[]
  required
- phone_consent
  Type: boolean
  required
- phone_numbers
  Type: array object[]
  required
- email
  Type: string
patient_authorized_release
Type: boolean
required
patient_histories
Type: array object[]
required
- category
  Type: stringenum
  required
  values
  present_illness
  medical
  family
  social
- questions
  Type: array object[]
  required
patient_payments
Type: array object[]
required
- amount_cents
  Type: number
  required
- organization_id
  Type: string
  required
- patient_payment_id
  Type: string
  required
- source
  Type: stringenum
  required
  values
  MANUAL_ENTRY
  CHARGEBEE_PAYMENTS
  CHARGEBEE MANUALLY VOIDED BY CANDID
  CHARGEBEE_REFUNDS
  SQUARE_REFUNDS
  SQUARE_PAYMENTS
  STRIPE_CHARGES
  STRIPE_REFUNDS
  ELATION_PAYMENTS
- source_internal_id
  Type: string
  required
- encounter_external_id
  Type: string
- patient_external_id
  Type: string
- payment_name
  Type: string
- payment_note
  Type: string
- payment_timestamp
  Type: string
- service_line_id
  Type: string
- status
  Type: stringenum
  values
  PENDING
  paid
  CANCELED
  voided
  FAILED
provider_accepts_assignment
Type: boolean
required
rendering_provider
Type: object
required
- address
  Type: object
  required
- npi
  Type: string
  required
- provider_id
  Type: string
  required
- first_name
  Type: string
- last_name
  Type: string
- organization_name
  Type: string
- provider_commercial_license_type
  Type: stringenum
  values
  0
  A
  B
  C
  D
- qualifier
  Type: stringenum
  values
  DQ
  DN
  DK
  P3
- secondary_identification
  Type: object
- tax_id
  Type: string
- taxonomy_code
  Type: string
responsible_party
Type: stringenum
required
values
- INSURANCE_PAY
- SELF_PAY
- UNKNOWN
schema_instances
Type: array object[]
required
- content
  Type: object
  required
- schema_id
  Type: string
  required
service_facility
Type: object
required
- address
  Type: object
  required
- organization_name
  Type: string
  required
- service_facility_id
  Type: string
  required
- mammography_certification_number
  Type: string
- npi
  Type: string
- secondary_identification
  Type: string
submission_origin
Type: stringenum
required

Branches-compatible submission origin.
values
- CANDID
- EXTERNAL
tags
Type: array object[]
required
- color
  Type: stringenum
  required
  values
  black
  white
  gray
  red
  yellow
- creator_id
  Type: string
  required
- description
  Type: string
  required
- tag_id
  Type: string
  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
- address
  Type: object
  required
- npi
  Type: string
  required
- provider_id
  Type: string
  required
- first_name
  Type: string
- last_name
  Type: string
- organization_name
  Type: string
- provider_commercial_license_type
  Type: stringenum
  values
  0
  A
  B
  C
  D
- qualifier
  Type: stringenum
  values
  DQ
  DN
  DK
  P3
- secondary_identification
  Type: object
- tax_id
  Type: string
- taxonomy_code
  Type: string
billing_notes
Type: array object[] | null
- billing_note_id
  Type: string
  required
- created_at
  Type: string
  required
- encounter_id
  Type: string
  required
- text
  Type: string
  required
- author_auth0_id
  Type: string | null
- author_name
  Type: string | null
claim_creation_id
Type: string
claim_supplemental_information
Type: array object[] | null
- attachment_report_type_code
  Type: stringenum
  required
  values
  10
  11
  13
  15
  21
- attachment_transmission_code
  Type: stringenum
  required
  values
  BM
  EL
  FX
- attachment_control_number
  Type: string | 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
- condition_indicator1
  Type: stringenum
  required
  values
  AV
  NU
  S2
  ST
- condition_indicator2
  Type: string | nullenum
  values
  AV
  NU
  S2
  ST
  null
- condition_indicator3
  Type: string | nullenum
  values
  AV
  NU
  S2
  ST
  null
existing_medications
Type: array object[] | null
- name
  Type: string
  required
- as_needed
  Type: boolean | null
- dosage
  Type: string | null
- dosage_form
  Type: string | null
- frequency
  Type: string | null
- rx_cui
  Type: string | null
guarantor
Type: object | null
- address
  Type: object
  required
- auto_charge_consent
  Type: boolean
  required
- email_consent
  Type: boolean
  required
- external_id
  Type: string
  required
- first_name
  Type: string
  required
- guarantor_id
  Type: string
  required
- last_name
  Type: string
  required
- phone_consent
  Type: boolean
  required
- phone_numbers
  Type: array object[]
  required
- date_of_birth
  Type: string | null
- email
  Type: string | null
initial_referring_provider
Type: object
- address
  Type: object
  required
- npi
  Type: string
  required
- provider_id
  Type: string
  required
- first_name
  Type: string
- last_name
  Type: string
- organization_name
  Type: string
- provider_commercial_license_type
  Type: stringenum
  values
  0
  A
  B
  C
  D
- qualifier
  Type: stringenum
  values
  DQ
  DN
  DK
  P3
- secondary_identification
  Type: object
- tax_id
  Type: string
- taxonomy_code
  Type: string
interventions
Type: array object[] | null
- category
  Type: stringenum
  required
  values
  allopathic
  naturopathic
  tests
  lifestyle
- name
  Type: string
  required
- description
  Type: string | null
- labs
  Type: array object[] | null
- medication
  Type: 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
- address
  Type: object
  required
- npi
  Type: string
  required
- provider_id
  Type: string
  required
- first_name
  Type: string
- last_name
  Type: string
- organization_name
  Type: string
- provider_commercial_license_type
  Type: stringenum
  values
  0
  A
  B
  C
  D
- qualifier
  Type: stringenum
  values
  DQ
  DN
  DK
  P3
- secondary_identification
  Type: object
- tax_id
  Type: string
- taxonomy_code
  Type: string
organization_id
Type: string
other_operating_provider
Type: object
- address
  Type: object
  required
- npi
  Type: string
  required
- provider_id
  Type: string
  required
- first_name
  Type: string
- last_name
  Type: string
- organization_name
  Type: string
- provider_commercial_license_type
  Type: stringenum
  values
  0
  A
  B
  C
  D
- qualifier
  Type: stringenum
  values
  DQ
  DN
  DK
  P3
- secondary_identification
  Type: object
- tax_id
  Type: string
- taxonomy_code
  Type: string
patient_control_number
Type: string | null

Patient control number for the latest claim, when present.
pay_to_address
Type: object | null
- address1
  Type: string
  required
- city
  Type: string
  required
- state
  Type: stringenum
  required
  values
  AA
  AE
  AP
  AL
  AK
- zip_code
  Type: string
  required
- zip_plus_four_code
  Type: string
  required
- address2
  Type: string | 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
- property_casualty_patient_identifier
  Type: string
  required
- property_casualty_patient_identifier_qualifier
  Type: stringenum
  required
  values
  1W
  SY
referral_number
Type: string
referring_provider
Type: object
- address
  Type: object
  required
- npi
  Type: string
  required
- provider_id
  Type: string
  required
- first_name
  Type: string
- last_name
  Type: string
- organization_name
  Type: string
- provider_commercial_license_type
  Type: stringenum
  values
  0
  A
  B
  C
  D
- qualifier
  Type: stringenum
  values
  DQ
  DN
  DK
  P3
- secondary_identification
  Type: object
- tax_id
  Type: string
- taxonomy_code
  Type: string
related_causes_information
Type: object | null
- related_causes_code_1
  Type: stringenum
  required
  values
  AA
  AB
  AP
  EM
  OA
  ZZ
- related_causes_code_2
  Type: string | nullenum
  values
  AA
  AB
  AP
  EM
  OA
  ZZ
  null
- state_or_province_code
  Type: string | 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
- first_name
  Type: string
  required
- gender
  Type: stringenum
  required
  values
  male
  female
  other
  not_given
  unknown
- individual_id
  Type: string
  required
- insurance_card
  Type: object
  required
- last_name
  Type: string
  required
- patient_relationship_to_subscriber_code
  Type: stringenum
  required
  values
  10
  15
  17
  18
  19
- address
  Type: object
- date_of_birth
  Type: string
subscriber_secondary
Type: object
- first_name
  Type: string
  required
- gender
  Type: stringenum
  required
  values
  male
  female
  other
  not_given
  unknown
- individual_id
  Type: string
  required
- insurance_card
  Type: object
  required
- last_name
  Type: string
  required
- patient_relationship_to_subscriber_code
  Type: stringenum
  required
  values
  10
  15
  17
  18
  19
- address
  Type: object
- date_of_birth
  Type: string
subscriber_tertiary
Type: object
- first_name
  Type: string
  required
- gender
  Type: stringenum
  required
  values
  male
  female
  other
  not_given
  unknown
- individual_id
  Type: string
  required
- insurance_card
  Type: object
  required
- last_name
  Type: string
  required
- patient_relationship_to_subscriber_code
  Type: stringenum
  required
  values
  10
  15
  17
  18
  19
- address
  Type: object
- date_of_birth
  Type: string
supervising_provider
Type: object
- address
  Type: object
  required
- npi
  Type: string
  required
- provider_id
  Type: string
  required
- first_name
  Type: string
- last_name
  Type: string
- organization_name
  Type: string
- provider_commercial_license_type
  Type: stringenum
  values
  0
  A
  B
  C
  D
- qualifier
  Type: stringenum
  values
  DQ
  DN
  DK
  P3
- secondary_identification
  Type: object
- tax_id
  Type: string
- taxonomy_code
  Type: string
synchronicity
Type: string | nullenum
values
- Synchronous
- Asynchronous
- null
treating_provider
Type: object
- first_name
  Type: string
  required
- last_name
  Type: string
  required
- provider_id
  Type: string
  required
- address
  Type: object
- license_type
  Type: stringenum
  values
  MD
  NP
  PA
  LMFT
  LCPC
- npi
  Type: string
- tax_id
  Type: string
- taxonomy_code
  Type: string
type_of_bill
Type: object
- code
  Type: string
  required
- frequency_code
  Type: stringenum
  required
  values
  0
  1
  2
  3
  4
- type_of_care
  Type: stringenum
  required
  values
  1
  2
  3
  4
  5
  6
  7
  8
  9
- type_of_facility
  Type: stringenum
  required
  values
  1
  2
  3
  4
  6
  7
  8
vitals
Type: object | null
- blood_pressure_diastolic_mmhg
  Type: number | null
- blood_pressure_systolic_mmhg
  Type: number | null
- body_temperature_f
  Type: number | null
- height_in
  Type: number | null
- hematocrit_pct
  Type: number | null
- hemoglobin_gdl
  Type: number | null
- weight_lbs
  Type: number | null
work_queue_id
Type: string
work_queue_membership_activated_at
Type: string