openapi: 3.2.0
info:
  title: Reference Superbill API
  version: 1.0.0
servers:
- url: https://pre-api.joincandidhealth.com
  description: Production
- url: https://pre-api-staging.joincandidhealth.com
  description: Staging
- url: https://sandbox-pre-api.joincandidhealth.com
  description: CandidSandbox
- url: https://staging-pre-api.joincandidhealth.com
  description: CandidStaging
- url: http://localhost:4000
  description: Local
- url: https://api.joincandidhealth.com
  description: Production
- url: https://api-staging.joincandidhealth.com
  description: Staging
- url: https://sandbox-api.joincandidhealth.com
  description: CandidSandbox
- url: https://staging-api.joincandidhealth.com
  description: CandidStaging
- url: http://localhost:5050
  description: Local
tags:
- name: Superbill
paths:
  /api/superbill/v1:
    post:
      operationId: create_superbill
      summary: Create Superbill
      tags:
      - Superbill
      parameters:
      - name: Authorization
        in: header
        description: OAuth authentication
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_superbills_v1_SuperbillResponse'
        '422':
          description: Error response with status 422
          content:
            application/json:
              schema:
                type: object
                properties:
                  errorName:
                    type: string
                    enum:
                    - UnprocessableEntityError
                  content:
                    $ref: '#/components/schemas/type_commons_UnprocessableEntityErrorMessage'
                required:
                - errorName
                - content
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                patient_external_id:
                  $ref: '#/components/schemas/type_commons_PatientExternalId'
                  description: Empty string not allowed
                date_range_min:
                  type: string
                  format: date
                  description: Minimum (inclusive) date selected for the superbill
                date_range_max:
                  type: string
                  format: date
                  description: Maximum (inclusive) date selected for the superbill
                pay_to_address:
                  $ref: '#/components/schemas/type_commons_StreetAddressShortZip'
                  description: Address that will be displayed on the superbill as the 'Pay to' Address. If not provided this value will be set from available encounter data.
                output_format:
                  $ref: '#/components/schemas/type_superbills_v1_SuperbillOutputFormat'
                  description: Output format for the superbill. Defaults to DOCX if not specified.
                include_merged_patient_data:
                  type: boolean
                  description: If true will include claims from any alternative patients the given patient_external_id has.
              required:
              - patient_external_id
              - date_range_min
              - date_range_max
components:
  schemas:
    type_superbills_v1_SuperbillResponse:
      type: object
      properties:
        superbills:
          type: array
          items:
            $ref: '#/components/schemas/type_superbills_v1_Superbill'
          description: Each object represents a single Superbill for a single billing provider.
      required:
      - superbills
      title: SuperbillResponse
    type_commons_StreetAddressShortZip:
      type: object
      properties:
        address1:
          type: string
        address2:
          type: string
        city:
          type: string
        state:
          $ref: '#/components/schemas/type_commons_State'
        zip_code:
          type: string
          description: 5-digit zip code
        zip_plus_four_code:
          type: string
          description: 4-digit zip add-on code https://en.wikipedia.org/wiki/ZIP_Code#ZIP+4
      required:
      - address1
      - city
      - state
      - zip_code
      title: StreetAddressShortZip
    type_commons_PatientExternalId:
      type: string
      title: PatientExternalId
    type_superbills_v1_Superbill:
      type: object
      properties:
        superbill_id:
          type: string
          description: Primary id of the superbill.
        patient_external_id:
          $ref: '#/components/schemas/type_commons_PatientExternalId'
          description: external_id of the patient.
        authed_url:
          type: string
          description: Authenticated URL for downloading the generated superbill file.
        date_range_min:
          type: string
          format: date
          description: Minimum (inclusive) date selected for this superbill.
        date_range_max:
          type: string
          format: date
          description: Maximum (inclusive) date selected for this superbill.
        file_name:
          type: string
          description: Original filename of the superbill.
      required:
      - superbill_id
      - patient_external_id
      - authed_url
      - date_range_min
      - date_range_max
      - file_name
      title: Superbill
    type_commons_UnprocessableEntityErrorMessage:
      type: object
      properties:
        message:
          type: string
      title: UnprocessableEntityErrorMessage
    type_superbills_v1_SuperbillOutputFormat:
      type: string
      enum:
      - DOCX
      - PDF
      description: Output format for the generated superbill.
      title: SuperbillOutputFormat
    type_commons_State:
      type: string
      enum:
      - AA
      - AE
      - AP
      - AL
      - AK
      - AS
      - AZ
      - AR
      - CA
      - CO
      - CT
      - DC
      - DE
      - FL
      - FM
      - GA
      - GU
      - HI
      - ID
      - IL
      - IN
      - IA
      - KS
      - KY
      - LA
      - ME
      - MD
      - MA
      - MH
      - MI
      - MN
      - MP
      - MS
      - MO
      - MT
      - NE
      - NV
      - NH
      - NJ
      - NM
      - NY
      - NC
      - ND
      - OH
      - OK
      - OR
      - PA
      - PR
      - PW
      - RI
      - SC
      - SD
      - TN
      - TX
      - UT
      - VI
      - VT
      - VA
      - WA
      - WV
      - WI
      - WY
      title: State
  securitySchemes:
    OAuthScheme:
      type: http
      scheme: bearer
      description: OAuth 2.0 authentication