Candid Health

Candid Health Encounter Supplemental Information API

The Encounter Supplemental Information API from Candid Health — 2 operation(s) for encounter supplemental information.

GitHub OpenAPI

Operations 4

GET /api/encounter-supplemental-information/v1/{encounter_id} Get Encounter Supplemental Information #
PUT /api/encounter-supplemental-information/v1/{encounter_id} Create Encounter Supplemental Information #
PATCH /api/encounter-supplemental-information/v1/{encounter_id}/{supplemental_information_id} Update Encounter Supplemental Information #
DELETE /api/encounter-supplemental-information/v1/{encounter_id}/{supplemental_information_id} Delete Encounter Supplemental Information #

Documentation

📖
Documentation
https://docs.joincandidhealth.com/api-reference/eligibility/v-2
📖
Documentation
https://docs.joincandidhealth.com/api-reference/encounters/v-4
📖
Documentation
https://docs.joincandidhealth.com/api-reference/encounters/v-4/get-all
📖
APIReference
https://docs.joincandidhealth.com/api-reference/encounters/v-4/create
📖
Documentation
https://docs.joincandidhealth.com/api-reference/eligibility/v-2/submit-eligibility-check
📖
APIReference
https://docs.joincandidhealth.com/api-reference/pre-encounter/coverages/v-1/check-eligibility
📖
Documentation
https://docs.joincandidhealth.com/api-reference/charge-capture/v-1/create
📖
Documentation
https://docs.joincandidhealth.com/api-reference/payers/v-3/get
📖
APIReference
https://docs.joincandidhealth.com/api-reference/fee-schedules/v-3/get-match
📖
Documentation
https://docs.joincandidhealth.com/api-reference/insurance-adjudications/v-1/get
📖
Documentation
https://docs.joincandidhealth.com/api-reference/events/v-1/get

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/candid-health/refs/heads/main/openapi/candid-health-encounter-supplemental-information-api-openapi.yml

Other Resources

🔗
PostmanCollection
https://raw.githubusercontent.com/api-evangelist/candid-health/refs/heads/main/collections/candidhealth.postman_collection.json
🔗
OpenCollection
https://raw.githubusercontent.com/api-evangelist/candid-health/refs/heads/main/collections/candidhealth.opencollection.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/candid-health-encounter-supplemental-information-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

candid-health-encounter-supplemental-information-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Reference Encounter Supplemental Information 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: Encounter Supplemental Information
paths:
  /api/encounter-supplemental-information/v1/{encounter_id}:
    get:
      operationId: get
      summary: Get Encounter Supplemental Information
      tags:
      - Encounter Supplemental Information
      parameters:
      - name: encounter_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/type_commons_EncounterId'
      - name: Authorization
        in: header
        description: OAuth authentication
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/type_encounter-supplemental-information_v1_SupplementalInformation'
    put:
      operationId: create
      summary: Create Encounter Supplemental Information
      tags:
      - Encounter Supplemental Information
      parameters:
      - name: encounter_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/type_commons_EncounterId'
      - 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_encounter-supplemental-information_v1_SupplementalInformation'
        '404':
          description: Error response with status 404
          content:
            application/json:
              schema:
                type: object
                properties:
                  errorName:
                    type: string
                    enum:
                    - EntityNotFoundError
                  content:
                    $ref: '#/components/schemas/type_commons_EntityNotFoundErrorMessage'
                required:
                - errorName
                - content
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/type_encounter-supplemental-information_v1_CreateSupplementalInformationRequest'
  /api/encounter-supplemental-information/v1/{encounter_id}/{supplemental_information_id}:
    patch:
      operationId: update
      summary: Update Encounter Supplemental Information
      tags:
      - Encounter Supplemental Information
      parameters:
      - name: encounter_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/type_commons_EncounterId'
      - name: supplemental_information_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/type_encounter-supplemental-information_v1_SupplementalInformationId'
      - 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_encounter-supplemental-information_v1_SupplementalInformation'
        '404':
          description: Error response with status 404
          content:
            application/json:
              schema:
                type: object
                properties:
                  errorName:
                    type: string
                    enum:
                    - EntityNotFoundError
                  content:
                    $ref: '#/components/schemas/type_commons_EntityNotFoundErrorMessage'
                required:
                - errorName
                - content
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/type_encounter-supplemental-information_v1_UpdateSupplementalInformationRequest'
    delete:
      operationId: delete
      summary: Delete Encounter Supplemental Information
      tags:
      - Encounter Supplemental Information
      parameters:
      - name: encounter_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/type_commons_EncounterId'
      - name: supplemental_information_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/type_encounter-supplemental-information_v1_SupplementalInformationId'
      - name: Authorization
        in: header
        description: OAuth authentication
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response
        '404':
          description: Error response with status 404
          content:
            application/json:
              schema:
                type: object
                properties:
                  errorName:
                    type: string
                    enum:
                    - EntityNotFoundError
                  content:
                    $ref: '#/components/schemas/type_commons_EntityNotFoundErrorMessage'
                required:
                - errorName
                - content
components:
  schemas:
    type_encounter-supplemental-information_v1_SupplementalInformationId:
      type: string
      format: uuid
      title: SupplementalInformationId
    type_commons_EntityNotFoundErrorMessage:
      type: object
      properties:
        id:
          type: string
      required:
      - id
      title: EntityNotFoundErrorMessage
    type_encounter-attachments_v1_AttachmentId:
      type: string
      format: uuid
      title: AttachmentId
    type_encounter-supplemental-information_v1_CreateSupplementalInformationRequest:
      type: object
      properties:
        attachment_id:
          $ref: '#/components/schemas/type_encounter-attachments_v1_AttachmentId'
        attachment_report_type_code:
          $ref: '#/components/schemas/type_commons_ReportTypeCode'
        attachment_transmission_code:
          $ref: '#/components/schemas/type_commons_ReportTransmissionCode'
        attachment_control_number:
          type: string
        attachment_inclusion:
          $ref: '#/components/schemas/type_encounter-supplemental-information_v1_AttachmentInclusion'
      required:
      - attachment_report_type_code
      - attachment_transmission_code
      - attachment_inclusion
      title: CreateSupplementalInformationRequest
    type_commons_EncounterId:
      type: string
      format: uuid
      title: EncounterId
    type_commons_ReportTypeCode:
      type: string
      enum:
      - '03'
      - '04'
      - '05'
      - '06'
      - '07'
      - 08
      - 09
      - '10'
      - '11'
      - '13'
      - '15'
      - '21'
      - A3
      - A4
      - AM
      - AS
      - B2
      - B3
      - B4
      - BR
      - BS
      - BT
      - CB
      - CK
      - CT
      - D2
      - DA
      - DB
      - DG
      - DJ
      - DS
      - EB
      - HC
      - HR
      - I5
      - IR
      - LA
      - M1
      - MT
      - NN
      - OB
      - OC
      - OD
      - OE
      - OX
      - OZ
      - P4
      - P5
      - PE
      - PN
      - PO
      - PQ
      - PY
      - PZ
      - RB
      - RR
      - RT
      - RX
      - SG
      - V5
      - XP
      title: ReportTypeCode
    type_encounter-supplemental-information_v1_AttachmentInclusion:
      type: string
      enum:
      - not_included
      - included_on_next_submission
      - included_on_all_submissions
      title: AttachmentInclusion
    type_encounter-supplemental-information_v1_SupplementalInformation:
      type: object
      properties:
        supplemental_information_id:
          $ref: '#/components/schemas/type_encounter-supplemental-information_v1_SupplementalInformationId'
        attachment_id:
          $ref: '#/components/schemas/type_encounter-attachments_v1_AttachmentId'
        attachment_report_type_code:
          $ref: '#/components/schemas/type_commons_ReportTypeCode'
        attachment_transmission_code:
          $ref: '#/components/schemas/type_commons_ReportTransmissionCode'
        attachment_control_number:
          type: string
        attachment_inclusion:
          $ref: '#/components/schemas/type_encounter-supplemental-information_v1_AttachmentInclusion'
        encounter_id:
          $ref: '#/components/schemas/type_commons_EncounterId'
      required:
      - supplemental_information_id
      - attachment_report_type_code
      - attachment_transmission_code
      - attachment_inclusion
      - encounter_id
      title: SupplementalInformation
    type_encounter-supplemental-information_v1_UpdateSupplementalInformationRequest:
      type: object
      properties:
        attachment_id:
          $ref: '#/components/schemas/type_encounter-attachments_v1_AttachmentId'
        attachment_report_type_code:
          $ref: '#/components/schemas/type_commons_ReportTypeCode'
        attachment_transmission_code:
          $ref: '#/components/schemas/type_commons_ReportTransmissionCode'
        attachment_control_number:
          type: string
        attachment_inclusion:
          $ref: '#/components/schemas/type_encounter-supplemental-information_v1_AttachmentInclusion'
      title: UpdateSupplementalInformationRequest
    type_commons_ReportTransmissionCode:
      type: string
      enum:
      - AA
      - BM
      - EL
      - FX
      title: ReportTransmissionCode
  securitySchemes:
    OAuthScheme:
      type: http
      scheme: bearer
      description: OAuth 2.0 authentication