EncounterCreate

Encounter create payload.

  • 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
  • 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
  • external_id
    Type: string
    min length:  
    1
    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
  • patient_authorized_release
    Type: boolean
    required
  • place_of_service_code
    Type: stringenum
    required
    values
    • 10
    • 11
    • 12
    • 13
    • 14
  • 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
  • responsible_party
    Type: stringenum
    required
    values
    • INSURANCE_PAY
    • SELF_PAY
    • UNKNOWN
  • accident_date
    Type: string
  • additional_information
    Type: string
  • admission_date
    Type: string
  • appointment_type
    Type: string
  • billing_notes
    Type: array
  • claim_supplemental_information
    Type: array
  • clinical_notes
    Type: array
  • date_of_service
    Type: string
  • delay_reason_code
  • discharge_date
    Type: string
  • end_date_of_service
    Type: string
  • epsdt_referral
  • existing_medications
    Type: array
  • external_claim_submission
  • guarantor
  • initial_referring_provider
  • interventions
    Type: array
  • last_menstrual_period_date
    Type: string
  • metadata
    Type: object
    • propertyName
      Type: anything
  • onset_of_current_illness_or_symptom_date
    Type: string
  • patient_histories
    Type: array
  • pay_to_address
  • prior_authorization_number
    Type: string | null
  • property_casualty_claim_number
    Type: string
  • property_casualty_patient_identifier
  • referral_number
    Type: string
  • referring_provider
    Type: object | null
    • 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
  • related_causes_information
  • schema_instances
    Type: array object[]
    • content
      Type: object
      required
    • schema_id
      Type: string
      min length:  
      1
      required
  • secondary_payer_carrier_code
    Type: string
  • service_authorization_exception_code
  • service_facility
    Type: object
    • 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
  • service_lines
    Type: array object[]
    • 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
  • subscriber_primary
    Type: object | null
    • 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
  • subscriber_secondary
    Type: object | null
    • 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
  • subscriber_tertiary
    Type: object | null
    • 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
  • supervising_provider
  • synchronicity
  • tag_ids
    Type: array string[]
  • treating_provider
  • vitals