openapi: 3.2.0 info: title: Reference V1 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: v1 paths: /eligibility-checks/v1: post: operationId: post summary: Post description: Sends real-time eligibility checks to payers through Stedi. tags: - v1 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_pre-encounter_eligibilityChecks_v1_EligibilityResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/type_pre-encounter_eligibilityChecks_v1_EligibilityRequest' /eligibility-checks/v1/batch: post: operationId: batch summary: Batch description: Sends a batch of eligibility checks to payers through Stedi. tags: - v1 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_pre-encounter_eligibilityChecks_v1_BatchEligibilityResponse' requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/type_pre-encounter_eligibilityChecks_v1_EligibilityRequest' /eligibility-checks/v1/batch/{batch_id}: get: operationId: poll-batch summary: Poll Batch description: Polls the status of a batch eligibility check. tags: - v1 parameters: - name: batch_id in: path required: true schema: type: string - name: page_token in: query required: false schema: $ref: '#/components/schemas/type_pre-encounter_common_PageToken' - 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_pre-encounter_eligibilityChecks_v1_EligibilityCheckPage' /eligibility-checks/v1/payer/search: get: operationId: payer-search summary: Payer Search description: Searches for payers that match the query parameters. tags: - v1 parameters: - name: page_size in: query required: false schema: type: integer - name: page_token in: query required: false schema: $ref: '#/components/schemas/type_pre-encounter_common_PageToken' - name: query in: query required: false schema: type: string - 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_pre-encounter_eligibilityChecks_v1_PayerSearchResponse' /eligibility-checks/v1/recommendation: get: operationId: recommendation summary: Recommendation description: "Gets recommendation for eligibility checks based on filters. This endpoint will retrieve all the latest eligibility recommendations for each \neligibility recommendation type for the given filters. If you want to get a specific recommendation type, you can use the `type` query parameter." tags: - v1 parameters: - name: filters in: query required: false schema: $ref: '#/components/schemas/type_pre-encounter_common_FilterQueryString' - 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_pre-encounter_eligibilityChecks_v1_EligibilityRecommendation' post: operationId: create-recommendation summary: Create Recommendation description: Create an eligibiilty recommendation based on the request. tags: - v1 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_pre-encounter_eligibilityChecks_v1_EligibilityRecommendation' requestBody: content: application/json: schema: $ref: '#/components/schemas/type_pre-encounter_eligibilityChecks_v1_PostEligibilityRecommendationRequest' /eligibility-checks/v1/recommendation/{recommendation_id}/{version}/vote: put: operationId: vote-recommendation summary: Vote Recommendation description: Submit user feedback on an eligibility recommendation. The path must contain the next version number to prevent race conditions. For example, if the current version of the recommendation is n, you will need to send a request to this endpoint with `/{recommendation_id}/{n+1}/vote` to update the vote. tags: - v1 parameters: - name: recommendation_id in: path required: true schema: type: string - name: version in: path required: true schema: type: string - 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_pre-encounter_eligibilityChecks_v1_EligibilityRecommendation' '404': description: Error response with status 404 content: application/json: schema: type: object properties: errorName: type: string enum: - NotFoundError content: $ref: '#/components/schemas/type_pre-encounter_common_ErrorBase4xx' required: - errorName - content '409': description: Error response with status 409 content: application/json: schema: type: object properties: errorName: type: string enum: - VersionConflictError content: $ref: '#/components/schemas/type_pre-encounter_common_VersionConflictErrorBody' required: - errorName - content requestBody: content: application/json: schema: $ref: '#/components/schemas/type_pre-encounter_eligibilityChecks_v1_Vote' /eligibility-checks/v1/get-multi/: get: operationId: get-multi summary: Get Multi tags: - v1 parameters: - name: page_token in: query required: false schema: $ref: '#/components/schemas/type_pre-encounter_common_PageToken' - name: limit in: query required: false schema: type: integer - name: subscriber_member_id in: query required: false schema: type: string - name: payer_id in: query required: false schema: type: string - name: provider_npi in: query required: false schema: type: string - name: date_of_service in: query required: false schema: type: string - name: initiated_at_min in: query required: false schema: type: string format: date-time - name: initiated_at_max in: query required: false schema: type: string format: date-time - 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_pre-encounter_eligibilityChecks_v1_EligibilityCheckPage' /eligibility-checks/v1/insurance-discovery: post: operationId: insurance-discovery summary: Insurance Discovery description: 'Sends an insurance discovery check to find potential coverage matches for a patient through Stedi. Given patient demographics, this endpoint discovers what insurance coverages exist for the patient.' tags: - v1 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_pre-encounter_eligibilityChecks_v1_InsuranceDiscoveryResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/type_pre-encounter_eligibilityChecks_v1_InsuranceDiscoveryRequest' /eligibility-checks/v1/coordination-of-benefits: post: operationId: coordination-of-benefits summary: Coordination Of Benefits description: 'Sends a coordination of benefits check through Stedi to determine whether a patient has coverage overlap across multiple payers and, if so, which payer is primary. Medicare and Medicare Advantage plans are not supported.' tags: - v1 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_pre-encounter_eligibilityChecks_v1_CoordinationOfBenefitsResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/type_pre-encounter_eligibilityChecks_v1_CoordinationOfBenefitsRequest' /appointments/v1: post: operationId: create summary: Create description: Adds an appointment. VersionConflictError is returned when the placer_appointment_id is already in use. tags: - v1 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_pre-encounter_appointments_v1_Appointment' '404': description: Error response with status 404 content: application/json: schema: type: object properties: errorName: type: string enum: - NotFoundError content: $ref: '#/components/schemas/type_pre-encounter_common_ErrorBase4xx' required: - errorName - content '409': description: Error response with status 409 content: application/json: schema: type: object properties: errorName: type: string enum: - VersionConflictError content: $ref: '#/components/schemas/type_pre-encounter_common_VersionConflictErrorBody' required: - errorName - content requestBody: content: application/json: schema: $ref: '#/components/schemas/type_pre-encounter_appointments_v1_MutableAppointment' /appointments/v1/visits: get: operationId: get_visits summary: Get Visits description: 'Gets all Visits within a given time range. The return list is ordered by start_time ascending. **IMPORTANT:** This endpoint requires a date filter on `appointment.startTimestamp` to ensure acceptable query performance. Without date filtering, the query can take 50+ seconds on large datasets due to grouping and aggregation operations. Example filters: - `appointment.startTimestamp|gt|2024-01-01` - appointments after January 1, 2024 - `appointment.startTimestamp|eq|2024-12-08` - appointments on December 8, 2024 - `appointment.startTimestamp|lt|2024-12-31` - appointments before December 31, 2024 You can combine the date filter with other filters using commas: - `appointment.startTimestamp|gt|2024-01-01,appointment.status|eq|PENDING`' tags: - v1 parameters: - name: page_token in: query required: false schema: $ref: '#/components/schemas/type_pre-encounter_common_PageToken' - name: limit in: query required: false schema: type: integer - name: sort_field in: query description: Defaults to appointment.start_time. required: false schema: $ref: '#/components/schemas/type_pre-encounter_lists_v1_SortFieldString' - name: sort_direction in: query description: Defaults to ascending. required: false schema: $ref: '#/components/schemas/type_pre-encounter_common_SortDirection' - name: filters in: query description: '**Required:** Must include a date filter on appointment.startTimestamp (using gt, lt, or eq operators). Example: appointment.startTimestamp|gt|2024-01-01' required: false schema: $ref: '#/components/schemas/type_pre-encounter_common_FilterQueryString' - 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_pre-encounter_appointments_v1_VisitsPage' '400': description: Error response with status 400 content: application/json: schema: type: object properties: errorName: type: string enum: - BadRequestError content: $ref: '#/components/schemas/type_pre-encounter_common_ErrorBase4xx' required: - errorName - content /appointments/v1/visits/counts: get: operationId: get_counts summary: Get Counts description: 'Gets aggregate counts for the visits matching the given filters. The counts respect all provided filters but are independent of pagination, so this can be fetched once when filters change instead of on every page of `get_visits`. **IMPORTANT:** Like `get_visits`, this endpoint requires a date filter on `appointment.startTimestamp` to ensure acceptable query performance.' tags: - v1 parameters: - name: filters in: query description: '**Required:** Must include a date filter on appointment.startTimestamp (using gt, lt, or eq operators). Example: appointment.startTimestamp|gt|2024-01-01' required: false schema: $ref: '#/components/schemas/type_pre-encounter_common_FilterQueryString' - 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_pre-encounter_appointments_v1_CountsResponse' '400': description: Error response with status 400 content: application/json: schema: type: object properties: errorName: type: string enum: - BadRequestError content: $ref: '#/components/schemas/type_pre-encounter_common_ErrorBase4xx' required: - errorName - content /appointments/v1/{id}: get: operationId: get summary: Get description: Gets an appointment. tags: - v1 parameters: - name: id in: path required: true schema: $ref: '#/components/schemas/type_pre-encounter_common_AppointmentId' - 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_pre-encounter_appointments_v1_Appointment' '404': description: Error response with status 404 content: application/json: schema: type: object properties: errorName: type: string enum: - NotFoundError content: $ref: '#/components/schemas/type_pre-encounter_common_ErrorBase4xx' required: - errorName - content /appointments/v1/{id}/history: get: operationId: get_history summary: Get History description: Gets an appointment along with it's full history. The return list is ordered by version ascending. tags: - v1 parameters: - name: id in: path required: true schema: $ref: '#/components/schemas/type_pre-encounter_common_AppointmentId' - 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_pre-encounter_appointments_v1_Appointment' '404': description: Error response with status 404 content: application/json: schema: type: object properties: errorName: type: string enum: - NotFoundError content: $ref: '#/components/schemas/type_pre-encounter_common_ErrorBase4xx' required: - errorName - content /appointments/v1/{id}/{version}: put: operationId: update summary: Update description: Updates an appointment. The path must contain the next version number to prevent race conditions. For example, if the current version of the appointment is n, you will need to send a request to this endpoint with `/{id}/n+1` to update the appointment. Updating historic versions is not supported. tags: - v1 parameters: - name: id in: path required: true schema: $ref: '#/components/schemas/type_pre-encounter_common_AppointmentId' - name: version in: path required: true schema: type: string - 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_pre-encounter_appointments_v1_Appointment' '404': description: Error response with status 404 content: application/json: schema: type: object properties: errorName: type: string enum: - NotFoundError content: $ref: '#/components/schemas/type_pre-encounter_common_ErrorBase4xx' required: - errorName - content '409': description: Error response with status 409 content: application/json: schema: type: object properties: errorName: type: string enum: - VersionConflictError content: $ref: '#/components/schemas/type_pre-encounter_common_VersionConflictErrorBody' required: - errorName - content requestBody: content: application/json: schema: $ref: '#/components/schemas/type_pre-encounter_appointments_v1_MutableAppointment' delete: operationId: deactivate summary: Deactivate description: Sets an appointment as deactivated. The path must contain the most recent version to prevent race conditions. Deactivating historic versions is not supported. Subsequent updates via PUT to the appointment will "reactivate" the appointment and set the deactivated flag to false. tags: - v1 parameters: - name: id in: path required: true schema: $ref: '#/components/schemas/type_pre-encounter_common_AppointmentId' - name: version in: path required: true schema: type: string - 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: - NotFoundError content: $ref: '#/components/schemas/type_pre-encounter_common_ErrorBase4xx' required: - errorName - content '409': description: Error response with status 409 content: application/json: schema: type: object properties: errorName: type: string enum: - VersionConflictError content: $ref: '#/components/schemas/type_pre-encounter_common_VersionConflictErrorBody' required: - errorName - content /appointments/v1/updates/scan: get: operationId: scan summary: Scan description: Scans up to 100 appointment updates. The since query parameter is inclusive, and the result list is ordered by updatedAt ascending. tags: - v1 parameters: - name: since in: query required: true schema: type: string format: date-time - 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_pre-encounter_appointments_v1_Appointment' /coverages/v1/: post: operationId: create summary: Create description: Creates a new Coverage. A Coverage provides the high-level identifiers and descriptors of a specific insurance plan for a specific individual - typically the information you can find on an insurance card. Additionally a coverage will include detailed benefits information covered by the specific plan for the individual. tags: - v1 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_pre-encounter_coverages_v1_Coverage' requestBody: content: application/json: schema: $ref: '#/components/schemas/type_pre-encounter_coverages_v1_MutableCoverage' get: operationId: get_multi summary: Get Multi description: Returns a list of Coverages based on the search criteria. tags: - v1 parameters: - name: patient_id in: query required: false schema: type: string - 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_pre-encounter_coverages_v1_Coverage' /coverages/v1//{id}/{version}: put: operationId: update summary: Update description: Updates a Coverage. The path must contain the next version number to prevent race conditions. For example, if the current version of the coverage is n, you will need to send a request to this endpoint with `/{id}/n+1` to update the coverage. Updating historic versions is not supported. tags: - v1 parameters: - name: id in: path required: true schema: $ref: '#/components/schemas/type_pre-encounter_common_CoverageId' - name: version in: path required: true schema: type: string - 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_pre-encounter_coverages_v1_Coverage' '404': description: Error response with status 404 content: application/json: schema: type: object properties: errorName: type: string enum: - NotFoundError content: $ref: '#/components/schemas/type_pre-encounter_common_ErrorBase4xx' required: - errorName - content '409': description: Error response with status 409 content: application/json: schema: type: object properties: errorName: type: string enum: - VersionConflictError content: $ref: '#/components/schemas/type_pre-encounter_common_VersionConflictErrorBody' required: - errorName - content requestBody: content: application/json: schema: $ref: '#/components/schemas/type_pre-encounter_coverages_v1_MutableCoverage' /coverages/v1//get-multi-paginated: get: operationId: get_multi_paginated summary: Get Multi Paginated description: Returns a page of Coverages based on the search criteria. tags: - v1 parameters: - name: patient_id in: query required: false schema: type: string - name: payer_plan_group_id in: query required: false schema: type: string - name: page_token in: query required: false schema: $ref: '#/components/schemas/type_pre-encounter_common_PageToken' - name: limit in: query description: Must be between 0 and 1000. Defaults to 100 required: false schema: type: integer - 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_pre-encounter_coverages_v1_CoveragesPage' '400': description: Error response with status 400 content: application/json: schema: type: object properties: errorName: type: string enum: - BadRequestError content: $ref: '#/components/schemas/type_pre-encounter_common_ErrorBase4xx' required: - errorName - content /coverages/v1//{id}: get: operationId: get summary: Get description: gets a specific Coverage tags: - v1 parameters: - name: id in: path required: true schema: $ref: '#/components/schemas/type_pre-encounter_common_CoverageId' - 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_pre-encounter_coverages_v1_Coverage' /coverages/v1//{id}/history: get: operationId: get_history summary: Get History description: "Gets a coverage's history. Full history is returned if no filters are \ndefined. The return list is ordered by version, defaulting to ascending." tags: - v1 parameters: - name: id in: path required: true schema: $ref: '#/components/schemas/type_pre-encounter_common_CoverageId' - name: start in: query required: false schema: type: string format: date - name: end in: query required: false schema: type: string format: date - name: non_auto_updated_coverages_only in: query description: If true, only returns coverages that have NOT been auto-updated by the system. required: false schema: type: boolean - name: sort_direction in: query description: Defaults to ascending. Sorts by version. required: false schema: $ref: '#/components/schemas/type_pre-encounter_common_SortDirection' - name: limit in: query description: Must be between 0 and 1000. No default. required: false schema: type: integer - 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_pre-encounter_coverages_v1_Coverage' '400': description: Error response with status 400 content: application/json: schema: type: object properties: errorName: type: string enum: - BadRequestError content: $ref: '#/components/schemas/type_pre-encounter_common_ErrorBase4xx' required: - errorName - content '404': description: Error response with status 404 content: application/json: schema: type: object properties: errorName: type: string enum: - NotFoundError content: $ref: '#/components/schemas/type_pre-encounter_common_ErrorBase4xx' required: - errorName - content /coverages/v1//updates/scan: get: operationId: scan summary: Scan description: 'Scans up to 100 coverage updates. The since query parameter is inclusive, and the result list is ordered by updatedAt ascending. **Polling Pattern:** To continuously poll for updates without gaps: 1. Make your initial request with a `since` timestamp (e.g., `since=2020-01-01T13:00:00.000Z`) 2. The API returns up to 100 coverage records, sorted by `updated_at` ascending 3. Find the `updated_at` value from the last record in the response 4. Use that `updated_at` value as the `since` parameter in your next request 5. Repeat steps 2-4 to ingest updates until you receive an empty list **Important Notes:** - The `since` parameter is inclusive, so you may receive the last record from the previous batch again (you can deduplicate by ID and version) - All coverage records include `updated_at`, `id`, `version`, `deactivated`, and `updating_user` fields for tracking changes - Timestamps have millisecond resolution for precise ordering' tags: - v1 parameters: - name: since in: query required: true schema: type: string format: date-time - 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_pre-encounter_coverages_v1_Coverage' /coverages/v1//batch-update-ppg/{ppg_id}: post: operationId: batch_update_ppg summary: Batch Update Ppg description: Finds all coverages associated with the given ppg_id and updates the ppg_fields for each coverage. tags: - v1 parameters: - name: ppg_id in: path required: true schema: $ref: '#/components/schemas/type_pre-encounter_common_PayerPlanGroupId' - name: Authorization in: header description: OAuth authentication required: true schema: type: string responses: '200': description: Successful response requestBody: content: application/json: schema: $ref: '#/components/schemas/type_pre-encounter_coverages_v1_PayerPlanGroupFields' /coverages/v1//{id}/eligibility: post: operationId: check_eligibility summary: Check Eligibility description: Initiates an eligibility check. Returns the metadata of the check if successfully initiated. tags: - v1 parameters: - name: id in: path required: true schema: $ref: '#/components/schemas/type_pre-encounter_common_CoverageId' - 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_pre-encounter_eligibilityChecks_v1_EligibilityCheckMetadata' requestBody: content: application/json: schema: type: object properties: service_code: $ref: '#/components/schemas/type_pre-encounter_coverages_v1_ServiceTypeCode' date_of_service: type: string format: date npi: type: string required: - service_code - date_of_service - npi /coverages/v1//{id}/eligibility/{check_id}: get: operationId: get_eligibility summary: Get Eligibility description: Gets the eligibility of a patient for a specific coverage if successful. tags: - v1 parameters: - name: id in: path required: true schema: $ref: '#/components/schemas/type_pre-encounter_common_CoverageId' - name: check_id in: path required: true schema: type: string - 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_pre-encounter_coverages_v1_CoverageEligibilityCheckResponse' /images/v1: post: operationId: create summary: Create description: Adds an image. VersionConflictError is returned if a front or back of this coverage already exists. tags: - v1 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_pre-encounter_images_v1_Image' '409': description: Error response with status 409 content: application/json: schema: type: object properties: errorName: type: string enum: - VersionConflictError content: $ref: '#/components/schemas/type_pre-encounter_common_VersionConflictErrorBody' required: - errorName - content requestBody: content: application/json: schema: $ref: '#/components/schemas/type_pre-encounter_images_v1_MutableImage' get: operationId: getMulti summary: Get Multi description: Searches for images that match the query parameters. tags: - v1 parameters: - name: patient_id in: query required: false schema: type: string - name: coverage_id in: query required: false schema: type: string - name: file_type in: query required: false schema: type: string - name: patient_notes in: query required: false schema: type: string - name: sort_field in: query description: The field to order by. Defaults to updatedAt. required: false schema: $ref: '#/components/schemas/type_pre-encounter_images_v1_ImageSortField' - name: sort_direction in: query description: The direction to order by. Defaults to desc. required: false schema: $ref: '#/components/schemas/type_pre-encounter_common_SortDirection' - 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_pre-encounter_images_v1_Image' /images/v1/{id}: get: operationId: get summary: Get description: Gets an image by imageId. tags: - v1 parameters: - name: id in: path required: true schema: $ref: '#/components/schemas/type_pre-encounter_images_v1_ImageId' - 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_pre-encounter_images_v1_Image' '404': description: Error response with status 404 content: application/json: schema: type: object properties: errorName: type: string enum: - NotFoundError content: $ref: '#/components/schemas/type_pre-encounter_common_ErrorBase4xx' required: - errorName - content /images/v1/{id}/{version}: put: operationId: update summary: Update description: Updates an Image. The path must contain the most recent version to prevent races. tags: - v1 parameters: - name: id in: path required: true schema: $ref: '#/components/schemas/type_pre-encounter_images_v1_ImageId' - name: version in: path required: true schema: type: string - 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_pre-encounter_images_v1_Image' '404': description: Error response with status 404 content: application/json: schema: type: object properties: errorName: type: string enum: - NotFoundError content: $ref: '#/components/schemas/type_pre-encounter_common_ErrorBase4xx' required: - errorName - content '409': description: Error response with status 409 content: application/json: schema: type: object properties: errorName: type: string enum: - VersionConflictError content: $ref: '#/components/schemas/type_pre-encounter_common_VersionConflictErrorBody' required: - errorName - content requestBody: content: application/json: schema: $ref: '#/components/schemas/type_pre-encounter_images_v1_MutableImage' delete: operationId: deactivate summary: Deactivate description: Sets an Image as deactivated. The path must contain the most recent version to prevent races. tags: - v1 parameters: - name: id in: path required: true schema: $ref: '#/components/schemas/type_pre-encounter_images_v1_ImageId' - name: version in: path required: true schema: type: string - 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: - NotFoundError content: $ref: '#/components/schemas/type_pre-encounter_common_ErrorBase4xx' required: - errorName - content '409': description: Error response with status 409 content: application/json: schema: type: object properties: errorName: type: string enum: - VersionConflictError content: $ref: '#/components/schemas/type_pre-encounter_common_VersionConflictErrorBody' required: - errorName - content /lists/v1/patient: get: operationId: get_patient_list summary: Get Patient List description: Gets patients with dependent objects for patients that match the query parameters. tags: - v1 parameters: - name: page_token in: query required: false schema: $ref: '#/components/schemas/type_pre-encounter_common_PageToken' - name: limit in: query required: false schema: type: integer - name: sort_field in: query description: Defaults to patient.updatedAt. required: false schema: $ref: '#/components/schemas/type_pre-encounter_lists_v1_SortFieldString' - name: sort_direction in: query description: Defaults to ascending. required: false schema: $ref: '#/components/schemas/type_pre-encounter_common_SortDirection' - name: filters in: query required: false schema: $ref: '#/components/schemas/type_pre-encounter_common_FilterQueryString' - name: include_deactivated in: query description: If true, includes deactivated patients in the results. Defaults to false. required: false schema: type: boolean - name: redirect_to_primary in: query description: If true, and filtering by mrn equals, then only return the primary version of the patient requested required: false schema: type: boolean - name: hide_alternatives in: query description: If true, then do not show alternative patients required: false schema: type: boolean - 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_pre-encounter_lists_v1_PatientListPage' '400': description: Error response with status 400 content: application/json: schema: type: object properties: errorName: type: string enum: - BadRequestError content: $ref: '#/components/schemas/type_pre-encounter_common_ErrorBase4xx' required: - errorName - content /lists/v1/appointment: get: operationId: get_appointment_list summary: Get Appointment List description: Searches for appointments that match the query parameters. tags: - v1 parameters: - name: sort_field in: query description: Defaults to appointment.startTimestamp. required: false schema: $ref: '#/components/schemas/type_pre-encounter_lists_v1_SortFieldString' - name: sort_direction in: query description: Defaults to asc. required: false schema: $ref: '#/components/schemas/type_pre-encounter_common_SortDirection' - name: limit in: query description: Defaults to 100. required: false schema: type: integer - name: page_token in: query required: false schema: $ref: '#/components/schemas/type_pre-encounter_common_PageToken' - name: filters in: query required: false schema: $ref: '#/components/schemas/type_pre-encounter_common_FilterQueryString' - name: include_deactivated in: query description: If true, includes deactivated appointments in the results. Defaults to false. required: false schema: type: boolean - name: include_merged_patient_data in: query description: If true and a patient id is specified, then also include appointments from any alternative patients that are merged into this patient. Defaults to false. required: false schema: type: boolean - 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_pre-encounter_lists_v1_AppointmentListPage' /notes/v1/{id}: get: operationId: get summary: Get description: Gets a note by NoteId. tags: - v1 parameters: - name: id in: path required: true schema: $ref: '#/components/schemas/type_pre-encounter_common_NoteId' - 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_pre-encounter_notes_v1_Note' /notes/v1: post: operationId: create summary: Create description: Adds a new note. tags: - v1 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_pre-encounter_notes_v1_Note' requestBody: content: application/json: schema: $ref: '#/components/schemas/type_pre-encounter_notes_v1_MutableNote' /notes/v1/{id}/{version}: put: operationId: update summary: Update description: Updates a note. The path must contain the most recent version to prevent races. tags: - v1 parameters: - name: id in: path required: true schema: $ref: '#/components/schemas/type_pre-encounter_common_NoteId' - name: version in: path required: true schema: type: string - 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_pre-encounter_notes_v1_Note' requestBody: content: application/json: schema: $ref: '#/components/schemas/type_pre-encounter_notes_v1_MutableNote' delete: operationId: deactivate summary: Deactivate description: Sets a note as deactivated. The path must contain the most recent version to prevent races. tags: - v1 parameters: - name: id in: path required: true schema: $ref: '#/components/schemas/type_pre-encounter_common_NoteId' - name: version in: path required: true schema: type: string - name: Authorization in: header description: OAuth authentication required: true schema: type: string responses: '200': description: Successful response /organization-external-providers/v1/{id}: get: operationId: get summary: Get description: Gets an organization external provider by ID. tags: - v1 parameters: - name: id in: path required: true schema: $ref: '#/components/schemas/type_pre-encounter_organizationExternalProviders_v1_OrganizationExternalProviderId' - 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_pre-encounter_organizationExternalProviders_v1_OrganizationExternalProvider' '404': description: Error response with status 404 content: application/json: schema: type: object properties: errorName: type: string enum: - NotFoundError content: $ref: '#/components/schemas/type_pre-encounter_common_ErrorBase4xx' required: - errorName - content /organization-external-providers/v1: get: operationId: getMulti summary: Get Multi description: Searches for organization external providers that match the query parameters. tags: - v1 parameters: - name: limit in: query required: false schema: type: integer - name: page_token in: query required: false schema: $ref: '#/components/schemas/type_pre-encounter_common_PageToken' - name: sort_field in: query description: Defaults to name.family. required: false schema: $ref: '#/components/schemas/type_pre-encounter_organizationExternalProviders_v1_OrganizationExternalProviderSortField' - name: sort_direction in: query description: Defaults to ascending. required: false schema: $ref: '#/components/schemas/type_pre-encounter_common_SortDirection' - name: npi in: query required: false schema: type: string - name: type in: query required: false schema: $ref: '#/components/schemas/type_pre-encounter_organizationExternalProviders_v1_OrganizationExternalProviderType' - name: first_name in: query required: false schema: type: string - name: last_name in: query required: false schema: type: string - 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_pre-encounter_organizationExternalProviders_v1_OrganizationExternalProviderPage' post: operationId: create summary: Create description: Creates a new organization external provider. BadRequestError is returned when the NPI is already in use. tags: - v1 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_pre-encounter_organizationExternalProviders_v1_OrganizationExternalProvider' '400': description: Error response with status 400 content: application/json: schema: type: object properties: errorName: type: string enum: - BadRequestError content: $ref: '#/components/schemas/type_pre-encounter_common_ErrorBase4xx' required: - errorName - content requestBody: content: application/json: schema: $ref: '#/components/schemas/type_pre-encounter_organizationExternalProviders_v1_MutableOrganizationExternalProvider' /organization-external-providers/v1/{id}/{version}: put: operationId: update summary: Update description: Updates an organization external provider. The path must contain the next version number to prevent race conditions. For example, if the current version of the provider is n, you will need to send a request to this endpoint with `/{id}/n+1` to update the provider. Updating historic versions is not supported. BadRequestError is returned when the NPI is already in use by another provider. tags: - v1 parameters: - name: id in: path required: true schema: $ref: '#/components/schemas/type_pre-encounter_organizationExternalProviders_v1_OrganizationExternalProviderId' - name: version in: path required: true schema: type: string - 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_pre-encounter_organizationExternalProviders_v1_OrganizationExternalProvider' '400': description: Error response with status 400 content: application/json: schema: type: object properties: errorName: type: string enum: - BadRequestError content: $ref: '#/components/schemas/type_pre-encounter_common_ErrorBase4xx' required: - errorName - content '404': description: Error response with status 404 content: application/json: schema: type: object properties: errorName: type: string enum: - NotFoundError content: $ref: '#/components/schemas/type_pre-encounter_common_ErrorBase4xx' required: - errorName - content '409': description: Error response with status 409 content: application/json: schema: type: object properties: errorName: type: string enum: - VersionConflictError content: $ref: '#/components/schemas/type_pre-encounter_common_VersionConflictErrorBody' required: - errorName - content requestBody: content: application/json: schema: $ref: '#/components/schemas/type_pre-encounter_organizationExternalProviders_v1_MutableOrganizationExternalProvider' delete: operationId: deactivate summary: Deactivate description: Sets an organization external provider as deactivated. The path must contain the most recent version plus 1 to prevent race conditions. Deactivating historic versions is not supported. tags: - v1 parameters: - name: id in: path required: true schema: $ref: '#/components/schemas/type_pre-encounter_organizationExternalProviders_v1_OrganizationExternalProviderId' - name: version in: path required: true schema: type: string - 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: - NotFoundError content: $ref: '#/components/schemas/type_pre-encounter_common_ErrorBase4xx' required: - errorName - content '409': description: Error response with status 409 content: application/json: schema: type: object properties: errorName: type: string enum: - VersionConflictError content: $ref: '#/components/schemas/type_pre-encounter_common_VersionConflictErrorBody' required: - errorName - content /organization-external-providers/v1/updates/scan: get: operationId: scan summary: Scan description: 'Scans up to 1000 organization external provider updates. The since query parameter is inclusive, and the result list is ordered by updatedAt ascending. **Polling Pattern:** To continuously poll for updates without gaps: 1. Make your initial request with a `since` timestamp (e.g., `since=2020-01-01T13:00:00.000Z`) 2. The API returns 100 by default and up to 1000 records, sorted by `updated_at` ascending 3. Find the `updated_at` value from the last record in the response 4. Use that `updated_at` value as the `since` parameter in your next request 5. Repeat steps 2-4 to ingest updates until you receive an empty list **Important Notes:** - The `since` parameter is inclusive, so you may receive the last record from the previous batch again (you can deduplicate by ID and version) - All records include `updated_at`, `id`, `version`, `deactivated`, and `updating_user` fields for tracking changes - Timestamps have millisecond resolution for precise ordering' tags: - v1 parameters: - name: since in: query required: true schema: type: string format: date-time - name: maxResults in: query required: false schema: type: integer - 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_pre-encounter_organizationExternalProviders_v1_OrganizationExternalProvider' /patient-merge/v1: post: operationId: create summary: Create description: Creates a new patient merge record. tags: - v1 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_pre-encounter_patientMerges_v1_PatientMerge' '400': description: Error response with status 400 content: application/json: schema: type: object properties: errorName: type: string enum: - BadRequestError content: $ref: '#/components/schemas/type_pre-encounter_common_ErrorBase4xx' required: - errorName - content '500': description: Error response with status 500 content: application/json: schema: type: object properties: errorName: type: string enum: - InternalError content: $ref: '#/components/schemas/type_pre-encounter_common_ErrorBase5xx' required: - errorName - content requestBody: content: application/json: schema: $ref: '#/components/schemas/type_pre-encounter_patientMerges_v1_MutablePatientMerge' /patient-merge/v1/status/{mrn_or_id}: get: operationId: get_status summary: Get Status description: Gets the merge status for a patient by patient ID or mrn. If the provided value is a valid UUID, it will be treated as a patient ID. Otherwise, it will be treated as an MRN. tags: - v1 parameters: - name: mrn_or_id in: path required: true schema: type: string - 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_pre-encounter_patientMerges_v1_PatientMergeStatus' '404': description: Error response with status 404 content: application/json: schema: type: object properties: errorName: type: string enum: - NotFoundError content: $ref: '#/components/schemas/type_pre-encounter_common_ErrorBase4xx' required: - errorName - content /patient-merge/v1/all/{mrn}: get: operationId: get_all_by_mrn summary: Get All By Mrn description: Gets all patient merge records that have the given mrn. tags: - v1 parameters: - name: mrn in: path required: true schema: type: string - 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_pre-encounter_patientMerges_v1_PatientMerge' '404': description: Error response with status 404 content: application/json: schema: type: object properties: errorName: type: string enum: - NotFoundError content: $ref: '#/components/schemas/type_pre-encounter_common_ErrorBase4xx' required: - errorName - content /patient-merge/v1/{id}/{version}: delete: operationId: deactivate summary: Deactivate description: Deactivates a patient merge record. Path must contain next version. tags: - v1 parameters: - name: id in: path required: true schema: $ref: '#/components/schemas/type_pre-encounter_common_PatientMergeId' - name: version in: path required: true schema: type: string - 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: - NotFoundError content: $ref: '#/components/schemas/type_pre-encounter_common_ErrorBase4xx' required: - errorName - content '409': description: Error response with status 409 content: application/json: schema: type: object properties: errorName: type: string enum: - VersionConflictError content: $ref: '#/components/schemas/type_pre-encounter_common_VersionConflictErrorBody' required: - errorName - content /patient-merge/v1/updates/scan: get: operationId: scan summary: Scan description: 'Scans up to 1000 patient merge updates. The since query parameter is inclusive, and the result list is ordered by updatedAt ascending. **Polling Pattern:** To continuously poll for updates without gaps: 1. Make your initial request with a `since` timestamp (e.g., `since=2020-01-01T13:00:00.000Z`) 2. The API returns 100 by default and up to 1000 patient merge records, sorted by `updated_at` ascending 3. Find the `updated_at` value from the last record in the response 4. Use that `updated_at` value as the `since` parameter in your next request 5. Repeat steps 2-4 to ingest updates until you receive an empty list **Important Notes:** - The `since` parameter is inclusive, so you may receive the last record from the previous batch again (you can deduplicate by ID and version) - All patient merge records include `updated_at`, `id`, `version`, `deactivated`, and `updating_user` fields for tracking changes - Timestamps have millisecond resolution for precise ordering' tags: - v1 parameters: - name: since in: query required: true schema: type: string format: date-time - name: maxResults in: query required: false schema: type: integer - 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_pre-encounter_patientMerges_v1_PatientMerge' /patients/v1: post: operationId: create summary: Create description: Adds a patient. VersionConflictError is returned when the patient's external ID is already in use. tags: - v1 parameters: - name: skip_duplicate_check in: query required: false schema: type: boolean - 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_pre-encounter_patients_v1_Patient' '409': description: Error response with status 409 content: application/json: schema: type: object properties: errorName: type: string enum: - VersionConflictError content: $ref: '#/components/schemas/type_pre-encounter_common_VersionConflictErrorBody' required: - errorName - content requestBody: content: application/json: schema: $ref: '#/components/schemas/type_pre-encounter_patients_v1_MutablePatient' get: operationId: search summary: Search description: Returns a list of Patients based on the search criteria. tags: - v1 parameters: - name: mrn in: query required: false schema: type: string - name: similar_name_ordering in: query description: A string that is used to order similar names in search results. required: false schema: type: string - 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_pre-encounter_patients_v1_Patient' /patients/v1/with_mrn: post: operationId: create_with_mrn summary: Create With Mrn description: Adds a patient and hydrates their MRN with a pre-existing MRN. Once this patient is created their MRN will not be editable. BadRequestError is returned when the MRN is greater than 20 characters. VersionConflictError is returned when the patient's external ID is already in use. tags: - v1 parameters: - name: skip_duplicate_check in: query required: false schema: type: boolean - 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_pre-encounter_patients_v1_Patient' '400': description: Error response with status 400 content: application/json: schema: type: object properties: errorName: type: string enum: - BadRequestError content: $ref: '#/components/schemas/type_pre-encounter_common_ErrorBase4xx' required: - errorName - content '409': description: Error response with status 409 content: application/json: schema: type: object properties: errorName: type: string enum: - VersionConflictError content: $ref: '#/components/schemas/type_pre-encounter_common_VersionConflictErrorBody' required: - errorName - content requestBody: content: application/json: schema: $ref: '#/components/schemas/type_pre-encounter_patients_v1_MutablePatientWithMrn' /patients/v1/get_multi: get: operationId: get_multi summary: Get Multi description: Searches for patients that match the query parameters. tags: - v1 parameters: - name: limit in: query required: false schema: type: integer - name: mrn in: query required: false schema: type: string - name: page_token in: query required: false schema: $ref: '#/components/schemas/type_pre-encounter_common_PageToken' - name: sort_field in: query required: false schema: $ref: '#/components/schemas/type_pre-encounter_patients_v1_PatientSortField' - name: sort_direction in: query description: Defaults to ascending. required: false schema: $ref: '#/components/schemas/type_pre-encounter_common_SortDirection' - name: redirect_to_primary in: query description: If true, then only return the primary version of any patients requested required: false schema: type: boolean - 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_pre-encounter_patients_v1_PatientPage' /patients/v1/search_providers: get: operationId: search_providers summary: Search Providers description: Searches for referring providers that match the query parameters. The search is case-insensitive, supports fuzzy matching, and matches against provider name and NPI. The search criteria must be an alphanumeric string, and the search is limited to the first 20 results. tags: - v1 parameters: - name: search_criteria in: query required: true schema: type: string - 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_pre-encounter_common_ExternalProvider' /patients/v1/{id}: get: operationId: get summary: Get description: Gets a patient. tags: - v1 parameters: - name: id in: path required: true schema: $ref: '#/components/schemas/type_pre-encounter_common_PatientId' - 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_pre-encounter_patients_v1_Patient' '404': description: Error response with status 404 content: application/json: schema: type: object properties: errorName: type: string enum: - NotFoundError content: $ref: '#/components/schemas/type_pre-encounter_common_ErrorBase4xx' required: - errorName - content /patients/v1/mrn/{mrn}: get: operationId: get_by_mrn summary: Get By Mrn description: Gets a patient by mrn. tags: - v1 parameters: - name: mrn in: path required: true schema: type: string - 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_pre-encounter_patients_v1_Patient' '404': description: Error response with status 404 content: application/json: schema: type: object properties: errorName: type: string enum: - NotFoundError content: $ref: '#/components/schemas/type_pre-encounter_common_ErrorBase4xx' required: - errorName - content /patients/v1/{id}/history: get: operationId: get_history summary: Get History description: Gets a patient along with it's full history. The return list is ordered by version ascending. tags: - v1 parameters: - name: id in: path required: true schema: $ref: '#/components/schemas/type_pre-encounter_common_PatientId' - 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_pre-encounter_patients_v1_Patient' '404': description: Error response with status 404 content: application/json: schema: type: object properties: errorName: type: string enum: - NotFoundError content: $ref: '#/components/schemas/type_pre-encounter_common_ErrorBase4xx' required: - errorName - content /patients/v1/{id}/snapshot: get: operationId: get_coverage_snapshot summary: Get Coverage Snapshot description: Gets a patient along with their coverages at a specific point in time. Note that the date passed in is only used to determine what the filing order was for that patient during that time. The actual data returned will always be the latest version of the patient and coverages. tags: - v1 parameters: - name: id in: path required: true schema: $ref: '#/components/schemas/type_pre-encounter_common_PatientId' - name: date in: query required: false schema: type: string format: date-time - 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_pre-encounter_patients_v1_PatientCoverageSnapshot' '404': description: Error response with status 404 content: application/json: schema: type: object properties: errorName: type: string enum: - NotFoundError content: $ref: '#/components/schemas/type_pre-encounter_common_ErrorBase4xx' required: - errorName - content /patients/v1/{id}/eligibility-timeline: get: operationId: get_eligibility_timeline summary: Get Eligibility Timeline description: Gets a patient's eligibility audit timeline, newest-first. Org-scoped and keyset-paginated. tags: - v1 parameters: - name: id in: path required: true schema: $ref: '#/components/schemas/type_pre-encounter_common_PatientId' - name: event_types in: query required: false schema: $ref: '#/components/schemas/type_pre-encounter_patients_v1_EligibilityAuditEventType' - name: coverage_id in: query required: false schema: $ref: '#/components/schemas/type_pre-encounter_common_CoverageId' - name: appointment_id in: query required: false schema: $ref: '#/components/schemas/type_pre-encounter_common_AppointmentId' - name: page_token in: query required: false schema: $ref: '#/components/schemas/type_pre-encounter_common_PageToken' - name: limit in: query required: false schema: type: integer - 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_pre-encounter_patients_v1_EligibilityTimelinePage' /patients/v1/{id}/{version}: put: operationId: update summary: Update description: Updates a patient. The path must contain the next version number to prevent race conditions. For example, if the current version of the patient is n, you will need to send a request to this endpoint with `/{id}/n+1` to update the patient. Updating historic versions is not supported. tags: - v1 parameters: - name: id in: path required: true schema: $ref: '#/components/schemas/type_pre-encounter_common_PatientId' - name: version in: path required: true schema: type: string - 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_pre-encounter_patients_v1_Patient' '404': description: Error response with status 404 content: application/json: schema: type: object properties: errorName: type: string enum: - NotFoundError content: $ref: '#/components/schemas/type_pre-encounter_common_ErrorBase4xx' required: - errorName - content '409': description: Error response with status 409 content: application/json: schema: type: object properties: errorName: type: string enum: - VersionConflictError content: $ref: '#/components/schemas/type_pre-encounter_common_VersionConflictErrorBody' required: - errorName - content requestBody: content: application/json: schema: $ref: '#/components/schemas/type_pre-encounter_patients_v1_MutablePatient' delete: operationId: deactivate summary: Deactivate description: Sets a patient as deactivated. The path must contain the most recent version plus 1 to prevent race conditions. Deactivating historic versions is not supported. tags: - v1 parameters: - name: id in: path required: true schema: $ref: '#/components/schemas/type_pre-encounter_common_PatientId' - name: version in: path required: true schema: type: string - 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: - NotFoundError content: $ref: '#/components/schemas/type_pre-encounter_common_ErrorBase4xx' required: - errorName - content '409': description: Error response with status 409 content: application/json: schema: type: object properties: errorName: type: string enum: - VersionConflictError content: $ref: '#/components/schemas/type_pre-encounter_common_VersionConflictErrorBody' required: - errorName - content patch: operationId: reactivate summary: Reactivate description: Removes the deactivated flag for a patient. The path must contain the most recent version plus 1 to prevent race conditions. Reactivating historic versions is not supported. tags: - v1 parameters: - name: id in: path required: true schema: $ref: '#/components/schemas/type_pre-encounter_common_PatientId' - name: version in: path required: true schema: type: string - 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: - NotFoundError content: $ref: '#/components/schemas/type_pre-encounter_common_ErrorBase4xx' required: - errorName - content '409': description: Error response with status 409 content: application/json: schema: type: object properties: errorName: type: string enum: - VersionConflictError content: $ref: '#/components/schemas/type_pre-encounter_common_VersionConflictErrorBody' required: - errorName - content /patients/v1/updates/scan: get: operationId: scan summary: Scan description: 'Scans up to 1000 patient updates. The since query parameter is inclusive, and the result list is ordered by updatedAt ascending. **Polling Pattern:** To continuously poll for updates without gaps: 1. Make your initial request with a `since` timestamp (e.g., `since=2020-01-01T13:00:00.000Z`) 2. The API returns 100 by default and up to 1000 patient records, sorted by `updated_at` ascending 3. Find the `updated_at` value from the last record in the response 4. Use that `updated_at` value as the `since` parameter in your next request 5. Repeat steps 2-4 to ingest updates until you receive an empty list **Important Notes:** - The `since` parameter is inclusive, so you may receive the last record from the previous batch again (you can deduplicate by ID and version) - All patient records include `updated_at`, `id`, `version`, `deactivated`, and `updating_user` fields for tracking changes - Timestamps have millisecond resolution for precise ordering' tags: - v1 parameters: - name: since in: query required: true schema: type: string format: date-time - name: maxResults in: query required: false schema: type: integer - 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_pre-encounter_patients_v1_Patient' /tags/v1/{id}: get: operationId: get summary: Get description: Gets a tag by TagId. tags: - v1 parameters: - name: id in: path required: true schema: $ref: '#/components/schemas/type_pre-encounter_common_TagId' - 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_pre-encounter_tags_v1_Tag' /tags/v1: get: operationId: getAll summary: Get All description: Gets all tags. Defaults to page size of 1000. tags: - v1 parameters: - name: limit in: query required: false schema: type: integer - name: page_token in: query required: false schema: $ref: '#/components/schemas/type_pre-encounter_common_PageToken' - 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_pre-encounter_tags_v1_TagPage' post: operationId: create summary: Create description: Adds a new tag if it does not already exist, otherwise, returns the existing tag. tags: - v1 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_pre-encounter_tags_v1_Tag' requestBody: content: application/json: schema: $ref: '#/components/schemas/type_pre-encounter_tags_v1_MutableTag' /tags/v1/{id}/{version}: put: operationId: update summary: Update description: Updates a tag. The path must contain the most recent version to prevent races. tags: - v1 parameters: - name: id in: path required: true schema: $ref: '#/components/schemas/type_pre-encounter_common_TagId' - name: version in: path required: true schema: type: string - 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_pre-encounter_tags_v1_Tag' requestBody: content: application/json: schema: $ref: '#/components/schemas/type_pre-encounter_tags_v1_MutableTag' delete: operationId: deactivate summary: Deactivate description: Sets a tag as deactivated. The path must contain the most recent version to prevent races. tags: - v1 parameters: - name: id in: path required: true schema: $ref: '#/components/schemas/type_pre-encounter_common_TagId' - name: version in: path required: true schema: type: string - name: Authorization in: header description: OAuth authentication required: true schema: type: string responses: '200': description: Successful response /api/import-invoice/v1: post: operationId: import_invoice summary: Import Invoice description: Import an existing invoice from a third party service to reflect state in Candid. tags: - v1 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_import-invoice_v1_ImportInvoice' '409': description: Error response with status 409 content: application/json: schema: type: object properties: errorName: type: string enum: - EntityConflictError content: $ref: '#/components/schemas/type_commons_EntityConflictErrorMessage' required: - errorName - content '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: $ref: '#/components/schemas/type_import-invoice_v1_CreateImportInvoiceRequest' get: operationId: get_multi summary: Get Multi description: Returns all Invoices for the authenticated user's organization with all filters applied. tags: - v1 parameters: - name: patient_external_id in: query required: false schema: $ref: '#/components/schemas/type_commons_PatientExternalId' - name: encounter_external_id in: query required: false schema: $ref: '#/components/schemas/type_commons_EncounterExternalId' - name: note in: query description: partial match supported required: false schema: type: string - name: due_date_before in: query description: all invoices whose due date is before this due date, not inclusive required: false schema: type: string format: date - name: due_date_after in: query description: all invoices whose due date is after this due date, not inclusive required: false schema: type: string format: date - name: status in: query description: all invoices that match any of the provided statuses required: false schema: $ref: '#/components/schemas/type_invoices_v2_InvoiceStatus' - name: limit in: query description: Defaults to 100 required: false schema: type: integer - name: sort in: query description: Defaults to created_at required: false schema: $ref: '#/components/schemas/type_invoices_v2_InvoiceSortField' - name: sort_direction in: query description: Sort direction. Defaults to descending order required: false schema: $ref: '#/components/schemas/type_commons_SortDirection' - name: page_token in: query required: false schema: $ref: '#/components/schemas/type_commons_PageToken' - 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_import-invoice_v1_ImportInvoicesPage' /api/import-invoice/v1/{invoice_id}: get: operationId: get summary: Get description: Retrieve and view an import invoice tags: - v1 parameters: - name: invoice_id in: path description: InvoiceId to be returned required: true schema: $ref: '#/components/schemas/type_commons_InvoiceId' - 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_import-invoice_v1_ImportInvoice' '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 patch: operationId: update summary: Update description: Update the information on the imported invoice tags: - v1 parameters: - name: invoice_id in: path required: true schema: $ref: '#/components/schemas/type_commons_InvoiceId' - 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_import-invoice_v1_ImportInvoice' '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_import-invoice_v1_ImportInvoiceUpdateRequest' /api/patient-ar/v1/inventory: get: operationId: list-inventory summary: List Inventory Records description: 'Retrieve a list of inventory records based on the provided filters. Each inventory record provides the latest invoiceable status of the associated claim. The response is paginated, and the `page_token` can be used to retrieve subsequent pages. Initial requests should not include `page_token`.' tags: - v1 parameters: - name: since in: query description: Timestamp to filter records since, inclusive required: false schema: type: string format: date-time - name: limit in: query description: Maximum number of records to return, default is 100 required: false schema: type: integer default: 100 - name: page_token in: query required: false schema: $ref: '#/components/schemas/type_commons_PageToken' - 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_patient-ar_v1_ListInventoryPagedResponse' '403': description: Error response with status 403 content: application/json: schema: type: object properties: errorName: type: string enum: - UnauthorizedError content: $ref: '#/components/schemas/type_commons_UnauthorizedErrorMessage' required: - errorName - content '422': description: The provided filters are invalid or not supported. content: application/json: schema: type: object properties: errorName: type: string enum: - InvalidFiltersError description: The provided filters are invalid or not supported. content: $ref: '#/components/schemas/type_patient-ar_v1_InvalidFiltersErrorType' description: The provided filters are invalid or not supported. required: - errorName - content /api/patient-ar/v1/invoice-itemization/{claim_id}: get: operationId: itemize summary: Invoice Itemization description: Provides detailed itemization of invoice data for a specific claim. tags: - v1 parameters: - name: claim_id in: path required: true schema: $ref: '#/components/schemas/type_commons_ClaimId' - 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_patient-ar_v1_InvoiceItemizationResponse' '403': description: Error response with status 403 content: application/json: schema: type: object properties: errorName: type: string enum: - UnauthorizedError content: $ref: '#/components/schemas/type_commons_UnauthorizedErrorMessage' required: - errorName - content '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 /api/patient-refunds/v1: get: operationId: getMulti summary: Get patient refunds description: 'Returns all patient refunds satisfying the search criteria AND whose organization_id matches the current organization_id of the authenticated user.' tags: - v1 parameters: - name: limit in: query description: Defaults to 100. The value must be greater than 0 and less than 1000. required: false schema: type: integer - name: patient_external_id in: query required: false schema: $ref: '#/components/schemas/type_commons_PatientExternalId' - name: claim_id in: query required: false schema: $ref: '#/components/schemas/type_commons_ClaimId' - name: service_line_id in: query required: false schema: $ref: '#/components/schemas/type_commons_ServiceLineId' - name: billing_provider_id in: query required: false schema: $ref: '#/components/schemas/type_commons_ProviderId' - name: unattributed in: query description: returns payments with unattributed allocations if set to true required: false schema: type: boolean - name: invoice_id in: query required: false schema: $ref: '#/components/schemas/type_commons_InvoiceId' - name: sources in: query required: false schema: $ref: '#/components/schemas/type_financials_PatientTransactionSource' - name: sort in: query description: Defaults to refund_timestamp required: false schema: $ref: '#/components/schemas/type_patient-refunds_v1_PatientRefundSortField' - name: sort_direction in: query description: Sort direction. Defaults to descending order if not provided. required: false schema: $ref: '#/components/schemas/type_commons_SortDirection' - name: page_token in: query required: false schema: $ref: '#/components/schemas/type_commons_PageToken' - 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_patient-refunds_v1_PatientRefundsPage' '403': description: Error response with status 403 content: application/json: schema: type: object properties: errorName: type: string enum: - UnauthorizedError content: $ref: '#/components/schemas/type_commons_UnauthorizedErrorMessage' required: - errorName - content '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 post: operationId: create summary: Create patient refund description: 'Creates a new patient refund record and returns the newly created PatientRefund object. The allocations can describe whether the refund is being applied toward a specific service line, claim, or billing provider.' tags: - v1 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_patient-refunds_v1_PatientRefund' '403': description: Error response with status 403 content: application/json: schema: type: object properties: errorName: type: string enum: - UnauthorizedError content: $ref: '#/components/schemas/type_commons_UnauthorizedErrorMessage' required: - errorName - content '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 '422': description: Error response with status 422 content: application/json: schema: type: object properties: errorName: type: string enum: - ReallocationWouldOverdraftError content: $ref: '#/components/schemas/type_financials_ReallocationWouldOverdraftErrorContent' required: - errorName - content requestBody: content: application/json: schema: type: object properties: amount_cents: type: integer refund_timestamp: type: string format: date-time refund_note: type: string patient_external_id: $ref: '#/components/schemas/type_commons_PatientExternalId' allocations: type: array items: $ref: '#/components/schemas/type_financials_AllocationCreate' invoice: $ref: '#/components/schemas/type_commons_InvoiceId' refund_reason: $ref: '#/components/schemas/type_financials_RefundReason' allocation_restrictions: type: array items: $ref: '#/components/schemas/type_financials_AllocationRestrictionCreate' description: 'Optional restrictions constraining which claims this refund''s credit can be auto-allocated to (e.g. billing provider NPI). Restriction (type, value) pairs must be unique. When omitted, the refund is unrestricted. Refunds created from an existing payment inherit that payment''s restrictions instead.' raise_on_overdraft: type: boolean description: If true, the refund will be rejected if it would cause any account to be overdrafted. Defaults to false. required: - amount_cents - patient_external_id - allocations /api/patient-refunds/v1/{patient_refund_id}: get: operationId: get summary: Get patient refund description: Retrieves a previously created patient refund by its `patient_refund_id`. tags: - v1 parameters: - name: patient_refund_id in: path required: true schema: $ref: '#/components/schemas/type_patient-refunds_v1_PatientRefundId' - 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_patient-refunds_v1_PatientRefund' '403': description: Error response with status 403 content: application/json: schema: type: object properties: errorName: type: string enum: - UnauthorizedError content: $ref: '#/components/schemas/type_commons_UnauthorizedErrorMessage' required: - errorName - content '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 patch: operationId: update summary: Update description: Updates the patient refund record matching the provided patient_refund_id. tags: - v1 parameters: - name: patient_refund_id in: path required: true schema: $ref: '#/components/schemas/type_patient-refunds_v1_PatientRefundId' - 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_patient-refunds_v1_PatientRefund' '403': description: Error response with status 403 content: application/json: schema: type: object properties: errorName: type: string enum: - UnauthorizedError content: $ref: '#/components/schemas/type_commons_UnauthorizedErrorMessage' required: - errorName - content '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 '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: refund_timestamp: type: string format: date-time refund_note: $ref: '#/components/schemas/type_financials_NoteUpdate' invoice: $ref: '#/components/schemas/type_financials_InvoiceUpdate' refund_reason: $ref: '#/components/schemas/type_financials_RefundReasonUpdate' delete: operationId: delete summary: Delete patient refund description: Deletes the patient refund record matching the provided patient_refund_id. tags: - v1 parameters: - name: patient_refund_id in: path required: true schema: $ref: '#/components/schemas/type_patient-refunds_v1_PatientRefundId' - name: Authorization in: header description: OAuth authentication required: true schema: type: string responses: '200': description: Successful response '403': description: Error response with status 403 content: application/json: schema: type: object properties: errorName: type: string enum: - UnauthorizedError content: $ref: '#/components/schemas/type_commons_UnauthorizedErrorMessage' required: - errorName - content '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 '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 /api/charge_capture_claim_creation/v1/{charge_capture_claim_creation_id}: get: operationId: get summary: Get Charge Capture Claim Creation tags: - v1 parameters: - name: charge_capture_claim_creation_id in: path required: true schema: $ref: '#/components/schemas/type_commons_ChargeCaptureClaimCreationId' - 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_charge-capture-bundles_v1_ChargeCaptureClaimCreation' /api/charge_capture_claim_creation/v1/all/summary: get: operationId: getSummary summary: Get Charge Capture Claim Creation Summary tags: - v1 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_charge-capture-bundles_v1_ChargeCaptureClaimCreationSummary' /api/charge_capture_claim_creation/v1/error/{charge_capture_bundle_error_id}: patch: operationId: resolveChargeCreationError summary: Mark a ClaimCreationAttempt error as resolved tags: - v1 parameters: - name: charge_capture_bundle_error_id in: path required: true schema: type: string format: uuid - name: Authorization in: header description: OAuth authentication required: true schema: type: string responses: '200': description: Successful response '403': description: Error response with status 403 content: application/json: schema: type: object properties: errorName: type: string enum: - UnauthorizedError content: $ref: '#/components/schemas/type_commons_UnauthorizedErrorMessage' required: - errorName - content '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: type: object properties: resolved_by: type: string description: A string, denoting who resolved the error for audit trail purposes. resolution_reason: type: string description: A string denoting why or how the error was dealt with for audit trail purposes. /api/charge_capture_claim_creation/v1: get: operationId: getAll summary: Get all Charge Capture Claim Creations tags: - v1 parameters: - name: limit in: query description: Maximum number of entities per page, defaults to 100. required: false schema: type: integer - name: sort in: query description: Defaults to created_at required: false schema: $ref: '#/components/schemas/type_charge-capture-bundles_v1_ChargeCaptureClaimCreationSortField' - name: sort_direction in: query description: Sort direction. Defaults to descending order if not provided. required: false schema: $ref: '#/components/schemas/type_commons_SortDirection' - name: page_token in: query required: false schema: $ref: '#/components/schemas/type_commons_PageToken' - name: patient_external_id in: query description: The patient ID from the external EMR platform for the patient required: false schema: type: string - name: claim_creation_status in: query description: the status of the charge capture Claim Creation, refers to whether it was able to create a claim. required: false schema: $ref: '#/components/schemas/type_charge-capture-bundles_v1_ChargeCaptureClaimCreationStatus' - name: charge_status in: query description: the status of the charge captures required: false schema: $ref: '#/components/schemas/type_charge-capture_v1_ChargeCaptureStatus' - name: charge_external_id in: query description: 'A client-specified unique ID to associate with this encounter; for example, your internal encounter ID or a Dr. Chrono encounter ID. This field should not contain PHI.' required: false schema: type: string - name: date_of_service_min in: query description: 'Date formatted as YYYY-MM-DD; eg: 2019-08-24. This date must be the local date in the timezone where the service occurred.' required: false schema: type: string format: date - name: date_of_service_max in: query description: 'Date formatted as YYYY-MM-DD; eg: 2019-08-24. This date must be the local date in the timezone where the service occurred.' required: false schema: type: string format: date - name: claim_ids in: query description: A list of claim IDs to filter by. This will return all charge capture claim_creations that have a resulting claim with one of the IDs in this list. required: false schema: $ref: '#/components/schemas/type_commons_EncounterId' - name: claim_creation_ids in: query description: A list of Claim Creation IDs to filter by. required: false schema: $ref: '#/components/schemas/type_commons_ChargeCaptureClaimCreationId' - name: billing_provider_npis in: query description: A list of billing provider NPIs to filter by. This will return all charge capture claim_creations which include one or more charges with one of the NPIs in this list. required: false schema: type: string - name: service_facility_name in: query description: A string to filter by. This will return all charge capture claim_creations which include one or more charges with this service facility name. required: false schema: type: string - name: primary_payer_ids in: query description: A list of primary payer IDs to filter by. This will return all charge capture claim_creations which include one or more charges with one of the primary payer IDs in this list. required: false schema: type: string - name: rendering_provider_npis in: query description: A list of rendering provider NPIs to filter by. This will return all charge capture claim_creations which include one or more charges with one of the NPIs in this list. required: false schema: type: string - name: rendering_provider_names in: query description: A list of rendering provider names to filter by. This will return all charge capture claim_creations which include one or more charges with one of the names in this list. required: false schema: type: string - name: supervising_provider_npis in: query description: A list of supervising provider NPIs to filter by. This will return all charge capture claim_creations which include one or more charges with one of the NPIs in this list. required: false schema: type: string - name: supervising_provider_names in: query description: A list of supervising provider names to filter by. This will return all charge capture claim_creations which include one or more charges with one of the names in this list. required: false schema: type: string - name: claim_status in: query description: the status of the claim to filter by created from charge capture bundle. required: false schema: $ref: '#/components/schemas/type_claims_ClaimStatus' - name: claim_creation_category in: query description: A list of claim creation categories to filter by. This will return all charge capture claim_creations which include one or more charges with one of the names in this list. required: false schema: type: string - name: tags in: query description: A list of tags to filter by. This will return all charge captures with one of the tags. required: false schema: type: string - name: primary_payer_names in: query description: A list of primary payer names to filter by. This will return all charge captures with one of the names. required: false schema: type: string - name: patient_names in: query description: A list of patient names to filter by. This will return all charge captures with one of the names. required: false schema: type: string - name: has_charge_capture_updates in: query description: If true, only return claim_creations that have charge captures that have been updated since the Claim Creation has had a status of BILLED. See the updates property on ChargeCapture for more details. required: false schema: type: boolean - 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_charge-capture-bundles_v1_ChargeCaptureClaimCreationPage' /api/charge_captures/v1: post: operationId: create summary: Create a Charge Capture tags: - v1 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_charge-capture_v1_ChargeCapture' '403': description: Error response with status 403 content: application/json: schema: type: object properties: errorName: type: string enum: - UnauthorizedError content: $ref: '#/components/schemas/type_commons_UnauthorizedErrorMessage' required: - errorName - content '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 '409': description: Error response with status 409 content: application/json: schema: type: object properties: errorName: type: string enum: - ChargeExternalIdConflictError content: $ref: '#/components/schemas/type_charge-capture_v1_ChargeExternalIdConflictErrorMessage' required: - errorName - content '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: data: $ref: '#/components/schemas/type_charge-capture_v1_ChargeCaptureData' description: Charge Capture data contains all the fields needed to create an encounter, but listed as optional. Candid will use this data when attempting to bundle multiple Charge Captures into a single encounter. charge_external_id: type: string description: A client-specified unique ID to associate with this encounter; for example, your internal encounter ID or a Dr. Chrono encounter ID. This field should not contain PHI. originating_system: type: string description: An optional string field denoting the originating system of the charge. claim_creation_category: type: string description: An optional string field denoting the user defined category of the claim creation. ehr_source_url: type: string description: External URL reference that links to Charge Capture details within the external system (e.g. the EHR visit page). Send full URL format for the external link (e.g. https://emr_charge_capture_url.com/123). patient_external_id: type: string description: The patient ID from the external EMR platform for the patient status: $ref: '#/components/schemas/type_charge-capture_v1_ChargeCaptureStatus' description: the status of the charge capture attachment_external_document_ids: type: array items: type: string description: Provide external attachment IDs which have been uploaded to Candid. They will be associated with the Encounter at Encounter creation time. metadata: type: array items: $ref: '#/components/schemas/type_custom-schemas_v1_SchemaInstance' description: 'Key-value pairs that adhere to metadata schemas. Multiple metadata instances can be associated with a charge capture.' hl7_message_type: $ref: '#/components/schemas/type_charge-capture_v1_Hl7MessageType' description: The HL7 message type that produced this write. Used to differentiate post-submission update behavior. Sent by HL7 producers (conduit); null for manual / script writes. required: - data - charge_external_id - patient_external_id - status get: operationId: getAll summary: Get all Charge Captures tags: - v1 parameters: - name: limit in: query description: Maximum number of entities per page, defaults to 100. required: false schema: type: integer - name: sort in: query description: Defaults to created_at required: false schema: $ref: '#/components/schemas/type_charge-capture_v1_ChargeCaptureSortField' - name: sort_direction in: query description: Sort direction. Defaults to descending order if not provided. required: false schema: $ref: '#/components/schemas/type_commons_SortDirection' - name: page_token in: query required: false schema: $ref: '#/components/schemas/type_commons_PageToken' - name: patient_external_id in: query description: The patient ID from the external EMR platform for the patient required: false schema: type: string - name: status in: query description: the status of the charge captures required: false schema: $ref: '#/components/schemas/type_charge-capture_v1_ChargeCaptureStatus' - name: charge_external_id in: query description: 'A client-specified unique ID to associate with this encounter; for example, your internal encounter ID or a Dr. Chrono encounter ID. This field should not contain PHI.' required: false schema: type: string - name: date_of_service_min in: query description: 'Date formatted as YYYY-MM-DD; eg: 2019-08-24. This date must be the local date in the timezone where the service occurred.' required: false schema: type: string format: date - name: date_of_service_max in: query description: 'Date formatted as YYYY-MM-DD; eg: 2019-08-24. This date must be the local date in the timezone where the service occurred.' required: false schema: type: string format: date - name: claim_ids in: query description: A list of claim IDs to filter by. This will return all charge captures that have a resulting claim with one of the IDs in this list. required: false schema: $ref: '#/components/schemas/type_commons_EncounterId' - name: claim_creation_ids in: query description: A list of Claim Creation IDs to filter by. required: false schema: $ref: '#/components/schemas/type_commons_ChargeCaptureClaimCreationId' - name: billing_provider_npis in: query description: A list of billing provider NPIs to filter by. This will return all charge captures with one of the NPIs in this list. required: false schema: type: string - name: service_facility_name in: query description: A string to filter by. This will return all charge captures with this service facility name. required: false schema: type: string - name: primary_payer_ids in: query description: A list of primary payer IDs to filter by. This will return all charge captures with one of the primary payer IDs in this list. required: false schema: type: string - name: rendering_provider_npis in: query description: A list of rendering provider NPIs to filter by. This will return all charge captures with one of the NPIs in this list. required: false schema: type: string - name: rendering_provider_names in: query description: A list of rendering provider names to filter by. This will return all charge captures with one of the names in this list. required: false schema: type: string - name: supervising_provider_npis in: query description: A list of supervising provider NPIs to filter by. This will return all charge captures with one of the NPIs in this list. required: false schema: type: string - name: supervising_provider_names in: query description: A list of supervising provider names to filter by. This will return all charge captures with one of the names in this list. required: false schema: type: string - name: claim_creation_category in: query description: A list of claim creation categories to filter by. This will return all charge capture claim_creations which include one or more charges with one of the names in this list. required: false schema: type: string - name: tags in: query description: A list of tags to filter by. This will return all charge captures with one of the tags. required: false schema: type: string - name: primary_payer_names in: query description: A list of primary payer names to filter by. This will return all charge captures with one of the names. required: false schema: type: string - name: patient_names in: query description: A list of patient names to filter by. This will return all charge captures with one of the names. required: false schema: type: string - name: exclude_charges_linked_to_claims in: query description: Whether to exclude charge captures which are part of a claim creation. required: false schema: type: boolean - name: patient_external_id_ranked_sort in: query description: The patient ID from the external EMR platform for the patient required: false schema: type: string - name: status_ranked_sort in: query description: The charge capture status to show first required: false schema: $ref: '#/components/schemas/type_charge-capture_v1_ChargeCaptureStatus' - name: charge_external_id_ranked_sort in: query description: 'A client-specified unique ID to associate with this encounter; for example, your internal encounter ID or a Dr. Chrono encounter ID. This field should not contain PHI.' required: false schema: type: string - name: date_of_service_min_ranked_sort in: query description: 'Date formatted as YYYY-MM-DD; eg: 2019-08-24. This date must be the local date in the timezone where the service occurred.' required: false schema: type: string format: date - name: date_of_service_max_ranked_sort in: query description: 'Date formatted as YYYY-MM-DD; eg: 2019-08-24. This date must be the local date in the timezone where the service occurred.' required: false schema: type: string format: date - name: search_term in: query description: 'Filter by any of the following fields: charge_id, claim_id, patient external_id, patient date of birth, patient first name, patient last name, or charge external id.' required: false schema: type: string - name: billable_status in: query description: Defines if the Encounter is to be billed by Candid to the responsible_party. Examples for when this should be set to NOT_BILLABLE include if the Encounter has not occurred yet or if there is no intention of ever billing the responsible_party. required: false schema: $ref: '#/components/schemas/type_encounters_v4_BillableStatusType' - name: responsible_party in: query description: Defines the party to be billed with the initial balance owed on the claim. Use SELF_PAY if you intend to bill self pay/cash pay. required: false schema: $ref: '#/components/schemas/type_encounters_v4_ResponsiblePartyType' - name: claim_ids_ranked_sort in: query description: A list of claim IDs to show first. This will return all charge captures that have a resulting claim with one of the IDs in this list. required: false schema: $ref: '#/components/schemas/type_commons_EncounterId' - name: claim_creation_ids_ranked_sort in: query description: A list of Claim Creation IDs to show first. required: false schema: $ref: '#/components/schemas/type_commons_ChargeCaptureClaimCreationId' - name: billing_provider_npis_ranked_sort in: query description: A list of billing provider NPIs to show first. This will return all charge captures with one of the NPIs in this list. required: false schema: type: string - name: service_facility_name_ranked_sort in: query description: A string to show first. This will return all charge captures with this service facility name. required: false schema: type: string - name: primary_payer_ids_ranked_sort in: query description: A list of primary payer IDs to show first. This will return all charge captures with one of the primary payer IDs in this list. required: false schema: type: string - name: rendering_provider_npis_ranked_sort in: query description: A list of rendering provider NPIs to show first. This will return all charge captures with one of the NPIs in this list. required: false schema: type: string - name: rendering_provider_names_ranked_sort in: query description: A list of rendering provider names to show first. This will return all charge captures with one of the names in this list. required: false schema: type: string - name: supervising_provider_npis_ranked_sort in: query description: A list of supervising provider NPIs to show first. This will return all charge captures with one of the NPIs in this list. required: false schema: type: string - name: supervising_provider_names_ranked_sort in: query description: A list of supervising provider names to show first. This will return all charge captures with one of the names in this list. required: false schema: type: string - name: claim_status in: query description: the status of the claim to filter by created from charge capture bundle. required: false schema: $ref: '#/components/schemas/type_claims_ClaimStatus' - name: claim_creation_category_ranked_sort in: query description: A list of claim creation categories to sort by. This will return all charge capture claim_creations which include one or more charges with one of the names in this list. required: false schema: type: string - name: tags_ranked_sort in: query description: A list of tags. This will return all charge captures with one of the tags. required: false schema: type: string - name: primary_payer_names_ranked_sort in: query description: A list of primary payer names to sort by. This will return all charge captures with one of the names. required: false schema: type: string - name: patient_names_ranked_sort in: query description: A list of patient names to sort by. This will return all charge captures with one of the names. required: false schema: type: string - 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_charge-capture_v1_ChargeCapturePage' /api/charge_captures/v1/create-from-pre-encounter: post: operationId: create-from-pre-encounter-patient summary: Create a Charge Capture from pre-encounter patient and appointment description: "Create a Charge Capture from a pre-encounter patient and appointment. This endpoint is intended to be used by consumers who are managing\npatients and appointments in the pre-encounter service and is currently under development. Consumers who are not taking advantage\nof the pre-encounter service should use the standard create endpoint.\n\nAt encounter creation time, information from the provided patient and appointment objects will be populated\nwhere applicable. In particular, the following fields are populated from the patient and appointment objects:\n - Patient\n - Referring Provider\n - Subscriber Primary\n - Subscriber Secondary\n - Referral Number\n - Responsible Party\n - Guarantor\n\nNote that these fields should not be populated in the ChargeCaptureData property of this endpoint, as they will be overwritten at encounter creation time.\n\nUtilizing this endpoint opts you into automatic updating of the encounter when the patient or appointment is updated, assuming the\nencounter has not already been submitted or adjudicated." tags: - v1 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_charge-capture_v1_ChargeCapture' '403': description: Error response with status 403 content: application/json: schema: type: object properties: errorName: type: string enum: - UnauthorizedError content: $ref: '#/components/schemas/type_commons_UnauthorizedErrorMessage' required: - errorName - content '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 '409': description: Error response with status 409 content: application/json: schema: type: object properties: errorName: type: string enum: - ChargeExternalIdConflictError content: $ref: '#/components/schemas/type_charge-capture_v1_ChargeExternalIdConflictErrorMessage' required: - errorName - content '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: data: $ref: '#/components/schemas/type_charge-capture_v1_ChargeCaptureData' description: Charge Capture data contains all the fields needed to create an encounter, but listed as optional. Candid will use this data when attempting to bundle multiple Charge Captures into a single encounter. charge_external_id: type: string description: A client-specified unique ID to associate with this encounter; for example, your internal encounter ID or a Dr. Chrono encounter ID. This field should not contain PHI. pre_encounter_patient_id: $ref: '#/components/schemas/type_commons_PreEncounterPatientId' pre_encounter_appointment_ids: type: array items: $ref: '#/components/schemas/type_commons_PreEncounterAppointmentId' originating_system: type: string description: An optional string field denoting the originating system of the charge. claim_creation_category: type: string description: An optional string field denoting the user defined category of the claim creation. ehr_source_url: type: string description: External URL reference that links to Charge Capture details within the external system (e.g. the EHR visit page). Send full URL format for the external link (e.g. https://emr_charge_capture_url.com/123). status: $ref: '#/components/schemas/type_charge-capture_v1_ChargeCaptureStatus' description: the status of the charge capture attachment_external_document_ids: type: array items: type: string description: Provide external attachment IDs which have been uploaded to Candid. They will be associated with the Encounter at Encounter creation time. hl7_message_type: $ref: '#/components/schemas/type_charge-capture_v1_Hl7MessageType' description: The HL7 message type that produced this write. Used to differentiate post-submission update behavior. Sent by HL7 producers (conduit); null for manual / script writes. required: - data - charge_external_id - pre_encounter_patient_id - pre_encounter_appointment_ids - status /api/charge_captures/v1/changes: patch: operationId: updatePostBilledChanges summary: Update a ChargeCapturePostBilledChange tags: - v1 parameters: - name: Authorization in: header description: OAuth authentication required: true schema: type: string responses: '200': description: This list of updates will always return at most 1 update that is not resolved. The singular update will contain the difference between the updated charge and the created encounter. content: application/json: schema: type: array items: $ref: '#/components/schemas/type_charge-capture_v1_ChargeCapturePostBilledChange' '403': description: Error response with status 403 content: application/json: schema: type: object properties: errorName: type: string enum: - UnauthorizedError content: $ref: '#/components/schemas/type_commons_UnauthorizedErrorMessage' required: - errorName - content '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: type: object properties: charge_capture_change_ids: type: array items: $ref: '#/components/schemas/type_commons_ChargeCapturePostBilledChangeId' description: 'A list of UUIDs corresponding to ChargeCapturePostBilledChanges. All of the charges sent will be marked as resolved' resolved: type: boolean description: 'Whether the change has been resolved. If true, the change will be marked as resolved. If false, the change will be marked as unresolved.' required: - charge_capture_change_ids - resolved /api/charge_captures/v1/{charge_capture_id}: patch: operationId: update summary: Update Charge Capture tags: - v1 parameters: - name: charge_capture_id in: path required: true schema: $ref: '#/components/schemas/type_commons_ChargeCaptureId' - 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_charge-capture_v1_ChargeCapture' '403': description: Error response with status 403 content: application/json: schema: type: object properties: errorName: type: string enum: - UnauthorizedError content: $ref: '#/components/schemas/type_commons_UnauthorizedErrorMessage' required: - errorName - content '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 '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: data: $ref: '#/components/schemas/type_charge-capture_v1_ChargeCaptureData' charge_external_id: type: string description: 'A client-specified unique ID to associate with this encounter; for example, your internal encounter ID or a Dr. Chrono encounter ID. This field should not contain PHI.' ehr_source_url: type: string description: 'External URL reference that links to Charge Capture details within the external system (e.g. the EHR visit page). Send full URL format for the external link (e.g. https://emr_charge_capture_url.com/123).' originating_system: type: string description: An optional string field denoting the originating system of the charge. claim_creation_category: type: string description: An optional string field denoting the user defined category of the claim creation. patient_external_id: type: string description: The patient ID from the external EMR platform for the patient status: $ref: '#/components/schemas/type_charge-capture_v1_ChargeCaptureStatus' description: the status of the charge capture attachment_external_document_ids: type: array items: type: string description: Provide external attachment IDs which have been uploaded to Candid. They will be associated with the Encounter at Encounter creation time. metadata: type: array items: $ref: '#/components/schemas/type_custom-schemas_v1_SchemaInstance' description: 'Key-value pairs that adhere to metadata schemas. Multiple metadata instances can be associated with a charge capture.' hl7_message_type: $ref: '#/components/schemas/type_charge-capture_v1_Hl7MessageType' description: The HL7 message type that produced this write. Used to differentiate post-submission update behavior. Sent by HL7 producers (conduit); null for manual / script writes. get: operationId: get summary: Get Charge Capture tags: - v1 parameters: - name: charge_capture_id in: path required: true schema: $ref: '#/components/schemas/type_commons_ChargeCaptureId' - 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_charge-capture_v1_ChargeCapture' /api/charge_captures/v1/find-by-metadata: post: operationId: findByMetadata summary: Find Charge Captures by Metadata tags: - v1 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_charge-capture_v1_ChargeCapturePage' requestBody: content: application/json: schema: type: object properties: metadata: type: array items: $ref: '#/components/schemas/type_custom-schemas_v1_SchemaInstance' description: 'Filter by metadata schema instances. This will return all charge captures that match any of the provided schema instances.' limit: type: integer description: Maximum number of entities per page, defaults to 100. page_token: $ref: '#/components/schemas/type_commons_PageToken' required: - metadata /api/custom-schemas/v1: get: operationId: getMulti summary: Get all custom schemas description: Returns all custom schemas. tags: - v1 parameters: - name: organization_id in: query description: Filter to a specific organization's schemas. If not provided, defaults to the requesting user's organization. required: false schema: $ref: '#/components/schemas/type_commons_OrganizationId' - 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_custom-schemas_v1_SchemaGetMultiResponse' '403': description: Error response with status 403 content: application/json: schema: type: object properties: errorName: type: string enum: - UnauthorizedError content: $ref: '#/components/schemas/type_commons_UnauthorizedErrorMessage' required: - errorName - content post: operationId: create summary: Create a custom schema description: 'Create custom schema with a set of typed keys. Schema keys can be referenced as inputs in user-configurable rules in the Rules Engine, and key-value pairs can be attached to claims via the Encounters API.' tags: - v1 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_custom-schemas_v1_Schema' '422': description: Error response with status 422 content: application/json: schema: type: object properties: errorName: type: string enum: - SchemaValidationHttpFailure content: $ref: '#/components/schemas/type_custom-schemas_v1_SchemaValidationFailure' required: - errorName - content requestBody: content: application/json: schema: type: object properties: name: type: string description: type: string fields: type: array items: $ref: '#/components/schemas/type_custom-schemas_v1_SchemaField' required: - name - fields /api/custom-schemas/v1/{schema_id}: get: operationId: get summary: Get custom schema description: Return a custom schema with a given ID. tags: - v1 parameters: - name: schema_id in: path required: true schema: $ref: '#/components/schemas/type_commons_SchemaId' - 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_custom-schemas_v1_Schema' '403': description: Error response with status 403 content: application/json: schema: type: object properties: errorName: type: string enum: - UnauthorizedError content: $ref: '#/components/schemas/type_commons_UnauthorizedErrorMessage' required: - errorName - content '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 patch: operationId: update summary: Update custom schema description: Update the name, description, or keys on a preexisting schema. tags: - v1 parameters: - name: schema_id in: path required: true schema: $ref: '#/components/schemas/type_commons_SchemaId' - 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_custom-schemas_v1_Schema' '403': description: Error response with status 403 content: application/json: schema: type: object properties: errorName: type: string enum: - UnauthorizedError content: $ref: '#/components/schemas/type_commons_UnauthorizedErrorMessage' required: - errorName - content '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 '422': description: Error response with status 422 content: application/json: schema: type: object properties: errorName: type: string enum: - SchemaValidationHttpFailure content: $ref: '#/components/schemas/type_custom-schemas_v1_SchemaValidationFailure' required: - errorName - content requestBody: content: application/json: schema: type: object properties: name: type: string description: type: string fields_to_add: type: array items: $ref: '#/components/schemas/type_custom-schemas_v1_SchemaField' description: A list of typed entries to add to schema. Only additive modifications are permitted. /api/encounter-attachments/v1/{encounter_id}: get: operationId: get summary: Get Encounter Attachments tags: - v1 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-attachments_v1_EncounterAttachment' put: operationId: create summary: Create Encounter Attachment description: 'Uploads a file to the encounter. The file will be stored in the encounter''s attachments. Deprecated: Use create-v2 instead.' tags: - v1 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-attachments_v1_AttachmentId' requestBody: content: multipart/form-data: schema: type: object properties: attachment_file: type: string format: binary description: 'The file for upload. The maximum file size is 25MB. The allowed mime types are: - application/pdf - image/png - image/jpeg - text/plain - text/csv - application/vnd.openxmlformats-officedocument.wordprocessingml.document - application/vnd.openxmlformats-officedocument.spreadsheetml.sheet' attachment_type: $ref: '#/components/schemas/type_encounter-attachments_v1_EncounterAttachmentType' required: - attachment_file - attachment_type delete: operationId: delete summary: Delete Encounter Attachment tags: - v1 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: Successful response requestBody: content: application/json: schema: type: object properties: attachment_id: $ref: '#/components/schemas/type_encounter-attachments_v1_AttachmentId' required: - attachment_id /api/encounter-attachments/v1/{encounter_id}/v2: put: operationId: create-with-description summary: Create Encounter Attachment V2 description: 'Uploads a file to the encounter. The file will be stored in the encounter''s attachments.' tags: - v1 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-attachments_v1_AttachmentId' requestBody: content: multipart/form-data: schema: type: object properties: attachment_file: type: string format: binary description: 'The file for upload. The maximum file size is 25MB. The allowed mime types are: - application/pdf - image/png - image/jpeg - text/plain - text/csv - application/vnd.openxmlformats-officedocument.wordprocessingml.document - application/vnd.openxmlformats-officedocument.spreadsheetml.sheet' attachment_type: $ref: '#/components/schemas/type_encounter-attachments_v1_EncounterAttachmentType' description: type: string required: - attachment_file - attachment_type /api/encounter-attachments/v1/create-from-charge-capture-external-id: post: operationId: create-with-charge-capture-external-id summary: Create an Attachment from a Charge Capture external ID description: 'Uploads a file using an external identifier. For Charge Capture, the file will be associated with the Encounter at Encounter creation time. Note: Attachments created via this endpoint are not searchable via the get endpoint until they are associated with an encounter.' tags: - v1 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_encounter-attachments_v1_AttachmentId' requestBody: content: multipart/form-data: schema: type: object properties: charge_capture_external_id: type: string attachment_file: type: string format: binary description: 'The file for upload. The maximum file size is 25MB. The allowed mime types are: - application/pdf - image/png - image/jpeg - text/plain - text/csv - application/vnd.openxmlformats-officedocument.wordprocessingml.document - application/vnd.openxmlformats-officedocument.spreadsheetml.sheet' attachment_type: $ref: '#/components/schemas/type_encounter-attachments_v1_EncounterAttachmentType' description: type: string required: - charge_capture_external_id - attachment_file - attachment_type /api/encounter-attachments/v1/by-charge-capture-external-id/{charge_capture_external_id}: get: operationId: get-by-charge-capture-external-id summary: Get Attachments by Charge Capture External ID description: Returns all attachments associated with the given charge capture external ID. tags: - v1 parameters: - name: charge_capture_external_id in: path required: true schema: type: string - 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-attachments_v1_ChargeCaptureAttachment' delete: operationId: delete-by-charge-capture-external-id summary: Delete Attachment by Charge Capture External ID description: Deletes an attachment associated with the given charge capture external ID. tags: - v1 parameters: - name: charge_capture_external_id in: path required: true schema: type: string - name: Authorization in: header description: OAuth authentication required: true schema: type: string responses: '200': description: Successful response requestBody: content: application/json: schema: type: object properties: attachment_id: $ref: '#/components/schemas/type_encounter-attachments_v1_AttachmentId' required: - attachment_id /api/encounter-supplemental-information/v1/{encounter_id}: get: operationId: get summary: Get Encounter Supplemental Information tags: - v1 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: - v1 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: - v1 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: - v1 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 /api/events/v1/: get: operationId: scan summary: Scan description: Scans the last 30 days of events. All results are sorted by created date, descending. tags: - v1 parameters: - name: page_token in: query required: false schema: $ref: '#/components/schemas/type_commons_PageToken' - name: limit in: query description: Number of events to return. Minimum value is 1, maximum is 100. Defaults to 10. required: false schema: type: integer - name: event_types in: query description: 'Event types to filter on. Defaults to showing all event types. | Event Type | Description | |------------|-------------| | `CandidApi.Encounter.Created` | When a new claim is created | | `CandidApi.Encounter.StatusUpdated` | When a claim''s status has been updated | | `PreEncounter.Patient.Created` | When a new patient has been created | | `PreEncounter.Patient.Updated` | When a patient''s information has been updated | | `PreEncounter.Coverage.Created` | When a new coverage has been created for a patient | | `PreEncounter.Coverage.Updated` | When a patient''s coverage has been updated | | `PreEncounter.Tag.Created` | When a new tag has been created for a patient | | `PreEncounter.Tag.Updated` | When a patient''s tag has been updated | | `CandidApi.OrganizationProvider.Created` | When a new organization provider has been created | | `CandidApi.OrganizationProvider.Updated` | When an organization provider has been updated |' required: false schema: type: string - name: created_before in: query description: Filters for only events created before this time (inclusive). required: false schema: type: string format: date-time - name: created_after in: query description: Filters for only events created after this time (inclusive). required: false schema: type: string format: date-time - 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_events_v1_EventScanPage' '400': description: Error response with status 400 content: application/json: schema: type: object properties: errorName: type: string enum: - BadRequestError content: $ref: '#/components/schemas/type_commons_BadRequestErrorMessage' required: - errorName - content '500': description: Error response with status 500 content: application/json: schema: type: object properties: errorName: type: string enum: - InternalError content: $ref: '#/components/schemas/type_commons_InternalErrorMessage' required: - errorName - content /api/events/v1/{event_id}: get: operationId: get summary: Get tags: - v1 parameters: - name: event_id in: path required: true schema: $ref: '#/components/schemas/type_events_v1_EventId' - 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_events_v1_Event' '400': description: Error response with status 400 content: application/json: schema: type: object properties: errorName: type: string enum: - BadRequestError content: $ref: '#/components/schemas/type_commons_BadRequestErrorMessage' required: - errorName - content '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 '500': description: Error response with status 500 content: application/json: schema: type: object properties: errorName: type: string enum: - InternalError content: $ref: '#/components/schemas/type_commons_InternalErrorMessage' required: - errorName - content /api/external-payment-account-config/v1: get: operationId: get_multi summary: Get Multi tags: - v1 parameters: - name: limit in: query description: Defaults to 100 required: false schema: type: integer - name: page_token in: query required: false schema: $ref: '#/components/schemas/type_commons_PageToken' - 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_external-payment-account-config_v1_ExternalPaymentAccountConfigPage' /api/guarantors/v1/{encounter_id}: post: operationId: create summary: Create guarantor description: Creates a new guarantor and returns the newly created Guarantor object. tags: - v1 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_guarantor_v1_Guarantor' '409': description: Error response with status 409 content: application/json: schema: type: object properties: errorName: type: string enum: - EncounterHasExistingGuarantorError content: $ref: '#/components/schemas/type_guarantor_v1_EncounterHasExistingGuarantorErrorType' required: - errorName - content '422': description: Error response with status 422 content: application/json: schema: type: object properties: errorName: type: string enum: - HttpRequestValidationsError content: type: array items: $ref: '#/components/schemas/type_commons_RequestValidationError' required: - errorName - content requestBody: content: application/json: schema: $ref: '#/components/schemas/type_guarantor_v1_GuarantorCreate' /api/guarantors/v1/{guarantor_id}: get: operationId: get summary: Get guarantor description: Retrieves a guarantor by its `guarantor_id`. tags: - v1 parameters: - name: guarantor_id in: path required: true schema: $ref: '#/components/schemas/type_guarantor_v1_GuarantorId' - 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_guarantor_v1_Guarantor' patch: operationId: update summary: Update guarantor description: Updates a guarantor by its `guarantor_id`. tags: - v1 parameters: - name: guarantor_id in: path required: true schema: $ref: '#/components/schemas/type_guarantor_v1_GuarantorId' - 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_guarantor_v1_Guarantor' requestBody: content: application/json: schema: $ref: '#/components/schemas/type_guarantor_v1_GuarantorUpdate' /api/health-care-code-informations/v1/{encounter_id}: put: operationId: update summary: Update tags: - v1 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_health-care-code-information_v1_HealthCareCodeInformationGetAllResponse' '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 '422': description: Error response with status 422 content: application/json: schema: type: object properties: errorName: type: string enum: - HttpRequestValidationError content: $ref: '#/components/schemas/type_commons_RequestValidationError' required: - errorName - content requestBody: content: application/json: schema: $ref: '#/components/schemas/type_health-care-code-information_v1_HealthCareCodeInformationUpdate' get: operationId: get_all_for_encounter summary: Get All For Encounter tags: - v1 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_health-care-code-information_v1_HealthCareCodeInformationGetAllResponse' '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 /api/insurance-adjudications/v1/{insurance_adjudication_id}: get: operationId: get summary: Get insurance adjudication description: Retrieves a previously created insurance adjudication by its `insurance_adjudication_id`. tags: - v1 parameters: - name: insurance_adjudication_id in: path required: true schema: $ref: '#/components/schemas/type_insurance-adjudications_v1_InsuranceAdjudicationId' - 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_insurance-adjudications_v1_InsuranceAdjudication' '403': description: Error response with status 403 content: application/json: schema: type: object properties: errorName: type: string enum: - UnauthorizedError content: $ref: '#/components/schemas/type_commons_UnauthorizedErrorMessage' required: - errorName - content /api/insurance-refunds/v1: get: operationId: get_multi summary: Get insurance refunds description: 'Returns all insurance refunds satisfying the search criteria AND whose organization_id matches the current organization_id of the authenticated user.' tags: - v1 parameters: - name: limit in: query description: Defaults to 100. The value must be greater than 0 and less than 1000. required: false schema: type: integer - name: payer_uuid in: query required: false schema: $ref: '#/components/schemas/type_payers_v3_PayerUuid' - name: claim_id in: query required: false schema: $ref: '#/components/schemas/type_commons_ClaimId' - name: service_line_id in: query required: false schema: $ref: '#/components/schemas/type_commons_ServiceLineId' - name: billing_provider_id in: query required: false schema: $ref: '#/components/schemas/type_commons_ProviderId' - name: sort in: query description: Defaults to refund_timestamp required: false schema: $ref: '#/components/schemas/type_insurance-refunds_v1_InsuranceRefundSortField' - name: sort_direction in: query description: Sort direction. Defaults to descending order if not provided. required: false schema: $ref: '#/components/schemas/type_commons_SortDirection' - name: page_token in: query required: false schema: $ref: '#/components/schemas/type_commons_PageToken' - 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_insurance-refunds_v1_InsuranceRefundsPage' '403': description: Error response with status 403 content: application/json: schema: type: object properties: errorName: type: string enum: - UnauthorizedError content: $ref: '#/components/schemas/type_commons_UnauthorizedErrorMessage' required: - errorName - content '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 post: operationId: create summary: Create insurance refund description: 'Creates a new insurance refund record and returns the newly created `InsuranceRefund` object. The allocations can describe whether the refund is being applied toward a specific service line, claim, or billing provider.' tags: - v1 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_insurance-refunds_v1_InsuranceRefund' '403': description: Error response with status 403 content: application/json: schema: type: object properties: errorName: type: string enum: - UnauthorizedError content: $ref: '#/components/schemas/type_commons_UnauthorizedErrorMessage' required: - errorName - content '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 '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: $ref: '#/components/schemas/type_insurance-refunds_v1_InsuranceRefundCreate' /api/insurance-refunds/v1/{insurance_refund_id}: get: operationId: get summary: Get insurance refund description: 'Retrieves a previously created insurance refund by its `insurance_refund_id`. If the refund does not exist, a `403` will be thrown.' tags: - v1 parameters: - name: insurance_refund_id in: path required: true schema: $ref: '#/components/schemas/type_insurance-refunds_v1_InsuranceRefundId' - 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_insurance-refunds_v1_InsuranceRefund' '403': description: Error response with status 403 content: application/json: schema: type: object properties: errorName: type: string enum: - UnauthorizedError content: $ref: '#/components/schemas/type_commons_UnauthorizedErrorMessage' required: - errorName - content '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 patch: operationId: update summary: Update description: 'Updates the patient refund record matching the provided insurance_refund_id. If updating the refund amount, then the allocations must be appropriately updated as well.' tags: - v1 parameters: - name: insurance_refund_id in: path required: true schema: $ref: '#/components/schemas/type_insurance-refunds_v1_InsuranceRefundId' - 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_insurance-refunds_v1_InsuranceRefund' '403': description: Error response with status 403 content: application/json: schema: type: object properties: errorName: type: string enum: - UnauthorizedError content: $ref: '#/components/schemas/type_commons_UnauthorizedErrorMessage' required: - errorName - content '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 '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: refund_timestamp: type: string format: date-time refund_note: $ref: '#/components/schemas/type_financials_NoteUpdate' refund_reason: $ref: '#/components/schemas/type_financials_RefundReasonUpdate' delete: operationId: delete summary: Delete insurance refund description: 'Deletes the insurance refund record matching the provided `insurance_refund_id`. If the matching record''s organization_id does not match the authenticated user''s current organization_id, then a response code of `403` will be returned.' tags: - v1 parameters: - name: insurance_refund_id in: path required: true schema: $ref: '#/components/schemas/type_insurance-refunds_v1_InsuranceRefundId' - name: Authorization in: header description: OAuth authentication required: true schema: type: string responses: '200': description: Successful response '403': description: Error response with status 403 content: application/json: schema: type: object properties: errorName: type: string enum: - UnauthorizedError content: $ref: '#/components/schemas/type_commons_UnauthorizedErrorMessage' required: - errorName - content '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 '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 /api/medication-dispense/v1: post: operationId: create summary: Medication Dispense Create tags: - v1 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_encounters_v4_Encounter' '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 '422': description: Error response with status 422 content: application/json: schema: type: object properties: errorName: type: string enum: - InvalidTagNamesError content: $ref: '#/components/schemas/type_encounters_v4_InvalidTagNamesErrorType' required: - errorName - content requestBody: content: application/json: schema: $ref: '#/components/schemas/type_medication-dispense_v1_MedicationDispenseCreate' /api/non-insurance-payer-payments/v1: get: operationId: get_multi summary: Get non-insurance payer payments description: Returns all non-insurance payer payments tags: - v1 parameters: - name: limit in: query description: Defaults to 100. The value must be greater than 0 and less than 1000. required: false schema: type: integer - name: non_insurance_payer_id in: query required: false schema: $ref: '#/components/schemas/type_non-insurance-payers_v1_NonInsurancePayerId' - name: check_number in: query required: false schema: type: string - name: invoice_id in: query required: false schema: $ref: '#/components/schemas/type_commons_InvoiceId' - name: sort in: query description: Defaults to refund_timestamp required: false schema: $ref: '#/components/schemas/type_non-insurance-payer-payments_v1_NonInsurancePayerPaymentSortField' - name: sort_direction in: query description: Sort direction. Defaults to descending order if not provided. required: false schema: $ref: '#/components/schemas/type_commons_SortDirection' - name: page_token in: query required: false schema: $ref: '#/components/schemas/type_commons_PageToken' - 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_non-insurance-payer-payments_v1_NonInsurancePayerPaymentsPage' '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 post: operationId: create summary: Create non-insurance payer payment tags: - v1 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_non-insurance-payer-payments_v1_NonInsurancePayerPayment' '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 '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: $ref: '#/components/schemas/type_non-insurance-payer-payments_v1_NonInsurancePayerPaymentCreate' /api/non-insurance-payer-payments/v1/{non_insurance_payer_payment_id}: get: operationId: get summary: Get non-insurance payer payment description: Retrieves a previously created non-insurance payer payment by its `non_insurance_payer_payment_id`. tags: - v1 parameters: - name: non_insurance_payer_payment_id in: path required: true schema: $ref: '#/components/schemas/type_non-insurance-payer-payments_v1_NonInsurancePayerPaymentId' - 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_non-insurance-payer-payments_v1_NonInsurancePayerPayment' '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 patch: operationId: update summary: Update tags: - v1 parameters: - name: non_insurance_payer_payment_id in: path required: true schema: $ref: '#/components/schemas/type_non-insurance-payer-payments_v1_NonInsurancePayerPaymentId' - 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_non-insurance-payer-payments_v1_NonInsurancePayerPayment' '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 '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: payment_timestamp: type: string format: date-time payment_note: $ref: '#/components/schemas/type_financials_NoteUpdate' invoice_id: $ref: '#/components/schemas/type_financials_InvoiceUpdate' delete: operationId: delete summary: Delete non-insurance payer payment description: Deletes the non-insurance payer payment record matching the provided `non_insurance_payer_payment_id`. tags: - v1 parameters: - name: non_insurance_payer_payment_id in: path required: true schema: $ref: '#/components/schemas/type_non-insurance-payer-payments_v1_NonInsurancePayerPaymentId' - 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 '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 /api/non-insurance-payer-refunds/v1: get: operationId: get_multi summary: Get non-insurance payer refunds refunds description: Returns all non-insurance payer refunds satisfying the search criteria tags: - v1 parameters: - name: limit in: query description: Defaults to 100. The value must be greater than 0 and less than 1000. required: false schema: type: integer - name: non_insurance_payer_id in: query required: false schema: $ref: '#/components/schemas/type_non-insurance-payers_v1_NonInsurancePayerId' - name: check_number in: query required: false schema: type: string - name: invoice_id in: query required: false schema: $ref: '#/components/schemas/type_commons_InvoiceId' - name: sort in: query description: Defaults to refund_timestamp required: false schema: $ref: '#/components/schemas/type_non-insurance-payer-refunds_v1_NonInsurancePayerRefundSortField' - name: sort_direction in: query description: Sort direction. Defaults to descending order if not provided. required: false schema: $ref: '#/components/schemas/type_commons_SortDirection' - name: page_token in: query required: false schema: $ref: '#/components/schemas/type_commons_PageToken' - 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_non-insurance-payer-refunds_v1_NonInsurancePayerRefundsPage' '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 post: operationId: create summary: Create non-insurance payer refund description: 'Creates a new non-insurance payer refund record and returns the newly created `NonInsurancePayerRefund` object. The allocations can describe whether the refund is being applied toward a specific service line, claim, or billing provider.' tags: - v1 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_non-insurance-payer-refunds_v1_NonInsurancePayerRefund' '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 '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: $ref: '#/components/schemas/type_non-insurance-payer-refunds_v1_NonInsurancePayerRefundCreate' /api/non-insurance-payer-refunds/v1/{non_insurance_payer_refund_id}: get: operationId: get summary: Get non-insurance payer refund description: Retrieves a previously created non-insurance payer refund by its `non_insurance_payer_refund_id`. tags: - v1 parameters: - name: non_insurance_payer_refund_id in: path required: true schema: $ref: '#/components/schemas/type_non-insurance-payer-refunds_v1_NonInsurancePayerRefundId' - 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_non-insurance-payer-refunds_v1_NonInsurancePayerRefund' '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 patch: operationId: update summary: Update description: 'Updates the non-insurance payer refund record matching the provided non_insurance_payer_refund_id. If updating the refund amount, then the allocations must be appropriately updated as well.' tags: - v1 parameters: - name: non_insurance_payer_refund_id in: path required: true schema: $ref: '#/components/schemas/type_non-insurance-payer-refunds_v1_NonInsurancePayerRefundId' - 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_non-insurance-payer-refunds_v1_NonInsurancePayerRefund' '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 '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: refund_timestamp: type: string format: date-time refund_note: $ref: '#/components/schemas/type_financials_NoteUpdate' refund_reason: $ref: '#/components/schemas/type_financials_RefundReasonUpdate' invoice_id: $ref: '#/components/schemas/type_financials_InvoiceUpdate' delete: operationId: delete summary: Delete non-insurance payer refund description: Deletes the non-insurance payer refund record matching the provided `non_insurance_payer_refund_id`. tags: - v1 parameters: - name: non_insurance_payer_refund_id in: path required: true schema: $ref: '#/components/schemas/type_non-insurance-payer-refunds_v1_NonInsurancePayerRefundId' - 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 '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 /api/non-insurance-payers/v1: post: operationId: create summary: Create tags: - v1 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_non-insurance-payers_v1_NonInsurancePayer' '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 '409': description: Error response with status 409 content: application/json: schema: type: object properties: errorName: type: string enum: - EntityConflictError content: $ref: '#/components/schemas/type_commons_EntityConflictErrorMessage' required: - errorName - content requestBody: content: application/json: schema: $ref: '#/components/schemas/type_non-insurance-payers_v1_CreateNonInsurancePayerRequest' get: operationId: get_multi summary: Get Multi tags: - v1 parameters: - name: name in: query required: false schema: type: string - name: category in: query description: Fuzzy-match category names of non-insurance payers. required: false schema: type: string - name: categories_exact in: query description: 'Filter by one or more categories by name. When multiple are present, non-insurance payers with any of the specified categories will be matched.' required: false schema: type: string - name: clinical_trial_ids in: query description: 'Filter by one or more clinical trials by their `clinical_trial_id`. When multiple are present, non-insurance payers with any of the specified clinical trials will be matched.' required: false schema: $ref: '#/components/schemas/type_commons_ClinicalTrialId' - name: enabled in: query required: false schema: type: boolean - name: sort in: query required: false schema: $ref: '#/components/schemas/type_non-insurance-payers_v1_NonInsurancePayerSortField' - name: sort_direction in: query required: false schema: $ref: '#/components/schemas/type_commons_SortDirection' - name: limit in: query description: Defaults to 100 required: false schema: type: integer - name: page_token in: query required: false schema: $ref: '#/components/schemas/type_commons_PageToken' - name: organization_id in: query description: Filter to a specific organization's non-insurance payers. If not provided, defaults to the requesting user's organization. required: false schema: $ref: '#/components/schemas/type_commons_OrganizationId' - 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_non-insurance-payers_v1_NonInsurancePayerPage' '403': description: Error response with status 403 content: application/json: schema: type: object properties: errorName: type: string enum: - UnauthorizedError content: $ref: '#/components/schemas/type_commons_UnauthorizedErrorMessage' required: - errorName - content '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 /api/non-insurance-payers/v1/{non_insurance_payer_id}/toggle_enablement: patch: operationId: toggle_enablement summary: Toggle Enablement tags: - v1 parameters: - name: non_insurance_payer_id in: path required: true schema: $ref: '#/components/schemas/type_non-insurance-payers_v1_NonInsurancePayerId' - 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_non-insurance-payers_v1_NonInsurancePayer' '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_non-insurance-payers_v1_ToggleNonInsurancePayerEnablementRequest' /api/non-insurance-payers/v1/categories: get: operationId: getCategories summary: Get non-insurance payer categories description: 'Returns a paginated list of all non-insurance payer categories. Non-insurance payer categories are simply strings and are not stored as a separate object in Candid. They are created when added to at least one non-insurance payer''s `category` field and are deleted when there are no longer any non-insurance payers that contain them.' tags: - v1 parameters: - name: search_term in: query description: Filters categories by fuzzy matching on name. required: false schema: type: string - name: limit in: query description: Limits the maximum number of categories that will be returned. Defaults to 100. required: false schema: type: integer - name: page_token in: query description: The page token to continue paging through a previous request. required: false schema: $ref: '#/components/schemas/type_commons_PageToken' - 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_non-insurance-payers_v1_NonInsurancePayerCategoriesPage' /api/non-insurance-payers/v1/{non_insurance_payer_id}: get: operationId: get summary: Get tags: - v1 parameters: - name: non_insurance_payer_id in: path required: true schema: $ref: '#/components/schemas/type_non-insurance-payers_v1_NonInsurancePayerId' - name: organization_id in: query description: Organization context for cross-org access. If not provided, defaults to the requesting user's organization. required: false schema: $ref: '#/components/schemas/type_commons_OrganizationId' - 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_non-insurance-payers_v1_NonInsurancePayer' '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 patch: operationId: update summary: Update tags: - v1 parameters: - name: non_insurance_payer_id in: path required: true schema: $ref: '#/components/schemas/type_non-insurance-payers_v1_NonInsurancePayerId' - 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_non-insurance-payers_v1_NonInsurancePayer' '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 '409': description: Error response with status 409 content: application/json: schema: type: object properties: errorName: type: string enum: - EntityConflictError content: $ref: '#/components/schemas/type_commons_EntityConflictErrorMessage' required: - errorName - content requestBody: content: application/json: schema: $ref: '#/components/schemas/type_non-insurance-payers_v1_NonInsurancePayerUpdateRequest' delete: operationId: delete summary: Delete tags: - v1 parameters: - name: non_insurance_payer_id in: path required: true schema: $ref: '#/components/schemas/type_non-insurance-payers_v1_NonInsurancePayerId' - 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 /api/payer-plan-groups/v1: get: operationId: getMulti summary: Get payer plans description: Returns all payer plans matching filter criteria. tags: - v1 parameters: - name: plan_group_name in: query required: false schema: type: string - name: payer_uuid in: query required: false schema: $ref: '#/components/schemas/type_payers_v3_PayerUuid' - name: payer_id in: query required: false schema: $ref: '#/components/schemas/type_payers_v3_PayerId' - name: plan_type in: query required: false schema: $ref: '#/components/schemas/type_commons_SourceOfPaymentCode' - name: is_active in: query required: false schema: type: boolean - name: payer_plan_group_id in: query required: false schema: $ref: '#/components/schemas/type_commons_PayerPlanGroupId' - name: limit in: query description: Defaults to 100. Cannot exc required: false schema: type: integer - name: sort_by_similarity in: query description: 'If this property is passed, the results will be ordered by those that contain a payer_id, payer_name, plan_group_name, or payer_address most similar to the value passed. This will take precedence over the sort and sort_direction properties. This will always sort in order of most similar to least similar.' required: false schema: type: string - name: sort in: query description: Defaults to plan_group_name. If sort_by_similarity is passed, that sort will takes precedence over this property. required: false schema: $ref: '#/components/schemas/type_payer-plan-groups_v1_PayerPlanGroupSortField' - name: sort_direction in: query description: Sort direction. Defaults to ascending order if not provided. required: false schema: $ref: '#/components/schemas/type_commons_SortDirection' - name: page_token in: query required: false schema: $ref: '#/components/schemas/type_commons_PageToken' - name: organization_id in: query description: Filter to a specific organization's payer plans. If not provided, defaults to the requesting user's organization. required: false schema: $ref: '#/components/schemas/type_commons_OrganizationId' - 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_payer-plan-groups_v1_PayerPlanGroupPage' '403': description: Error response with status 403 content: application/json: schema: type: object properties: errorName: type: string enum: - UnauthorizedError content: $ref: '#/components/schemas/type_commons_UnauthorizedErrorMessage' required: - errorName - content '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 post: operationId: create summary: Create a payer plan description: Create a payer plan tags: - v1 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_payer-plan-groups_v1_PayerPlanGroup' '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 '422': description: Error response with status 422 content: application/json: schema: type: object properties: errorName: type: string enum: - PayerPlanGroupAlreadyExistsHttpError content: $ref: '#/components/schemas/type_payer-plan-groups_v1_PayerPlanGroupAlreadyExistsError' required: - errorName - content requestBody: content: application/json: schema: $ref: '#/components/schemas/type_payer-plan-groups_v1_MutablePayerPlanGroup' /api/payer-plan-groups/v1/{payer_plan_group_id}: get: operationId: get summary: Get payer plan description: Return a payer plan with a given ID. tags: - v1 parameters: - name: payer_plan_group_id in: path required: true schema: $ref: '#/components/schemas/type_commons_PayerPlanGroupId' - 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_payer-plan-groups_v1_PayerPlanGroup' '403': description: Error response with status 403 content: application/json: schema: type: object properties: errorName: type: string enum: - UnauthorizedError content: $ref: '#/components/schemas/type_commons_UnauthorizedErrorMessage' required: - errorName - content '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 put: operationId: update summary: Update payer plan description: Update any of the fields on a payer plan tags: - v1 parameters: - name: payer_plan_group_id in: path required: true schema: $ref: '#/components/schemas/type_commons_PayerPlanGroupId' - 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_payer-plan-groups_v1_PayerPlanGroup' '403': description: Error response with status 403 content: application/json: schema: type: object properties: errorName: type: string enum: - UnauthorizedError content: $ref: '#/components/schemas/type_commons_UnauthorizedErrorMessage' required: - errorName - content '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 '422': description: Error response with status 422 content: application/json: schema: type: object properties: errorName: type: string enum: - PayerPlanGroupAlreadyExistsHttpError content: $ref: '#/components/schemas/type_payer-plan-groups_v1_PayerPlanGroupAlreadyExistsError' required: - errorName - content requestBody: content: application/json: schema: $ref: '#/components/schemas/type_payer-plan-groups_v1_MutablePayerPlanGroup' patch: operationId: deactivate summary: Delete payer plan description: Marks the payer plan as deactivated tags: - v1 parameters: - name: payer_plan_group_id in: path required: true schema: $ref: '#/components/schemas/type_commons_PayerPlanGroupId' - 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_payer-plan-groups_v1_PayerPlanGroup' '403': description: Error response with status 403 content: application/json: schema: type: object properties: errorName: type: string enum: - UnauthorizedError content: $ref: '#/components/schemas/type_commons_UnauthorizedErrorMessage' required: - errorName - content '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 /api/superbill/v1: post: operationId: create_superbill summary: Create Superbill tags: - v1 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 /api/write-offs/v1: get: operationId: get_multi summary: Get all write-offs description: Returns all write-offs satisfying the search criteria. tags: - v1 parameters: - name: limit in: query description: Defaults to 100. The value must be greater than 0 and less than 1000. required: false schema: type: integer - name: patient_external_id in: query required: false schema: $ref: '#/components/schemas/type_commons_PatientExternalId' - name: payer_uuid in: query required: false schema: $ref: '#/components/schemas/type_payers_v3_PayerUuid' - name: service_line_id in: query required: false schema: $ref: '#/components/schemas/type_commons_ServiceLineId' - name: claim_id in: query required: false schema: $ref: '#/components/schemas/type_commons_ClaimId' - name: billing_provider_id in: query required: false schema: $ref: '#/components/schemas/type_commons_ProviderId' - name: sort in: query description: Defaults to write_off_timestamp required: false schema: $ref: '#/components/schemas/type_write-offs_v1_WriteOffSortField' - name: sort_direction in: query description: Sort direction. Defaults to descending order if not provided. required: false schema: $ref: '#/components/schemas/type_commons_SortDirection' - name: page_token in: query required: false schema: $ref: '#/components/schemas/type_commons_PageToken' - name: account_types in: query description: Filters the returned values to include only the provided account types. required: false schema: $ref: '#/components/schemas/type_financials_AccountType' - 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_write-offs_v1_WriteOffsPage' post: operationId: create summary: Create write-off description: 'Creates one or many write-offs applied toward a specific service line, claim, or billing provider.' tags: - v1 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_write-offs_v1_CreateWriteOffsResponse' requestBody: content: application/json: schema: type: object properties: write_offs: type: array items: $ref: '#/components/schemas/type_write-offs_v1_WriteOffCreate' required: - write_offs /api/write-offs/v1/{write_off_id}: get: operationId: get summary: Get write-off description: Retrieves a previously created write off by its `write_off_id`. tags: - v1 parameters: - name: write_off_id in: path required: true schema: $ref: '#/components/schemas/type_write-offs_v1_WriteOffId' - 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_write-offs_v1_WriteOff' /api/write-offs/v1/{write_off_id}/revert: post: operationId: revert summary: Revert write-off description: Reverts a write off given a `write_off_id`. tags: - v1 parameters: - name: write_off_id in: path required: true schema: $ref: '#/components/schemas/type_write-offs_v1_WriteOffId' - 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_write-offs_v1_WriteOff' /api/write-offs/v1/{adjustment_id}/revert: post: operationId: revert-insurance-balance-adjustment summary: Revert Insurance Balance Adjustment description: Reverts an Insurance Balance Adjustment given an `adjustment_id` tags: - v1 parameters: - name: adjustment_id in: path required: true schema: $ref: '#/components/schemas/type_commons_AdjustmentId' - 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_write-offs_v1_WriteOff' /api/write-offs/v1/{adjustment_id}/revert-era-originated: post: operationId: revert-era-originated-insurance-balance-adjustment summary: Revert ERA-originated Insurance Balance Adjustment description: Reverts an ERA-originated Insurance Balance Adjustment given an `adjustment_id` tags: - v1 parameters: - name: adjustment_id in: path required: true schema: $ref: '#/components/schemas/type_commons_AdjustmentId' - 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_commons_AdjustmentId' components: schemas: type_pre-encounter_tags_v1_MutableTag: type: object properties: value: type: string description: type: string alert: type: boolean required: - value description: An object representing a Tag. title: MutableTag type_pre-encounter_eligibilityChecks_v1_CobSubscriber: type: object properties: first_name: type: string description: The subscriber's first name. last_name: type: string description: The subscriber's last name. date_of_birth: type: string description: The subscriber's date of birth. member_id: type: string description: The member ID for the subscriber's insurance policy. ssn: type: string description: The subscriber's Social Security Number (SSN). required: - first_name - last_name - date_of_birth description: 'The primary policyholder for the insurance plan or a dependent with a unique member ID. You must provide at least one of member_id or ssn.' title: CobSubscriber type_financials_AllocationTarget: oneOf: - type: object properties: type: type: string enum: - service_line description: 'Discriminator value: service_line' service_line_id: $ref: '#/components/schemas/type_commons_ServiceLineId' claim_id: $ref: '#/components/schemas/type_commons_ClaimId' encounter_id: $ref: '#/components/schemas/type_commons_EncounterId' required: - type - service_line_id - claim_id - encounter_id - type: object properties: type: type: string enum: - claim description: 'Discriminator value: claim' claim_id: $ref: '#/components/schemas/type_commons_ClaimId' encounter_id: $ref: '#/components/schemas/type_commons_EncounterId' required: - type - claim_id - encounter_id - type: object properties: type: type: string enum: - billing_provider_id description: 'Discriminator value: billing_provider_id' billing_provider_id: $ref: '#/components/schemas/type_commons_ProviderId' required: - type - billing_provider_id - type: object properties: type: type: string enum: - appointment description: 'Discriminator value: appointment' appointment_id: $ref: '#/components/schemas/type_commons_AppointmentId' patient_external_id: $ref: '#/components/schemas/type_commons_PatientExternalId' required: - type - appointment_id - patient_external_id - type: object properties: type: type: string enum: - unattributed description: 'Discriminator value: unattributed' required: - type discriminator: propertyName: type description: 'Allocation targets describe whether the portion of a payment is being applied toward a specific service line, claim, billing provider, or is unallocated.' title: AllocationTarget type_guarantor_v1_EncounterHasExistingGuarantorErrorType: type: object properties: message: type: string required: - message title: EncounterHasExistingGuarantorErrorType type_financials_InvoiceUpdate: oneOf: - type: object properties: type: type: string enum: - set description: 'Discriminator value: set' value: $ref: '#/components/schemas/type_commons_InvoiceId' required: - type - value - type: object properties: type: type: string enum: - remove description: 'Discriminator value: remove' required: - type discriminator: propertyName: type title: InvoiceUpdate type_service-facility_EncounterServiceFacilityUpdateWithOptionalAddress: type: object properties: organization_name: type: string npi: type: string description: 'An NPI specific to the service facility if applicable, i.e. if it has one and is not under the billing provider''s NPI. Box 32 section (a) of the CMS-1500 claim form.' address: $ref: '#/components/schemas/type_commons_StreetAddressShortZipOptional' description: zip_plus_four_code is required for service facility address. When the zip_plus_four_code is not available use "9998" as per CMS documentation. secondary_identification: type: string description: 'An additional identifier for the service facility other than the facility''s NPI. Some payers may require this field. Potential examples: state license number, provider commercial number, or location number. Box 32 section (b) of the CMS-1500 claim form.' mammography_certification_number: type: string description: The associated mammography certification number for this service facility. This is a 6 digit code assigned by the FDA. title: EncounterServiceFacilityUpdateWithOptionalAddress type_guarantor_v1_GuarantorId: type: string format: uuid title: GuarantorId type_pre-encounter_patients_v1_EligibilityAuditEventType: type: string enum: - APPOINTMENT_STATUS_CHANGED - APPOINTMENT_WORK_QUEUE_CHANGED - APPOINTMENT_COPAY_UPDATED - COVERAGE_CREATED - COVERAGE_UPDATED - ELIG_CHECK_COMPLETED title: EligibilityAuditEventType type_non-insurance-payer-payments_v1_NonInsurancePayerPaymentId: type: string format: uuid title: NonInsurancePayerPaymentId type_pre-encounter_appointments_v1_Service: type: object properties: universal_service_identifier: $ref: '#/components/schemas/type_pre-encounter_appointments_v1_UniversalServiceIdentifier' description: Contains the code describing the activity type that is being scheduled. start_timestamp: type: string format: date-time title: Service type_x12_v1_TypeOfBillComposite: type: object properties: type_of_facility: $ref: '#/components/schemas/type_x12_v1_TypeOfFacilityCode' description: The FL04 Institutional type of facility code for the bill. The second digit of the composite code. type_of_care: $ref: '#/components/schemas/type_x12_v1_TypeOfCareCode' description: The FL04 Institutional type of care code for the bill. The third digit of the composite code. frequency_code: $ref: '#/components/schemas/type_x12_v1_TypeOfBillFrequencyCode' description: The FL04 Institutional frequency code for the bill. The fourth digit of the composite code. code: type: string description: The composite, 4 digit code of the composite, starting with a padding code 0. required: - type_of_facility - type_of_care - frequency_code - code title: TypeOfBillComposite type_non-insurance-payer-refunds_v1_NonInsurancePayerRefundSortField: type: string enum: - amount_cents - refund_timestamp title: NonInsurancePayerRefundSortField type_financials_RefundReason: type: string enum: - OVERCHARGED - ENTERED_IN_ERROR - TRANSFER title: RefundReason type_pre-encounter_common_ExternalIdentifier: type: object properties: value: type: string system: type: string period: $ref: '#/components/schemas/type_pre-encounter_common_Period' required: - value - system description: An external identifier for a patient title: ExternalIdentifier 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_encounters_v4_EncounterSubmissionOriginType: type: string enum: - CANDID - EXTERNAL title: EncounterSubmissionOriginType type_encounters_v4_Vitals: type: object properties: height_in: type: integer weight_lbs: type: integer blood_pressure_systolic_mmhg: type: integer blood_pressure_diastolic_mmhg: type: integer body_temperature_f: type: number format: double hemoglobin_gdl: type: number format: double hematocrit_pct: type: number format: double title: Vitals type_insurance-adjudications_v1_ServiceLineAdjudicationId: type: string format: uuid title: ServiceLineAdjudicationId type_pre-encounter_patients_v1_AuthorizationUnit: type: string enum: - VISIT - UNIT title: AuthorizationUnit type_pre-encounter_coverages_v1_MutableCoverage: type: object properties: status: $ref: '#/components/schemas/type_pre-encounter_coverages_v1_CoverageStatus' description: The status indiciating if the coverage is active or not. subscriber: $ref: '#/components/schemas/type_pre-encounter_coverages_v1_Subscriber' description: The party who has signed-up for or 'owns' the contractual relationship to the policy or to whom the benefit of the policy for services rendered to them or their family is due. relationship: $ref: '#/components/schemas/type_pre-encounter_common_Relationship' description: The relationship of beneficiary (patient) to the subscriber. https://hl7.org/fhir/valueset-relationship.html patient: $ref: '#/components/schemas/type_pre-encounter_common_PatientId' description: The canonical Candid patient UUID corresponding with the patient who benefits from the insurance coverage insurance_plan: $ref: '#/components/schemas/type_pre-encounter_coverages_v1_InsurancePlan' verified: type: boolean description: A boolean indicating if the coverage has been verified by a user. eligibility_checks: type: array items: $ref: '#/components/schemas/type_pre-encounter_eligibilityChecks_v1_EligibilityCheckMetadata' description: A list of eligibility check metadata that have been initiated on this coverage. latest_eligibility_check: $ref: '#/components/schemas/type_pre-encounter_coverages_v1_LatestEligibilityCheck' description: The latest eligibility check metadata that has been initiated on this coverage. benefits: $ref: '#/components/schemas/type_pre-encounter_coverages_v1_CoverageBenefits' description: The eligibility of the patient for the coverage, manually verified by users. orcon: type: boolean description: ORCON (Originator Controlled) - When set to true, the Candid system will hide this coverage from downstream integrations. Updates made in the Candid UI will unset this flag. Defaults to false. auto_update_enabled: type: boolean description: Default to true. When set to true, the Candid system will automatically update this coverage with the latest eligibility check benefits information. Auto update behavior is also set at the eligibilityConfig org level configuration. previous_appointment_copays: type: object additionalProperties: type: integer description: A map of UniversalServiceIdentifier (MD_Visit, Treatment, Tests, Activity) to copay values in cents. This is used to track copay values for each service type to handle OOP max resets correctly. required: - status - subscriber - relationship - patient - insurance_plan - verified title: MutableCoverage type_encounters_v4_NoteCategory: type: string enum: - clinical - care_plan - diagnoses - vitals - physical_exam - review_of_systems - medical_decisions - history_of_present_illness - patient_info - chief_complaint - health_record - consent - procedure - time_in_appointment title: NoteCategory type_pre-encounter_coverages_v1_CoverageBenefits: type: object properties: plan_coverage: $ref: '#/components/schemas/type_pre-encounter_coverages_v1_PlanCoverage' service_specific_coverage: type: array items: $ref: '#/components/schemas/type_pre-encounter_coverages_v1_ServiceCoverage' benefits_related_entities: type: array items: $ref: '#/components/schemas/type_pre-encounter_coverages_v1_BenefitsRelatedEntity' non_covered_details: type: array items: $ref: '#/components/schemas/type_pre-encounter_coverages_v1_NonCoveredDetail' notes: type: string autoUpdatedEligibilityCheckId: type: string title: CoverageBenefits type_property-and-casualty_v1_PropertyCasualtyPatientIdentifier: type: object properties: property_casualty_patient_identifier_qualifier: $ref: '#/components/schemas/type_property-and-casualty_v1_PropertyCasualtyPatientIdentifierQualifier' description: 'Represents REF01 on the EDI 837 Loop 2010CA Property and Casualty Patient Identifier segment. Valid values include 1W (Member Identification Number) and SY (Social Security Number).' property_casualty_patient_identifier: type: string description: Represents REF02 on the EDI 837 Loop 2010CA Property and Casualty Patient Identifier segment. Value cannot exceed 50 characters required: - property_casualty_patient_identifier_qualifier - property_casualty_patient_identifier title: PropertyCasualtyPatientIdentifier type_x12_v1_TypeOfFacilityCode: type: string enum: - '1' - '2' - '3' - '4' - '6' - '7' - '8' title: TypeOfFacilityCode type_insurance-refunds_v1_InsuranceRefundSortField: type: string enum: - amount_cents - refund_timestamp - refund_note - refund_reason title: InsuranceRefundSortField type_encounters_v4_PatientHistoryCategoryOptional: type: object properties: category: $ref: '#/components/schemas/type_encounters_v4_PatientHistoryCategoryEnum' questions: type: array items: $ref: '#/components/schemas/type_encounters_v4_IntakeQuestionOptional' description: Must contain at least one item. title: PatientHistoryCategoryOptional type_commons_AppointmentId: type: string title: AppointmentId type_encounters_v4_ClaimSupplementalInformation: type: object properties: attachment_report_type_code: $ref: '#/components/schemas/type_commons_ReportTypeCode' attachment_transmission_code: $ref: '#/components/schemas/type_commons_ReportTransmissionCode' attachment_control_number: type: string required: - attachment_report_type_code - attachment_transmission_code title: ClaimSupplementalInformation type_non-insurance-payer-payments_v1_NonInsurancePayerPayment: type: object properties: non_insurance_payer_payment_id: $ref: '#/components/schemas/type_non-insurance-payer-payments_v1_NonInsurancePayerPaymentId' non_insurance_payer: $ref: '#/components/schemas/type_non-insurance-payers_v1_NonInsurancePayer' amount_cents: type: integer check_number: type: string payment_timestamp: type: string format: date-time payment_note: type: string allocations: type: array items: $ref: '#/components/schemas/type_financials_Allocation' invoice_id: $ref: '#/components/schemas/type_commons_InvoiceId' required: - non_insurance_payer_payment_id - non_insurance_payer - amount_cents - allocations title: NonInsurancePayerPayment type_pre-encounter_organizationExternalProviders_v1_OrganizationExternalProviderId: type: string format: uuid description: The unique identifier for an OrganizationExternalProvider in the database title: OrganizationExternalProviderId type_property-and-casualty_v1_PropertyCasualtyPatientIdentifierCreateOptional: type: object properties: property_casualty_patient_identifier_qualifier: $ref: '#/components/schemas/type_property-and-casualty_v1_PropertyCasualtyPatientIdentifierQualifier' description: 'Represents REF01 on the EDI 837 Loop 2010CA Property and Casualty Patient Identifier segment. Valid values include 1W (Member Identification Number) and SY (Social Security Number).' property_casualty_patient_identifier: type: string description: Represents REF02 on the EDI 837 Loop 2010CA Property and Casualty Patient Identifier segment. Value cannot exceed 50 characters title: PropertyCasualtyPatientIdentifierCreateOptional type_pre-encounter_common_CoverageId: type: string format: uuid description: The unique identifier for a Coverage in the database title: CoverageId type_commons_ProcedureModifier: type: string enum: - AV - AU - AW - AY - '07' - 08 - 09 - '10' - '11' - '12' - '13' - '14' - '15' - '16' - '22' - '23' - '24' - '25' - '26' - '27' - '28' - '32' - '33' - '47' - '50' - '51' - '52' - '53' - '54' - '55' - '56' - '57' - '58' - '59' - '62' - '63' - '66' - '73' - '74' - '76' - '77' - '78' - '79' - '80' - '81' - '82' - '90' - '91' - '92' - '93' - '95' - '96' - '97' - '99' - A1 - A2 - A3 - A4 - A5 - A6 - A7 - A8 - A9 - AA - AB - AD - AE - AF - AG - AH - AI - AJ - AK - AM - AO - AP - AQ - AR - AS - AT - AZ - BA - BL - BO - BP - BR - BU - CA - CB - CC - CD - CE - CF - CG - CH - CI - CJ - CK - CL - CM - CN - CR - CS - CT - CO - CQ - DA - E1 - E2 - E3 - E4 - EA - EB - EC - ED - EE - EJ - EM - EP - ER - ET - EV - EX - EY - F1 - F2 - F3 - F4 - F5 - F6 - F7 - F8 - F9 - FA - FB - FC - FP - FQ - FR - FS - FT - FX - FY - G0 - G1 - G2 - G3 - G4 - G5 - G6 - G7 - G8 - G9 - GA - GB - GC - GE - GF - GG - GH - GJ - GK - GL - GM - GN - GO - GP - GQ - GR - GS - GT - GU - GV - GW - GX - GY - GZ - HA - HB - HC - HD - HE - HF - HG - HH - HI - HJ - HK - HL - HM - HN - HO - HP - HQ - HR - HS - HT - HU - HV - HW - HX - HY - HZ - J1 - J2 - J3 - J4 - J5 - JA - JB - JC - JD - JE - JG - JW - JZ - K0 - K1 - K2 - K3 - K4 - KA - KB - KC - KD - KE - KF - KG - KH - KI - KJ - KK - KL - KM - KN - KO - KP - KQ - KR - KS - KT - KU - KV - KW - KX - KY - KZ - LC - LD - LL - LM - LR - LS - LT - LU - M2 - MA - MB - MC - MD - ME - MF - MG - MH - MS - N1 - N2 - N3 - NB - NR - NU - P1 - P2 - P3 - P4 - P5 - P6 - PA - PB - PC - PD - PI - PL - PM - PN - PO - PS - PT - Q0 - Q1 - Q2 - Q3 - Q4 - Q5 - Q6 - Q7 - Q8 - Q9 - QA - QB - QC - QD - QE - QF - QG - QH - QJ - QK - QL - QM - QN - QP - QQ - QR - QS - QT - QW - QX - QY - QZ - RA - RB - RC - RD - RE - RI - RR - RT - SA - SB - SC - SD - SE - SF - SG - SH - SJ - SL - SM - SN - SQ - SS - ST - SU - SV - SW - SY - T1 - T2 - T3 - T4 - T5 - T6 - T7 - T8 - T9 - TA - TB - TC - TD - TE - TF - TG - TH - TJ - TK - TL - TM - TN - TP - TQ - TR - TS - TT - TU - TV - TW - U1 - U2 - U3 - U4 - U5 - U6 - U7 - U8 - U9 - UA - UB - UC - UD - UE - UF - UG - UH - UJ - UK - UN - UP - UQ - UR - US - V1 - V2 - V3 - W1 - W2 - W3 - X4 - XE - XP - XS - XU - XY - ZZ title: ProcedureModifier type_payer-plan-groups_v1_PayerPlanGroupAlreadyExistsError: type: object properties: message: type: string id: $ref: '#/components/schemas/type_commons_PayerPlanGroupId' required: - message - id title: PayerPlanGroupAlreadyExistsError type_encounter-providers_v2_OrderingProviderOptional: type: object properties: first_name: type: string description: If the provider is an individual, this should be set instead of organization name last_name: type: string description: If the provider is an individual, this should be set instead of organization name organization_name: type: string description: If the provider is an organization, this should be set instead of first + last name npi: type: string description: 'A National Provider Identifier is a unique 10-digit identification number issued to health care providers in the United States' taxonomy_code: type: string address: $ref: '#/components/schemas/type_commons_StreetAddressLongZipOptional' title: OrderingProviderOptional type_health-care-code-information_v1_ICDCode: type: string title: ICDCode type_pre-encounter_eligibilityChecks_v1_StediPayer: type: object properties: stedi_id: type: string display_name: type: string primary_payer_id: type: string aliases: type: array items: type: string names: type: array items: type: string transaction_support: description: Any type employer_identification_numbers: type: array items: type: string payer_enrollment: description: Any type parent_payer_group: type: string coverage_types: type: array items: type: string required: - stedi_id - display_name - primary_payer_id - aliases - names - transaction_support title: StediPayer type_pre-encounter_eligibilityChecks_v1_EligibilityRecommendation: type: object properties: organization_id: $ref: '#/components/schemas/type_pre-encounter_common_OrganizationId' description: The organization that owns this object. deactivated: type: boolean description: True if the object is deactivated. Deactivated objects are not returned in search results but are returned in all other endpoints including scan. version: type: integer description: The version of the object. Any update to any property of an object object will create a new version. updated_at: type: string format: date-time updating_user_id: $ref: '#/components/schemas/type_pre-encounter_common_UserId' description: The user ID of the user who last updated the object. id: type: string description: The unique UUID identifier for an EligibilityRecommendation. eligibility_check_id: type: string recommendation: $ref: '#/components/schemas/type_pre-encounter_eligibilityChecks_v1_EligibilityRecommendationPayload' coverage_id: $ref: '#/components/schemas/type_pre-encounter_common_CoverageId' patient: $ref: '#/components/schemas/type_pre-encounter_eligibilityChecks_v1_EligibilityRecommendationPatientInfo' votes: type: array items: $ref: '#/components/schemas/type_pre-encounter_eligibilityChecks_v1_Vote' description: Array of votes for this recommendation required: - organization_id - deactivated - version - updated_at - updating_user_id - id - eligibility_check_id - recommendation - patient description: An eligibility recommendation object that contains an EligibilityRecommendationType and a payload of data denoting the recommendation. title: EligibilityRecommendation type_pre-encounter_coverages_v1_Subscriber: type: object properties: name: $ref: '#/components/schemas/type_pre-encounter_common_HumanName' date_of_birth: type: string format: date biological_sex: $ref: '#/components/schemas/type_pre-encounter_common_Sex' address: $ref: '#/components/schemas/type_pre-encounter_common_Address' employer_name: type: string required: - name - biological_sex title: Subscriber type_commons_DateRangeOptionalEnd: type: object properties: start_date: $ref: '#/components/schemas/type_commons_Date' end_date: $ref: '#/components/schemas/type_commons_Date' required: - start_date title: DateRangeOptionalEnd type_health-care-code-information_v1_PatientReasonForVisitCodeQualifier: type: string enum: - PR - APR title: PatientReasonForVisitCodeQualifier type_pre-encounter_eligibilityChecks_v1_PayerSearchResponse: type: object properties: next_page_token: $ref: '#/components/schemas/type_pre-encounter_common_PageToken' prev_page_token: $ref: '#/components/schemas/type_pre-encounter_common_PageToken' total: type: integer items: type: array items: $ref: '#/components/schemas/type_pre-encounter_eligibilityChecks_v1_StediPayerItem' stats: description: Any type required: - total - items - stats title: PayerSearchResponse type_pre-encounter_common_ContactPointUse: type: string enum: - HOME - WORK - TEMP - OLD - MOBILE title: ContactPointUse type_pre-encounter_images_v1_Image: type: object properties: organization_id: $ref: '#/components/schemas/type_pre-encounter_common_OrganizationId' description: The organization that owns this object. deactivated: type: boolean description: True if the object is deactivated. Deactivated objects are not returned in search results but are returned in all other endpoints including scan. version: type: integer description: The version of the object. Any update to any property of an object object will create a new version. updated_at: type: string format: date-time updating_user_id: $ref: '#/components/schemas/type_pre-encounter_common_UserId' description: The user ID of the user who last updated the object. file_name: type: string display_name: type: string file_type: type: string status: $ref: '#/components/schemas/type_pre-encounter_images_v1_ImageStatus' coverage: $ref: '#/components/schemas/type_pre-encounter_images_v1_CoverageAssociation' patient: $ref: '#/components/schemas/type_pre-encounter_images_v1_PatientAssociation' id: $ref: '#/components/schemas/type_pre-encounter_images_v1_ImageId' signed_url: type: string description: A signed URL to the image. This url can be used to upload an image to GCP storage or to read the image contents. required: - organization_id - deactivated - version - updated_at - updating_user_id - file_name - display_name - file_type - status - id - signed_url description: An Image object with immutable server-owned properties. title: Image type_commons_EmrPayerCrosswalk: type: string enum: - HEALTHIE - CANVAS - WAYSTAR - PAYER_PLAN_GROUP title: EmrPayerCrosswalk type_health-care-code-information_v1_OtherDiagnosisInformation: type: object properties: id: type: string format: uuid description: 'The id of this health care code information if it is already stored. If this is not set, this is referring to a new health care code information to be added to the encounter. If it is set, this refers to an update of an existing health care code information object on the encounter.' encounter_id: $ref: '#/components/schemas/type_commons_EncounterId' description: 'The encounter_id of this health care code information if it is already stored. This will be set by the server in responses, but clients are not expected to set it.' other_diagnosis_code_qualifier: $ref: '#/components/schemas/type_health-care-code-information_v1_OtherDiagnosisInformationCodeQualifier' other_diagnosis: $ref: '#/components/schemas/type_health-care-code-information_v1_ICDCode' present_on_admission_indicator: $ref: '#/components/schemas/type_health-care-code-information_v1_PresentOnAdmissionIndicatorCode' required: - other_diagnosis_code_qualifier - other_diagnosis description: This corresponds to BF and ABF code qualifier values. title: OtherDiagnosisInformation type_pre-encounter_eligibilityChecks_v1_CoordinationOfBenefitsResponse: type: object properties: provider: $ref: '#/components/schemas/type_pre-encounter_eligibilityChecks_v1_CobResponseProvider' description: Information about the provider who submitted the COB request. subscriber: $ref: '#/components/schemas/type_pre-encounter_eligibilityChecks_v1_CobResponseSubscriber' description: Information about the primary policyholder. dependent: $ref: '#/components/schemas/type_pre-encounter_eligibilityChecks_v1_CobResponseDependent' description: Information about the dependent listed in the COB request. payer: $ref: '#/components/schemas/type_pre-encounter_eligibilityChecks_v1_CobPayer' description: Information about the payer listed in the COB request. plan_date_information: $ref: '#/components/schemas/type_pre-encounter_eligibilityChecks_v1_CobPlanDateInformation' description: Date information for the plan. benefits_information: type: array items: description: Any type description: Raw passthrough of Stedi's benefits information (coverage, service types, related entities, etc.). errors: type: array items: $ref: '#/components/schemas/type_pre-encounter_eligibilityChecks_v1_EligibilityCheckErrorDetails' coordination_of_benefits: $ref: '#/components/schemas/type_pre-encounter_eligibilityChecks_v1_Cob' description: Overview of the COB response including whether coverage overlap exists and payer primacy. description: An object representing the data for a coordination of benefits response. title: CoordinationOfBenefitsResponse type_write-offs_v1_WriteOffSortField: type: string enum: - amount_cents - write_off_timestamp - write_off_note title: WriteOffSortField type_patient-ar_v1_InvalidFiltersErrorType: type: object properties: message: type: string required: - message title: InvalidFiltersErrorType type_health-care-code-information_v1_OtherProcedureInformationCodeQualifier: type: string enum: - BBQ - BQ title: OtherProcedureInformationCodeQualifier type_invoices_v2_InvoiceDestination: type: string enum: - STRIPE - CEDAR - HEALTHIE - COLLECTLY - THIRD_PARTY_PAYERS - INSTAMED - REVSPRING title: InvoiceDestination type_charge-capture_v1_ChargeCaptureData: type: object properties: benefits_assigned_to_provider: type: boolean description: Whether this patient has authorized insurance payments to be made to you, not them. If false, patient may receive reimbursement. Box 13 on the CMS-1500 claim form or Form Locator 53 on a UB-04 claim form. prior_authorization_number: $ref: '#/components/schemas/type_encounters_v4_PriorAuthorizationNumber' description: Box 23 on the CMS-1500 claim form or Form Locator 63 on a UB-04 claim form. external_id: $ref: '#/components/schemas/type_commons_EncounterExternalId' description: 'A client-specified unique ID to associate with this encounter; for example, your internal encounter ID or a Dr. Chrono encounter ID. This field should not contain PHI.' date_of_service: type: string format: date description: 'Date formatted as YYYY-MM-DD; eg: 2019-08-24. This date must be the local date in the timezone where the service occurred. Box 24a on the CMS-1500 claim form or Form Locator 45 on the UB-04 claim form. If service occurred over a range of dates, this should be the start date. If service lines have distinct date_of_service values, updating the encounter''s date_of_service will fail. If all service line date_of_service values are the same, updating the encounter''s date_of_service will update all service line date_of_service values.' tag_ids: type: array items: $ref: '#/components/schemas/type_tags_TagId' description: Names of tags that should be on the encounter. Note all tags on encounter will be overridden with this list. billable_status: $ref: '#/components/schemas/type_encounters_v4_BillableStatusType' description: Defines if the Encounter is to be billed by Candid to the responsible_party. Examples for when this should be set to NOT_BILLABLE include if the Encounter has not occurred yet or if there is no intention of ever billing the responsible_party. responsible_party: $ref: '#/components/schemas/type_encounters_v4_ResponsiblePartyType' description: Defines the party to be billed with the initial balance owed on the claim. Use SELF_PAY if you intend to bill self pay/cash pay. provider_accepts_assignment: type: boolean description: Whether you have accepted the patient's authorization for insurance payments to be made to you, not them. Box 27 on the CMS-1500 claim form. There is no exact equivalent of this field on a UB-04 claim, however contributes to the concept of Form Locator 53. synchronicity: $ref: '#/components/schemas/type_encounters_v4_SynchronicityType' description: Whether or not this was a synchronous or asynchronous encounter. Asynchronous encounters occur when providers and patients communicate online using forms, instant messaging, or other pre-recorded digital mediums. Synchronous encounters occur in live, real-time settings where the patient interacts directly with the provider, such as over video or a phone call. place_of_service_code: $ref: '#/components/schemas/type_commons_FacilityTypeCode' description: Box 24B on the CMS-1500 claim form. 837p Loop2300, CLM-05-1. 02 for telemedicine, 11 for in-person. Full list [here](https://www.cms.gov/Medicare/Coding/place-of-service-codes/Place_of_Service_Code_Set). appointment_type: type: string description: 'Human-readable description of the appointment type (ex: "Acupuncture - Headaches").' end_date_of_service: type: string format: date description: 'Date formatted as YYYY-MM-DD; eg: 2019-08-25. This date must be the local date in the timezone where the service occurred. If omitted, the Encounter is assumed to be for a single day. Must not be temporally before the date_of_service field. If service lines have distinct end_date_of_service values, updating the encounter''s end_date_of_service will fail. If all service line end_date_of_service values are the same, updating the encounter''s end_date_of_service will update all service line date_of_service values.' additional_information: type: string description: 'Defines additional information on the claim needed by the payer. Box 19 on the CMS-1500 claim form or Form Locator 80 on a UB-04 claim form.' service_authorization_exception_code: $ref: '#/components/schemas/type_encounters_v4_ServiceAuthorizationExceptionCode' description: '837p Loop2300 REF*4N Required when mandated by government law or regulation to obtain authorization for specific service(s) but, for the reasons listed in one of the enum values of ServiceAuthorizationExceptionCode, the service was performed without obtaining the authorization.' admission_date: type: string format: date description: '837p Loop2300 DTP*435, CMS-1500 Box 18 or UB-04 Form Locator 12. Required on all ambulance claims when the patient was known to be admitted to the hospital. OR Required on all claims involving inpatient medical visits.' discharge_date: type: string format: date description: 837p Loop2300 DTP*096, CMS-1500 Box 18 Required for inpatient claims when the patient was discharged from the facility and the discharge date is known. Not used on an institutional claim. onset_of_current_illness_or_symptom_date: type: string format: date description: "837p Loop2300 DTP*431, CMS-1500 Box 14\nRequired for the initial medical service or visit performed in response to a medical emergency when the date is available and is different than the date of service.\nOR\nThis date is the onset of acute symptoms for the current illness or condition.\n For UB-04 claims, this is populated separately via occurrence codes." last_menstrual_period_date: type: string format: date description: '837p Loop2300 DTP*484, CMS-1500 Box 14 Required when, in the judgment of the provider, the services on this claim are related to the patient''s pregnancy.de This field is populated separately via occurrence codes for UB-04 claim forms.' delay_reason_code: $ref: '#/components/schemas/type_commons_DelayReasonCode' description: 'Code indicating the reason why a claim submission was delayed. Corresponds to CLM-20 in the 837 specification (both professional and institutional).' patient_authorized_release: type: boolean description: 'Whether this patient has authorized the release of medical information for billing purpose. Box 12 on the CMS-1500 claim form or Form Locator 52 on a UB-04 claim form.' referral_number: type: string description: Refers to REF*9F on the 837p. Value cannot be greater than 50 characters. secondary_payer_carrier_code: type: string description: When Medicaid is billed as the secondary payer the Carrier Code is used to identify the primary payer. This is required for certain states. vitals: $ref: '#/components/schemas/type_encounters_v4_VitalsUpdate' description: 'If a vitals entity already exists for the encounter, then all values will be updated to the provided values. Otherwise, a new vitals object will be created for the encounter.' diagnoses: type: array items: $ref: '#/components/schemas/type_diagnoses_DiagnosisCreateOptional' description: 'Ideally, this field should contain no more than 12 diagnoses. However, more diagnoses may be submitted at this time, and coders will later prioritize the 12 that will be submitted to the payor.' clinical_notes: type: array items: $ref: '#/components/schemas/type_encounters_v4_ClinicalNoteCategoryCreateOptional' description: Holds a collection of clinical observations made by healthcare providers during patient encounters. Please note that medical records for appeals should be sent using the Encounter Attachments API. claim_supplemental_information: type: array items: $ref: '#/components/schemas/type_encounters_v4_ClaimSupplementalInformationOptional' description: Refers to Loop 2300 - Segment PWK on the 837P and 837i form. No more than 10 entries are permitted. epsdt_referral: $ref: '#/components/schemas/type_encounters_v4_EPSDTReferralOptional' description: Refers to Box 24H on the CMS1500 form and Loop 2300 CRC - EPSDT Referral on the 837P and 837i form existing_medications: type: array items: $ref: '#/components/schemas/type_encounters_v4_MedicationOptional' description: 'Existing medications that should be on the encounter. Note all current existing medications on encounter will be overridden with this list.' guarantor: $ref: '#/components/schemas/type_guarantor_v1_GuarantorOptional' description: Personal and contact info for the guarantor of the patient responsibility. subscriber_primary: $ref: '#/components/schemas/type_individual_SubscriberCreateOptional' description: Contains details of the primary insurance subscriber. subscriber_secondary: $ref: '#/components/schemas/type_individual_SubscriberCreateOptional' description: Contains details of the secondary insurance subscriber. subscriber_tertiary: $ref: '#/components/schemas/type_individual_SubscriberCreateOptional' description: Contains details of the tertiary insurance subscriber. interventions: type: array items: $ref: '#/components/schemas/type_encounters_v4_InterventionOptional' schema_instances: type: array items: $ref: '#/components/schemas/type_custom-schemas_v1_SchemaInstanceOptional' description: 'Key-value pairs that must adhere to a schema created via the Custom Schema API. Multiple schema instances cannot be created for the same schema on an encounter. Updating schema instances utilizes PUT semantics, so the schema instances on the encounter will be set to whatever inputs are provided. If null is provided as an input, then the encounter''s schema instances will be cleared.' external_claim_submission: $ref: '#/components/schemas/type_claim-submission_v1_ExternalClaimSubmissionCreateOptional' description: '***This field is in beta.*** To be included for claims that have been submitted outside of Candid. Candid supports posting remits and payments to these claims and working them in-platform (e.g. editing, resubmitting).' service_lines: type: array items: $ref: '#/components/schemas/type_service-lines_v2_ServiceLineCreateOptional' description: 'Each service line must be linked to a diagnosis. Concretely, `service_line.diagnosis_pointers`must contain at least one entry which should be in bounds of the diagnoses list field.' patient_histories: type: array items: $ref: '#/components/schemas/type_encounters_v4_PatientHistoryCategoryOptional' billing_notes: type: array items: $ref: '#/components/schemas/type_billing-notes_v2_BillingNoteBaseOptional' description: 'Spot to store misc, human-readable, notes about this encounter to be used in the billing process.' patient: $ref: '#/components/schemas/type_individual_PatientUpdateWithOptionalAddress' description: Contains the identification information of the individual receiving medical services. service_facility: $ref: '#/components/schemas/type_service-facility_EncounterServiceFacilityUpdateWithOptionalAddress' description: Encounter Service facility is typically the location a medical service was rendered, such as a provider office or hospital. For telehealth, service facility can represent the provider's location when the service was delivered (e.g., home), or the location where an in-person visit would have taken place, whichever is easier to identify. If the provider is in-network, service facility may be defined in payer contracts. Box 32 on the CMS-1500 claim form. There is no equivalent on the paper UB-04 claim form, but this field is equivalent to Loop 2310E Service Facility Location details on an 837i form, and is used when this is different to the entity identified as the Billing Provider. Note that for an in-network claim to be successfully adjudicated, the service facility address listed service_facility_id: $ref: '#/components/schemas/type_organization-service-facilities_v2_OrganizationServiceFacilityId' description: The ID of an existing Organization Service Facility to use for this encounter. The service facility's canonical data (name, address, NPI, etc.) will be populated automatically. If the value does not match an existing Organization Service Facility, the request will fail with a 422 error. This field is mutually exclusive with service_facility — providing both will result in a 422 error. rendering_provider: $ref: '#/components/schemas/type_encounter-providers_v2_RenderingProviderUpdateWithOptionalAddress' description: The rendering provider is the practitioner -- physician, nurse practitioner, etc. -- performing the service. For telehealth services, the rendering provider performs the visit, asynchronous communication, or other service. The rendering provider address should generally be the same as the service facility address. initial_referring_provider: $ref: '#/components/schemas/type_encounter-providers_v2_InitialReferringProviderUpdateWithOptionalAddress' description: 'The second iteration of Loop ID-2310. Use code "P3 - Primary Care Provider" in this loop to indicate the initial referral from the primary care provider or whatever provider wrote the initial referral for this patient''s episode of care being billed/reported in this transaction.' referring_provider: $ref: '#/components/schemas/type_encounter-providers_v2_ReferringProviderUpdateWithOptionalAddress' description: 'The final provider who referred the services that were rendered. All physicians who order services or refer Medicare beneficiaries must report this data.' supervising_provider: $ref: '#/components/schemas/type_encounter-providers_v2_SupervisingProviderUpdateWithOptionalAddress' description: Required when the rendering provider is supervised by a physician. If not required by this implementation guide, do not send. treating_provider: $ref: '#/components/schemas/type_encounter-providers_v2_TreatingProviderUpdateWithOptionalAddress' description: The treating provider is the provider who treats the patient. This is supported for professional and institutional encounters. billing_provider: $ref: '#/components/schemas/type_encounter-providers_v2_BillingProviderUpdateWithOptionalAddress' description: The billing provider is the provider or business entity submitting the claim. Billing provider may be, but is not necessarily, the same person/NPI as the rendering provider. From a payer's perspective, this represents the person or entity being reimbursed. When a contract exists with the target payer, the billing provider should be the entity contracted with the payer. In some circumstances, this will be an individual provider. In that case, submit that provider's NPI and the tax ID (TIN) that the provider gave to the payer during contracting. In other cases, the billing entity will be a medical group. If so, submit the group NPI and the group's tax ID. Box 33 on the CMS-1500 claim form or Form Locator 1 on a UB-04 claim form. pay_to_address: $ref: '#/components/schemas/type_commons_StreetAddressShortZipOptional' description: Specifies the address to which payments for the claim should be sent. related_causes_information: $ref: '#/components/schemas/type_related-causes_v1_RelatedCausesInformationCreateOptional' description: Corresponds to box 10a on the CMS-1500 (Loop 2300 on 837) property_casualty_claim_number: type: string description: 837p Loop2010 REF02, CMS1500 Box 11b accident_date: type: string format: date description: 837p Loop2300 DTP*439, CMS1500 Box 15 property_casualty_patient_identifier: $ref: '#/components/schemas/type_property-and-casualty_v1_PropertyCasualtyPatientIdentifierCreateOptional' description: 'Patient identifier for Property and Casualty claims. 837p Loop2010CA' title: ChargeCaptureData type_pre-encounter_eligibilityChecks_v1_EligibilityRecommendationPayload: oneOf: - type: object properties: type: type: string enum: - MEDICARE_ADVANTAGE description: 'Discriminator value: MEDICARE_ADVANTAGE' payload: $ref: '#/components/schemas/type_pre-encounter_eligibilityChecks_v1_MedicareAdvantageRecommendationPayload' required: - type - payload - type: object properties: type: type: string enum: - MEDICAID_MANAGED_CARE description: 'Discriminator value: MEDICAID_MANAGED_CARE' payload: $ref: '#/components/schemas/type_pre-encounter_eligibilityChecks_v1_MedicareAdvantageRecommendationPayload' required: - type - payload - type: object properties: type: type: string enum: - COORDINATION_OF_BENEFITS description: 'Discriminator value: COORDINATION_OF_BENEFITS' payload: description: Any type required: - type - payload - type: object properties: type: type: string enum: - COPAY_ESTIMATION description: 'Discriminator value: COPAY_ESTIMATION' payload: $ref: '#/components/schemas/type_pre-encounter_eligibilityChecks_v1_CopayEstimationRecommendationPayload' required: - type - payload - type: object properties: type: type: string enum: - USER_CONFIGURED_PROMPTS description: 'Discriminator value: USER_CONFIGURED_PROMPTS' payload: $ref: '#/components/schemas/type_pre-encounter_eligibilityChecks_v1_UserConfiguredPromptsRecommendationPayload' required: - type - payload discriminator: propertyName: type title: EligibilityRecommendationPayload type_encounters_v4_PatientHistoryCategory: type: object properties: category: $ref: '#/components/schemas/type_encounters_v4_PatientHistoryCategoryEnum' questions: type: array items: $ref: '#/components/schemas/type_encounters_v4_IntakeQuestion' description: Must contain at least one item. required: - category - questions title: PatientHistoryCategory type_encounters_v4_IntakeFollowUpOptional: type: object properties: id: $ref: '#/components/schemas/type_encounters_v4_IntakeFollowUpId' text: type: string response: type: string title: IntakeFollowUpOptional type_pre-encounter_common_Relationship: type: string enum: - SELF - SPOUSE - CHILD - COMMON_LAW_SPOUSE - OTHER title: Relationship type_pre-encounter_patients_v1_ReferralUnit: type: string enum: - VISIT - UNIT title: ReferralUnit type_non-insurance-payers_v1_NonInsurancePayerCategoryUpdate: oneOf: - type: object properties: type: type: string enum: - remove description: 'Discriminator value: remove' required: - type - type: object properties: type: type: string enum: - set description: 'Discriminator value: set' value: type: string required: - type - value description: Max 255 characters allowed discriminator: propertyName: type title: NonInsurancePayerCategoryUpdate type_pre-encounter_coverages_v1_CoveragesPage: type: object properties: next_page_token: $ref: '#/components/schemas/type_pre-encounter_common_PageToken' prev_page_token: $ref: '#/components/schemas/type_pre-encounter_common_PageToken' total: type: integer items: type: array items: $ref: '#/components/schemas/type_pre-encounter_coverages_v1_Coverage' required: - total - items title: CoveragesPage type_pre-encounter_eligibilityChecks_v1_CobEncounter: type: object properties: date_of_service: type: string description: The date of service. Defaults to the current date if not specified. beginning_date_of_service: type: string description: The beginning date of service. If included, end_date_of_service is also required. end_date_of_service: type: string description: The end date of service. If included, beginning_date_of_service is also required. description: 'Information about the encounter for the COB check. Service dates must be within the past 2 years and must not be in the future.' title: CobEncounter type_encounter-attachments_v1_EncounterAttachment: type: object properties: attachment_id: $ref: '#/components/schemas/type_encounter-attachments_v1_AttachmentId' file_name: type: string description: type: string content_type: type: string authed_url: $ref: '#/components/schemas/type_commons_LinkUrl' encounter_id: $ref: '#/components/schemas/type_commons_EncounterId' attachment_type: $ref: '#/components/schemas/type_encounter-attachments_v1_EncounterAttachmentType' created_at: type: string format: date-time created_by: $ref: '#/components/schemas/type_users_v2_UserV2' required: - attachment_id - file_name - description - content_type - authed_url - encounter_id - attachment_type - created_at - created_by title: EncounterAttachment type_custom-schemas_v1_SchemaInstance: type: object properties: schema_id: $ref: '#/components/schemas/type_commons_SchemaId' description: The schema to which the content must adhere. content: type: object additionalProperties: description: Any type description: A set of key-value pairs that adhere to the naming and type convention of the schema. Not all keys in the schema must be included, but attaching any key that does not exist in the schema or attaching a key with the incorrect value type will result in errors. required: - schema_id - content title: SchemaInstance type_pre-encounter_coverages_v1_ServiceCoverageDetails: type: object properties: copay: $ref: '#/components/schemas/type_pre-encounter_coverages_v1_CoverageValue' coinsurance: $ref: '#/components/schemas/type_pre-encounter_coverages_v1_CoverageValue' visits: $ref: '#/components/schemas/type_pre-encounter_coverages_v1_CoverageValue' visits_remaining: $ref: '#/components/schemas/type_pre-encounter_coverages_v1_CoverageValue' additional_notes: type: string title: ServiceCoverageDetails type_service-lines_v2_TestResultType: type: string enum: - HEMATOCRIT - HEMOGLOBIN - LDL - VITAMIN_D title: TestResultType type_pre-encounter_eligibilityChecks_v1_EligibilityRecommendationPatientInfo: type: object properties: id: $ref: '#/components/schemas/type_pre-encounter_common_PatientId' mrn: type: string organization_id: $ref: '#/components/schemas/type_pre-encounter_common_OrganizationId' last_name: type: string first_name: type: string date_of_birth: type: string format: date member_id: type: string description: "An object representing patient information for an eligibility recommendation. \nThis is used to find recommendations. Each field helps us find the right corresponding\neligibility recommendation for the patient." title: EligibilityRecommendationPatientInfo type_commons_LinkUrl: type: string title: LinkUrl type_pre-encounter_coverages_v1_Coverage: type: object properties: organization_id: $ref: '#/components/schemas/type_pre-encounter_common_OrganizationId' description: The organization that owns this object. deactivated: type: boolean description: True if the object is deactivated. Deactivated objects are not returned in search results but are returned in all other endpoints including scan. version: type: integer description: The version of the object. Any update to any property of an object object will create a new version. updated_at: type: string format: date-time updating_user_id: $ref: '#/components/schemas/type_pre-encounter_common_UserId' description: The user ID of the user who last updated the object. status: $ref: '#/components/schemas/type_pre-encounter_coverages_v1_CoverageStatus' description: The status indiciating if the coverage is active or not. subscriber: $ref: '#/components/schemas/type_pre-encounter_coverages_v1_Subscriber' description: The party who has signed-up for or 'owns' the contractual relationship to the policy or to whom the benefit of the policy for services rendered to them or their family is due. relationship: $ref: '#/components/schemas/type_pre-encounter_common_Relationship' description: The relationship of beneficiary (patient) to the subscriber. https://hl7.org/fhir/valueset-relationship.html patient: $ref: '#/components/schemas/type_pre-encounter_common_PatientId' description: The canonical Candid patient UUID corresponding with the patient who benefits from the insurance coverage insurance_plan: $ref: '#/components/schemas/type_pre-encounter_coverages_v1_InsurancePlan' verified: type: boolean description: A boolean indicating if the coverage has been verified by a user. eligibility_checks: type: array items: $ref: '#/components/schemas/type_pre-encounter_eligibilityChecks_v1_EligibilityCheckMetadata' description: A list of eligibility check metadata that have been initiated on this coverage. latest_eligibility_check: $ref: '#/components/schemas/type_pre-encounter_coverages_v1_LatestEligibilityCheck' description: The latest eligibility check metadata that has been initiated on this coverage. benefits: $ref: '#/components/schemas/type_pre-encounter_coverages_v1_CoverageBenefits' description: The eligibility of the patient for the coverage, manually verified by users. orcon: type: boolean description: ORCON (Originator Controlled) - When set to true, the Candid system will hide this coverage from downstream integrations. Updates made in the Candid UI will unset this flag. Defaults to false. auto_update_enabled: type: boolean description: Default to true. When set to true, the Candid system will automatically update this coverage with the latest eligibility check benefits information. Auto update behavior is also set at the eligibilityConfig org level configuration. previous_appointment_copays: type: object additionalProperties: type: integer description: A map of UniversalServiceIdentifier (MD_Visit, Treatment, Tests, Activity) to copay values in cents. This is used to track copay values for each service type to handle OOP max resets correctly. id: $ref: '#/components/schemas/type_pre-encounter_common_CoverageId' required: - organization_id - deactivated - version - updated_at - updating_user_id - status - subscriber - relationship - patient - insurance_plan - verified - id description: A coverage object with immutable server-owned properties. title: Coverage type_pre-encounter_eligibilityChecks_v1_CobDependent: type: object properties: first_name: type: string description: The dependent's first name. last_name: type: string description: The dependent's last name. date_of_birth: type: string description: The dependent's date of birth. ssn: type: string description: The dependent's Social Security Number (SSN). required: - first_name - last_name - date_of_birth description: 'A dependent for which you want to check coordination of benefits. If the dependent has their own member ID, include their information in the subscriber object instead.' title: CobDependent type_health-care-code-information_v1_AdmittingDiagnosisCodeQualifier: type: string enum: - BJ - ABJ title: AdmittingDiagnosisCodeQualifier type_health-care-code-information_v1_PrincipalDiagnosisCodeQualifier: type: string enum: - BK - ABK title: PrincipalDiagnosisCodeQualifier type_write-offs_v1_InsuranceWriteOffTarget: oneOf: - type: object properties: type: type: string enum: - service_line_id description: 'Discriminator value: service_line_id' value: $ref: '#/components/schemas/type_commons_ServiceLineId' required: - type - value - type: object properties: type: type: string enum: - claim_id description: 'Discriminator value: claim_id' value: $ref: '#/components/schemas/type_commons_ClaimId' required: - type - value - type: object properties: type: type: string enum: - billing_provider_id description: 'Discriminator value: billing_provider_id' value: $ref: '#/components/schemas/type_commons_ProviderId' required: - type - value discriminator: propertyName: type title: InsuranceWriteOffTarget type_encounters_v4_IntakeQuestionOptional: type: object properties: id: $ref: '#/components/schemas/type_encounters_v4_IntakeQuestionId' text: type: string responses: type: array items: $ref: '#/components/schemas/type_encounters_v4_IntakeResponseAndFollowUpsOptional' title: IntakeQuestionOptional type_pre-encounter_eligibilityChecks_v1_InsuranceDiscoverySubscriber: type: object properties: first_name: type: string description: The subscriber's first name. last_name: type: string description: The subscriber's last name. middle_name: type: string description: The subscriber's middle name or initial. date_of_birth: type: string description: The subscriber's date of birth, formatted as YYYYMMDD. ssn: type: string description: The subscriber's Social Security Number (SSN). Full SSN is preferred, but even the last 4 digits can help. gender: $ref: '#/components/schemas/type_pre-encounter_eligibilityChecks_v1_InsuranceDiscoveryGender' address: $ref: '#/components/schemas/type_pre-encounter_eligibilityChecks_v1_InsuranceDiscoveryAddress' required: - first_name - last_name description: 'Demographic information for the patient when they are the health plan subscriber. Providing as much information as possible improves the probability of finding matching coverage. SSN and address (especially zip code) are strongly recommended.' title: InsuranceDiscoverySubscriber type_health-care-code-information_v1_DiagnosisRelatedGroupCodeQualifier: type: string enum: - DR title: DiagnosisRelatedGroupCodeQualifier type_commons_ChargeCaptureId: type: string format: uuid title: ChargeCaptureId type_commons_ClaimSubmissionPayerResponsibilityType: type: string enum: - primary - secondary title: ClaimSubmissionPayerResponsibilityType type_pre-encounter_common_DisabilityStatus: type: string enum: - DISABLED - NON_DISABLED title: DisabilityStatus type_billing-notes_v2_BillingNoteType: type: string enum: - manual - system - queue_added - queue_moved - task_created title: BillingNoteType 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_pre-encounter_coverages_v1_LatestEligibilityCheck: type: object properties: check_id: type: string status: $ref: '#/components/schemas/type_pre-encounter_eligibilityChecks_v1_EligibilityStatus' initiated_at: type: string format: date-time errors: type: array items: $ref: '#/components/schemas/type_pre-encounter_eligibilityChecks_v1_EligibilityCheckErrorDetails' required: - check_id - status - initiated_at description: A type to represent the latest eligibility check status of a coverage. title: LatestEligibilityCheck type_commons_QualifierCode: type: string enum: - DQ - DN - DK - P3 title: QualifierCode type_tags_TagColorEnum: type: string enum: - black - white - gray - red - yellow - green - blue - indigo - purple - pink title: TagColorEnum type_pre-encounter_eligibilityChecks_v1_IndividualProvider: type: object properties: first_name: type: string last_name: type: string npi: type: string required: - npi title: IndividualProvider type_financials_RefundReasonUpdate: oneOf: - type: object properties: type: type: string enum: - set description: 'Discriminator value: set' value: $ref: '#/components/schemas/type_financials_RefundReason' required: - type - value - type: object properties: type: type: string enum: - remove description: 'Discriminator value: remove' required: - type discriminator: propertyName: type title: RefundReasonUpdate type_commons_PayerPlanGroupId: type: string format: uuid title: PayerPlanGroupId type_pre-encounter_coverages_v1_CoverageEligibilityCheckResponse: type: object properties: metadata: $ref: '#/components/schemas/type_pre-encounter_eligibilityChecks_v1_EligibilityCheckMetadata' check: $ref: '#/components/schemas/type_pre-encounter_eligibilityChecks_v1_EligibilityCheck' required: - metadata title: CoverageEligibilityCheckResponse type_pre-encounter_common_HumanName: type: object properties: family: type: string given: type: array items: type: string use: $ref: '#/components/schemas/type_pre-encounter_common_NameUse' period: $ref: '#/components/schemas/type_pre-encounter_common_Period' suffix: type: string required: - family - given - use title: HumanName type_pre-encounter_eligibilityChecks_v1_EligibilityCheckMetadata: type: object properties: check_id: type: string service_code: $ref: '#/components/schemas/type_pre-encounter_coverages_v1_ServiceTypeCode' status: $ref: '#/components/schemas/type_pre-encounter_eligibilityChecks_v1_EligibilityCheckStatus' initiated_by: $ref: '#/components/schemas/type_pre-encounter_common_UserId' initiated_at: type: string format: date-time required: - check_id - service_code - status - initiated_by - initiated_at title: EligibilityCheckMetadata type_events_v1_Event: type: object properties: id: $ref: '#/components/schemas/type_events_v1_EventId' created_at: type: string format: date-time timestamp: type: string format: date-time event_type: type: string schema_version: type: string payload: description: Any type required: - id - created_at - timestamp - event_type - schema_version - payload title: Event type_financials_NoteUpdate: oneOf: - type: object properties: type: type: string enum: - set description: 'Discriminator value: set' value: type: string required: - type - value - type: object properties: type: type: string enum: - remove description: 'Discriminator value: remove' required: - type discriminator: propertyName: type title: NoteUpdate type_payers_v4_PayerUuid: type: string format: uuid title: PayerUuid type_import-invoice_v1_ImportInvoicesPage: type: object properties: prev_page_token: $ref: '#/components/schemas/type_commons_PageToken' next_page_token: $ref: '#/components/schemas/type_commons_PageToken' items: type: array items: $ref: '#/components/schemas/type_import-invoice_v1_ImportInvoice' required: - items title: ImportInvoicesPage type_patient-refunds_v1_PatientRefundId: type: string format: uuid title: PatientRefundId type_commons_EntityConflictErrorMessage: type: object properties: entity_name: type: string required: - entity_name title: EntityConflictErrorMessage type_commons_ClinicalTrialId: type: string format: uuid title: ClinicalTrialId type_health-care-code-information_v1_D8Date: type: string format: date title: D8Date type_pre-encounter_eligibilityChecks_v1_EligibilityCheckPage: type: object properties: next_page_token: $ref: '#/components/schemas/type_pre-encounter_common_PageToken' prev_page_token: $ref: '#/components/schemas/type_pre-encounter_common_PageToken' total: type: integer items: type: array items: $ref: '#/components/schemas/type_pre-encounter_eligibilityChecks_v1_EligibilityCheck' required: - total - items title: EligibilityCheckPage type_pre-encounter_patients_v1_Guarantor: type: object properties: name: $ref: '#/components/schemas/type_pre-encounter_common_HumanName' telecom: $ref: '#/components/schemas/type_pre-encounter_common_ContactPoint' email: type: string birth_date: type: string format: date address: $ref: '#/components/schemas/type_pre-encounter_common_Address' required: - name - address title: Guarantor type_pre-encounter_eligibilityChecks_v1_CoordinationOfBenefitsRequest: type: object properties: trading_partner_service_id: type: string description: 'The Payer ID. Each check must be for a participating health plan for which the patient has coverage. Medicare and Medicare Advantage plans are not supported.' provider: $ref: '#/components/schemas/type_pre-encounter_eligibilityChecks_v1_CobProvider' subscriber: $ref: '#/components/schemas/type_pre-encounter_eligibilityChecks_v1_CobSubscriber' dependent: $ref: '#/components/schemas/type_pre-encounter_eligibilityChecks_v1_CobDependent' encounter: $ref: '#/components/schemas/type_pre-encounter_eligibilityChecks_v1_CobEncounter' required: - trading_partner_service_id - provider - subscriber - encounter description: An object representing the data for a coordination of benefits request. title: CoordinationOfBenefitsRequest type_pre-encounter_patients_v1_ExternalProvenance: type: object properties: external_id: type: string system_name: type: string required: - external_id - system_name description: Information about the upstream system that owns this patient data. title: ExternalProvenance type_commons_IntendedSubmissionMedium: type: string enum: - paper - electronic description: The medium (paper or electronic) via which we intended to submit the claim. The clearinghouse to which we sent the claim may use a different medium in certain cases, e.g., if the payer does not support electronic claims. title: IntendedSubmissionMedium type_commons_PreEncounterPatientId: type: string format: uuid title: PreEncounterPatientId type_guarantor_v1_GuarantorUpdate: type: object properties: first_name: type: string last_name: type: string external_id: type: string description: A unique identifier for the guarantor assigned by an external system. date_of_birth: type: string format: date description: 'Date formatted as YYYY-MM-DD; eg: 2019-08-25.' address: $ref: '#/components/schemas/type_commons_StreetAddressShortZip' phone_numbers: type: array items: $ref: '#/components/schemas/type_commons_PhoneNumber' phone_consent: type: boolean email: $ref: '#/components/schemas/type_commons_Email' email_consent: type: boolean auto_charge_consent: type: boolean title: GuarantorUpdate type_patient-ar_v1_ListInventoryPagedResponse: type: object properties: records: type: array items: $ref: '#/components/schemas/type_patient-ar_v1_InventoryRecord' description: List of inventory records matching the filters next_page_token: $ref: '#/components/schemas/type_commons_PageToken' description: Token for the next page of results, if available required: - records title: ListInventoryPagedResponse type_pre-encounter_lists_v1_SortFieldString: type: string description: 'The field to order by. Valid values are either keys on the list item object or a special ordering "similar_name:" (Ex: similar_name:John). Similar name ordering uses trigrams to fuzzy match patient name to the search criteria. Path names are camelCase.' title: SortFieldString type_payer-plan-groups_v1_PayerPlanGroupPage: type: object properties: prev_page_token: $ref: '#/components/schemas/type_commons_PageToken' next_page_token: $ref: '#/components/schemas/type_commons_PageToken' items: type: array items: $ref: '#/components/schemas/type_payer-plan-groups_v1_PayerPlanGroup' required: - items title: PayerPlanGroupPage type_patient-ar_v1_PatientPaymentInfo: type: object properties: total_payment_cents: type: integer description: The total amount of patient payments in cents for the service line. items: type: array items: $ref: '#/components/schemas/type_patient-ar_v1_PatientPaymentAllocation' description: A list of patient payment items associated with the service line. required: - total_payment_cents - items title: PatientPaymentInfo type_pre-encounter_coverages_v1_MemberInfo: type: object properties: member_id: type: string description: "Stedi requires that you supply at least one of these fields in the request: memberId, dateOfBirth, or lastName. \nHowever, each payer has different requirements, so you should supply as many of the fields necessary for each payer \nto identify the subscriber/dependent in their system." first_name: type: string last_name: type: string date_of_birth: type: string format: date description: "Stedi requires that you supply at least one of these fields in the request: memberId, dateOfBirth, or lastName. \nHowever, each payer has different requirements, so you should supply as many of the fields necessary for each payer \nto identify the subscriber/dependent in their system." required: - first_name - last_name title: MemberInfo type_health-care-code-information_v1_ConditionInformationCodeQualifier: type: string enum: - BG title: ConditionInformationCodeQualifier type_health-care-code-information_v1_ValueCode: type: string enum: - '01' - '02' - '04' - '05' - '06' - 08 - 09 - '10' - '11' - '12' - '13' - '14' - '15' - '16' - '21' - '22' - '23' - '24' - '25' - '26' - '27' - '28' - '29' - '30' - '31' - '32' - '33' - '34' - '35' - '37' - '38' - '39' - '40' - '41' - '42' - '43' - '44' - '45' - '46' - '47' - '48' - '49' - '50' - '51' - '52' - '53' - '54' - '55' - '56' - '57' - '58' - '59' - '60' - '61' - '66' - '67' - '68' - '69' - '80' - '81' - '82' - '83' - '84' - '85' - '87' - '89' - '90' - '91' - A0 - A1 - A2 - A3 - A4 - A5 - A6 - A7 - A8 - A9 - AA - AB - B1 - B2 - B3 - B7 - BA - BB - C1 - C2 - C3 - C7 - CA - CB - D3 - D4 - D5 - D6 - FC - FD - G8 - P1 - P2 - P3 - Y1 - Y2 - Y3 - Y4 - Y5 title: ValueCode type_billing-notes_v2_BillingNoteBaseOptional: type: object properties: text: type: string description: Empty string not allowed. title: BillingNoteBaseOptional type_pre-encounter_common_NameUse: type: string enum: - USUAL - OFFICIAL - TEMP - NICKNAME - ANONYMOUS - OLD - MAIDEN title: NameUse type_non-insurance-payers_v1_NonInsurancePayerId: type: string format: uuid title: NonInsurancePayerId type_invoices_v2_InvoiceDestinationMetadata: type: object properties: invoice_destination: $ref: '#/components/schemas/type_invoices_v2_InvoiceDestination' description: Defines which third-party service this invoice was created in source_id: type: string description: The id of the invoice in the third-party service source_customer_id: type: string description: The id of the customer that the invoice is attributed to in the third-party service destination_status: type: string description: The status of the invoice in the third-party service required: - invoice_destination - source_id - source_customer_id title: InvoiceDestinationMetadata type_pre-encounter_common_CanonicalProviderId: type: string description: The unique identifier for a provider configured in the Candid system title: CanonicalProviderId type_invoices_v2_ServiceLineInvoiceItem: type: object properties: service_line_id: $ref: '#/components/schemas/type_commons_ServiceLineId' amount_cents: type: integer required: - service_line_id - amount_cents title: ServiceLineInvoiceItem type_health-care-code-information_v1_OtherProcedureInformation: type: object properties: id: type: string format: uuid description: 'The id of this health care code information if it is already stored. If this is not set, this is referring to a new health care code information to be added to the encounter. If it is set, this refers to an update of an existing health care code information object on the encounter.' encounter_id: $ref: '#/components/schemas/type_commons_EncounterId' description: 'The encounter_id of this health care code information if it is already stored. This will be set by the server in responses, but clients are not expected to set it.' other_procedure_code_qualifier: $ref: '#/components/schemas/type_health-care-code-information_v1_OtherProcedureInformationCodeQualifier' other_procedure_code: $ref: '#/components/schemas/type_health-care-code-information_v1_ICDCode' other_procedure_date: $ref: '#/components/schemas/type_health-care-code-information_v1_D8Date' description: 'An [RFC 3339, section 5.6 datetime](https://ijmacd.github.io/rfc3339-iso8601/). For example, 2017-07-21T17:32:28Z. In practice, only the date portion of this is used for claim submission, so midnight time is fine.' required: - other_procedure_code_qualifier - other_procedure_code - other_procedure_date description: This corresponds to the BBQ or BQ code qualifier values. title: OtherProcedureInformation type_clinical-trials_v1_ClinicalTrialPhase: type: string enum: - Phase 1 - Phase 2 - Phase 3 title: ClinicalTrialPhase type_pre-encounter_common_TagId: type: string description: The unique identifier for a Tag. title: TagId type_commons_PatientExternalId: type: string title: PatientExternalId type_pre-encounter_patients_v1_PatientSortField: type: string description: 'The field to order by. Valid values are either keys on the patient object or a special ordering "similar_name:" (Ex: similar_name:John). Similar name ordering uses trigrams to fuzzy match patient names to the search criteria.' title: PatientSortField type_financials_AllocationTargetCreate: oneOf: - type: object properties: type: type: string enum: - service_line_by_id description: 'Discriminator value: service_line_by_id' value: $ref: '#/components/schemas/type_commons_ServiceLineId' required: - type - value - type: object properties: type: type: string enum: - claim_by_id description: 'Discriminator value: claim_by_id' value: $ref: '#/components/schemas/type_commons_ClaimId' required: - type - value - type: object properties: type: type: string enum: - claim_by_encounter_external_id description: 'Discriminator value: claim_by_encounter_external_id' value: $ref: '#/components/schemas/type_commons_EncounterExternalId' required: - type - value - type: object properties: type: type: string enum: - billing_provider_by_id description: 'Discriminator value: billing_provider_by_id' value: $ref: '#/components/schemas/type_commons_ProviderId' required: - type - value - type: object properties: type: type: string enum: - appointment_by_id_and_patient_external_id description: 'Discriminator value: appointment_by_id_and_patient_external_id' appointment_id: $ref: '#/components/schemas/type_commons_AppointmentId' patient_external_id: $ref: '#/components/schemas/type_commons_PatientExternalId' required: - type - appointment_id - patient_external_id - type: object properties: type: type: string enum: - unattributed description: 'Discriminator value: unattributed' required: - type discriminator: propertyName: type description: 'Allocation targets describe whether the portion of a payment is being applied toward a specific service line, claim, billing provider, or is unallocated.' title: AllocationTargetCreate type_health-care-code-information_v1_OccurrenceInformationCodeQualifier: type: string enum: - BH title: OccurrenceInformationCodeQualifier type_pre-encounter_eligibilityChecks_v1_Cob: type: object properties: classification: type: string description: 'The classification for the discovered benefits. One of: `CobInstanceExistsPrimacyDetermined`, `CobInstanceExistsPrimacyUndetermined`, `CoverageOverlapNoBenefitOverlap`, `CoverageOverlapExistsNotSubjectToCob`, or `MemberFoundNoCob`.' instance_exists: type: boolean description: If true, the COB response contains at least one coordination of benefits instance. primacy_determined: type: boolean description: If true, Stedi was able to determine the primary payer for the patient. coverage_overlap: type: boolean description: If true, the patient has active coverage with two or more payers during the service date. benefit_overlap: type: boolean description: If true, the patient has active coverage from two or more payers for the same service type code. description: 'An overview of the COB response. Indicates whether there is a coverage overlap, whether that overlap creates a coordination of benefits instance, and whether Stedi was able to identify payer primacy (when a COB instance exists).' title: Cob type_pre-encounter_eligibilityChecks_v1_EligibilityCheckErrorDetails: type: object properties: field?: type: string description?: type: string location?: type: string possibleResolutions?: type: string code?: type: string followupAction?: type: string description: This object is our fern representation of Stedi's EligbilityCheckError object from their API. title: EligibilityCheckErrorDetails type_import-invoice_v1_CreateImportInvoiceRequest: type: object properties: external_payment_account_config_id: $ref: '#/components/schemas/type_payment-account-configs_PaymentAccountConfigId' patient_external_id: $ref: '#/components/schemas/type_commons_PatientExternalId' external_customer_identifier: type: string description: Id of the customer in the source system note: type: string due_date: type: string format: date description: If given as None, days_until_due in the payment config will be used to create a default date items: type: array items: $ref: '#/components/schemas/type_invoices_v2_InvoiceItemCreate' status: $ref: '#/components/schemas/type_invoices_v2_InvoiceStatus' external_identifier: type: string description: Id of the invoice being imported in the source system. Warning - This field CANNOT be updated. customer_invoice_url: type: string description: Link to the patient view of the invoice in the third-party service required: - external_payment_account_config_id - patient_external_id - external_customer_identifier - items - status - external_identifier title: CreateImportInvoiceRequest type_pre-encounter_common_ExternalProviderType: type: string enum: - PRIMARY - REFERRING - ATTENDING title: ExternalProviderType type_claims_ClaimStatus: type: string enum: - biller_received - coded - submitted_to_payer - missing_information - not_billable - waiting_for_provider - era_received - rejected - denied - paid - paid_incorrectly - finalized_paid - finalized_denied - held_by_customer - era_requires_review title: ClaimStatus type_individual_Patient: type: object properties: first_name: type: string last_name: type: string gender: $ref: '#/components/schemas/type_individual_Gender' external_id: type: string description: The ID used to identify this individual in your system. For example, your internal patient ID or an EHR patient ID. date_of_birth: type: string format: date description: Box 3 on the CMS-1500 claim form or Form Locator 10 on a UB-04 claim form. The date format should be in ISO 8601 date; formatted YYYY-MM-DD (i.e. 2012-02-01) address: $ref: '#/components/schemas/type_commons_StreetAddressShortZip' description: Box 5 on the CMS-1500 claim form or Form Locator 9 on a UB-04 claim form. individual_id: $ref: '#/components/schemas/type_individual_IndividualId' phone_numbers: type: array items: $ref: '#/components/schemas/type_commons_PhoneNumber' phone_consent: type: boolean email: $ref: '#/components/schemas/type_commons_Email' email_consent: type: boolean auto_charge_consent: type: boolean non_insurance_payers: type: array items: $ref: '#/components/schemas/type_non-insurance-payers_v1_NonInsurancePayer' non_insurance_payers_info: type: array items: $ref: '#/components/schemas/type_individual_PatientNonInsurancePayerInfo' required: - first_name - last_name - gender - external_id - date_of_birth - address - individual_id - phone_numbers - phone_consent - email_consent - auto_charge_consent - non_insurance_payers - non_insurance_payers_info title: Patient type_non-insurance-payers_v1_NonInsurancePayerAddressUpdate: oneOf: - type: object properties: type: type: string enum: - remove description: 'Discriminator value: remove' required: - type - type: object properties: type: type: string enum: - set description: 'Discriminator value: set' value: $ref: '#/components/schemas/type_commons_StreetAddressShortZip' required: - type discriminator: propertyName: type title: NonInsurancePayerAddressUpdate type_pre-encounter_eligibilityChecks_v1_BatchEligibilityResponse: type: object properties: batch_id: type: string submitted_at: type: string format: date-time required: - batch_id - submitted_at description: An object representing the data for a batch eligibility response. title: BatchEligibilityResponse type_pre-encounter_eligibilityChecks_v1_InsuranceDiscoveryStatus: type: string enum: - PENDING - COMPLETE description: The status of the insurance discovery check. title: InsuranceDiscoveryStatus type_commons_UnprocessableEntityErrorMessage: type: object properties: message: type: string title: UnprocessableEntityErrorMessage type_guarantor_v1_GuarantorCreate: type: object properties: first_name: type: string last_name: type: string external_id: type: string date_of_birth: type: string format: date address: $ref: '#/components/schemas/type_commons_StreetAddressShortZip' phone_numbers: type: array items: $ref: '#/components/schemas/type_commons_PhoneNumber' phone_consent: type: boolean description: Defaults to false email: $ref: '#/components/schemas/type_commons_Email' email_consent: type: boolean description: Defaults to false auto_charge_consent: type: boolean description: Defaults to false required: - first_name - last_name - external_id - address title: GuarantorCreate type_commons_EPSDTReferralConditionIndicatorCode: type: string enum: - AV - NU - S2 - ST title: EPSDTReferralConditionIndicatorCode type_pre-encounter_common_FilterQueryString: type: string description: 'A serialized list of filters separated by commas indicating filters to apply. Each filter is of the form ''path:operator:value''. Example: ''patient.mrn|eq|12345''. Filters are separated by commas. Example: ''patient.mrn|eq|12345,appointment.startDate|gt|67890''. All filters are ANDed together. Valid operators are ''eq'', ''gt'', ''lt'', ''contains'', ''ieq'', ''in''. ieq is a case-insensitive equality operator. in allows searching for values that match any item in a semicolon-separated list (e.g., ''patient.id|in|foo;bar;baz''). Path values are camelCase.' title: FilterQueryString type_encounter-providers_v2_EncounterAdditionalProvider: type: object properties: provider_id: $ref: '#/components/schemas/type_encounter-providers_v2_ProviderId' first_name: type: string last_name: type: string npi: type: string description: 'A National Provider Identifier is a unique 10-digit identification number issued to health care providers in the United States' taxonomy_code: type: string address: $ref: '#/components/schemas/type_commons_StreetAddressLongZip' tax_id: type: string license_type: $ref: '#/components/schemas/type_organization-providers_v2_LicenseType' description: The license type of the provider (e.g., MD, NP, PA, LCSW). required: - provider_id - first_name - last_name description: A lighter-weight provider type with optional NPI. Used for treating providers and other additional provider roles that may not have full NPI credentials. title: EncounterAdditionalProvider type_pre-encounter_common_AdditionalPayerInformation: type: object properties: availity_eligibility_id: type: string availity_payer_id: type: string availity_payer_name: type: string availity_remittance_payer_id: type: string title: AdditionalPayerInformation type_service-lines_v2_ServiceLine: type: object properties: created_at: type: string format: date-time modifiers: type: array items: $ref: '#/components/schemas/type_commons_ProcedureModifier' charge_amount_cents: type: integer allowed_amount_cents: type: integer insurance_balance_cents: type: integer patient_balance_cents: type: integer paid_amount_cents: type: integer primary_paid_amount_cents: type: integer secondary_paid_amount_cents: type: integer tertiary_paid_amount_cents: type: integer patient_responsibility_cents: type: integer copay_cents: type: integer coinsurance_cents: type: integer deductible_cents: type: integer diagnosis_id_zero: $ref: '#/components/schemas/type_diagnoses_DiagnosisId' diagnosis_id_one: $ref: '#/components/schemas/type_diagnoses_DiagnosisId' diagnosis_id_two: $ref: '#/components/schemas/type_diagnoses_DiagnosisId' diagnosis_id_three: $ref: '#/components/schemas/type_diagnoses_DiagnosisId' drug_identification: $ref: '#/components/schemas/type_service-lines_v2_DrugIdentification' service_line_era_data: $ref: '#/components/schemas/type_service-lines_v2_ServiceLineERAData' service_line_manual_adjustments: type: array items: $ref: '#/components/schemas/type_service-lines_v2_ServiceLineAdjustment' related_invoices: type: array items: $ref: '#/components/schemas/type_invoices_Invoice' related_invoice_info: type: array items: $ref: '#/components/schemas/type_invoices_v2_InvoiceInfo' denial_reason: $ref: '#/components/schemas/type_service-lines_v2_ServiceLineDenialReason' place_of_service_code: $ref: '#/components/schemas/type_commons_FacilityTypeCode' description: 837p Loop2300, SV105. This enum is not used or required in 837i claims. If your organization does not intend to submit claims with a different place of service at the service line level, this field should not be populated. 02 for telemedicine, 11 for in-person. Full list [here](https://www.cms.gov/Medicare/Coding/place-of-service-codes/Place_of_Service_Code_Set). place_of_service_code_as_submitted: $ref: '#/components/schemas/type_commons_FacilityTypeCode' description: 837p Loop2300, SV105. 02 for telemedicine, 11 for in-person. Full list [here](https://www.cms.gov/Medicare/Coding/place-of-service-codes/Place_of_Service_Code_Set). service_line_id: $ref: '#/components/schemas/type_commons_ServiceLineId' procedure_code: type: string ordering_provider: $ref: '#/components/schemas/type_encounter-providers_v2_EncounterProvider' revenue_code: type: string description: A 4 digit code that specifies facility department or type of service arrangement for institutional service line items (837i). This code is not required for professional claim billing (837p). quantity: $ref: '#/components/schemas/type_commons_Decimal' description: 'String representation of a Decimal that can be parsed by most libraries. For professional claims, a ServiceLine quantity cannot contain more than one digit of precision (Example: 1.1 is valid, 1.11 is not). For institutional claims, a ServiceLine quantity cannot contain more than three decimal digits of precision.' units: $ref: '#/components/schemas/type_commons_ServiceLineUnits' claim_id: $ref: '#/components/schemas/type_commons_ClaimId' date_of_service_range: $ref: '#/components/schemas/type_commons_DateRangeOptionalEnd' description: 'A range of dates of service for this service line. If the service line is for a single date, the end date will be empty.' description: type: string description: A free-form description to clarify the related data elements and their content. Maps to SV1-01, C003-07 on a 837-P and SV2-02, C003-07 on a 837-I form. date_of_service: type: string format: date end_date_of_service: type: string format: date test_results: type: array items: $ref: '#/components/schemas/type_service-lines_v2_TestResult' description: 'Contains a list of test results. Test result types may map to MEA-02 on the 837-P (ex: Hemoglobin, Hematocrit). This is unused by 837-i and ignored for institutional service lines. No more than 5 MEA-02 test results may be submitted per service line.' has_epsdt_indicator: type: boolean description: 'Maps to SV1-11 on the 837-P and Box 24H on the CMS-1500. If the value is true, the box will be populated with "Y". Otherwise, the box will not be populated.' has_family_planning_indicator: type: boolean description: 'Maps to SV1-12 on the 837-P and Box 24I on the CMS-1500. If the value is true, the box will be populated with "Y". Otherwise, the box will not be populated.' note: type: string description: Maps to NTE02 loop 2400 on the EDI 837. prior_authorization_number: type: string description: Prior authorization number for this service line. Maps to the appropriate REF segment on Loop 2400 of the EDI 837p. This is not used for institutional claims (EDI 837i). external_id: type: string description: 'An external identifier for this service line. This is not used in the EDI 837, but can be used to identify the service line in external systems. This field should not contain PHI. Must be unique on a given claim.' required: - created_at - service_line_id - procedure_code - quantity - units - claim_id - date_of_service_range - date_of_service title: ServiceLine type_commons_BadRequestErrorMessage: type: object properties: message: type: string title: BadRequestErrorMessage type_pre-encounter_coverages_v1_PlanCoverage: type: object properties: in_network: $ref: '#/components/schemas/type_pre-encounter_coverages_v1_PlanCoverageDetails' in_network_flat: type: array items: $ref: '#/components/schemas/type_pre-encounter_coverages_v1_CoverageDetails' out_of_network: $ref: '#/components/schemas/type_pre-encounter_coverages_v1_PlanCoverageDetails' out_of_network_flat: type: array items: $ref: '#/components/schemas/type_pre-encounter_coverages_v1_CoverageDetails' title: PlanCoverage type_pre-encounter_coverages_v1_InsurancePlan: type: object properties: member_id: type: string payer_id: $ref: '#/components/schemas/type_pre-encounter_common_PayerId' payer_name: type: string additional_payer_information: $ref: '#/components/schemas/type_pre-encounter_common_AdditionalPayerInformation' group_number: type: string name: type: string plan_type: $ref: '#/components/schemas/type_pre-encounter_coverages_v1_NetworkType' type: $ref: '#/components/schemas/type_pre-encounter_coverages_v1_InsuranceTypeCode' period: $ref: '#/components/schemas/type_pre-encounter_common_Period' insurance_card_image_locator: type: string address: $ref: '#/components/schemas/type_pre-encounter_common_Address' payer_plan_group_id: $ref: '#/components/schemas/type_pre-encounter_common_PayerPlanGroupId' description: The ID of the Candid configured payer plan group associated with this coverage carve_outs: type: array items: $ref: '#/components/schemas/type_pre-encounter_coverages_v1_CoverageCarveOut' required: - member_id - payer_id - payer_name title: InsurancePlan type_non-insurance-payers_v1_NonInsurancePayer: type: object properties: non_insurance_payer_id: $ref: '#/components/schemas/type_non-insurance-payers_v1_NonInsurancePayerId' name: type: string description: type: string category: type: string enabled: type: boolean address: $ref: '#/components/schemas/type_commons_StreetAddressShortZip' clinical_trials: type: array items: $ref: '#/components/schemas/type_clinical-trials_v1_ClinicalTrial' required: - non_insurance_payer_id - name - enabled - clinical_trials title: NonInsurancePayer type_health-care-code-information_v1_OtherDiagnosisInformationCodeQualifier: type: string enum: - BF - ABF title: OtherDiagnosisInformationCodeQualifier type_pre-encounter_patients_v1_SpecializationCategory: type: string enum: - BEHAVIORAL_HEALTH_THERAPY - CARDIOLOGY - DERMATOLOGY - ENDOCRINOLOGY - ENT - GASTROENTEROLOGY - GENERAL_SURGERY - GENETICS - HEMATOLOGY - INFECTIOUS_DISEASE - NEUROLOGY - NUTRITIONAL_THERAPY - OB_GYN - ONCOLOGY - OPHTHALMOLOGY - ORTHOPEDICS - PAIN_MANAGEMENT - PEDIATRICS - PHYSICAL_THERAPY - PODIATRY - PRIMARY_CARE - PSYCHIATRY - PULMONOLOGY - RADIOLOGY - RHEUMATOLOGY - SCREENING - UROLOGY - OTHER title: SpecializationCategory type_commons_Email: type: string title: Email type_import-invoice_v1_ImportInvoice: type: object properties: id: $ref: '#/components/schemas/type_commons_InvoiceId' created_at: type: string format: date-time updated_at: type: string format: date-time items: $ref: '#/components/schemas/type_invoices_v2_InvoiceItemInfo' description: The InvoiceItem rollup which contains all claim and service line invoice items patient_external_id: $ref: '#/components/schemas/type_commons_PatientExternalId' external_customer_identifier: type: string description: Id of the customer in the source system status: $ref: '#/components/schemas/type_invoices_v2_InvoiceStatus' external_identifier: type: string description: Id of the invoice being imported in the source system note: type: string customer_invoice_url: type: string description: Link to the patient view of the invoice in the third-party service due_date: type: string format: date amount_cents: type: integer description: Total monetary amount (in cents) of all Invoice Items required: - id - created_at - updated_at - items - patient_external_id - external_customer_identifier - status - external_identifier - due_date - amount_cents title: ImportInvoice type_x12_v1_PatientDischargeStatusCode: type: string enum: - '01' - '02' - '03' - '04' - '05' - '06' - '07' - 09 - '20' - '21' - '30' - '40' - '41' - '42' - '43' - '50' - '51' - '61' - '62' - '63' - '64' - '65' - '66' - '69' - '70' - '81' - '82' - '83' - '84' - '85' - '86' - '87' - '88' - '89' - '90' - '91' - '92' - '93' - '94' - '95' title: PatientDischargeStatusCode type_pre-encounter_common_CanonicalNonInsurancePayerAssociation: type: object properties: id: $ref: '#/components/schemas/type_pre-encounter_common_CanonicalNonInsurancePayerId' member_id: type: string period: $ref: '#/components/schemas/type_pre-encounter_common_Period' clinical_trial_info: type: array items: $ref: '#/components/schemas/type_pre-encounter_common_CanonicalClinicalTrialAssociation' description: A patient cannot be associated with a given trial more than once required: - id title: CanonicalNonInsurancePayerAssociation type_encounters_v4_ClaimSupplementalInformationOptional: type: object properties: attachment_report_type_code: $ref: '#/components/schemas/type_commons_ReportTypeCode' attachment_transmission_code: $ref: '#/components/schemas/type_commons_ReportTransmissionCode' attachment_control_number: type: string title: ClaimSupplementalInformationOptional type_pre-encounter_notes_v1_MutableNote: type: object properties: value: type: string type: $ref: '#/components/schemas/type_pre-encounter_notes_v1_NoteType' description: Defaults to GENERAL when omitted. author_email: type: string author_name: type: string required: - value description: An object representing a Note. title: MutableNote type_health-care-code-information_v1_PrincipalDiagnosis: type: object properties: id: type: string format: uuid description: 'The id of this health care code information if it is already stored. If this is not set, this is referring to a new health care code information to be added to the encounter. If it is set, this refers to an update of an existing health care code information object on the encounter.' encounter_id: $ref: '#/components/schemas/type_commons_EncounterId' description: 'The encounter_id of this health care code information if it is already stored. This will be set by the server in responses, but clients are not expected to set it.' principal_diagnosis_code_qualifier: $ref: '#/components/schemas/type_health-care-code-information_v1_PrincipalDiagnosisCodeQualifier' primary_diagnosis_code: $ref: '#/components/schemas/type_health-care-code-information_v1_ICDCode' present_on_admission_indicator: $ref: '#/components/schemas/type_health-care-code-information_v1_PresentOnAdmissionIndicatorCode' required: - principal_diagnosis_code_qualifier - primary_diagnosis_code description: This corresponds to BK or ABK code qualifier values. title: PrincipalDiagnosis type_commons_InvoiceId: type: string format: uuid title: InvoiceId type_financials_BalanceEarmark: type: object properties: id: type: string format: uuid target: $ref: '#/components/schemas/type_financials_AllocationEarmarkType' description: The target for this earmark (date of service or external encounter ID) amount_earmarked_cents: type: integer description: The amount earmarked in cents for future allocation created_by_allocation_id: $ref: '#/components/schemas/type_commons_AllocationId' description: The ID of the allocation that created this earmark required: - id - target description: 'Represents an active balance earmarking record that holds allocated funds for future auto-allocation. Earmarks are created when funds are allocated but should be held for a specific encounter or date of service. Only active (non-deleted) earmarks are returned.' title: BalanceEarmark type_x12_v1_ClaimAdjustmentReasonCode: type: object properties: group_code: $ref: '#/components/schemas/type_commons_ClaimAdjustmentGroupCodes' reason_code: $ref: '#/components/schemas/type_x12_v1_Carc' amount_cents: type: integer required: - group_code - reason_code - amount_cents title: ClaimAdjustmentReasonCode type_write-offs_v1_WriteOff: oneOf: - type: object properties: type: type: string enum: - patient description: 'Discriminator value: patient' write_off_id: $ref: '#/components/schemas/type_write-offs_v1_WriteOffId' write_off_timestamp: type: string format: date-time write_off_note: type: string write_off_reason: $ref: '#/components/schemas/type_write-offs_v1_PatientWriteOffReason' patient_external_id: $ref: '#/components/schemas/type_commons_PatientExternalId' claim_id: $ref: '#/components/schemas/type_commons_ClaimId' service_line_id: $ref: '#/components/schemas/type_commons_ServiceLineId' reverts_write_off_id: $ref: '#/components/schemas/type_write-offs_v1_WriteOffId' reverted_by_write_off_id: $ref: '#/components/schemas/type_write-offs_v1_WriteOffId' amount_cents: type: integer required: - type - write_off_id - write_off_timestamp - write_off_reason - patient_external_id - claim_id - service_line_id - amount_cents - type: object properties: type: type: string enum: - insurance description: 'Discriminator value: insurance' write_off_id: $ref: '#/components/schemas/type_write-offs_v1_WriteOffId' payer: $ref: '#/components/schemas/type_payers_v3_Payer' write_off_target: $ref: '#/components/schemas/type_write-offs_v1_InsuranceWriteOffTarget' write_off_timestamp: type: string format: date-time write_off_note: type: string write_off_reason: $ref: '#/components/schemas/type_write-offs_v1_InsuranceWriteOffReason' reverts_write_off_id: $ref: '#/components/schemas/type_write-offs_v1_WriteOffId' reverted_by_write_off_id: $ref: '#/components/schemas/type_write-offs_v1_WriteOffId' amount_cents: type: integer required: - type - write_off_id - payer - write_off_target - write_off_timestamp - write_off_reason - amount_cents - type: object properties: type: type: string enum: - non_insurance_payer description: 'Discriminator value: non_insurance_payer' write_off_id: $ref: '#/components/schemas/type_write-offs_v1_WriteOffId' non_insurance_payer: $ref: '#/components/schemas/type_non-insurance-payers_v1_NonInsurancePayer' service_line_id: $ref: '#/components/schemas/type_commons_ServiceLineId' write_off_timestamp: type: string format: date-time write_off_note: type: string write_off_reason: $ref: '#/components/schemas/type_write-offs_v1_InsuranceWriteOffReason' reverts_write_off_id: $ref: '#/components/schemas/type_write-offs_v1_WriteOffId' reverted_by_write_off_id: $ref: '#/components/schemas/type_write-offs_v1_WriteOffId' amount_cents: type: integer required: - type - write_off_id - non_insurance_payer - service_line_id - write_off_timestamp - write_off_reason - amount_cents discriminator: propertyName: type title: WriteOff type_encounter-providers_v2_ProviderId: type: string format: uuid title: ProviderId type_charge-capture_v1_ChargeCaptureStatus: type: string enum: - planned - not-billable - billable - aborted - entered-in-error title: ChargeCaptureStatus type_encounters_v4_LabCodeType: type: string enum: - quest - labcorp title: LabCodeType type_commons_SortDirection: type: string enum: - asc - desc title: SortDirection type_pre-encounter_organizationExternalProviders_v1_LicenseType: type: string enum: - MD - NP - PA - LMFT - LCPC - LCSW - PMHNP - FNP - LPCC - DO - RD - SLP - APRN - LPC - PHD - PSYD - LMSW - LMHC - OTHER_MASTERS - BCBA - UNKNOWN - RPH - PHT - LAC - LMT - DC - ND - MA - PT - IBCLC - RN - DPT - LCMHC - CNM - RNFA - ACSW - APC - BCABA - BHA - OD - DPM - DA - DDS - DEH - DMD - PTA - LCADC - LCAT - LCMHCS - LCMHCA - LCSWA - LICSW - LISW - LMFTS - LMFTA - LPCI - LSCSW - MHCA - MHT - RBT - RCSWI - RHMCI - LPN - OTD - OMS - MFTA - APCC - DNP - AGNPBC - ANP - FNPPP - LCSWR - ALC - RMFTI - LAMFT - LPCA - LSWI - CSW - CPC - LGMFT - LLPC - PLPC - PLMFT - LMHCA - CIT - CT - MFT - LSW - PLMHP - PCMSW - LMHP - OTR/L - RPA - COTA - CRNP - SLP-CF - NP-C - PA-C - AMFT - CDN - CGC - CNS - MDPHD - AuD - ATC - LAT title: LicenseType type_individual_PatientUpdateWithOptionalAddress: type: object properties: first_name: type: string last_name: type: string gender: $ref: '#/components/schemas/type_individual_Gender' external_id: type: string description: The ID used to identify this individual in your system. For example, your internal patient ID or an EHR patient ID. date_of_birth: type: string format: date description: Box 3 on the CMS-1500 claim form or Form Locator 10 on a UB-04 claim form. The date format should be in ISO 8601 date; formatted YYYY-MM-DD (i.e. 2012-02-01) address: $ref: '#/components/schemas/type_commons_StreetAddressShortZipOptional' description: Box 5 on the CMS-1500 claim form or Form Locator 9 on a UB-04 claim form. phone_numbers: type: array items: $ref: '#/components/schemas/type_commons_PhoneNumberOptional' phone_consent: type: boolean email: $ref: '#/components/schemas/type_commons_Email' email_consent: type: boolean auto_charge_consent: type: boolean non_insurance_payers: type: array items: $ref: '#/components/schemas/type_non-insurance-payers_v1_NonInsurancePayerId' description: On update, we will replace the existing list of non-insurance payers with the new list if populated. non_insurance_payers_info: type: array items: $ref: '#/components/schemas/type_individual_PatientNonInsurancePayerInfoCreateOptional' description: On update, we will replace the existing list of non-insurance payers with the new list if populated. title: PatientUpdateWithOptionalAddress type_health-care-code-information_v1_OccurrenceInformation: type: object properties: id: type: string format: uuid description: 'The id of this health care code information if it is already stored. If this is not set, this is referring to a new health care code information to be added to the encounter. If it is set, this refers to an update of an existing health care code information object on the encounter.' encounter_id: $ref: '#/components/schemas/type_commons_EncounterId' description: 'The encounter_id of this health care code information if it is already stored. This will be set by the server in responses, but clients are not expected to set it.' occurrence_code_qualifier: $ref: '#/components/schemas/type_health-care-code-information_v1_OccurrenceInformationCodeQualifier' occurrence_code: $ref: '#/components/schemas/type_health-care-code-information_v1_OccurrenceCode' occurrence_date: $ref: '#/components/schemas/type_health-care-code-information_v1_D8Date' description: 'An [RFC 3339, section 5.6 datetime](https://ijmacd.github.io/rfc3339-iso8601/). For example, 2017-07-21T17:32:28Z. In practice, only the date portion of this is used for claim submission, so midnight time is fine.' required: - occurrence_code_qualifier - occurrence_code - occurrence_date description: This corresponds to the BH code qualifier value. title: OccurrenceInformation type_health-care-code-information_v1_TreatmentCode: type: string title: TreatmentCode type_x12_v1_RemittanceAdviceRemarkCode: type: object properties: reason_code: $ref: '#/components/schemas/type_x12_v1_Rarc' required: - reason_code title: RemittanceAdviceRemarkCode type_pre-encounter_common_CanonicalClinicalTrialAssociation: type: object properties: id: $ref: '#/components/schemas/type_pre-encounter_common_CanonicalClinicalTrialId' clinical_trial_arm: type: string period: $ref: '#/components/schemas/type_pre-encounter_common_Period' required: - id title: CanonicalClinicalTrialAssociation type_pre-encounter_common_UserId: type: string description: The unique identifier for a User in the database title: UserId type_pre-encounter_common_SexualOrientation: type: string enum: - HETEROSEXUAL - HOMOSEXUAL - BISEXUAL - TWO_SPIRIT - OTHER - UNKNOWN - REFUSED title: SexualOrientation type_encounter-providers_v2_RenderingProviderUpdateWithOptionalAddress: type: object properties: first_name: type: string description: If the provider is an individual, this should be set instead of organization name last_name: type: string description: If the provider is an individual, this should be set instead of organization name organization_name: type: string description: If the provider is an organization, this should be set instead of first + last name npi: type: string description: 'A National Provider Identifier is a unique 10-digit identification number issued to health care providers in the United States' taxonomy_code: type: string address: $ref: '#/components/schemas/type_commons_StreetAddressShortZipOptional' secondary_identification: $ref: '#/components/schemas/type_encounter-providers_v2_ProviderSecondaryIdentificationOptional' description: 'Only one of provider_commercial_license_type or secondary_identification may be provided 837i Loop2310BB G2 Secondary Identification' title: RenderingProviderUpdateWithOptionalAddress type_pre-encounter_appointments_v1_AppointmentStatus: type: string enum: - PENDING - NOT_READY - READY - CHECKED_IN title: AppointmentStatus type_commons_Npi: type: string title: Npi type_pre-encounter_patients_v1_MutablePatient: type: object properties: name: $ref: '#/components/schemas/type_pre-encounter_common_HumanName' other_names: type: array items: $ref: '#/components/schemas/type_pre-encounter_common_HumanName' description: Other names for the patient. other_identifiers: type: array items: $ref: '#/components/schemas/type_pre-encounter_common_ExternalIdentifier' description: Other identifiers for the patient. gender: $ref: '#/components/schemas/type_pre-encounter_common_Gender' birth_date: type: string format: date social_security_number: type: string biological_sex: $ref: '#/components/schemas/type_pre-encounter_common_Sex' description: The biological sex of the patient. This corresponds to the HL7 AdministrativeGender https://www.hl7.org/fhir/valueset-administrative-gender.html sexual_orientation: $ref: '#/components/schemas/type_pre-encounter_common_SexualOrientation' description: The sexual orientation of the patient. pronouns: type: array items: type: string description: The pronouns of the patient. race: $ref: '#/components/schemas/type_pre-encounter_common_Race' ethnicity: $ref: '#/components/schemas/type_pre-encounter_common_Ethnicity' disability_status: $ref: '#/components/schemas/type_pre-encounter_common_DisabilityStatus' marital_status: $ref: '#/components/schemas/type_pre-encounter_patients_v1_MaritalStatus' deceased: type: string format: date-time description: Time of death for the patient. Leave unset if the patient is not deceased. multiple_birth: type: integer description: The number of siblings the patient was born with. Leave unset if the patient was not part of a multiple birth. primary_address: $ref: '#/components/schemas/type_pre-encounter_common_Address' description: The primary address for the patient. other_addresses: type: array items: $ref: '#/components/schemas/type_pre-encounter_common_Address' description: Other addresses for the patient. primary_telecom: $ref: '#/components/schemas/type_pre-encounter_common_ContactPoint' description: The primary phone number for the patient. other_telecoms: type: array items: $ref: '#/components/schemas/type_pre-encounter_common_ContactPoint' description: Other phone numbers for the patient. email: type: string electronic_communication_opt_in: type: boolean description: Use electronic_communication_consent for granular channel-level consent. This field is kept in sync automatically but should not be used for new integrations. electronic_communication_consent: $ref: '#/components/schemas/type_pre-encounter_patients_v1_ElectronicCommunicationConsent' description: Granular consent for electronic communication channels. photo: type: string language: type: string external_provenance: $ref: '#/components/schemas/type_pre-encounter_patients_v1_ExternalProvenance' description: Information about the upstream system that owns this patient data. Leave unset if Candid owns patient data. contacts: type: array items: $ref: '#/components/schemas/type_pre-encounter_patients_v1_Contact' description: Contacts for the patient. general_practitioners: type: array items: $ref: '#/components/schemas/type_pre-encounter_common_ExternalProvider' filing_order: $ref: '#/components/schemas/type_pre-encounter_patients_v1_FilingOrder' coverages_for_related_causes: $ref: '#/components/schemas/type_pre-encounter_patients_v1_CoveragesForRelatedCauses' non_insurance_payers: type: array items: $ref: '#/components/schemas/type_pre-encounter_common_CanonicalNonInsurancePayerId' non_insurance_payer_associations: type: array items: $ref: '#/components/schemas/type_pre-encounter_common_CanonicalNonInsurancePayerAssociation' guarantor: $ref: '#/components/schemas/type_pre-encounter_patients_v1_Guarantor' self_pay: type: boolean authorizations: type: array items: $ref: '#/components/schemas/type_pre-encounter_patients_v1_Authorization' referrals: type: array items: $ref: '#/components/schemas/type_pre-encounter_patients_v1_Referral' primary_service_facility_id: type: string service_facilities: type: array items: $ref: '#/components/schemas/type_pre-encounter_common_PatientServiceFacility' description: Associated service facilities for this patient. do_not_invoice_reason: $ref: '#/components/schemas/type_pre-encounter_patients_v1_DoNotInvoiceReason' description: If this value is defined, the customer will not be invoiced. note_ids: type: array items: $ref: '#/components/schemas/type_pre-encounter_common_NoteId' tag_ids: type: array items: $ref: '#/components/schemas/type_pre-encounter_common_TagId' origination_detail: $ref: '#/components/schemas/type_pre-encounter_patients_v1_OriginationDetail' description: Information about the patient source, if applicable. inferred_patient_metadata: $ref: '#/components/schemas/type_pre-encounter_patients_v1_InferredPatientMetadata' description: Metadata for the patient used for patient inference from encounters. orcon: type: boolean description: ORCON (Originator Controlled) - When set to true, the Candid system will hide this patient from downstream integrations. Updates made in the Candid UI will unset this flag. Defaults to false. advanced_directives: type: array items: $ref: '#/components/schemas/type_pre-encounter_patients_v1_AdvancedDirective' hipaa_code: type: string required: - name - other_names - birth_date - biological_sex - primary_address - other_addresses - other_telecoms - contacts - general_practitioners - filing_order description: An object representing patient demographics information. title: MutablePatient type_service-facility_ServiceFacilityId: type: string format: uuid title: ServiceFacilityId type_encounter-supplemental-information_v1_AttachmentInclusion: type: string enum: - not_included - included_on_next_submission - included_on_all_submissions title: AttachmentInclusion type_pre-encounter_coverages_v1_ServiceTypeCode: type: string enum: - '1' - '2' - '3' - '4' - '5' - '6' - '7' - '8' - '9' - '10' - '11' - '12' - '13' - '14' - '15' - '16' - '17' - '18' - '19' - '20' - '21' - '22' - '23' - '24' - '25' - '26' - '27' - '28' - '30' - '32' - '33' - '34' - '35' - '36' - '37' - '38' - '39' - '40' - '41' - '42' - '43' - '44' - '45' - '46' - '47' - '48' - '49' - '50' - '51' - '52' - '53' - '54' - '55' - '56' - '57' - '58' - '59' - '60' - '61' - '62' - '63' - '64' - '65' - '66' - '67' - '68' - '69' - '70' - '71' - '72' - '73' - '74' - '75' - '76' - '77' - '78' - '79' - '80' - '81' - '82' - '83' - '84' - '85' - '86' - '87' - '88' - '89' - '90' - '91' - '92' - '93' - '94' - '95' - '96' - '97' - '98' - '99' - A0 - A1 - A2 - A3 - A4 - A5 - A6 - A7 - A8 - A9 - AA - AB - AC - AD - AE - AF - AG - AH - AI - AJ - AK - AL - AM - AN - AO - AQ - AR - B1 - B2 - B3 - BA - BB - BC - BD - BE - BF - BG - BH - BI - BJ - BK - BL - BM - BN - BP - BQ - BR - BS - BT - BU - BV - BW - BX - BY - BZ - C1 - CA - CB - CC - CD - CE - CF - CG - CH - CI - CJ - CK - CL - CM - CN - CO - CP - CQ - DG - DM - DS - GF - GN - GY - IC - MH - NI - 'ON' - PT - PU - RN - RT - TC - TN - UC description: Code identifying the type of service or benefit within a specific insurance policy (X12 008010 Element 1365) title: ServiceTypeCode type_pre-encounter_appointments_v1_Visit: type: object properties: patient_id: $ref: '#/components/schemas/type_pre-encounter_common_PatientId' organization_id: $ref: '#/components/schemas/type_pre-encounter_common_OrganizationId' patient: $ref: '#/components/schemas/type_pre-encounter_patients_v1_MutablePatientWithMrn' start_time: type: string format: date-time status: $ref: '#/components/schemas/type_pre-encounter_appointments_v1_AppointmentStatus' primary_coverage_status: $ref: '#/components/schemas/type_pre-encounter_coverages_v1_CoverageStatus' secondary_coverage_status: $ref: '#/components/schemas/type_pre-encounter_coverages_v1_CoverageStatus' primary_payer_name: type: string primary_payer_plan_group_id: $ref: '#/components/schemas/type_pre-encounter_common_PayerPlanGroupId' secondary_payer_name: type: string secondary_payer_plan_group_id: $ref: '#/components/schemas/type_pre-encounter_common_PayerPlanGroupId' required: - patient_id - organization_id - patient - start_time - status description: A visit is a collection of appointments that occur on the same day. title: Visit type_encounters_v4_ClinicalNoteCategory: type: object properties: category: $ref: '#/components/schemas/type_encounters_v4_NoteCategory' notes: type: array items: type: string notes_structured: type: array items: $ref: '#/components/schemas/type_encounters_v4_ClinicalNote' required: - category - notes title: ClinicalNoteCategory type_pre-encounter_eligibilityChecks_v1_Provider: oneOf: - $ref: '#/components/schemas/type_pre-encounter_eligibilityChecks_v1_IndividualProvider' - $ref: '#/components/schemas/type_pre-encounter_eligibilityChecks_v1_OrganizationProvider' title: Provider type_commons_FacilityTypeCode: type: string enum: - '01' - '02' - '03' - '04' - '05' - '06' - '07' - 08 - 09 - '10' - '11' - '12' - '13' - '14' - '15' - '16' - '17' - '18' - '19' - '20' - '21' - '22' - '23' - '24' - '25' - '26' - '31' - '32' - '33' - '34' - '41' - '42' - '49' - '50' - '51' - '52' - '53' - '54' - '55' - '56' - '57' - '58' - '60' - '61' - '62' - '65' - '71' - '72' - '81' - '99' description: 'Box 24B on the CMS-1500 claim form. Line-level place of service is not currently supported. 02 for telemedicine, 11 for in-person. Full list here: https://www.cms.gov/Medicare/Coding/place-of-service-codes/Place_of_Service_Code_Set' title: FacilityTypeCode type_health-care-code-information_v1_ExternalCauseOfInjuryCodeQualifier: type: string enum: - BN - ABN title: ExternalCauseOfInjuryCodeQualifier type_charge-capture-bundles_v1_ChargeCaptureClaimCreationPage: type: object properties: prev_page_token: $ref: '#/components/schemas/type_commons_PageToken' next_page_token: $ref: '#/components/schemas/type_commons_PageToken' items: type: array items: $ref: '#/components/schemas/type_charge-capture-bundles_v1_ChargeCaptureClaimCreation' required: - items title: ChargeCaptureClaimCreationPage type_financials_AllocationEarmarkType: oneOf: - type: object properties: type: type: string enum: - date_of_service description: 'Discriminator value: date_of_service' value: $ref: '#/components/schemas/type_commons_Date' required: - type - value description: Earmark for auto-allocation to an encounter with this specific date of service - type: object properties: type: type: string enum: - external_encounter_id description: 'Discriminator value: external_encounter_id' value: $ref: '#/components/schemas/type_commons_EncounterExternalId' required: - type - value description: Earmark for auto-allocation to an encounter with this specific external ID (more specific than date of service) discriminator: propertyName: type description: 'If enabled for your organization, defines how a patient prepayment allocation should be earmarked for future auto-allocation. Earmarks hold the allocation until a matching encounter is created, then attempt to allocate to that encounter. Only applicable for unattributed allocations.' title: AllocationEarmarkType type_service-facility_EncounterServiceFacility: type: object properties: service_facility_id: $ref: '#/components/schemas/type_service-facility_ServiceFacilityId' organization_name: type: string npi: type: string description: 'An NPI specific to the service facility if applicable, i.e. if it has one and is not under the billing provider''s NPI. Box 32 section (a) of the CMS-1500 claim form.' address: $ref: '#/components/schemas/type_commons_StreetAddressLongZip' description: zip_plus_four_code is required for service facility address. When the zip_plus_four_code is not available use "9998" as per CMS documentation. secondary_identification: type: string description: 'An additional identifier for the service facility other than the facility''s NPI. Some payers may require this field. Potential examples: state license number, provider commercial number, or location number. Box 32 section (b) of the CMS-1500 claim form.' mammography_certification_number: type: string description: The associated mammography certification number for this service facility. This is a 6 digit code assigned by the FDA. required: - service_facility_id - organization_name - address title: EncounterServiceFacility type_pre-encounter_eligibilityChecks_v1_ParsedResponse: type: object properties: eligibility_status: $ref: '#/components/schemas/type_pre-encounter_eligibilityChecks_v1_EligibilityStatus' plan_metadata: $ref: '#/components/schemas/type_pre-encounter_coverages_v1_PlanMetadata' benefits: $ref: '#/components/schemas/type_pre-encounter_coverages_v1_CoverageBenefits' required: - eligibility_status title: ParsedResponse type_financials_AccountType: type: string enum: - PATIENT - INSURANCE - THIRD_PARTY_PAYER title: AccountType type_pre-encounter_patients_v1_MutablePatientWithMrn: type: object properties: name: $ref: '#/components/schemas/type_pre-encounter_common_HumanName' other_names: type: array items: $ref: '#/components/schemas/type_pre-encounter_common_HumanName' description: Other names for the patient. other_identifiers: type: array items: $ref: '#/components/schemas/type_pre-encounter_common_ExternalIdentifier' description: Other identifiers for the patient. gender: $ref: '#/components/schemas/type_pre-encounter_common_Gender' birth_date: type: string format: date social_security_number: type: string biological_sex: $ref: '#/components/schemas/type_pre-encounter_common_Sex' description: The biological sex of the patient. This corresponds to the HL7 AdministrativeGender https://www.hl7.org/fhir/valueset-administrative-gender.html sexual_orientation: $ref: '#/components/schemas/type_pre-encounter_common_SexualOrientation' description: The sexual orientation of the patient. pronouns: type: array items: type: string description: The pronouns of the patient. race: $ref: '#/components/schemas/type_pre-encounter_common_Race' ethnicity: $ref: '#/components/schemas/type_pre-encounter_common_Ethnicity' disability_status: $ref: '#/components/schemas/type_pre-encounter_common_DisabilityStatus' marital_status: $ref: '#/components/schemas/type_pre-encounter_patients_v1_MaritalStatus' deceased: type: string format: date-time description: Time of death for the patient. Leave unset if the patient is not deceased. multiple_birth: type: integer description: The number of siblings the patient was born with. Leave unset if the patient was not part of a multiple birth. primary_address: $ref: '#/components/schemas/type_pre-encounter_common_Address' description: The primary address for the patient. other_addresses: type: array items: $ref: '#/components/schemas/type_pre-encounter_common_Address' description: Other addresses for the patient. primary_telecom: $ref: '#/components/schemas/type_pre-encounter_common_ContactPoint' description: The primary phone number for the patient. other_telecoms: type: array items: $ref: '#/components/schemas/type_pre-encounter_common_ContactPoint' description: Other phone numbers for the patient. email: type: string electronic_communication_opt_in: type: boolean description: Use electronic_communication_consent for granular channel-level consent. This field is kept in sync automatically but should not be used for new integrations. electronic_communication_consent: $ref: '#/components/schemas/type_pre-encounter_patients_v1_ElectronicCommunicationConsent' description: Granular consent for electronic communication channels. photo: type: string language: type: string external_provenance: $ref: '#/components/schemas/type_pre-encounter_patients_v1_ExternalProvenance' description: Information about the upstream system that owns this patient data. Leave unset if Candid owns patient data. contacts: type: array items: $ref: '#/components/schemas/type_pre-encounter_patients_v1_Contact' description: Contacts for the patient. general_practitioners: type: array items: $ref: '#/components/schemas/type_pre-encounter_common_ExternalProvider' filing_order: $ref: '#/components/schemas/type_pre-encounter_patients_v1_FilingOrder' coverages_for_related_causes: $ref: '#/components/schemas/type_pre-encounter_patients_v1_CoveragesForRelatedCauses' non_insurance_payers: type: array items: $ref: '#/components/schemas/type_pre-encounter_common_CanonicalNonInsurancePayerId' non_insurance_payer_associations: type: array items: $ref: '#/components/schemas/type_pre-encounter_common_CanonicalNonInsurancePayerAssociation' guarantor: $ref: '#/components/schemas/type_pre-encounter_patients_v1_Guarantor' self_pay: type: boolean authorizations: type: array items: $ref: '#/components/schemas/type_pre-encounter_patients_v1_Authorization' referrals: type: array items: $ref: '#/components/schemas/type_pre-encounter_patients_v1_Referral' primary_service_facility_id: type: string service_facilities: type: array items: $ref: '#/components/schemas/type_pre-encounter_common_PatientServiceFacility' description: Associated service facilities for this patient. do_not_invoice_reason: $ref: '#/components/schemas/type_pre-encounter_patients_v1_DoNotInvoiceReason' description: If this value is defined, the customer will not be invoiced. note_ids: type: array items: $ref: '#/components/schemas/type_pre-encounter_common_NoteId' tag_ids: type: array items: $ref: '#/components/schemas/type_pre-encounter_common_TagId' origination_detail: $ref: '#/components/schemas/type_pre-encounter_patients_v1_OriginationDetail' description: Information about the patient source, if applicable. inferred_patient_metadata: $ref: '#/components/schemas/type_pre-encounter_patients_v1_InferredPatientMetadata' description: Metadata for the patient used for patient inference from encounters. orcon: type: boolean description: ORCON (Originator Controlled) - When set to true, the Candid system will hide this patient from downstream integrations. Updates made in the Candid UI will unset this flag. Defaults to false. advanced_directives: type: array items: $ref: '#/components/schemas/type_pre-encounter_patients_v1_AdvancedDirective' hipaa_code: type: string mrn: type: string description: The medical record number for the patient. required: - name - other_names - birth_date - biological_sex - primary_address - other_addresses - other_telecoms - contacts - general_practitioners - filing_order - mrn title: MutablePatientWithMrn type_pre-encounter_tags_v1_TagPage: type: object properties: next_page_token: $ref: '#/components/schemas/type_pre-encounter_common_PageToken' prev_page_token: $ref: '#/components/schemas/type_pre-encounter_common_PageToken' total: type: integer items: type: array items: $ref: '#/components/schemas/type_pre-encounter_tags_v1_Tag' required: - total - items title: TagPage type_pre-encounter_common_Period: type: object properties: start: type: string format: date end: type: string format: date title: Period type_invoices_v2_UnattributedInvoiceItem: type: object properties: amount_cents: type: integer required: - amount_cents title: UnattributedInvoiceItem type_pre-encounter_coverages_v1_CoverageLevel: type: string enum: - EMPLOYEE_AND_CHILDREN - EMPLOYEE_ONLY - EMPLOYEE_AND_SPOUSE - FAMILY - INDIVIDUAL title: CoverageLevel type_pre-encounter_eligibilityChecks_v1_EligibilityCheckStatus: type: string enum: - COMPLETED - FAILED - PENDING description: enum to represent the status of an eligibility checks title: EligibilityCheckStatus type_x12_v1_PointOfOriginForAdmissionOrVisitCode: type: string enum: - '1' - '2' - '4' - '5' - '6' - '8' - '9' - D - E - F - G title: PointOfOriginForAdmissionOrVisitCode type_insurance-refunds_v1_InsuranceRefundCreate: type: object properties: payer_identifier: $ref: '#/components/schemas/type_payers_v3_PayerIdentifier' amount_cents: type: integer refund_timestamp: type: string format: date-time refund_note: type: string allocations: type: array items: $ref: '#/components/schemas/type_financials_AllocationCreate' refund_reason: $ref: '#/components/schemas/type_financials_RefundReason' required: - payer_identifier - amount_cents - allocations title: InsuranceRefundCreate type_encounters_v4_IntakeFollowUpId: type: string title: IntakeFollowUpId type_charge-capture-bundles_v1_ChargeCaptureClaimCreationSortField: type: string enum: - created_at title: ChargeCaptureClaimCreationSortField type_pre-encounter_coverages_v1_CarveOutType: type: string enum: - BEHAVIORAL - MEDICAL - THERAPY title: CarveOutType type_write-offs_v1_WriteOffId: type: string format: uuid title: WriteOffId type_superbills_v1_SuperbillOutputFormat: type: string enum: - DOCX - PDF description: Output format for the generated superbill. title: SuperbillOutputFormat type_commons_PatientRelationshipToInsuredCodeAll: type: string enum: - '01' - '04' - '05' - '07' - '10' - '15' - '17' - '18' - '19' - '20' - '21' - '22' - '23' - '24' - '29' - '32' - '33' - '36' - '39' - '40' - '41' - '43' - '53' - G8 title: PatientRelationshipToInsuredCodeAll type_pre-encounter_common_Sex: type: string enum: - FEMALE - MALE - UNKNOWN - REFUSED title: Sex type_charge-capture-bundles_v1_ChargeCaptureClaimCreationStatus: type: string enum: - not-started - in-error - successful - successful-dry-run - aborted - held title: ChargeCaptureClaimCreationStatus type_pre-encounter_patients_v1_Authorization: type: object properties: payer_id: $ref: '#/components/schemas/type_pre-encounter_common_PayerId' payer_name: type: string additional_payer_information: $ref: '#/components/schemas/type_pre-encounter_common_AdditionalPayerInformation' authorization_number: type: string cpt_code: type: string apply_for_all_cpt_codes: type: boolean description: If true, then the authorization will apply for all claims for the payer that fall in range the `period`. no_prior_authorization_required: type: boolean description: If true, indicates that prior authorization is not required and prior authorization number will not be set on the claim for this authorization. units: $ref: '#/components/schemas/type_pre-encounter_patients_v1_AuthorizationUnit' quantity: type: integer period: $ref: '#/components/schemas/type_pre-encounter_common_Period' notes: type: string billing_provider_npi: type: string description: The NPI of the billing provider for which this authorization applies. service_facility: $ref: '#/components/schemas/type_pre-encounter_common_PatientServiceFacility' description: When set, specifies the service facility for which this authorization applies. dx_codes: type: array items: type: string description: When set, the authorization will only apply when at least one of these diagnosis codes is found on the claim/service lines (in addition to other criteria). required: - payer_id - payer_name - authorization_number - cpt_code - units title: Authorization type_pre-encounter_eligibilityChecks_v1_RequestCorrection: type: object properties: property: type: string request_value: type: string corrected_value: type: string required: - property - request_value - corrected_value title: RequestCorrection type_pre-encounter_eligibilityChecks_v1_InsuranceDiscoveryDependent: type: object properties: first_name: type: string description: The dependent's first name. last_name: type: string description: The dependent's last name. middle_name: type: string description: The dependent's middle name or initial. date_of_birth: type: string description: The dependent's date of birth, formatted as YYYYMMDD. ssn: type: string description: The dependent's Social Security Number (SSN). gender: $ref: '#/components/schemas/type_pre-encounter_eligibilityChecks_v1_InsuranceDiscoveryGender' address: $ref: '#/components/schemas/type_pre-encounter_eligibilityChecks_v1_InsuranceDiscoveryAddress' required: - first_name - last_name description: 'Demographic information for the patient when they are a dependent on a health plan. If you only have the dependent''s information, identify them in the subscriber object instead and leave this empty.' title: InsuranceDiscoveryDependent type_non-insurance-payers_v1_NonInsurancePayerCategoriesPage: type: object properties: prev_page_token: $ref: '#/components/schemas/type_commons_PageToken' next_page_token: $ref: '#/components/schemas/type_commons_PageToken' items: type: array items: type: string required: - items title: NonInsurancePayerCategoriesPage type_encounters_v4_InvalidTagNamesErrorType: type: object properties: invalid_tag_names: type: array items: type: string required: - invalid_tag_names title: InvalidTagNamesErrorType type_health-care-code-information_v1_HealthCareCodeInformationUpdate: type: object properties: principal_diagnosis: $ref: '#/components/schemas/type_health-care-code-information_v1_SetOrClearPrincipalDiagnosis' description: Set & Replace semantics. If the id matches the existing principal_diagnosis, that diagnosis is updated in place. If the entry has no id, it is created newly, its id will be in the response, and any existing principal_diagnosis is deleted and removed from any service line pointers. other_diagnosis_information: type: array items: $ref: '#/components/schemas/type_health-care-code-information_v1_OtherDiagnosisInformation' description: Set & Replace semantics. For each entry that has an id, any previous other_diagnosis_information by that id is updated in place. For each entry without an id, it is created newly and its id will be in the response. For each existing entry that was not referred to by id, it is deleted, including having it removed from any service line pointers. admitting_diagnosis: $ref: '#/components/schemas/type_health-care-code-information_v1_SetOrClearAdmittingDiagnosis' description: Set & Replace semantics. If the id matches the existing admitting_diagnosis, that diagnosis is updated in place. If the entry has no id, it is created newly, its id will be in the response, and any existing principal_diagnosis is deleted. This object only applies to 837i institutional claim forms. patient_reasons_for_visit: type: array items: $ref: '#/components/schemas/type_health-care-code-information_v1_PatientReasonForVisit' description: Set & Replace semantics. For each entry that has an id, any previous patient_reasons_for_visit by that id is updated in place. For each entry without an id, it is created newly and its id will be in the response. For each existing entry that was not referred to by id, it is deleted. This object only applies to 837i institutional claim forms. external_causes_of_injury: type: array items: $ref: '#/components/schemas/type_health-care-code-information_v1_ExternalCauseOfInjury' description: Set & Replace semantics. For each entry that has an id, any previous external_causes_of_injury by that id is updated in place. For each entry without an id, it is created newly and its id will be in the response. For each existing entry that was not referred to by id, it is deleted. This object only applies to 837i institutional claim forms. diagnosis_related_groups: $ref: '#/components/schemas/type_health-care-code-information_v1_SetOrClearDiagnosisRelatedGroup' description: Set & Replace semantics. If the id matches the existing diagnosis_related_groups, that diagnosis_related_group is updated in place. If the entry has no id, it is created newly, its id will be in the response, and any existing diagnosis_related_groups is deleted. This object only applies to 837i institutional claim forms. principal_procedure: $ref: '#/components/schemas/type_health-care-code-information_v1_SetOrClearPrincipalProcedureInformation' description: Set & Replace semantics. If the id matches the existing principal_procedure, that principal_procedure is updated in place. If the entry has no id, it is created newly, its id will be in the response, and any existing principal_procedure is deleted. This object only applies to 837i institutional claim forms. other_procedure_information: type: array items: $ref: '#/components/schemas/type_health-care-code-information_v1_OtherProcedureInformation' description: Set & Replace semantics. For each entry that has an id, any previous other_procedure_information by that id is updated in place. For each entry without an id, it is created newly and its id will be in the response. For each existing entry that was not referred to by id, it is deleted. This object only applies to 837i institutional claim forms. occurrence_span_information: type: array items: $ref: '#/components/schemas/type_health-care-code-information_v1_OccurrenceSpanInformation' description: Set & Replace semantics. For each entry that has an id, any previous occurrence_span_information by that id is updated in place. For each entry without an id, it is created newly and its id will be in the response. For each existing entry that was not referred to by id, it is deleted. This object only applies to 837i institutional claim forms. occurrence_information: type: array items: $ref: '#/components/schemas/type_health-care-code-information_v1_OccurrenceInformation' description: Set & Replace semantics. For each entry that has an id, any previous occurrence_information by that id is updated in place. For each entry without an id, it is created newly and its id will be in the response. For each existing entry that was not referred to by id, it is deleted. This object only applies to 837i institutional claim forms. treatment_code_information: type: array items: $ref: '#/components/schemas/type_health-care-code-information_v1_TreatmentCodeInformation' description: Set & Replace semantics. For each entry that has an id, any previous treatment_code_information by that id is updated in place. For each entry without an id, it is created newly and its id will be in the response. For each existing entry that was not referred to by id, it is deleted. This object only applies to 837i institutional claim forms. value_information: type: array items: $ref: '#/components/schemas/type_health-care-code-information_v1_ValueInformation' description: Set & Replace semantics. For each entry that has an id, any previous value_information by that id is updated in place. For each entry without an id, it is created newly and its id will be in the response. For each existing entry that was not referred to by id, it is deleted. This object only applies to 837i institutional claim forms. condition_information: type: array items: $ref: '#/components/schemas/type_health-care-code-information_v1_ConditionInformation' description: Set & Replace semantics. For each entry that has an id, any previous condition_information by that id is updated in place. For each entry without an id, it is created newly and its id will be in the response. For each existing entry that was not referred to by id, it is deleted. This object only applies to 837i institutional claim forms. title: HealthCareCodeInformationUpdate type_insurance-cards_v2_InsuranceCard: type: object properties: group_number: type: string description: Box 11 on the CMS-1500 claim form. plan_name: type: string description: Box 11c on the CMS-1500 claim form. plan_type: $ref: '#/components/schemas/type_commons_SourceOfPaymentCode' insurance_type: $ref: '#/components/schemas/type_commons_InsuranceTypeCode' payer_plan_group_id: $ref: '#/components/schemas/type_commons_PayerPlanGroupId' payer_address: $ref: '#/components/schemas/type_commons_StreetAddressLongZip' insurance_card_id: $ref: '#/components/schemas/type_insurance-cards_v2_InsuranceCardId' member_id: type: string payer_name: type: string payer_id: type: string rx_bin: type: string rx_pcn: type: string image_url_front: type: string image_url_back: type: string payer_uuid: $ref: '#/components/schemas/type_payers_v4_PayerUuid' required: - insurance_card_id - member_id - payer_name - payer_id title: InsuranceCard type_diagnoses_DiagnosisCreateOptional: type: object properties: name: type: string description: Empty string not allowed. code_type: $ref: '#/components/schemas/type_diagnoses_DiagnosisTypeCode' description: Typically, providers submitting claims to Candid are using ICD-10 diagnosis codes. If you are using ICD-10 codes, the primary diagnosis code listed on the claim should use the ABK code_type. If more than one diagnosis is being submitted on a claim, please use ABF for the rest of the listed diagnoses. If you are using ICD-9 diagnosis codes, use BK and BF for the principal and following diagnosis code(s) respectively. code: type: string description: "Empty string not allowed.\nShould be of the appropriate format for the provided `code_type`.\nMust obey the ICD-10 format if an ICD-10 code_type is provided, specifically:\n - Letter\n - Digit\n - Digit or the letter `A` or `B`\n - (Optional) Period `.`\n - Up to 4 (or as few as 0) letters and digits" present_on_admission_indicator: $ref: '#/components/schemas/type_yes-no-indicator_YesNoIndicator' description: 'For Institutional claims only. A "Y" indicates that the onset occurred prior to admission to the hospital. An "N" indicates that the onset did NOT occur prior to admission to the hospital. A "U" indicates that it is unknown whether the onset occurred prior to admission to the hospital or not.' title: DiagnosisCreateOptional type_write-offs_v1_InsuranceWriteOffReason: type: string enum: - SMALL_BALANCE - NO_AUTHORIZATION_REFERRAL - TIMELY_FILING - STALE_DATE - TIMELY_FILING_LATE_ENCOUNTER - CREDENTIALING_OR_CONTRACTING - NON_COVERED_MAX_BENEFIT - NOT_MEDICALLY_NECESSARY - BUNDLED_OR_INCLUSIVE - UNCOLLECTIBLE_OR_NON_BILLABLE - EFFORTS_EXHAUSTED - ADMINISTRATIVE_WRITE_OFF - CASE_RATE_OR_CAPITATED - OTHER - UNKNOWN - CONTRACTUAL_ADJUSTMENT - PRIMARY_PAID_MAX_BENEFITS - INTEREST title: InsuranceWriteOffReason type_pre-encounter_common_VersionConflictErrorBody: type: object properties: message: type: string data: description: Any type latest_version: type: integer required: - message title: VersionConflictErrorBody 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_custom-schemas_v1_SchemaField: type: object properties: key: type: string type: $ref: '#/components/schemas/type_commons_Primitive' required: - key - type title: SchemaField type_pre-encounter_organizationExternalProviders_v1_MutableOrganizationExternalProvider: type: object properties: name: $ref: '#/components/schemas/type_pre-encounter_common_HumanName' types: type: array items: $ref: '#/components/schemas/type_pre-encounter_organizationExternalProviders_v1_OrganizationExternalProviderType' npi: type: string tax_id: type: string taxonomy_code: type: string phone_number: type: string other_phone_numbers: type: array items: type: string fax_number: type: string other_fax_numbers: type: array items: type: string emails: type: array items: type: string license_type: $ref: '#/components/schemas/type_pre-encounter_organizationExternalProviders_v1_LicenseType' addresses: type: array items: $ref: '#/components/schemas/type_pre-encounter_common_Address' required: - name - types description: An object representing an organization-level external provider. title: MutableOrganizationExternalProvider type_health-care-code-information_v1_OccurrenceCode: type: string enum: - '01' - '02' - '03' - '04' - '05' - '06' - 09 - '10' - '11' - '12' - '16' - '17' - '18' - '19' - '20' - '21' - '22' - '24' - '25' - '26' - '27' - '28' - '29' - '30' - '31' - '32' - '33' - '34' - '35' - '36' - '37' - '38' - '39' - '40' - '41' - '42' - '43' - '44' - '45' - '46' - '47' - '50' - '51' - '52' - '54' - '55' - '56' - '61' - '62' - A1 - A2 - A3 - A4 - B1 - B2 - B3 - C1 - C2 - C3 title: OccurrenceCode type_charge-capture_v1_ChargeCapturePage: type: object properties: prev_page_token: $ref: '#/components/schemas/type_commons_PageToken' next_page_token: $ref: '#/components/schemas/type_commons_PageToken' items: type: array items: $ref: '#/components/schemas/type_charge-capture_v1_ChargeCapture' item_count: type: integer required: - items - item_count title: ChargeCapturePage type_health-care-code-information_v1_DiagnosisRelatedGroup: type: object properties: id: type: string format: uuid description: 'The id of this health care code information if it is already stored. If this is not set, this is referring to a new health care code information to be added to the encounter. If it is set, this refers to an update of an existing health care code information object on the encounter.' encounter_id: $ref: '#/components/schemas/type_commons_EncounterId' description: 'The encounter_id of this health care code information if it is already stored. This will be set by the server in responses, but clients are not expected to set it.' diagnosis_related_group_code_qualifier: $ref: '#/components/schemas/type_health-care-code-information_v1_DiagnosisRelatedGroupCodeQualifier' diagnosis_related_group_code: $ref: '#/components/schemas/type_health-care-code-information_v1_MSDRGCode' required: - diagnosis_related_group_code_qualifier - diagnosis_related_group_code description: This corresponds to DR code qualifier values. title: DiagnosisRelatedGroup type_encounters_v4_IntakeQuestionId: type: string title: IntakeQuestionId type_individual_Gender: type: string enum: - male - female - other - not_given - unknown title: Gender type_encounters_v4_ClinicalNoteCategoryCreateOptional: type: object properties: category: $ref: '#/components/schemas/type_encounters_v4_NoteCategory' notes: type: array items: $ref: '#/components/schemas/type_encounters_v4_ClinicalNoteOptional' title: ClinicalNoteCategoryCreateOptional type_pre-encounter_coverages_v1_NetworkType: type: string enum: - 09 - '11' - '12' - '13' - '14' - '15' - '16' - '17' - AM - BL - CH - CI - DS - FI - HM - LM - MA - MB - MC - OF - TV - VA - WC - ZZ title: NetworkType type_commons_DelayReasonCode: type: string enum: - '1' - '2' - '3' - '4' - '5' - '6' - '7' - '8' - '9' - '10' - '11' - '15' - '16' - '17' description: Code indicating the reason why a request was delayed title: DelayReasonCode type_pre-encounter_eligibilityChecks_v1_PostEligibilityRecommendationRequest: type: object properties: eligibility_check_id: type: string patient: $ref: '#/components/schemas/type_pre-encounter_eligibilityChecks_v1_EligibilityRecommendationPatientInfo' recommendation: $ref: '#/components/schemas/type_pre-encounter_eligibilityChecks_v1_EligibilityRecommendationPayload' required: - eligibility_check_id - patient - recommendation title: PostEligibilityRecommendationRequest type_non-insurance-payers_v1_CreateNonInsurancePayerRequest: type: object properties: name: type: string description: Max 50 characters allowed description: type: string description: Max 255 characters allowed category: type: string description: Max 255 characters allowed address: $ref: '#/components/schemas/type_commons_StreetAddressShortZip' clinical_trials: type: array items: $ref: '#/components/schemas/type_clinical-trials_v1_MutableClinicalTrial' description: The same name cannot be used across several clinical trials required: - name title: CreateNonInsurancePayerRequest type_insurance-adjudications_v1_InsuranceAdjudicationId: type: string format: uuid title: InsuranceAdjudicationId type_pre-encounter_patients_v1_EligibilityTimelinePage: type: object properties: next_page_token: $ref: '#/components/schemas/type_pre-encounter_common_PageToken' prev_page_token: $ref: '#/components/schemas/type_pre-encounter_common_PageToken' total: type: integer items: type: array items: $ref: '#/components/schemas/type_pre-encounter_patients_v1_EligibilityTimelineEvent' required: - total - items title: EligibilityTimelinePage type_custom-schemas_v1_SchemaValidationFailure: type: object properties: errors: type: array items: $ref: '#/components/schemas/type_custom-schemas_v1_SchemaValidationError' required: - errors title: SchemaValidationFailure type_pre-encounter_coverages_v1_BenefitsRelatedEntity: type: object properties: entityIdentifier: type: string entityType: type: string entityName: type: string contactInformation: type: array items: $ref: '#/components/schemas/type_pre-encounter_coverages_v1_RelatedEntityContact' serviceTypeCodes: type: array items: $ref: '#/components/schemas/type_pre-encounter_coverages_v1_ServiceTypeCode' title: BenefitsRelatedEntity type_invoices_v2_InvoiceSortField: type: string enum: - CREATED_AT - UPDATED_AT - PATIENT_EXTERNAL_ID - NOTE - DUE_DATE - STATUS title: InvoiceSortField type_pre-encounter_eligibilityChecks_v1_CobResponseSubscriber: type: object properties: member_id: type: string description: The member ID for the subscriber's insurance policy. first_name: type: string last_name: type: string middle_name: type: string gender: type: string description: The subscriber's gender. Typically `F` - Female, `M` - Male, or `U` - Unknown. date_of_birth: type: string ssn: type: string group_number: type: string description: The group number associated with the subscriber's insurance policy. birth_sequence_number: type: string description: Birth order when there are multiple births associated with the provided birth date. address: $ref: '#/components/schemas/type_pre-encounter_eligibilityChecks_v1_CobAddress' aaa_errors: type: array items: $ref: '#/components/schemas/type_pre-encounter_eligibilityChecks_v1_EligibilityCheckErrorDetails' description: AAA errors specifying reasons for rejection and recommended follow-up actions. description: Information about the primary policyholder for the insurance plan listed in the COB request. title: CobResponseSubscriber type_pre-encounter_eligibilityChecks_v1_CobResponseProvider: type: object properties: provider_name: type: string description: The provider's last name. Applies to providers that are an individual. provider_first_name: type: string description: The provider's first name. Applies to providers that are an individual. provider_org_name: type: string description: The provider's organization name. npi: type: string description: The provider's National Provider Identifier (NPI). aaa_errors: type: array items: $ref: '#/components/schemas/type_pre-encounter_eligibilityChecks_v1_EligibilityCheckErrorDetails' description: AAA errors specifying reasons for rejection and recommended follow-up actions. description: Information about the entity that submitted the original COB request. title: CobResponseProvider type_encounters_v4_Intervention: type: object properties: name: type: string category: $ref: '#/components/schemas/type_encounters_v4_InterventionCategory' description: type: string description: '"Examples: ''Birth Control LAC'', ''Tracking'', ''Stress Management'', ''Supplement'', ''Labs''"' medication: $ref: '#/components/schemas/type_encounters_v4_Medication' description: Required when `type` is `allopathic`. labs: type: array items: $ref: '#/components/schemas/type_encounters_v4_Lab' description: Required when `type` is `tests`. required: - name - category title: Intervention type_commons_PhoneNumberType: type: string enum: - Home - Mobile - Work title: PhoneNumberType type_patient-ar_v1_PatientAdjustmentInfo: type: object properties: total_adjustment_cents: type: integer description: The total amount of patient adjustments in cents for the service line. required: - total_adjustment_cents title: PatientAdjustmentInfo type_patient-refunds_v1_PatientRefundSortField: type: string enum: - refund_source - amount_cents - refund_timestamp - refund_reason - refund_note title: PatientRefundSortField type_pre-encounter_coverages_v1_CoverageValue: type: object properties: family: type: number format: double individual: type: number format: double employeeAndSpouse: type: number format: double employeeAndChildren: type: number format: double title: CoverageValue type_pre-encounter_coverages_v1_Address: type: object properties: address1: type: string address2: type: string city: type: string state: type: string postal_code: type: string country_code: type: string country_sub_division_code: type: string title: Address type_pre-encounter_coverages_v1_NonCoveredDetail: type: object properties: type: $ref: '#/components/schemas/type_pre-encounter_coverages_v1_BenefitType' coverageLevel: $ref: '#/components/schemas/type_pre-encounter_coverages_v1_CoverageLevel' unit: $ref: '#/components/schemas/type_pre-encounter_coverages_v1_CoverageValueUnit' value: type: number format: double additional_notes: type: string service_type_codes: type: array items: $ref: '#/components/schemas/type_pre-encounter_coverages_v1_ServiceTypeCode' required: - type - coverageLevel - unit - value title: NonCoveredDetail type_commons_ChargeCapturePostBilledChangeId: type: string format: uuid title: ChargeCapturePostBilledChangeId type_pre-encounter_eligibilityChecks_v1_CobPayer: type: object properties: name: type: string description: The payer's name, such as `CIGNA`. payer_identification: type: string description: The trading_partner_service_id (Payer ID) used to identify the payer in the COB request. description: Information about the payer listed in the COB request. title: CobPayer type_pre-encounter_eligibilityChecks_v1_InsuranceDiscoveryEncounter: type: object properties: date_of_service: type: string description: A single date of service, formatted as YYYYMMDD. beginning_date_of_service: type: string description: The beginning date of service, formatted as YYYYMMDD. end_date_of_service: type: string description: The end date of service, formatted as YYYYMMDD. description: 'The date range for the service. If not specified, Stedi defaults to the current date. You can specify either a single date_of_service or a beginning_date_of_service and end_date_of_service.' title: InsuranceDiscoveryEncounter type_pre-encounter_images_v1_ImageSortField: type: string enum: - updatedAt - fileName - displayName - fileType - status title: ImageSortField type_commons_OrganizationId: type: string format: uuid title: OrganizationId type_patient-payments_v3_PatientPaymentStatus: type: string enum: - PENDING - paid - CANCELED - voided - FAILED - COMPLETED - succeeded - pending - failed - requires_action - canceled title: PatientPaymentStatus type_health-care-code-information_v1_MSDRGCode: type: string title: MSDRGCode type_individual_PatientNonInsurancePayerInfo: type: object properties: non_insurance_payer: $ref: '#/components/schemas/type_non-insurance-payers_v1_NonInsurancePayer' member_id: type: string clinical_trial_info: type: array items: $ref: '#/components/schemas/type_individual_PatientClinicalTrialInfo' description: A patient cannot be associated with a given trial more than once required: - non_insurance_payer - clinical_trial_info title: PatientNonInsurancePayerInfo type_payer-plan-groups_v1_PayerPlanGroup: type: object properties: plan_group_name: type: string payer_uuid: $ref: '#/components/schemas/type_payers_v3_PayerUuid' plan_type: $ref: '#/components/schemas/type_commons_SourceOfPaymentCode' payer_plan_group_id: $ref: '#/components/schemas/type_commons_PayerPlanGroupId' payer: $ref: '#/components/schemas/type_payers_v3_Payer' is_active: type: boolean organization_id: $ref: '#/components/schemas/type_commons_OrganizationId' required: - plan_group_name - payer_uuid - plan_type - payer_plan_group_id - payer - is_active - organization_id title: PayerPlanGroup type_commons_AllocationId: type: string format: uuid title: AllocationId type_encounter-supplemental-information_v1_SupplementalInformationId: type: string format: uuid title: SupplementalInformationId type_eras_ERA: type: object properties: check_number: type: string check_date: $ref: '#/components/schemas/type_commons_Date' era_id: $ref: '#/components/schemas/type_eras_EraId' required: - check_number - check_date - era_id title: ERA type_custom-schemas_v1_SchemaInstanceOptional: type: object properties: schema_id: $ref: '#/components/schemas/type_commons_SchemaId' description: The schema to which the content must adhere. content: type: object additionalProperties: description: Any type description: A set of key-value pairs that adhere to the naming and type convention of the schema. Not all keys in the schema must be included, but attaching any key that does not exist in the schema or attaching a key with the incorrect value type will result in errors. title: SchemaInstanceOptional type_import-invoice_v1_ImportInvoiceUpdateRequest: type: object properties: customer_invoice_url: type: string description: Link to the patient view of the invoice in the third-party service status: $ref: '#/components/schemas/type_invoices_v2_InvoiceStatus' note: type: string due_date: type: string format: date items: $ref: '#/components/schemas/type_import-invoice_v1_InvoiceItemInfoUpdate' description: None here represents there is no update to the invoice items title: ImportInvoiceUpdateRequest type_pre-encounter_images_v1_CoverageImageSide: type: string enum: - FRONT - BACK title: CoverageImageSide type_pre-encounter_patients_v1_CoveragesForRelatedCauses: type: object properties: coverages: type: array items: $ref: '#/components/schemas/type_pre-encounter_common_CoverageId' required: - coverages description: Additional coverages for the patient applicable to related causes such as Auto or Workers Comp title: CoveragesForRelatedCauses type_pre-encounter_appointments_v1_NotReadyReason: type: string enum: - INACTIVE_PRIMARY - INACTIVE_SECONDARY - MEDICARE_ADVANTAGE_CONVERSION - MEDICAID_MANAGED_CONVERSION - UNAVAILABLE_PRIMARY - UNAVAILABLE_SECONDARY - PENDING_PRIMARY - PENDING_SECONDARY - ELIGIBILITY_CHECK_FAILED_PRIMARY - ELIGIBILITY_CHECK_FAILED_SECONDARY - NEW_COMBO - NO_COVERAGE - ERROR - MANUAL description: The reason an appointment is NOT_READY. Only set when status is NOT_READY. All values except MANUAL are set by the automated eligibility check; MANUAL is set by staff via the API. title: NotReadyReason type_pre-encounter_appointments_v1_ReadySource: type: string enum: - MANUAL - MACHINE description: Indicates how this appointment's status was marked as READY - MANUAL or MACHINE. title: ReadySource type_encounter-providers_v2_SupervisingProviderSecondaryIdentificationOptional: type: object properties: reference_identification: type: string reference_identification_qualifier: $ref: '#/components/schemas/type_encounter-providers_v2_ProviderSecondaryIdentificationQualifier' title: SupervisingProviderSecondaryIdentificationOptional type_commons_EntityNotFoundErrorMessage: type: object properties: id: type: string required: - id title: EntityNotFoundErrorMessage type_payers_v3_Payer: type: object properties: payer_uuid: $ref: '#/components/schemas/type_payers_v3_PayerUuid' description: Auto-generated ID set on creation. payer_id: type: string description: The primary national payer ID of the payer. payer_name: type: string description: The primary display name of the payer. availity_payer_name: type: string description: The name of the payer as it appears in Availity. availity_claims_payer_id: type: string description: The ID of the payer as it appears in Availity. availity_eligibility_id: type: string description: The eligibility ID of the payer as it appears in Availity. availity_remittance_payer_id: type: string description: The remittance ID of the payer as it appears in Availity. street_address: $ref: '#/components/schemas/type_commons_StreetAddressLongZip' required: - payer_uuid - payer_id - payer_name title: Payer type_pre-encounter_eligibilityChecks_v1_EligibilityResponse: $ref: '#/components/schemas/type_pre-encounter_eligibilityChecks_v1_EligibilityCheck' description: An object representing the data for an eligibility response. title: EligibilityResponse type_patient-refunds_v1_PatientRefundsPage: type: object properties: prev_page_token: $ref: '#/components/schemas/type_commons_PageToken' next_page_token: $ref: '#/components/schemas/type_commons_PageToken' items: type: array items: $ref: '#/components/schemas/type_patient-refunds_v1_PatientRefund' required: - items title: PatientRefundsPage type_encounter-providers_v2_ReferringProviderSecondaryIdentificationOptional: type: object properties: reference_identification: type: string reference_identification_qualifier: $ref: '#/components/schemas/type_encounter-providers_v2_ReferringProviderSecondaryIdentificationQualifier' title: ReferringProviderSecondaryIdentificationOptional type_pre-encounter_patients_v1_Patient: type: object properties: organization_id: $ref: '#/components/schemas/type_pre-encounter_common_OrganizationId' description: The organization that owns this object. deactivated: type: boolean description: True if the object is deactivated. Deactivated objects are not returned in search results but are returned in all other endpoints including scan. version: type: integer description: The version of the object. Any update to any property of an object object will create a new version. updated_at: type: string format: date-time updating_user_id: $ref: '#/components/schemas/type_pre-encounter_common_UserId' description: The user ID of the user who last updated the object. name: $ref: '#/components/schemas/type_pre-encounter_common_HumanName' other_names: type: array items: $ref: '#/components/schemas/type_pre-encounter_common_HumanName' description: Other names for the patient. other_identifiers: type: array items: $ref: '#/components/schemas/type_pre-encounter_common_ExternalIdentifier' description: Other identifiers for the patient. gender: $ref: '#/components/schemas/type_pre-encounter_common_Gender' birth_date: type: string format: date social_security_number: type: string biological_sex: $ref: '#/components/schemas/type_pre-encounter_common_Sex' description: The biological sex of the patient. This corresponds to the HL7 AdministrativeGender https://www.hl7.org/fhir/valueset-administrative-gender.html sexual_orientation: $ref: '#/components/schemas/type_pre-encounter_common_SexualOrientation' description: The sexual orientation of the patient. pronouns: type: array items: type: string description: The pronouns of the patient. race: $ref: '#/components/schemas/type_pre-encounter_common_Race' ethnicity: $ref: '#/components/schemas/type_pre-encounter_common_Ethnicity' disability_status: $ref: '#/components/schemas/type_pre-encounter_common_DisabilityStatus' marital_status: $ref: '#/components/schemas/type_pre-encounter_patients_v1_MaritalStatus' deceased: type: string format: date-time description: Time of death for the patient. Leave unset if the patient is not deceased. multiple_birth: type: integer description: The number of siblings the patient was born with. Leave unset if the patient was not part of a multiple birth. primary_address: $ref: '#/components/schemas/type_pre-encounter_common_Address' description: The primary address for the patient. other_addresses: type: array items: $ref: '#/components/schemas/type_pre-encounter_common_Address' description: Other addresses for the patient. primary_telecom: $ref: '#/components/schemas/type_pre-encounter_common_ContactPoint' description: The primary phone number for the patient. other_telecoms: type: array items: $ref: '#/components/schemas/type_pre-encounter_common_ContactPoint' description: Other phone numbers for the patient. email: type: string electronic_communication_opt_in: type: boolean description: Use electronic_communication_consent for granular channel-level consent. This field is kept in sync automatically but should not be used for new integrations. electronic_communication_consent: $ref: '#/components/schemas/type_pre-encounter_patients_v1_ElectronicCommunicationConsent' description: Granular consent for electronic communication channels. photo: type: string language: type: string external_provenance: $ref: '#/components/schemas/type_pre-encounter_patients_v1_ExternalProvenance' description: Information about the upstream system that owns this patient data. Leave unset if Candid owns patient data. contacts: type: array items: $ref: '#/components/schemas/type_pre-encounter_patients_v1_Contact' description: Contacts for the patient. general_practitioners: type: array items: $ref: '#/components/schemas/type_pre-encounter_common_ExternalProvider' filing_order: $ref: '#/components/schemas/type_pre-encounter_patients_v1_FilingOrder' coverages_for_related_causes: $ref: '#/components/schemas/type_pre-encounter_patients_v1_CoveragesForRelatedCauses' non_insurance_payers: type: array items: $ref: '#/components/schemas/type_pre-encounter_common_CanonicalNonInsurancePayerId' non_insurance_payer_associations: type: array items: $ref: '#/components/schemas/type_pre-encounter_common_CanonicalNonInsurancePayerAssociation' guarantor: $ref: '#/components/schemas/type_pre-encounter_patients_v1_Guarantor' self_pay: type: boolean authorizations: type: array items: $ref: '#/components/schemas/type_pre-encounter_patients_v1_Authorization' referrals: type: array items: $ref: '#/components/schemas/type_pre-encounter_patients_v1_Referral' primary_service_facility_id: type: string service_facilities: type: array items: $ref: '#/components/schemas/type_pre-encounter_common_PatientServiceFacility' description: Associated service facilities for this patient. do_not_invoice_reason: $ref: '#/components/schemas/type_pre-encounter_patients_v1_DoNotInvoiceReason' description: If this value is defined, the customer will not be invoiced. note_ids: type: array items: $ref: '#/components/schemas/type_pre-encounter_common_NoteId' tag_ids: type: array items: $ref: '#/components/schemas/type_pre-encounter_common_TagId' origination_detail: $ref: '#/components/schemas/type_pre-encounter_patients_v1_OriginationDetail' description: Information about the patient source, if applicable. inferred_patient_metadata: $ref: '#/components/schemas/type_pre-encounter_patients_v1_InferredPatientMetadata' description: Metadata for the patient used for patient inference from encounters. orcon: type: boolean description: ORCON (Originator Controlled) - When set to true, the Candid system will hide this patient from downstream integrations. Updates made in the Candid UI will unset this flag. Defaults to false. advanced_directives: type: array items: $ref: '#/components/schemas/type_pre-encounter_patients_v1_AdvancedDirective' hipaa_code: type: string id: $ref: '#/components/schemas/type_pre-encounter_common_PatientId' description: The unique UUID identifier for a Patient. Patient ID is used in machine contexts. mrn: type: string description: The medical record number for the patient. Human-friendly Candid generated MRNs are of the form "YYMMDDXXXX", where "YYMMDD" is the date of patient creation and "XXXX" is a zero-padded incrementing integer. required: - organization_id - deactivated - version - updated_at - updating_user_id - name - other_names - birth_date - biological_sex - primary_address - other_addresses - other_telecoms - contacts - general_practitioners - filing_order - id - mrn description: A patient object with immutable server-owned properties. title: Patient type_commons_Primitive: type: string enum: - BOOLEAN - DOUBLE - INTEGER - STRING description: 'The BOOLEAN and STRING primitives respectively map to the `boolean` and `string` JSON data types. The DOUBLE and INTEGER primitives must be written as a JSON `number` type.' title: Primitive type_pre-encounter_notes_v1_Note: type: object properties: organization_id: $ref: '#/components/schemas/type_pre-encounter_common_OrganizationId' description: The organization that owns this object. deactivated: type: boolean description: True if the object is deactivated. Deactivated objects are not returned in search results but are returned in all other endpoints including scan. version: type: integer description: The version of the object. Any update to any property of an object object will create a new version. updated_at: type: string format: date-time updating_user_id: $ref: '#/components/schemas/type_pre-encounter_common_UserId' description: The user ID of the user who last updated the object. value: type: string type: $ref: '#/components/schemas/type_pre-encounter_notes_v1_NoteType' description: Defaults to GENERAL when omitted. author_email: type: string author_name: type: string id: $ref: '#/components/schemas/type_pre-encounter_common_NoteId' created_at: type: string format: date-time required: - organization_id - deactivated - version - updated_at - updating_user_id - value - id - created_at description: A Note object with immutable server-owned properties. title: Note type_pre-encounter_patients_v1_EligibilityTimelineEvent: type: object properties: id: type: string event_type: $ref: '#/components/schemas/type_pre-encounter_patients_v1_EligibilityAuditEventType' patient_id: $ref: '#/components/schemas/type_pre-encounter_common_PatientId' coverage_id: $ref: '#/components/schemas/type_pre-encounter_common_CoverageId' appointment_id: $ref: '#/components/schemas/type_pre-encounter_common_AppointmentId' timestamp: type: string format: date-time user_id: type: string user_name: type: string description: Actor display name; "Candid Health" for automated writes. payload: type: object additionalProperties: description: Any type description: Event-type-specific payload. required: - id - event_type - patient_id - timestamp - user_id - user_name - payload description: A single eligibility audit event. title: EligibilityTimelineEvent type_health-care-code-information_v1_ValueInformation: type: object properties: id: type: string format: uuid description: 'The id of this health care code information if it is already stored. If this is not set, this is referring to a new health care code information to be added to the encounter. If it is set, this refers to an update of an existing health care code information object on the encounter.' encounter_id: $ref: '#/components/schemas/type_commons_EncounterId' description: 'The encounter_id of this health care code information if it is already stored. This will be set by the server in responses, but clients are not expected to set it.' value_code_qualifier: $ref: '#/components/schemas/type_health-care-code-information_v1_ValueCodeQualifier' value_code: $ref: '#/components/schemas/type_health-care-code-information_v1_ValueCode' value_code_amount: $ref: '#/components/schemas/type_commons_Decimal' required: - value_code_qualifier - value_code - value_code_amount description: This corresponds to the BE code qualifier value. title: ValueInformation type_patient-ar_v1_ServiceLineItemization: type: object properties: service_line_id: $ref: '#/components/schemas/type_commons_ServiceLineId' description: The ID of the service line. procedure_code: type: string description: The procedure code (CPT/HCPCS) associated with the service line. date_of_service: type: string format: date description: The date of service for the service line. patient_balance_cents: type: integer description: The total patient balance in cents for the service line. Negative values indicate a credit balance. charge_amount_cents: type: integer description: The total charge amount in cents for the service line. insurance_adjustments: $ref: '#/components/schemas/type_patient-ar_v1_InsuranceAdjustmentInfo' insurance_payments: $ref: '#/components/schemas/type_patient-ar_v1_InsurancePaymentInfo' non_insurance_adjustments: $ref: '#/components/schemas/type_patient-ar_v1_NonInsuranceAdjustmentInfo' non_insurance_payments: $ref: '#/components/schemas/type_patient-ar_v1_NonInsurancePaymentInfo' patient_adjustments: $ref: '#/components/schemas/type_patient-ar_v1_PatientAdjustmentInfo' patient_payments: $ref: '#/components/schemas/type_patient-ar_v1_PatientPaymentInfo' copay_cents: type: integer description: The copay amount in cents for the service line. coinsurance_cents: type: integer description: The coinsurance amount in cents for the service line. deductible_cents: type: integer description: The deductible amount in cents for the service line. required: - service_line_id - procedure_code - date_of_service - patient_balance_cents - charge_amount_cents - insurance_adjustments - insurance_payments - non_insurance_adjustments - non_insurance_payments - patient_adjustments - patient_payments - copay_cents - coinsurance_cents - deductible_cents title: ServiceLineItemization type_payment-account-configs_PaymentAccountConfigId: type: string format: uuid title: PaymentAccountConfigId type_pre-encounter_common_CanonicalNonInsurancePayerId: type: string description: The unique identifier for a non-insurance payer configured in the Candid system title: CanonicalNonInsurancePayerId type_insurance-cards_v2_InsuranceCardCreateOptional: type: object properties: group_number: type: string description: Box 11 on the CMS-1500 claim form. plan_name: type: string description: Box 11c on the CMS-1500 claim form. plan_type: $ref: '#/components/schemas/type_commons_SourceOfPaymentCode' insurance_type: $ref: '#/components/schemas/type_commons_InsuranceTypeCode' payer_plan_group_id: $ref: '#/components/schemas/type_commons_PayerPlanGroupId' payer_address: $ref: '#/components/schemas/type_commons_StreetAddressLongZipOptional' member_id: type: string payer_name: type: string payer_id: type: string rx_bin: type: string rx_pcn: type: string image_url_front: type: string image_url_back: type: string emr_payer_crosswalk: $ref: '#/components/schemas/type_commons_EmrPayerCrosswalk' description: Set to PAYER_PLAN_GROUP to use Payer Plans for automatic payer resolution. See Payer Information documentation for details. payer_plan_group_name: type: string description: When using emr_payer_crosswalk set to PAYER_PLAN_GROUP, specify the payer plan name here. See Payer Information documentation for details. title: InsuranceCardCreateOptional type_pre-encounter_eligibilityChecks_v1_EligibilityStatus: type: string enum: - ACTIVE - INACTIVE - UNKNOWN description: enum to represent the status of a patient's coverage title: EligibilityStatus type_encounters_v4_Encounter: type: object properties: external_id: $ref: '#/components/schemas/type_commons_EncounterExternalId' description: 'A client-specified unique ID to associate with this encounter; for example, your internal encounter ID or a Dr. Chrono encounter ID. This field should not contain PHI.' date_of_service: type: string format: date description: 'Date formatted as YYYY-MM-DD; eg: 2019-08-24. This date must be the local date in the timezone where the service occurred. Box 24a on the CMS-1500 claim form or Form Locator 45 on the UB-04 claim form. If service occurred over a range of dates, this should be the start date. date_of_service must be defined on either the encounter or the service lines but not both. If there are greater than zero service lines, it is recommended to specify date_of_service on the service_line instead of on the encounter to prepare for future API versions.' end_date_of_service: type: string format: date description: 'Date formatted as YYYY-MM-DD; eg: 2019-08-25. This date must be the local date in the timezone where the service occurred. If omitted, the Encounter is assumed to be for a single day. Must not be temporally before the date_of_service field. If there are greater than zero service lines, it is recommended to specify end_date_of_service on the service_line instead of on the encounter to prepare for future API versions.' patient_authorized_release: type: boolean description: 'Whether this patient has authorized the release of medical information for billing purpose. Box 12 on the CMS-1500 claim form or Form Locator 52 on a UB-04 claim form.' benefits_assigned_to_provider: type: boolean description: 'Whether this patient has authorized insurance payments to be made to you, not them. If false, patient may receive reimbursement. Box 13 on the CMS-1500 claim form or Form Locator 53 on a UB-04 claim form.' provider_accepts_assignment: type: boolean description: 'Whether you have accepted the patient''s authorization for insurance payments to be made to you, not them. Box 27 on the CMS-1500 claim form. There is no exact equivalent of this field on a UB-04 claim, however contributes to the concept of Form Locator 53.' appointment_type: type: string description: 'Human-readable description of the appointment type (ex: "Acupuncture - Headaches").' existing_medications: type: array items: $ref: '#/components/schemas/type_encounters_v4_Medication' interventions: type: array items: $ref: '#/components/schemas/type_encounters_v4_Intervention' pay_to_address: $ref: '#/components/schemas/type_commons_StreetAddressLongZip' description: Specifies the address to which payments for the claim should be sent. synchronicity: $ref: '#/components/schemas/type_encounters_v4_SynchronicityType' description: 'Whether or not this was a synchronous or asynchronous encounter. Asynchronous encounters occur when providers and patients communicate online using forms, instant messaging, or other pre-recorded digital mediums. Synchronous encounters occur in live, real-time settings where the patient interacts directly with the provider, such as over video or a phone call.' vitals: $ref: '#/components/schemas/type_encounters_v4_Vitals' billable_status: $ref: '#/components/schemas/type_encounters_v4_BillableStatusType' description: 'Defines if the Encounter is to be billed by Candid to the responsible_party. Examples for when this should be set to NOT_BILLABLE include if the Encounter has not occurred yet or if there is no intention of ever billing the responsible_party.' additional_information: type: string description: 'Defines additional information on the claim needed by the payer. Box 19 on the CMS-1500 claim form or Form Locator 80 on a UB-04 claim form.' service_authorization_exception_code: $ref: '#/components/schemas/type_encounters_v4_ServiceAuthorizationExceptionCode' description: '837p Loop2300 REF*4N Required when mandated by government law or regulation to obtain authorization for specific service(s) but, for the reasons listed in one of the enum values of ServiceAuthorizationExceptionCode, the service was performed without obtaining the authorization.' admission_date: type: string format: date description: '837p Loop2300 DTP*435, CMS-1500 Box 18 or UB-04 Form Locator 12. Required on all ambulance claims when the patient was known to be admitted to the hospital. OR Required on all claims involving inpatient medical visits.' discharge_date: type: string format: date description: 837p Loop2300 DTP*096, CMS-1500 Box 18 Required for inpatient claims when the patient was discharged from the facility and the discharge date is known. Not used on an institutional claim. onset_of_current_illness_or_symptom_date: type: string format: date description: "837p Loop2300 DTP*431, CMS-1500 Box 14\nRequired for the initial medical service or visit performed in response to a medical emergency when the date is available and is different than the date of service.\nOR\nThis date is the onset of acute symptoms for the current illness or condition.\n For UB-04 claims, this is populated separately via occurrence codes." last_menstrual_period_date: type: string format: date description: '837p Loop2300 DTP*484, CMS-1500 Box 14 Required when, in the judgment of the provider, the services on this claim are related to the patient''s pregnancy. This field is populated separately via occurrence codes for UB-04 claim forms.' delay_reason_code: $ref: '#/components/schemas/type_commons_DelayReasonCode' description: 'Code indicating the reason why a claim submission was delayed. Corresponds to CLM-20 in the 837 specification (both professional and institutional).' accident_state_or_province_code: $ref: '#/components/schemas/type_commons_State' description: 837i-REF1000 -- an optional state indicating where an accident related to the encounter occurred. claim_creation_id: $ref: '#/components/schemas/type_commons_ChargeCaptureClaimCreationId' description: If the encounter was created from ingested charge captures, this is the associated Charge Capture Claim Creation Id. patient_control_number: type: string description: 'A patient control number (PCN) is a unique identifier assigned to a patient within a healthcare system or facility. It''s used to track and manage a patient''s medical records, treatments, and other healthcare-related information.' encounter_id: $ref: '#/components/schemas/type_commons_EncounterId' claims: type: array items: $ref: '#/components/schemas/type_claims_Claim' patient: $ref: '#/components/schemas/type_individual_Patient' description: Contains the identification information of the individual receiving medical services. guarantor: $ref: '#/components/schemas/type_guarantor_v1_Guarantor' description: Personal and contact info for the guarantor of the patient responsibility. billing_provider: $ref: '#/components/schemas/type_encounter-providers_v2_EncounterProvider' description: The billing provider is the provider or business entity submitting the claim. Billing provider may be, but is not necessarily, the same person/NPI as the rendering provider. From a payer's perspective, this represents the person or entity being reimbursed. When a contract exists with the target payer, the billing provider should be the entity contracted with the payer. In some circumstances, this will be an individual provider. In that case, submit that provider's NPI and the tax ID (TIN) that the provider gave to the payer during contracting. In other cases, the billing entity will be a medical group. If so, submit the group NPI and the group's tax ID. Box 33 on the CMS-1500 claim form or Form Locator 1 on a UB-04 claim form. rendering_provider: $ref: '#/components/schemas/type_encounter-providers_v2_EncounterProvider' description: 'The rendering provider is the practitioner -- physician, nurse practitioner, etc. -- performing the service. For telehealth services, the rendering provider performs the visit, asynchronous communication, or other service. The rendering provider address should generally be the same as the service facility address.' attending_provider: $ref: '#/components/schemas/type_encounter-providers_v2_EncounterProvider' description: 837i NM1 2500 variant for Loop ID-2310. Used to indicate the individual whom has overall responsibility for the patient in institutional claims processing. admission_hour: type: integer description: '837i Loop 2300 DTP-03 Extension of the admission date with hour (0-23) details. Required for institutional submission.' admission_type_code: $ref: '#/components/schemas/type_x12_v1_TypeOfAdmissionOrVisitCode' description: 837i Loop 2300 CL1-01 Code used to indicate the priority of an admission or visit. Equivalent to Form Locator 14 Priority of Admission on a UB-04 claim, not used on CMS-1500 claim forms. admission_source_code: $ref: '#/components/schemas/type_x12_v1_PointOfOriginForAdmissionOrVisitCode' description: 837i Loop 2300 CLI1-02 Code used to indicate the conditions under which an admission occurs. Equivalent to Form Locator 15 Point of Origin on a UB-04 claim, not used on CMS-1500 claim forms. discharge_hour: type: integer description: '837i Loop 2300 DTP-03 Extension of the discharge date with hour (0-23) details.' discharge_status: $ref: '#/components/schemas/type_x12_v1_PatientDischargeStatusCode' description: '837i CL1-03 or Form Locator 17 on a UB-04 claim form. This is a required field on UB-04 claims. Code indicating patient status as of the "statement covers through date".' operating_provider: $ref: '#/components/schemas/type_encounter-providers_v2_EncounterProvider' description: 837i NM1 2500 variant for Loop ID-2310. Used to indicate the individual whom has primary responsibility for surgical procedures in institutional claims processing. other_operating_provider: $ref: '#/components/schemas/type_encounter-providers_v2_EncounterProvider' description: 837i NM1 2500 variant for Loop ID-2310. Used to indicate the individual whom has secondary responsibility for surgical procedures in institutional claims processing. Only used when operating_provider is also set. treating_provider: $ref: '#/components/schemas/type_encounter-providers_v2_EncounterAdditionalProvider' description: The treating provider is the provider who treats the patient. This is only supported for professional encounters. related_causes_information: $ref: '#/components/schemas/type_related-causes_v1_RelatedCausesInformation' property_casualty_claim_number: type: string description: 837p Loop2010 REF02, CMS1500 Box 11b accident_date: type: string format: date description: 837p Loop2300 DTP*439, CMS1500 Box 15 property_casualty_patient_identifier: $ref: '#/components/schemas/type_property-and-casualty_v1_PropertyCasualtyPatientIdentifier' description: 'Patient identifier for Property and Casualty claims. 837p Loop2010CA' submission_expectation: $ref: '#/components/schemas/type_encounters_v4_EncounterSubmissionExpectation' description: Describes the currently expected target form for this encounter. This affects what validations and queues the form is processed under. When this value is not set, it should be assumed to be TARGET_PROFESSIONAL. type_of_bill: $ref: '#/components/schemas/type_x12_v1_TypeOfBillComposite' description: Four digit code used in institutional forms to indicate the type of bill (e.g., hospital inpatient, hospital outpatient). First digit is a leading 0, followed by the type_of_facility, type_of_care, then frequency_code. Professional forms are not required to submit this attribute. You may send the 4 digit code via raw_code, or each individual digit separately via composite_codes. referring_provider: $ref: '#/components/schemas/type_encounter-providers_v2_EncounterProvider' initial_referring_provider: $ref: '#/components/schemas/type_encounter-providers_v2_EncounterProvider' supervising_provider: $ref: '#/components/schemas/type_encounter-providers_v2_EncounterProvider' service_facility: $ref: '#/components/schemas/type_service-facility_EncounterServiceFacility' description: Encounter Service facility is typically the location a medical service was rendered, such as a provider office or hospital. For telehealth, service facility can represent the provider's location when the service was delivered (e.g., home), or the location where an in-person visit would have taken place, whichever is easier to identify. If the provider is in-network, service facility may be defined in payer contracts. Box 32 on the CMS-1500 claim form. There is no equivalent on the paper UB-04 claim form, but this field is equivalent to Loop 2310E Service Facility Location details on an 837i form, and is used when this is different to the entity identified as the Billing Provider. Note that for an in-network claim to be successfully adjudicated, the service facility address listed subscriber_primary: $ref: '#/components/schemas/type_individual_Subscriber' description: 'Subscriber_primary is required when responsible_party is INSURANCE_PAY (i.e. when the claim should be billed to insurance). These are not required fields when responsible_party is SELF_PAY (i.e. when the claim should be billed to the patient). However, if you collect this for patients, even self-pay, we recommend including it when sending encounters to Candid. Note: Cash Pay is no longer a valid payer_id in v4, please use responsible party to define self-pay claims.' subscriber_secondary: $ref: '#/components/schemas/type_individual_Subscriber' description: Contains details of the secondary insurance subscriber. subscriber_tertiary: $ref: '#/components/schemas/type_individual_Subscriber' description: Contains details of the tertiary insurance subscriber. prior_authorization_number: $ref: '#/components/schemas/type_encounters_v4_PriorAuthorizationNumber' description: Box 23 on the CMS-1500 claim form or Form Locator 63 on a UB-04 claim form. responsible_party: $ref: '#/components/schemas/type_encounters_v4_ResponsiblePartyType' description: Defines the party to be billed with the initial balance owed on the claim. url: $ref: '#/components/schemas/type_commons_LinkUrl' description: URL that links directly to the claim created in Candid. diagnoses: type: array items: $ref: '#/components/schemas/type_diagnoses_Diagnosis' description: Contains the primary and other diagnosis health care code information objects associated with this encounter. For professional claims, these diagnoses correspond with those that are set on service lines directly, where as for institutional claims these are only associated directly with the claim itself. See also Health Care Code Information objects and corresponding apis. clinical_notes: type: array items: $ref: '#/components/schemas/type_encounters_v4_ClinicalNoteCategory' description: Holds a collection of clinical observations made by healthcare providers during patient encounters. Please note that medical records for appeals should be sent using the Encounter Attachments API. billing_notes: type: array items: $ref: '#/components/schemas/type_billing-notes_v2_BillingNote' description: 'Spot to store misc, human-readable, notes about this encounter to be used in the billing process.' place_of_service_code: $ref: '#/components/schemas/type_commons_FacilityTypeCode' description: Box 24B on the CMS-1500 claim form. 837p Loop2300, CLM-05-1. 02 for telemedicine, 11 for in-person. Full list [here](https://www.cms.gov/Medicare/Coding/place-of-service-codes/Place_of_Service_Code_Set). place_of_service_code_as_submitted: $ref: '#/components/schemas/type_commons_FacilityTypeCode' description: Box 24B on the CMS-1500 claim form. 837p Loop2300, CLM-05-1. 02 for telemedicine, 11 for in-person. Full list [here](https://www.cms.gov/Medicare/Coding/place-of-service-codes/Place_of_Service_Code_Set). patient_histories: type: array items: $ref: '#/components/schemas/type_encounters_v4_PatientHistoryCategory' patient_payments: type: array items: $ref: '#/components/schemas/type_patient-payments_v3_PatientPayment' tags: type: array items: $ref: '#/components/schemas/type_tags_Tag' coding_attribution: $ref: '#/components/schemas/type_encounters_v4_CodingAttributionType' description: The entity that performed the coding of medical services for the claim. work_queue_id: $ref: '#/components/schemas/type_commons_WorkQueueId' work_queue_membership_activated_at: type: string format: date-time owner_of_next_action: $ref: '#/components/schemas/type_encounters_v4_EncounterOwnerOfNextActionType' description: The party who is responsible for taking the next action on an Encounter, as defined by ownership of open Tasks. submission_origin: $ref: '#/components/schemas/type_encounters_v4_EncounterSubmissionOriginType' description: 'The party who originally submitted the Claim. For Claims originating in Candid, this will be EncounterSubmissionOriginType.CANDID. For Encounters created with an external_claim_submission object, this will be EncounterSubmissionOriginType.EXTERNAL.' schema_instances: type: array items: $ref: '#/components/schemas/type_custom-schemas_v1_SchemaInstance' description: 'Key-value pairs that must adhere to a schema created via the Custom Schema API. Multiple schema instances cannot be created for the same schema on an encounter.' referral_number: type: string description: Refers to REF*9F on the 837p. Value cannot be greater than 50 characters. epsdt_referral: $ref: '#/components/schemas/type_encounters_v4_EPSDTReferral' description: Refers to Box 24H on the CMS1500 form and Loop 2300 CRC - EPSDT Referral on the 837P and 837i form claim_supplemental_information: type: array items: $ref: '#/components/schemas/type_encounters_v4_ClaimSupplementalInformation' description: Refers to Loop 2300 - Segment PWK on the 837P and 837i form. No more than 10 entries are permitted. secondary_payer_carrier_code: type: string description: When Medicaid is billed as the secondary payer the Carrier Code is used to identify the primary payer. This is required for certain states. last_submitted_at: type: string format: date-time description: The date and time the encounter was last submitted to a payer. created_at: type: string format: date-time description: The date and time the encounter was created. next_responsible_party: $ref: '#/components/schemas/type_commons_NextResponsibleParty' description: The party (payer, patient, etc.) responsible for the remainder of the balance on the claim. organization_id: $ref: '#/components/schemas/type_commons_OrganizationId' required: - external_id - patient_authorized_release - benefits_assigned_to_provider - provider_accepts_assignment - billable_status - encounter_id - claims - patient - billing_provider - rendering_provider - service_facility - responsible_party - url - diagnoses - clinical_notes - patient_histories - patient_payments - tags - owner_of_next_action - submission_origin - schema_instances - created_at title: Encounter type_encounters_v4_EncounterOwnerOfNextActionType: type: string enum: - CANDID - CUSTOMER - CODER - NONE title: EncounterOwnerOfNextActionType type_encounter-providers_v2_BillingProviderSecondaryIdentificationQualifier: type: string enum: - G2 - LU title: BillingProviderSecondaryIdentificationQualifier type_pre-encounter_lists_v1_AppointmentListItem: type: object properties: appointment: $ref: '#/components/schemas/type_pre-encounter_appointments_v1_Appointment' patient: $ref: '#/components/schemas/type_pre-encounter_patients_v1_MutablePatientWithMrn' primary_coverage: $ref: '#/components/schemas/type_pre-encounter_coverages_v1_MutableCoverage' secondary_coverage: $ref: '#/components/schemas/type_pre-encounter_coverages_v1_MutableCoverage' primary_service_type: $ref: '#/components/schemas/type_pre-encounter_appointments_v1_UniversalServiceIdentifier' required: - appointment - patient title: AppointmentListItem type_payers_v3_PayerUuid: type: string format: uuid title: PayerUuid type_invoices_InvoiceStatus: type: string enum: - draft - open - paid - void - uncollectible - held title: InvoiceStatus type_commons_ReportTransmissionCode: type: string enum: - AA - BM - EL - FX title: ReportTransmissionCode type_non-insurance-payer-payments_v1_NonInsurancePayerPaymentSortField: type: string enum: - amount_cents - payment_timestamp title: NonInsurancePayerPaymentSortField type_pre-encounter_lists_v1_PatientListPage: type: object properties: next_page_token: $ref: '#/components/schemas/type_pre-encounter_common_PageToken' prev_page_token: $ref: '#/components/schemas/type_pre-encounter_common_PageToken' total: type: integer items: type: array items: $ref: '#/components/schemas/type_pre-encounter_lists_v1_PatientListItem' required: - total - items title: PatientListPage type_charge-capture-bundles_v1_ChargeCaptureClaimCreation: type: object properties: id: $ref: '#/components/schemas/type_commons_ChargeCaptureClaimCreationId' created_encounter_id: $ref: '#/components/schemas/type_commons_EncounterId' status: $ref: '#/components/schemas/type_charge-capture-bundles_v1_ChargeCaptureClaimCreationStatus' description: Status of the Claim Creation, Successful means that the Claim Creation created a corresponding Claim characteristics: type: object additionalProperties: description: Any type description: 'A dictionary of characteristics that are used to group charge captures together based on the bundling configuration. Example: {"service_facility.npi": "99999999", "date_of_service": "2023-01-01"}' errors: type: array items: $ref: '#/components/schemas/type_charge-capture_v1_ChargeCaptureError' description: 'All errors that were found when the Claim was attempted to be created. Errors can correspond to the Claim Creation as a whole or specific underlying Charge Captures.' encounter_creation_input: $ref: '#/components/schemas/type_charge-capture_v1_ChargeCaptureData' description: If a ChargeCaptureBundle attempts creation, this is the input that was created from the underlying charges and used to attempt encounter creation. required: - id - status - characteristics - errors title: ChargeCaptureClaimCreation type_financials_PatientTransactionSource: type: string enum: - MANUAL_ENTRY - CHARGEBEE - SQUARE - STRIPE - ELATION - CEDAR - HEALTHIE - REALLOCATION - PHREESIA - INSTAMED - SHERPA_HEALTH title: PatientTransactionSource type_service-lines_v2_ServiceLineDenialReason: type: object properties: reason: $ref: '#/components/schemas/type_service-lines_v2_DenialReasonContent' description: Text of the denial reason description: 'The reason a given service line was denied within a given time range. A service line may be denied for different reasons over time, but only one reason at a time.' title: ServiceLineDenialReason type_non-insurance-payers_v1_NonInsurancePayerPage: type: object properties: prev_page_token: $ref: '#/components/schemas/type_commons_PageToken' next_page_token: $ref: '#/components/schemas/type_commons_PageToken' items: type: array items: $ref: '#/components/schemas/type_non-insurance-payers_v1_NonInsurancePayer' required: - items title: NonInsurancePayerPage type_invoices_v2_InvoiceItemCreate: type: object properties: attribution: $ref: '#/components/schemas/type_invoices_v2_InvoiceItemAttributionCreate' amount_cents: type: integer required: - attribution - amount_cents title: InvoiceItemCreate type_claim-submission_v1_ClaimSubmissionRecordCreateOptional: type: object properties: submitted_at: type: string format: date-time description: When the claim was submitted to the payer. claim_frequency_code: $ref: '#/components/schemas/type_x12_v1_TypeOfBillFrequencyCode' payer_responsibility: $ref: '#/components/schemas/type_commons_ClaimSubmissionPayerResponsibilityType' intended_submission_medium: $ref: '#/components/schemas/type_commons_IntendedSubmissionMedium' description: 'The medium by which the claim was submitted to the payer: paper or electronic. If omitted, defaults to electronic.' description: Data about each external submission. title: ClaimSubmissionRecordCreateOptional type_commons_ClaimId: type: string format: uuid title: ClaimId type_health-care-code-information_v1_PrincipalProcedureInformation: type: object properties: id: type: string format: uuid description: 'The id of this health care code information if it is already stored. If this is not set, this is referring to a new health care code information to be added to the encounter. If it is set, this refers to an update of an existing health care code information object on the encounter.' encounter_id: $ref: '#/components/schemas/type_commons_EncounterId' description: 'The encounter_id of this health care code information if it is already stored. This will be set by the server in responses, but clients are not expected to set it.' principal_procedure_code_qualifier: $ref: '#/components/schemas/type_health-care-code-information_v1_PrincipalProcedureInformationCodeQualifier' principal_procedure_code: $ref: '#/components/schemas/type_health-care-code-information_v1_ICDCode' procedure_date: $ref: '#/components/schemas/type_health-care-code-information_v1_D8Date' description: 'An [RFC 3339, section 5.6 datetime](https://ijmacd.github.io/rfc3339-iso8601/). For example, 2017-07-21T17:32:28Z. In practice, only the date portion of this is used for claim submission, so midnight time is fine.' required: - principal_procedure_code_qualifier - principal_procedure_code - procedure_date description: This correspond to BBR, BR, and CAH code qualifier values. title: PrincipalProcedureInformation type_encounter-providers_v2_ReferringProviderSecondaryIdentificationQualifier: type: string enum: - 0B - 1G - G2 title: ReferringProviderSecondaryIdentificationQualifier type_encounters_v4_EPSDTReferral: type: object properties: condition_indicator1: $ref: '#/components/schemas/type_commons_EPSDTReferralConditionIndicatorCode' condition_indicator2: $ref: '#/components/schemas/type_commons_EPSDTReferralConditionIndicatorCode' condition_indicator3: $ref: '#/components/schemas/type_commons_EPSDTReferralConditionIndicatorCode' required: - condition_indicator1 title: EPSDTReferral type_non-insurance-payer-refunds_v1_NonInsurancePayerRefundId: type: string format: uuid title: NonInsurancePayerRefundId type_write-offs_v1_WriteOffsPage: type: object properties: prev_page_token: $ref: '#/components/schemas/type_commons_PageToken' next_page_token: $ref: '#/components/schemas/type_commons_PageToken' items: type: array items: $ref: '#/components/schemas/type_write-offs_v1_WriteOff' required: - items title: WriteOffsPage type_import-invoice_v1_InvoiceItemUpdateType: type: string enum: - APPEND - OVERWRITE title: InvoiceItemUpdateType type_organization-service-facilities_v2_OrganizationServiceFacilityId: type: string format: uuid title: OrganizationServiceFacilityId type_pre-encounter_common_Ethnicity: type: string enum: - HISPANIC_OR_LATINO - NOT_HISPANIC_OR_LATINO - UNKNOWN - REFUSED title: Ethnicity type_insurance-refunds_v1_InsuranceRefundId: type: string format: uuid title: InsuranceRefundId type_pre-encounter_patients_v1_PatientCoverageSnapshot: type: object properties: patient: $ref: '#/components/schemas/type_pre-encounter_patients_v1_Patient' primary_coverage: $ref: '#/components/schemas/type_pre-encounter_coverages_v1_Coverage' secondary_coverage: $ref: '#/components/schemas/type_pre-encounter_coverages_v1_Coverage' tertiary_coverage: $ref: '#/components/schemas/type_pre-encounter_coverages_v1_Coverage' coverages_for_related_causes: type: array items: $ref: '#/components/schemas/type_pre-encounter_coverages_v1_Coverage' required: - patient - coverages_for_related_causes title: PatientCoverageSnapshot type_pre-encounter_coverages_v1_CoverageStatus: type: string enum: - ACTIVE - CANCELLED - DRAFT - ENTERED_IN_ERROR description: enum to represent the statuses defined at https://build.fhir.org/valueset-fm-status.html title: CoverageStatus 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_charge-capture-bundles_v1_ChargeCaptureClaimCreationSummary: type: object properties: charge_capture_charges_not_linked_to_claims_count: type: integer description: The count of charge captures which are not part of a Claim Creation. charge_capture_claim_creations_not_started_count: type: integer description: The count of charge capture claim_creations that have a Claim Creation status of NOT_STARTED. charge_capture_held_claim_creations_count: type: integer description: The count of charge capture claim_creations that have a Claim Creation status of HELD. charge_capture_claim_creations_in_error_count: type: integer description: The count of charge capture claim_creations that have a Claim Creation status of IN_ERROR. charge_capture_unresolved_change_count: type: integer description: The number of ChargeCapturePostBilledChange items that are unresolved. required: - charge_capture_charges_not_linked_to_claims_count - charge_capture_claim_creations_not_started_count - charge_capture_held_claim_creations_count - charge_capture_claim_creations_in_error_count - charge_capture_unresolved_change_count title: ChargeCaptureClaimCreationSummary type_encounter-providers_v2_ProviderSecondaryIdentification: type: object properties: reference_identification: type: string description: Represents REF02 on the EDI 837 Loop 2010BB Billing Provider Secondary Identification segment. Value cannot exceed 50 characters reference_identification_qualifier: $ref: '#/components/schemas/type_encounter-providers_v2_ProviderSecondaryIdentificationQualifier' description: Represents REF01 on the EDI 837 Loop 2010BB Provider Secondary Identification segment. required: - reference_identification title: ProviderSecondaryIdentification type_commons_PhoneNumberOptional: type: object properties: number: type: string type: $ref: '#/components/schemas/type_commons_PhoneNumberType' title: PhoneNumberOptional type_health-care-code-information_v1_SetOrClearPrincipalDiagnosis: type: object properties: value: $ref: '#/components/schemas/type_health-care-code-information_v1_PrincipalDiagnosis' title: SetOrClearPrincipalDiagnosis type_encounter-providers_v2_EncounterProvider: type: object properties: first_name: type: string description: If the provider is an individual, this should be set instead of organization name last_name: type: string description: If the provider is an individual, this should be set instead of organization name organization_name: type: string description: If the provider is an organization, this should be set instead of first + last name provider_id: $ref: '#/components/schemas/type_encounter-providers_v2_ProviderId' address: $ref: '#/components/schemas/type_commons_StreetAddressLongZip' tax_id: type: string npi: type: string taxonomy_code: type: string qualifier: $ref: '#/components/schemas/type_commons_QualifierCode' provider_commercial_license_type: $ref: '#/components/schemas/type_commons_BillingProviderCommercialLicenseType' description: '837i Loop2010BB G2 Provider Commercial Number' secondary_identification: $ref: '#/components/schemas/type_encounter-providers_v2_ProviderSecondaryIdentification' description: 'Only one of provider_commercial_license_type or secondary_identification may be provided 837i Loop2010BB G2 Secondary Identification' required: - provider_id - address - npi title: EncounterProvider type_commons_ClaimAdjustmentGroupCodes: type: string enum: - CO - CR - DE - MA - OA - PI - PR - RR - NC - UNKNOWN title: ClaimAdjustmentGroupCodes type_pre-encounter_patients_v1_DoNotInvoiceReason: type: string enum: - BANKRUPTCY - DECEASED - HARDSHIP - OTHER - COLLECTIONS - BAD_ADDRESS - PROFESSIONAL_COURTESY title: DoNotInvoiceReason type_pre-encounter_eligibilityChecks_v1_CopayEstimationRecommendationPayload: type: object properties: structured_response: type: integer description: The estimated copay amount in cents exposition: type: string description: The AI's explanation of the copay estimate required: - exposition description: Payload for MD visit copay estimation from AI analysis title: CopayEstimationRecommendationPayload type_financials_ReallocationWouldOverdraftErrorContent: type: object properties: messages: type: array items: type: string description: 'Legacy field containing error messages as strings. Deprecated - use allocation_details for structured data. Will be removed in a future version after frontend migration.' allocation_details: type: array items: $ref: '#/components/schemas/type_financials_AllocationOverdraftDetail' description: 'Structured details about which allocations would be overdrafted. Each detail includes entity type, ID, and error message for table display.' required: - messages description: 'Error content when a reallocation would cause an account to be overdrafted. Contains both legacy string messages and new structured allocation details.' title: ReallocationWouldOverdraftErrorContent type_encounters_v4_IntakeResponseAndFollowUps: type: object properties: response: type: string follow_ups: type: array items: $ref: '#/components/schemas/type_encounters_v4_IntakeFollowUp' title: IntakeResponseAndFollowUps type_tags_Tag: type: object properties: tag_id: $ref: '#/components/schemas/type_tags_TagId' description: type: string color: $ref: '#/components/schemas/type_tags_TagColorEnum' creator_id: type: string required: - tag_id - description - color - creator_id title: Tag type_health-care-code-information_v1_ConditionInformation: type: object properties: id: type: string format: uuid description: 'The id of this health care code information if it is already stored. If this is not set, this is referring to a new health care code information to be added to the encounter. If it is set, this refers to an update of an existing health care code information object on the encounter.' encounter_id: $ref: '#/components/schemas/type_commons_EncounterId' description: 'The encounter_id of this health care code information if it is already stored. This will be set by the server in responses, but clients are not expected to set it.' condition_code_qualifier: $ref: '#/components/schemas/type_health-care-code-information_v1_ConditionInformationCodeQualifier' condition_code: $ref: '#/components/schemas/type_health-care-code-information_v1_ConditionCode' required: - condition_code_qualifier - condition_code description: This corresponds to the BG code qualifier value. title: ConditionInformation type_x12_v1_Rarc: type: string enum: - M1 - M2 - M3 - M4 - M5 - M6 - M7 - M8 - M9 - M10 - M11 - M12 - M13 - M14 - M15 - M16 - M17 - M18 - M19 - M20 - M21 - M22 - M23 - M24 - M25 - M26 - M27 - M28 - M29 - M30 - M31 - M32 - M33 - M34 - M35 - M36 - M37 - M38 - M39 - M40 - M41 - M42 - M43 - M44 - M45 - M46 - M47 - M48 - M49 - M50 - M51 - M52 - M53 - M54 - M55 - M56 - M57 - M58 - M59 - M60 - M61 - M62 - M63 - M64 - M65 - M66 - M67 - M68 - M69 - M70 - M71 - M72 - M73 - M74 - M75 - M76 - M77 - M78 - M79 - M80 - M81 - M82 - M83 - M84 - M85 - M86 - M87 - M88 - M89 - M90 - M91 - M92 - M93 - M94 - M95 - M96 - M97 - M98 - M99 - M100 - M101 - M102 - M103 - M104 - M105 - M106 - M107 - M108 - M109 - M110 - M111 - M112 - M113 - M114 - M115 - M116 - M117 - M118 - M119 - M120 - M121 - M122 - M123 - M124 - M125 - M126 - M127 - M128 - M129 - M130 - M131 - M132 - M133 - M134 - M135 - M136 - M137 - M138 - M139 - M140 - M141 - M142 - M143 - M144 - MA01 - MA02 - MA03 - MA04 - MA05 - MA06 - MA07 - MA08 - MA09 - MA10 - MA11 - MA12 - MA13 - MA14 - MA15 - MA16 - MA17 - MA18 - MA19 - MA20 - MA21 - MA22 - MA23 - MA24 - MA25 - MA26 - MA27 - MA28 - MA29 - MA30 - MA31 - MA32 - MA33 - MA34 - MA35 - MA36 - MA37 - MA38 - MA39 - MA40 - MA41 - MA42 - MA43 - MA44 - MA45 - MA46 - MA47 - MA48 - MA49 - MA50 - MA51 - MA52 - MA53 - MA54 - MA55 - MA56 - MA57 - MA58 - MA59 - MA60 - MA61 - MA62 - MA63 - MA64 - MA65 - MA66 - MA67 - MA68 - MA69 - MA70 - MA71 - MA72 - MA73 - MA74 - MA75 - MA76 - MA77 - MA78 - MA79 - MA80 - MA81 - MA82 - MA83 - MA84 - MA85 - MA86 - MA87 - MA88 - MA89 - MA90 - MA91 - MA92 - MA93 - MA94 - MA95 - MA96 - MA97 - MA98 - MA99 - MA100 - MA101 - MA102 - MA103 - MA104 - MA105 - MA106 - MA107 - MA108 - MA109 - MA110 - MA111 - MA112 - MA113 - MA114 - MA115 - MA116 - MA117 - MA118 - MA119 - MA120 - MA121 - MA122 - MA123 - MA124 - MA125 - MA126 - MA127 - MA128 - MA129 - MA130 - MA131 - MA132 - MA133 - MA134 - N1 - N2 - N3 - N4 - N5 - N6 - N7 - N8 - N9 - N10 - N11 - N12 - N13 - N14 - N15 - N16 - N17 - N18 - N19 - N20 - N21 - N22 - N23 - N24 - N25 - N26 - N27 - N28 - N29 - N30 - N31 - N32 - N33 - N34 - N35 - N36 - N37 - N38 - N39 - N40 - N41 - N42 - N43 - N44 - N45 - N46 - N47 - N48 - N49 - N50 - N51 - N52 - N53 - N54 - N55 - N56 - N57 - N58 - N59 - N60 - N61 - N62 - N63 - N64 - N65 - N66 - N67 - N68 - N69 - N70 - N71 - N72 - N73 - N74 - N75 - N76 - N77 - N78 - N79 - N80 - N81 - N82 - N83 - N84 - N85 - N86 - N87 - N88 - N89 - N90 - N91 - N92 - N93 - N94 - N95 - N96 - N97 - N98 - N99 - N100 - N101 - N102 - N103 - N104 - N105 - N106 - N107 - N108 - N109 - N110 - N111 - N112 - N113 - N114 - N115 - N116 - N117 - N118 - N119 - N120 - N121 - N122 - N123 - N124 - N125 - N126 - N127 - N128 - N129 - N130 - N131 - N132 - N133 - N134 - N135 - N136 - N137 - N138 - N139 - N140 - N141 - N142 - N143 - N144 - N145 - N146 - N147 - N148 - N149 - N150 - N151 - N152 - N153 - N154 - N155 - N156 - N157 - N158 - N159 - N160 - N161 - N162 - N163 - N164 - N165 - N166 - N167 - N168 - N169 - N170 - N171 - N172 - N173 - N174 - N175 - N176 - N177 - N178 - N179 - N180 - N181 - N182 - N183 - N184 - N185 - N186 - N187 - N188 - N189 - N190 - N191 - N192 - N193 - N194 - N195 - N196 - N197 - N198 - N199 - N200 - N201 - N202 - N203 - N204 - N205 - N206 - N207 - N208 - N209 - N210 - N211 - N212 - N213 - N214 - N215 - N216 - N217 - N218 - N219 - N220 - N221 - N222 - N223 - N224 - N225 - N226 - N227 - N228 - N229 - N230 - N231 - N232 - N233 - N234 - N235 - N236 - N237 - N238 - N239 - N240 - N241 - N242 - N243 - N244 - N245 - N246 - N247 - N248 - N249 - N250 - N251 - N252 - N253 - N254 - N255 - N256 - N257 - N258 - N259 - N260 - N261 - N262 - N263 - N264 - N265 - N266 - N267 - N268 - N269 - N270 - N271 - N272 - N273 - N274 - N275 - N276 - N277 - N278 - N279 - N280 - N281 - N282 - N283 - N284 - N285 - N286 - N287 - N288 - N289 - N290 - N291 - N292 - N293 - N294 - N295 - N296 - N297 - N298 - N299 - N300 - N301 - N302 - N303 - N304 - N305 - N306 - N307 - N308 - N309 - N310 - N311 - N312 - N313 - N314 - N315 - N316 - N317 - N318 - N319 - N320 - N321 - N322 - N323 - N324 - N325 - N326 - N327 - N328 - N329 - N330 - N331 - N332 - N333 - N334 - N335 - N336 - N337 - N338 - N339 - N340 - N341 - N342 - N343 - N344 - N345 - N346 - N347 - N348 - N349 - N350 - N351 - N352 - N353 - N354 - N355 - N356 - N357 - N358 - N359 - N360 - N361 - N362 - N363 - N364 - N365 - N366 - N367 - N368 - N369 - N370 - N371 - N372 - N373 - N374 - N375 - N376 - N377 - N378 - N379 - N380 - N381 - N382 - N383 - N384 - N385 - N386 - N387 - N388 - N389 - N390 - N391 - N392 - N393 - N394 - N395 - N396 - N397 - N398 - N399 - N400 - N401 - N402 - N403 - N404 - N405 - N406 - N407 - N408 - N409 - N410 - N411 - N412 - N413 - N414 - N415 - N416 - N417 - N418 - N419 - N420 - N421 - N422 - N423 - N424 - N425 - N426 - N427 - N428 - N429 - N430 - N431 - N432 - N433 - N434 - N435 - N436 - N437 - N438 - N439 - N440 - N441 - N442 - N443 - N444 - N445 - N446 - N447 - N448 - N449 - N450 - N451 - N452 - N453 - N454 - N455 - N456 - N457 - N458 - N459 - N460 - N461 - N462 - N463 - N464 - N465 - N466 - N467 - N468 - N469 - N470 - N471 - N472 - N473 - N474 - N475 - N476 - N477 - N478 - N479 - N480 - N481 - N482 - N483 - N484 - N485 - N486 - N487 - N488 - N489 - N490 - N491 - N492 - N493 - N494 - N495 - N496 - N497 - N498 - N499 - N500 - N501 - N502 - N503 - N504 - N505 - N506 - N507 - N508 - N509 - N510 - N511 - N512 - N513 - N514 - N515 - N516 - N517 - N518 - N519 - N520 - N521 - N522 - N523 - N524 - N525 - N526 - N527 - N528 - N529 - N530 - N531 - N532 - N533 - N534 - N535 - N536 - N537 - N538 - N539 - N540 - N541 - N542 - N543 - N544 - N545 - N546 - N547 - N548 - N549 - N550 - N551 - N552 - N553 - N554 - N555 - N556 - N557 - N558 - N559 - N560 - N561 - N562 - N563 - N564 - N565 - N566 - N567 - N568 - N569 - N570 - N571 - N572 - N573 - N574 - N575 - N576 - N577 - N578 - N579 - N580 - N581 - N582 - N583 - N584 - N585 - N586 - N587 - N588 - N589 - N590 - N591 - N592 - N593 - N594 - N595 - N596 - N597 - N598 - N599 - N600 - N601 - N602 - N603 - N604 - N605 - N606 - N607 - N608 - N609 - N610 - N611 - N612 - N613 - N614 - N615 - N616 - N617 - N618 - N619 - N620 - N621 - N622 - N623 - N624 - N625 - N626 - N627 - N628 - N629 - N630 - N631 - N632 - N633 - N634 - N635 - N636 - N637 - N638 - N639 - N640 - N641 - N642 - N643 - N644 - N645 - N646 - N647 - N648 - N649 - N650 - N651 - N652 - N653 - N654 - N655 - N656 - N657 - N658 - N659 - N660 - N661 - N662 - N663 - N664 - N665 - N666 - N667 - N668 - N669 - N670 - N671 - N672 - N673 - N674 - N675 - N676 - N677 - N678 - N679 - N680 - N681 - N682 - N683 - N684 - N685 - N686 - N687 - N688 - N689 - N690 - N691 - N692 - N693 - N694 - N695 - N696 - N697 - N698 - N699 - N700 - N701 - N702 - N703 - N704 - N705 - N706 - N707 - N708 - N709 - N710 - N711 - N712 - N713 - N714 - N715 - N716 - N717 - N718 - N719 - N720 - N721 - N722 - N723 - N724 - N725 - N726 - N727 - N728 - N729 - N730 - N731 - N732 - N733 - N734 - N735 - N736 - N737 - N738 - N739 - N740 - N741 - N742 - N743 - N744 - N745 - N746 - N747 - N748 - N749 - N750 - N751 - N752 - N753 - N754 - N755 - N756 - N757 - N758 - N759 - N760 - N761 - N762 - N763 - N764 - N765 - N766 - N767 - N768 - N769 - N770 - N771 - N772 - N773 - N774 - N775 - N776 - N777 - N778 - N779 - N780 - N781 - N782 - N783 - N784 - N785 - N786 - N787 - N788 - N789 - N790 - N791 - N792 - N793 - N794 - N795 - N796 - N797 - N798 - N799 - N800 - N801 - N802 - N803 - N804 - N805 - N806 - N807 - N808 - N809 - N810 - N811 - N812 - N815 - N816 - N817 - N818 - N819 - N820 - N821 - N822 - N823 - N824 - N825 - N826 - N827 - N828 - N829 - N830 - N831 - N832 - N833 - N834 - N835 - N836 - N837 - N838 - N839 - N840 - N841 - N842 - N843 - N844 - N845 - N846 - N847 - N848 - N849 - N850 - N851 - N852 - N853 - N854 - N855 - N856 - N857 - N858 - N859 - N860 - N861 - N862 - N863 - N864 - N865 - N866 - N867 - N868 - N869 - N870 - N871 - N872 - N873 - N874 - N875 - N876 - N877 - N878 - N879 - N880 - N881 - N882 - N883 - N884 - N885 - N886 - N887 - N888 - N889 - N890 - N891 - N892 - N893 - N894 - N895 - N896 - N897 - N898 - N899 - N900 - N901 - N902 - N903 - N904 - N905 - N906 - N907 - N908 - N909 - N910 - N911 - UNKNOWN title: Rarc type_patient-ar_v1_NonInsuranceAdjustmentInfo: type: object properties: total_adjustment_cents: type: integer description: The total amount of non-insurance adjustments in cents for the service line. required: - total_adjustment_cents title: NonInsuranceAdjustmentInfo type_pre-encounter_eligibilityChecks_v1_CobPlanDateInformation: type: object properties: plan_begin: type: string description: When the patient's health plan coverage begins. plan_end: type: string description: When the patient's health plan coverage ends. description: Dates associated with the patient's health plan coverage. title: CobPlanDateInformation type_external-payment-account-config_v1_ExternalPaymentAccountConfigPage: type: object properties: prev_page_token: $ref: '#/components/schemas/type_commons_PageToken' next_page_token: $ref: '#/components/schemas/type_commons_PageToken' items: type: array items: $ref: '#/components/schemas/type_external-payment-account-config_v1_ExternalPaymentAccountConfig' required: - items title: ExternalPaymentAccountConfigPage type_pre-encounter_patientMerges_v1_PatientMergeStatus: oneOf: - type: object properties: merge_status: type: string enum: - none description: 'Discriminator value: none' required: - merge_status - type: object properties: merge_status: type: string enum: - alternative description: 'Discriminator value: alternative' primary_mrn: type: string required: - merge_status - primary_mrn - type: object properties: merge_status: type: string enum: - primary description: 'Discriminator value: primary' alternative_mrns: type: array items: type: string required: - merge_status - alternative_mrns discriminator: propertyName: merge_status description: The merge status of a patient. title: PatientMergeStatus type_pre-encounter_eligibilityChecks_v1_OrganizationProvider: type: object properties: organization_name: type: string npi: type: string required: - npi title: OrganizationProvider type_pre-encounter_common_OrganizationId: type: string description: The unique identifier for an Organization in the database title: OrganizationId type_billing-notes_v2_BillingNoteMetadata: oneOf: - type: object properties: type: type: string enum: - queue_added description: 'Discriminator value: queue_added' queue_id: type: string queue_name: type: string required: - type - queue_id - queue_name - type: object properties: type: type: string enum: - queue_moved description: 'Discriminator value: queue_moved' from_queue_id: type: string from_queue_name: type: string to_queue_id: type: string to_queue_name: type: string required: - type - from_queue_id - from_queue_name - to_queue_id - to_queue_name - type: object properties: type: type: string enum: - task_created description: 'Discriminator value: task_created' task_id: type: string format: uuid task_type: type: string required: - type - task_id - task_type discriminator: propertyName: type title: BillingNoteMetadata type_pre-encounter_coverages_v1_CoverageCarveOut: type: object properties: carve_out: $ref: '#/components/schemas/type_pre-encounter_coverages_v1_CarveOutType' member_id: type: string payer_id: $ref: '#/components/schemas/type_pre-encounter_common_PayerId' payer_name: type: string group_number: type: string plan_type: $ref: '#/components/schemas/type_pre-encounter_coverages_v1_NetworkType' type: $ref: '#/components/schemas/type_pre-encounter_coverages_v1_InsuranceTypeCode' payer_plan_group_id: $ref: '#/components/schemas/type_pre-encounter_common_PayerPlanGroupId' description: The ID of the Candid configured payer plan group associated with this coverage required: - carve_out - member_id - payer_id - payer_name title: CoverageCarveOut type_commons_StreetAddressLongZipOptional: 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 title: StreetAddressLongZipOptional type_pre-encounter_common_NoteId: type: string description: The unique identifier for a Note. title: NoteId type_pre-encounter_coverages_v1_PlanCoverageDetails: type: object properties: deductible: $ref: '#/components/schemas/type_pre-encounter_coverages_v1_CoverageValue' deductible_contract: $ref: '#/components/schemas/type_pre-encounter_coverages_v1_CoverageValue' deductible_remaining: $ref: '#/components/schemas/type_pre-encounter_coverages_v1_CoverageValue' deductible_year_to_date: $ref: '#/components/schemas/type_pre-encounter_coverages_v1_CoverageValue' oop_max: $ref: '#/components/schemas/type_pre-encounter_coverages_v1_CoverageValue' oop_max_contract: $ref: '#/components/schemas/type_pre-encounter_coverages_v1_CoverageValue' oop_max_remaining: $ref: '#/components/schemas/type_pre-encounter_coverages_v1_CoverageValue' oop_max_year_to_date: $ref: '#/components/schemas/type_pre-encounter_coverages_v1_CoverageValue' additional_notes: type: string title: PlanCoverageDetails type_service-lines_v2_ServiceLineERAData: type: object properties: service_line_adjustments: type: array items: $ref: '#/components/schemas/type_service-lines_v2_ServiceLineAdjustment' description: 'Deprecated. This field aggregates all CARCs across a service line''s history without granular context (e.g., which CARCs relate to denials vs. payments vs. reversals), making it unsuitable for denial analysis or operational workflows.' remittance_advice_remark_codes: type: array items: type: string required: - service_line_adjustments - remittance_advice_remark_codes title: ServiceLineERAData type_pre-encounter_eligibilityChecks_v1_CobResponseDependent: type: object properties: member_id: type: string description: The member ID for the subscriber's insurance policy. first_name: type: string last_name: type: string middle_name: type: string gender: type: string description: The dependent's gender. Typically `F` - Female, `M` - Male, or `U` - Unknown. date_of_birth: type: string ssn: type: string group_number: type: string description: The group number associated with the subscriber's insurance policy. relation_to_subscriber: type: string description: The name of the relation_to_subscriber_code. For example, `Child` when the code is `19`. relation_to_subscriber_code: type: string description: 'The dependent''s relationship to the subscriber. For example `01` - Spouse, `19` - Child, `20` - Employee, `21` - Unknown, `39` - Organ Donor, `40` - Cadaver Donor, `53` - Life Partner, or `G8` - Other Relationship.' birth_sequence_number: type: string description: Birth order when there are multiple births associated with the provided birth date. address: $ref: '#/components/schemas/type_pre-encounter_eligibilityChecks_v1_CobAddress' aaa_errors: type: array items: $ref: '#/components/schemas/type_pre-encounter_eligibilityChecks_v1_EligibilityCheckErrorDetails' description: AAA errors specifying reasons for rejection and recommended follow-up actions. description: Information about the dependent listed in the original COB request. title: CobResponseDependent type_pre-encounter_eligibilityChecks_v1_Vote: type: object properties: user_id: $ref: '#/components/schemas/type_pre-encounter_common_UserId' description: The user who voted value: $ref: '#/components/schemas/type_pre-encounter_eligibilityChecks_v1_VoteValue' description: The vote value required: - user_id - value description: User feedback on a recommendation title: Vote type_insurance-refunds_v1_InsuranceRefundsPage: type: object properties: prev_page_token: $ref: '#/components/schemas/type_commons_PageToken' next_page_token: $ref: '#/components/schemas/type_commons_PageToken' items: type: array items: $ref: '#/components/schemas/type_insurance-refunds_v1_InsuranceRefund' required: - items title: InsuranceRefundsPage type_pre-encounter_appointments_v1_CountsResponse: type: object properties: not_ready_reason_counts: type: object additionalProperties: type: integer title: CountsResponse type_encounters_v4_Lab: type: object properties: name: type: string code: type: string code_type: $ref: '#/components/schemas/type_encounters_v4_LabCodeType' required: - name title: Lab type_pre-encounter_common_ErrorBase4xx: type: object properties: message: type: string data: description: Any type required: - message title: ErrorBase4xx type_patient-ar_v1_InvoiceItemizationResponse: type: object properties: claim_id: $ref: '#/components/schemas/type_commons_ClaimId' description: The ID of the claim associated with the invoice itemization. patient_balance_cents: type: integer description: The total patient balance in cents for the claim. Negative values indicate a credit balance. organization_service_facility_id: $ref: '#/components/schemas/type_organization-service-facilities_v2_OrganizationServiceFacilityId' description: The organization service facility ID from the claim's encounter. claim_level_patient_payments: $ref: '#/components/schemas/type_patient-ar_v1_PatientPaymentInfo' service_line_itemization: type: array items: $ref: '#/components/schemas/type_patient-ar_v1_ServiceLineItemization' description: A list of service line itemizations for the claim. required: - claim_id - patient_balance_cents - claim_level_patient_payments - service_line_itemization title: InvoiceItemizationResponse type_pre-encounter_common_Race: type: string enum: - AMERICAN_INDIAN_OR_ALASKA_NATIVE - WHITE - BLACK - ASIAN - NATIVE_HAWAIIAN_OR_OTHER_PACIFIC_ISLANDER - MIDDLE_EASTERN_OR_NORTH_AFRICAN - OTHER - UNKNOWN - REFUSED title: Race type_pre-encounter_organizationExternalProviders_v1_OrganizationExternalProvider: type: object properties: organization_id: $ref: '#/components/schemas/type_pre-encounter_common_OrganizationId' description: The organization that owns this object. deactivated: type: boolean description: True if the object is deactivated. Deactivated objects are not returned in search results but are returned in all other endpoints including scan. version: type: integer description: The version of the object. Any update to any property of an object object will create a new version. updated_at: type: string format: date-time updating_user_id: $ref: '#/components/schemas/type_pre-encounter_common_UserId' description: The user ID of the user who last updated the object. name: $ref: '#/components/schemas/type_pre-encounter_common_HumanName' types: type: array items: $ref: '#/components/schemas/type_pre-encounter_organizationExternalProviders_v1_OrganizationExternalProviderType' npi: type: string tax_id: type: string taxonomy_code: type: string phone_number: type: string other_phone_numbers: type: array items: type: string fax_number: type: string other_fax_numbers: type: array items: type: string emails: type: array items: type: string license_type: $ref: '#/components/schemas/type_pre-encounter_organizationExternalProviders_v1_LicenseType' addresses: type: array items: $ref: '#/components/schemas/type_pre-encounter_common_Address' id: $ref: '#/components/schemas/type_pre-encounter_organizationExternalProviders_v1_OrganizationExternalProviderId' required: - organization_id - deactivated - version - updated_at - updating_user_id - name - types - id description: An OrganizationExternalProvider object with immutable server-owned properties. title: OrganizationExternalProvider type_service-lines_v2_TestResult: type: object properties: value: type: number format: double result_type: $ref: '#/components/schemas/type_service-lines_v2_TestResultType' required: - value - result_type title: TestResult type_pre-encounter_patientMerges_v1_PatientMerge: type: object properties: organization_id: $ref: '#/components/schemas/type_pre-encounter_common_OrganizationId' description: The organization that owns this object. deactivated: type: boolean description: True if the object is deactivated. Deactivated objects are not returned in search results but are returned in all other endpoints including scan. version: type: integer description: The version of the object. Any update to any property of an object object will create a new version. updated_at: type: string format: date-time updating_user_id: $ref: '#/components/schemas/type_pre-encounter_common_UserId' description: The user ID of the user who last updated the object. alternative_patient_mrn: type: string description: The MRN of the patient that was merged. primary_patient_mrn: type: string description: The MRN of the patient that is getting a patient merged into them. id: $ref: '#/components/schemas/type_pre-encounter_common_PatientMergeId' required: - organization_id - deactivated - version - updated_at - updating_user_id - alternative_patient_mrn - primary_patient_mrn - id description: A PatientMerge object with immutable server-owned properties. title: PatientMerge type_encounter-providers_v2_ProviderSecondaryIdentificationOptional: type: object properties: reference_identification: type: string description: Represents REF02 on the EDI 837 Loop 2010BB Billing Provider Secondary Identification segment. Value cannot exceed 50 characters reference_identification_qualifier: $ref: '#/components/schemas/type_encounter-providers_v2_ProviderSecondaryIdentificationQualifier' description: Represents REF01 on the EDI 837 Loop 2010BB Provider Secondary Identification segment. title: ProviderSecondaryIdentificationOptional type_x12_v1_TypeOfBillFrequencyCode: type: string enum: - '0' - '1' - '2' - '3' - '4' - '5' - '7' - '8' - '9' - A - B - C - D - E - F - G - H - I - J - K - M - O - P - Q - X - Y - Z title: TypeOfBillFrequencyCode type_related-causes_v1_RelatedCausesInformationCreateOptional: type: object properties: related_causes_code_1: $ref: '#/components/schemas/type_related-causes_v1_RelatedCausesCode' related_causes_code_2: $ref: '#/components/schemas/type_related-causes_v1_RelatedCausesCode' state_or_province_code: type: string title: RelatedCausesInformationCreateOptional type_pre-encounter_coverages_v1_ServiceCoverage: type: object properties: service_code: $ref: '#/components/schemas/type_pre-encounter_coverages_v1_ServiceTypeCode' in_network: $ref: '#/components/schemas/type_pre-encounter_coverages_v1_ServiceCoverageDetails' in_network_flat: type: array items: $ref: '#/components/schemas/type_pre-encounter_coverages_v1_CoverageDetails' out_of_network: $ref: '#/components/schemas/type_pre-encounter_coverages_v1_ServiceCoverageDetails' out_of_network_flat: type: array items: $ref: '#/components/schemas/type_pre-encounter_coverages_v1_CoverageDetails' required: - service_code title: ServiceCoverage type_commons_PhoneNumber: type: object properties: number: type: string type: $ref: '#/components/schemas/type_commons_PhoneNumberType' required: - number - type title: PhoneNumber type_pre-encounter_patients_v1_PatientPage: type: object properties: next_page_token: $ref: '#/components/schemas/type_pre-encounter_common_PageToken' prev_page_token: $ref: '#/components/schemas/type_pre-encounter_common_PageToken' total: type: integer items: type: array items: $ref: '#/components/schemas/type_pre-encounter_patients_v1_Patient' required: - total - items title: PatientPage type_pre-encounter_patients_v1_FilingOrder: type: object properties: coverages: type: array items: $ref: '#/components/schemas/type_pre-encounter_common_CoverageId' required: - coverages description: The patient's active coverages, in order of primary, secondary, etc. title: FilingOrder type_invoices_v2_InvoiceStatus: type: string enum: - DRAFT - OPEN - PAID - VOID - UNCOLLECTIBLE - HELD title: InvoiceStatus type_encounters_v4_BillableStatusType: type: string enum: - BILLABLE - NOT_BILLABLE title: BillableStatusType type_health-care-code-information_v1_SetOrClearPrincipalProcedureInformation: type: object properties: value: $ref: '#/components/schemas/type_health-care-code-information_v1_PrincipalProcedureInformation' title: SetOrClearPrincipalProcedureInformation type_pre-encounter_eligibilityChecks_v1_UserConfiguredPromptsResult: type: object properties: user_prompt_id: type: string description: Reference to the user prompt in eligibility config prompt_name: type: string description: User-defined name for the prompt structured_response: description: The AI's structured answer (boolean, number, or string) exposition: type: string description: The AI's explanation of the answer required: - user_prompt_id - prompt_name - structured_response - exposition description: Individual result from a single user-configured prompt execution title: UserConfiguredPromptsResult type_pre-encounter_patients_v1_AdvancedDirective: type: string enum: - NONE - DURABLE_POWER_OF_ATTORNEY - LIVING_WILL - DO_NOT_RESUSCITATE - STANDARD_PRECAUTIONS - FALL_RISK title: AdvancedDirective type_insurance-adjudications_v1_ServiceLineAdjudication: type: object properties: service_line_adjudication_id: $ref: '#/components/schemas/type_insurance-adjudications_v1_ServiceLineAdjudicationId' denial_reason: $ref: '#/components/schemas/type_service-lines_v2_DenialReasonContent' description: Will be treated as a denial if present insurance_allowed_amount_cents: type: integer insurance_paid_amount_cents: type: integer deductible_amount_cents: type: integer coinsurance_amount_cents: type: integer copay_amount_cents: type: integer carcs: type: array items: $ref: '#/components/schemas/type_x12_v1_ClaimAdjustmentReasonCode' rarcs: type: array items: $ref: '#/components/schemas/type_x12_v1_RemittanceAdviceRemarkCode' required: - service_line_adjudication_id - carcs - rarcs title: ServiceLineAdjudication type_write-offs_v1_CreateWriteOffsResponse: type: object properties: write_offs: type: array items: $ref: '#/components/schemas/type_write-offs_v1_WriteOff' required: - write_offs title: CreateWriteOffsResponse type_related-causes_v1_RelatedCausesInformation: type: object properties: related_causes_code_1: $ref: '#/components/schemas/type_related-causes_v1_RelatedCausesCode' related_causes_code_2: $ref: '#/components/schemas/type_related-causes_v1_RelatedCausesCode' state_or_province_code: type: string required: - related_causes_code_1 title: RelatedCausesInformation type_commons_ServiceLineId: type: string format: uuid title: ServiceLineId type_health-care-code-information_v1_PrincipalProcedureInformationCodeQualifier: type: string enum: - BBR - BR - CAH title: PrincipalProcedureInformationCodeQualifier type_pre-encounter_common_Gender: type: string enum: - MAN - WOMAN - NON_BINARY - TWO_SPIRIT - FEMALE_TO_MALE - MALE_TO_FEMALE - OTHER - UNKNOWN - REFUSED title: Gender 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-providers_v2_ProviderSecondaryIdentificationQualifier: type: string enum: - 0B - 1G - G2 - LU title: ProviderSecondaryIdentificationQualifier type_financials_AllocationRestrictionCreate: type: object properties: restriction_type: $ref: '#/components/schemas/type_financials_AllocationRestrictionType' restriction_value: type: string description: For billing_provider_npi, the NPI. For service_facility_id, the organization service facility ID. required: - restriction_type - restriction_value description: 'Constrains which claims a payment''s credit can be auto-allocated to. Restrictions of the same restriction_type are OR''d together (any value may match); different restriction_types are AND''d (every type present must match). A payment with no restrictions can be allocated to any claim.' title: AllocationRestrictionCreate type_pre-encounter_patients_v1_InferredPatientMetadata: type: object properties: inferred_encounter_id: type: string inferred_encounter_latest_date_of_service: type: string format: date required: - inferred_encounter_id - inferred_encounter_latest_date_of_service title: InferredPatientMetadata type_pre-encounter_images_v1_ImageId: type: string description: The unique identifier for an Image title: ImageId type_users_v2_IdpUserMetadata: oneOf: - type: object properties: type: type: string enum: - auth_zero_metadata description: 'Discriminator value: auth_zero_metadata' auth0_id: type: string required: - type - auth0_id - type: object properties: type: type: string enum: - google_apps_metadata description: 'Discriminator value: google_apps_metadata' google_apps_id: type: string required: - type - google_apps_id - type: object properties: type: type: string enum: - other_idp_metadata description: 'Discriminator value: other_idp_metadata' idp_external_id: type: string required: - type - idp_external_id discriminator: propertyName: type title: IdpUserMetadata type_pre-encounter_lists_v1_PatientListItem: type: object properties: patient: $ref: '#/components/schemas/type_pre-encounter_patients_v1_Patient' primary_coverage: $ref: '#/components/schemas/type_pre-encounter_coverages_v1_MutableCoverage' secondary_coverage: $ref: '#/components/schemas/type_pre-encounter_coverages_v1_MutableCoverage' tertiary_coverage: $ref: '#/components/schemas/type_pre-encounter_coverages_v1_MutableCoverage' next_appointment: $ref: '#/components/schemas/type_pre-encounter_appointments_v1_MutableAppointment' primary_mrn: type: string alternative_mrns: type: array items: type: string required: - patient - alternative_mrns title: PatientListItem type_pre-encounter_organizationExternalProviders_v1_OrganizationExternalProviderPage: type: object properties: next_page_token: $ref: '#/components/schemas/type_pre-encounter_common_PageToken' prev_page_token: $ref: '#/components/schemas/type_pre-encounter_common_PageToken' total: type: integer items: type: array items: $ref: '#/components/schemas/type_pre-encounter_organizationExternalProviders_v1_OrganizationExternalProvider' required: - total - items title: OrganizationExternalProviderPage type_commons_InternalErrorMessage: type: object properties: message: type: string title: InternalErrorMessage type_health-care-code-information_v1_PresentOnAdmissionIndicatorCode: type: string enum: - Y - N - U - W - '1' title: PresentOnAdmissionIndicatorCode type_pre-encounter_eligibilityChecks_v1_EligibilityRequest: type: object properties: submitter_transaction_identifier: type: string description: 'A unique identifier for the eligibility check within the batch. Candid returns this identifier in the response for the /batch/{batch_id} polling endpoint so you can correlate benefit responses with the original eligibility check.' payer_id: type: string description: Supported payer ID values can be found [here](https://www.stedi.com/healthcare/network). provider: $ref: '#/components/schemas/type_pre-encounter_eligibilityChecks_v1_Provider' subscriber: $ref: '#/components/schemas/type_pre-encounter_coverages_v1_MemberInfo' description: The primary policyholder for the insurance plan or a dependent with a unique member ID. If a dependent has a unique member ID, include their information here and leave dependent undefined. dependent: $ref: '#/components/schemas/type_pre-encounter_coverages_v1_MemberInfo' description: If a dependent has a unique member ID, include their information as subscriber and leave this field undefined. encounter: $ref: '#/components/schemas/type_pre-encounter_eligibilityChecks_v1_Encounter' get_existing_check_initiated_after: type: string format: date-time description: If not provided, this endpoint will run a fresh eligibility check. If provided, it will return an existing successful eligibility check if one exists that was initiated after provided date with the same parameters (Date of Service, Payer ID, Provider, Subscriber, Dependent, and Encounter). source: type: string portal_password: type: string description: The password that the provider uses to log in to the payer's portal. This is not commonly used. portal_username: type: string description: The username that the provider uses to log in to the payer's portal. This is not commonly used. required: - payer_id - provider - subscriber description: An object representing the data for an eligibility request. title: EligibilityRequest type_commons_SourceOfPaymentCode: type: string enum: - 09 - '11' - '12' - '13' - '14' - '15' - '16' - '17' - AM - BL - CH - CI - DS - FI - HM - LM - MA - MB - MC - OF - TV - VA - WC - ZZ title: SourceOfPaymentCode type_health-care-code-information_v1_SetOrClearAdmittingDiagnosis: type: object properties: value: $ref: '#/components/schemas/type_health-care-code-information_v1_AdmittingDiagnosis' title: SetOrClearAdmittingDiagnosis type_encounter-providers_v2_SupervisingProviderUpdateWithOptionalAddress: type: object properties: first_name: type: string description: If the provider is an individual, this should be set instead of organization name last_name: type: string description: If the provider is an individual, this should be set instead of organization name organization_name: type: string description: If the provider is an organization, this should be set instead of first + last name npi: type: string description: 'A National Provider Identifier is a unique 10-digit identification number issued to health care providers in the United States' taxonomy_code: type: string address: $ref: '#/components/schemas/type_commons_StreetAddressShortZipOptional' secondary_identification: $ref: '#/components/schemas/type_encounter-providers_v2_SupervisingProviderSecondaryIdentificationOptional' title: SupervisingProviderUpdateWithOptionalAddress type_health-care-code-information_v1_TreatmentCodeInformation: type: object properties: id: type: string format: uuid description: 'The id of this health care code information if it is already stored. If this is not set, this is referring to a new health care code information to be added to the encounter. If it is set, this refers to an update of an existing health care code information object on the encounter.' encounter_id: $ref: '#/components/schemas/type_commons_EncounterId' description: 'The encounter_id of this health care code information if it is already stored. This will be set by the server in responses, but clients are not expected to set it.' treatment_code_qualifier: $ref: '#/components/schemas/type_health-care-code-information_v1_TreatmentCodeQualifier' treatment_code: $ref: '#/components/schemas/type_health-care-code-information_v1_TreatmentCode' required: - treatment_code_qualifier - treatment_code description: This corresponds to the TC code qualifier value. title: TreatmentCodeInformation type_charge-capture_v1_Hl7MessageType: type: string enum: - BAR - DFT - ADT description: HL7 message type that produced a charge-capture write. Values match the bare MSH-9-1 code emitted by HL7 producers (conduit). Constrains the `hl7_message_type` field on charge-capture create/update payloads so that whitespace, case drift, or non-canonical values are rejected at the API boundary instead of silently bypassing the BAR/DFT discriminator. title: Hl7MessageType 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_payers_v3_PayerId: type: string title: PayerId type_pre-encounter_coverages_v1_PlanDate: type: object properties: start_date: type: string format: date end_date: type: string format: date field_name: type: string required: - start_date - field_name title: PlanDate type_insurance-cards_v2_InsuranceCardId: type: string format: uuid title: InsuranceCardId type_commons_RequestValidationError: type: object properties: fieldName: type: string humanReadableMessage: type: string required: - fieldName title: RequestValidationError type_medication-dispense_v1_MedicationDispenseCreate: type: object properties: medication_dispense_external_id: type: string patient_external_id: type: string procedure_code: type: string quantity: $ref: '#/components/schemas/type_commons_Decimal' units: $ref: '#/components/schemas/type_commons_ServiceLineUnits' date_of_service: type: string format: date drug_identification: $ref: '#/components/schemas/type_service-lines_v2_DrugIdentification' description: type: string modifiers: type: array items: $ref: '#/components/schemas/type_commons_ProcedureModifier' required: - medication_dispense_external_id - patient_external_id - procedure_code - quantity - units - date_of_service title: MedicationDispenseCreate type_individual_PatientNonInsurancePayerInfoCreateOptional: type: object properties: non_insurance_payer_id: $ref: '#/components/schemas/type_non-insurance-payers_v1_NonInsurancePayerId' member_id: type: string clinical_trial_info: type: array items: $ref: '#/components/schemas/type_individual_PatientClinicalTrialInfoCreateOptional' title: PatientNonInsurancePayerInfoCreateOptional type_insurance-adjudications_v1_InsuranceAdjudication: type: object properties: insurance_adjudication_id: $ref: '#/components/schemas/type_insurance-adjudications_v1_InsuranceAdjudicationId' payer_uuid: $ref: '#/components/schemas/type_payers_v3_PayerUuid' post_date: type: string format: date check_number: type: string check_date: type: string format: date note: type: string claims: type: object additionalProperties: type: array items: $ref: '#/components/schemas/type_insurance-adjudications_v1_ClaimAdjudication' required: - insurance_adjudication_id - payer_uuid - check_date - claims title: InsuranceAdjudication type_pre-encounter_common_ExternalProvider: type: object properties: name: $ref: '#/components/schemas/type_pre-encounter_common_HumanName' type: $ref: '#/components/schemas/type_pre-encounter_common_ExternalProviderType' description: Defaults to ATTENDING. npi: type: string telecoms: type: array items: $ref: '#/components/schemas/type_pre-encounter_common_ContactPoint' addresses: type: array items: $ref: '#/components/schemas/type_pre-encounter_common_Address' period: $ref: '#/components/schemas/type_pre-encounter_common_Period' canonical_id: $ref: '#/components/schemas/type_pre-encounter_common_CanonicalProviderId' fax: type: string other_fax_numbers: type: array items: type: string emails: type: array items: type: string service_facilities: type: array items: $ref: '#/components/schemas/type_pre-encounter_common_PatientServiceFacility' description: Associated service facilities for this provider. required: - name - telecoms title: ExternalProvider type_encounters_v4_IntakeFollowUp: type: object properties: id: $ref: '#/components/schemas/type_encounters_v4_IntakeFollowUpId' text: type: string response: type: string required: - id - text title: IntakeFollowUp type_charge-capture_v1_ChargeCaptureError: type: object properties: id: type: string format: uuid charge_capture_id: $ref: '#/components/schemas/type_commons_ChargeCaptureId' description: 'The underlying Charge Capture that this error object references. The Charge Capture referenced will be a part of the Claim Creation tied to this error. Errors may also refer to all charge_captures present in a Claim Creation, in which case this field will be null.' message: type: string description: A human readable error explaining why this charge capture Claim Creation failed to create a claim. resolved: type: boolean description: Whether or not the error has been resolved as part of user workflows resolved_by: type: string description: A string denoting who resolved the error within candid's system. resolution_reason: type: string description: A string denoting how or why an error was resolved. field_in_error: type: string description: 'The field of the corresponding underlying ChargeCapture that has a field that is failing validations, is not present but marked as required, or otherwise in error.' claim_creation_id: $ref: '#/components/schemas/type_commons_ChargeCaptureClaimCreationId' description: The ID of the ChargeCaptureClaimCreation associated with this Error. required: - id - message - claim_creation_id title: ChargeCaptureError type_service-lines_v2_DrugIdentificationOptional: type: object properties: service_id_qualifier: $ref: '#/components/schemas/type_service-lines_v2_ServiceIdQualifier' national_drug_code: type: string national_drug_unit_count: type: string measurement_unit_code: $ref: '#/components/schemas/type_service-lines_v2_MeasurementUnitCode' link_sequence_number: type: string pharmacy_prescription_number: type: string conversion_formula: type: string drug_description: type: string title: DrugIdentificationOptional type_non-insurance-payers_v1_NonInsurancePayerDescriptionUpdate: oneOf: - type: object properties: type: type: string enum: - remove description: 'Discriminator value: remove' required: - type - type: object properties: type: type: string enum: - set description: 'Discriminator value: set' value: type: string required: - type - value description: Max 255 characters allowed discriminator: propertyName: type title: NonInsurancePayerDescriptionUpdate type_encounters_v4_InterventionOptional: type: object properties: name: type: string category: $ref: '#/components/schemas/type_encounters_v4_InterventionCategory' description: type: string description: '"Examples: ''Birth Control LAC'', ''Tracking'', ''Stress Management'', ''Supplement'', ''Labs''"' medication: $ref: '#/components/schemas/type_encounters_v4_MedicationOptional' description: Required when `type` is `allopathic`. labs: type: array items: $ref: '#/components/schemas/type_encounters_v4_LabOptional' description: Required when `type` is `tests`. title: InterventionOptional type_individual_IndividualId: type: string format: uuid title: IndividualId type_individual_SubscriberCreateOptional: type: object properties: first_name: type: string last_name: type: string gender: $ref: '#/components/schemas/type_individual_Gender' patient_relationship_to_subscriber_code: $ref: '#/components/schemas/type_commons_PatientRelationshipToInsuredCodeAll' date_of_birth: type: string format: date address: $ref: '#/components/schemas/type_commons_StreetAddressShortZipOptional' insurance_card: $ref: '#/components/schemas/type_insurance-cards_v2_InsuranceCardCreateOptional' description: Please reference our [Payer Information](https://docs.joincandidhealth.com/introduction/payer-information) documentation for more details on how to populate the `insurance_card` fields. title: SubscriberCreateOptional type_payer-plan-groups_v1_PayerPlanGroupSortField: type: string enum: - plan_group_name - plan_type - created_at title: PayerPlanGroupSortField type_pre-encounter_images_v1_CoverageAssociation: type: object properties: id: $ref: '#/components/schemas/type_pre-encounter_common_CoverageId' side: $ref: '#/components/schemas/type_pre-encounter_images_v1_CoverageImageSide' required: - id - side description: An association to a Coverage. title: CoverageAssociation type_health-care-code-information_v1_OccurrenceSpanInformation: type: object properties: id: type: string format: uuid description: 'The id of this health care code information if it is already stored. If this is not set, this is referring to a new health care code information to be added to the encounter. If it is set, this refers to an update of an existing health care code information object on the encounter.' encounter_id: $ref: '#/components/schemas/type_commons_EncounterId' description: 'The encounter_id of this health care code information if it is already stored. This will be set by the server in responses, but clients are not expected to set it.' occurrence_span_code_qualifier: $ref: '#/components/schemas/type_health-care-code-information_v1_OccurrenceSpanCodeQualifier' occurrence_span_code: $ref: '#/components/schemas/type_health-care-code-information_v1_OccurrenceSpanCode' occurrence_span_date: $ref: '#/components/schemas/type_health-care-code-information_v1_RD8Date' required: - occurrence_span_code_qualifier - occurrence_span_code - occurrence_span_date description: This corresponds to the BI code qualifier value. title: OccurrenceSpanInformation type_patient-ar_v1_NonInsurancePaymentInfo: type: object properties: total_payment_cents: type: integer description: The total amount of non-insurance payments in cents for the service line. required: - total_payment_cents title: NonInsurancePaymentInfo type_commons_PreEncounterAppointmentId: type: string format: uuid title: PreEncounterAppointmentId type_import-invoice_v1_InvoiceItemInfoUpdate: type: object properties: update_type: $ref: '#/components/schemas/type_import-invoice_v1_InvoiceItemUpdateType' description: 'The only supported update operations for invoice items is to either overwrite the entire list of invoice items or to append new invoice items' items: type: array items: $ref: '#/components/schemas/type_invoices_v2_InvoiceItemCreate' required: - update_type - items title: InvoiceItemInfoUpdate type_commons_AdjustmentId: type: string format: uuid title: AdjustmentId type_non-insurance-payers_v1_NonInsurancePayerUpdateRequest: type: object properties: name: type: string description: Max 50 characters allowed description: $ref: '#/components/schemas/type_non-insurance-payers_v1_NonInsurancePayerDescriptionUpdate' category: $ref: '#/components/schemas/type_non-insurance-payers_v1_NonInsurancePayerCategoryUpdate' address: $ref: '#/components/schemas/type_non-insurance-payers_v1_NonInsurancePayerAddressUpdate' title: NonInsurancePayerUpdateRequest type_invoices_v2_InvoiceInfo: type: object properties: id: $ref: '#/components/schemas/type_commons_InvoiceId' invoice: $ref: '#/components/schemas/type_invoices_v2_Invoice' invoice_type: $ref: '#/components/schemas/type_invoices_v2_InvoiceDestination' required: - id - invoice - invoice_type title: InvoiceInfo type_patient-payments_v3_PatientPaymentId: type: string title: PatientPaymentId type_individual_Subscriber: type: object properties: first_name: type: string last_name: type: string gender: $ref: '#/components/schemas/type_individual_Gender' patient_relationship_to_subscriber_code: $ref: '#/components/schemas/type_commons_PatientRelationshipToInsuredCodeAll' date_of_birth: type: string format: date address: $ref: '#/components/schemas/type_commons_StreetAddressShortZip' individual_id: $ref: '#/components/schemas/type_individual_IndividualId' insurance_card: $ref: '#/components/schemas/type_insurance-cards_v2_InsuranceCard' required: - first_name - last_name - gender - patient_relationship_to_subscriber_code - individual_id - insurance_card title: Subscriber type_pre-encounter_notes_v1_NoteType: type: string enum: - GENERAL - ELIGIBILITY description: Distinguishes what a note is about. `GENERAL` = a plain patient note; `ELIGIBILITY` = a note regarding the patient's eligibility. title: NoteType type_encounter-providers_v2_BillingProviderSecondaryIdentificationOptional: type: object properties: reference_identification: type: string description: Represents REF02 on the EDI 837 Loop 2010BB Billing Provider Secondary Identification segment. Value cannot exceed 50 characters reference_identification_qualifier: $ref: '#/components/schemas/type_encounter-providers_v2_BillingProviderSecondaryIdentificationQualifier' description: 'Represents REF01 on the EDI 837 Loop 2010BB Billing Provider Secondary Identification segment. Valid values include G2 (Provider Commercial Number) and LU (Location Number). Defaults to G2 if not set.' title: BillingProviderSecondaryIdentificationOptional type_insurance-adjudications_v1_ClaimAdjudication: type: object properties: claim_id: $ref: '#/components/schemas/type_commons_ClaimId' insurance_allowed_amount_cents: type: integer insurance_paid_amount_cents: type: integer charge_amount_cents: type: integer service_lines: type: object additionalProperties: type: array items: $ref: '#/components/schemas/type_insurance-adjudications_v1_ServiceLineAdjudication' payer_claim_number: type: string carcs: type: array items: $ref: '#/components/schemas/type_x12_v1_ClaimAdjustmentReasonCode' required: - claim_id - service_lines - carcs title: ClaimAdjudication type_pre-encounter_common_PageToken: type: string description: A token that can be used to retrieve the next or previous page of results title: PageToken type_patient-refunds_v1_PatientRefund: type: object properties: patient_refund_id: $ref: '#/components/schemas/type_patient-refunds_v1_PatientRefundId' organization_id: $ref: '#/components/schemas/type_commons_OrganizationId' source_internal_id: type: string refund_source: $ref: '#/components/schemas/type_financials_PatientTransactionSource' amount_cents: type: integer patient_external_id: $ref: '#/components/schemas/type_commons_PatientExternalId' refund_timestamp: type: string format: date-time refund_note: type: string allocations: type: array items: $ref: '#/components/schemas/type_financials_Allocation' invoice: $ref: '#/components/schemas/type_commons_InvoiceId' refund_reason: $ref: '#/components/schemas/type_financials_RefundReason' required: - patient_refund_id - organization_id - refund_source - amount_cents - patient_external_id - allocations title: PatientRefund type_encounters_v4_RxCui: type: string title: RxCui type_pre-encounter_coverages_v1_CoverageDetails: type: object properties: type: $ref: '#/components/schemas/type_pre-encounter_coverages_v1_BenefitType' coverageLevel: $ref: '#/components/schemas/type_pre-encounter_coverages_v1_CoverageLevel' unit: $ref: '#/components/schemas/type_pre-encounter_coverages_v1_CoverageValueUnit' value: type: number format: double additional_notes: type: string required: - type - coverageLevel - unit - value title: CoverageDetails type_pre-encounter_patients_v1_ReferralSource: type: string enum: - HOSPITAL - REFERRING_MD - SELF - OTHER title: ReferralSource type_claims_Claim: type: object properties: claim_id: $ref: '#/components/schemas/type_commons_ClaimId' status: $ref: '#/components/schemas/type_claims_ClaimStatus' clearinghouse: type: string clearinghouse_claim_id: type: string payer_claim_id: type: string clia_number: type: string service_lines: type: array items: $ref: '#/components/schemas/type_service-lines_v2_ServiceLine' eras: type: array items: $ref: '#/components/schemas/type_eras_ERA' required: - claim_id - status - service_lines - eras title: Claim type_financials_AllocationCreate: type: object properties: amount_cents: type: integer target: $ref: '#/components/schemas/type_financials_AllocationTargetCreate' earmark: $ref: '#/components/schemas/type_financials_AllocationEarmarkType' description: 'If enabled for your organization, optional earmarking configuration for patient prepayments. When provided on unattributed allocations, holds the payment for future auto-allocation to matching encounters.' required: - amount_cents - target description: 'Allocations are portions of payments that are applied to specific resources, known as targets. Each allocation has and amount, defined in cents, and a target.' title: AllocationCreate type_pre-encounter_coverages_v1_PlanMetadata: type: object properties: payer_name: type: string insurance_type: type: string insurance_type_code: type: string plan_name: type: string member_id: type: string group_number: type: string start_date: type: string format: date end_date: type: string format: date plan_dates: type: array items: $ref: '#/components/schemas/type_pre-encounter_coverages_v1_PlanDate' subscriber: $ref: '#/components/schemas/type_pre-encounter_coverages_v1_ExpandedMemberInfo' dependent: $ref: '#/components/schemas/type_pre-encounter_coverages_v1_ExpandedMemberInfo' title: PlanMetadata type_claim-submission_v1_ExternalClaimSubmissionCreateOptional: type: object properties: claim_created_at: type: string format: date-time description: When the claim was created in the external system. patient_control_number: type: string description: 'The Patient Control Number sent on the claim to the payer. To guarantee compatibility with all payers, this field must consist only of uppercase letters and numbers and be no more than 14 characters long.' submission_records: type: array items: $ref: '#/components/schemas/type_claim-submission_v1_ClaimSubmissionRecordCreateOptional' description: 'A successful claim submission record will be created for each value provided. An empty list may be provided for cases where the claim originated in an external system but was never submitted to a payer.' title: ExternalClaimSubmissionCreateOptional type_commons_ChargeCaptureClaimCreationId: type: string format: uuid title: ChargeCaptureClaimCreationId 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 type_encounters_v4_PatientHistoryCategoryEnum: type: string enum: - present_illness - medical - family - social title: PatientHistoryCategoryEnum type_patient-ar_v1_PatientPaymentAllocation: type: object properties: source_id: type: string description: 'Payment identifier from the source system (e.g., patient portal, manual entry). Note multiple allocations may exist for a single payment and thus may share the same source_id.' amount_cents: type: integer description: The amount of the patient payment in cents. required: - amount_cents title: PatientPaymentAllocation type_x12_v1_TypeOfAdmissionOrVisitCode: type: string enum: - '1' - '2' - '3' - '4' - '5' - '9' title: TypeOfAdmissionOrVisitCode type_guarantor_v1_Guarantor: type: object properties: first_name: type: string last_name: type: string external_id: type: string date_of_birth: type: string format: date address: $ref: '#/components/schemas/type_commons_StreetAddressShortZip' guarantor_id: $ref: '#/components/schemas/type_guarantor_v1_GuarantorId' phone_numbers: type: array items: $ref: '#/components/schemas/type_commons_PhoneNumber' phone_consent: type: boolean email: $ref: '#/components/schemas/type_commons_Email' email_consent: type: boolean auto_charge_consent: type: boolean required: - first_name - last_name - external_id - address - guarantor_id - phone_numbers - phone_consent - email_consent - auto_charge_consent title: Guarantor type_commons_SchemaId: type: string format: uuid title: SchemaId type_pre-encounter_common_PayerPlanGroupId: type: string format: uuid description: The unique identifier for a PayerPlanGroup in the database title: PayerPlanGroupId type_financials_AllocationRestrictionType: type: string enum: - billing_provider_npi - service_facility_id description: The dimension along which a payment's auto-allocation can be restricted. title: AllocationRestrictionType type_events_v1_EventScanPage: type: object properties: next_page_token: $ref: '#/components/schemas/type_commons_PageToken' items: type: array items: $ref: '#/components/schemas/type_events_v1_Event' required: - items title: EventScanPage type_diagnoses_DiagnosisId: type: string format: uuid title: DiagnosisId type_insurance-refunds_v1_InsuranceRefund: type: object properties: insurance_refund_id: $ref: '#/components/schemas/type_insurance-refunds_v1_InsuranceRefundId' payer: $ref: '#/components/schemas/type_payers_v3_Payer' amount_cents: type: integer refund_timestamp: type: string format: date-time refund_note: type: string allocations: type: array items: $ref: '#/components/schemas/type_financials_Allocation' refund_reason: $ref: '#/components/schemas/type_financials_RefundReason' required: - insurance_refund_id - payer - amount_cents - allocations title: InsuranceRefund type_pre-encounter_common_Address: type: object properties: use: $ref: '#/components/schemas/type_pre-encounter_common_AddressUse' line: type: array items: type: string city: type: string state: type: string postal_code: type: string country: type: string county: type: string period: $ref: '#/components/schemas/type_pre-encounter_common_Period' required: - use - line - city - state - postal_code - country title: Address type_commons_ServiceLineUnits: type: string enum: - MJ - UN title: ServiceLineUnits type_service-lines_v2_ServiceLineAdjustment: type: object properties: created_at: type: string format: date-time adjustment_group_code: type: string adjustment_reason_code: type: string adjustment_amount_cents: type: integer adjustment_note: type: string required: - created_at title: ServiceLineAdjustment type_health-care-code-information_v1_AdmittingDiagnosis: type: object properties: id: type: string format: uuid description: 'The id of this health care code information if it is already stored. If this is not set, this is referring to a new health care code information to be added to the encounter. If it is set, this refers to an update of an existing health care code information object on the encounter.' encounter_id: $ref: '#/components/schemas/type_commons_EncounterId' description: 'The encounter_id of this health care code information if it is already stored. This will be set by the server in responses, but clients are not expected to set it.' admitting_diagnosis_code_qualifier: $ref: '#/components/schemas/type_health-care-code-information_v1_AdmittingDiagnosisCodeQualifier' admitting_diagnosis_code: $ref: '#/components/schemas/type_health-care-code-information_v1_ICDCode' required: - admitting_diagnosis_code_qualifier - admitting_diagnosis_code description: This corresponds to BJ or ABJ code qualifier values. title: AdmittingDiagnosis type_encounters_v4_ClinicalNoteOptional: type: object properties: text: type: string author_name: type: string author_npi: $ref: '#/components/schemas/type_commons_Npi' timestamp: type: string format: date-time title: ClinicalNoteOptional type_pre-encounter_eligibilityChecks_v1_InsuranceDiscoveryGender: type: string enum: - M - F title: InsuranceDiscoveryGender type_service-lines_v2_MeasurementUnitCode: type: string enum: - ML - UN - GR - F2 - ME title: MeasurementUnitCode type_charge-capture_v1_ChargeCapture: type: object properties: id: $ref: '#/components/schemas/type_commons_ChargeCaptureId' status: $ref: '#/components/schemas/type_charge-capture_v1_ChargeCaptureStatus' charge_capture_data: $ref: '#/components/schemas/type_charge-capture_v1_ChargeCaptureData' date_of_service: type: string format: date patient_external_id: $ref: '#/components/schemas/type_commons_PatientExternalId' charge_external_id: type: string ehr_source_url: type: string originating_system: type: string claim_creation_category: type: string metadata: type: array items: $ref: '#/components/schemas/type_custom-schemas_v1_SchemaInstance' description: 'Key-value pairs that adhere to metadata schemas. Multiple metadata instances can be associated with a charge capture.' error: $ref: '#/components/schemas/type_charge-capture_v1_ChargeCaptureError' updates: type: array items: $ref: '#/components/schemas/type_charge-capture_v1_ChargeCapturePostBilledChange' description: This list of updates will always return at most 1 update that is not resolved. The singular update will contain the difference between the updated charge and the created encounter. claim_creation_id: $ref: '#/components/schemas/type_commons_ChargeCaptureClaimCreationId' required: - id - status - charge_capture_data - patient_external_id - charge_external_id - updates title: ChargeCapture type_health-care-code-information_v1_PatientReasonForVisit: type: object properties: id: type: string format: uuid description: 'The id of this health care code information if it is already stored. If this is not set, this is referring to a new health care code information to be added to the encounter. If it is set, this refers to an update of an existing health care code information object on the encounter.' encounter_id: $ref: '#/components/schemas/type_commons_EncounterId' description: 'The encounter_id of this health care code information if it is already stored. This will be set by the server in responses, but clients are not expected to set it.' patient_reason_for_visit_code_qualifier: $ref: '#/components/schemas/type_health-care-code-information_v1_PatientReasonForVisitCodeQualifier' patient_reason_for_visit: $ref: '#/components/schemas/type_health-care-code-information_v1_ICDCode' required: - patient_reason_for_visit_code_qualifier - patient_reason_for_visit description: This corresponds to PR or APR code qualifier values. title: PatientReasonForVisit type_tags_TagId: type: string title: TagId type_pre-encounter_appointments_v1_MutableAppointment: type: object properties: patient_id: $ref: '#/components/schemas/type_pre-encounter_common_PatientId' description: The Candid-defined patient identifier. start_timestamp: type: string format: date-time status: $ref: '#/components/schemas/type_pre-encounter_appointments_v1_AppointmentStatus' description: Defaults to PENDING. If status is NOT_READY, work_queue must be set. If status is READY or CHECKED_IN, work_queue must be null. If status is CHECKED_IN, checked_in_timestamp must be set. If checked_in_timestamp is set, status must be CHECKED_IN. not_ready_reason: $ref: '#/components/schemas/type_pre-encounter_appointments_v1_NotReadyReason' description: The reason the appointment is NOT_READY. Must only be set when status is NOT_READY; it is cleared otherwise. It is not recommended to change this value manually via API. ready_source: $ref: '#/components/schemas/type_pre-encounter_appointments_v1_ReadySource' description: The method that set the appointment status to READY. It is not recommended to change this value manually via API. Must only be set when the status is READY or CHECKED_IN, it is cleared otherwise. service_duration: type: integer description: The requested length of time allotted for the appointment. The units are in minutes. services: type: array items: $ref: '#/components/schemas/type_pre-encounter_appointments_v1_Service' placer_appointment_id: type: string description: ID for the appointment/order for the event. attending_doctor: $ref: '#/components/schemas/type_pre-encounter_common_ExternalProvider' description: Attending physician information. The attending physician will be stored as the Current MD for the patient. estimated_copay_cents: type: integer estimated_patient_responsibility_cents: type: integer description: The estimated amount the patient will be responsible for paying at the time of service. This does not include the copay. patient_deposit_cents: type: integer appointment_details: type: string checked_in_timestamp: type: string format: date-time description: The timestamp when the patient checked in for their appointment. If status is CHECKED_IN, checked_in_timestamp must be set. If checked_in_timestamp is set, status must be CHECKED_IN. notes: type: string location_resource_id: type: string description: 'Contains the coded identification of the location being scheduled. Components: ^' automated_eligibility_check_complete: type: boolean description: True if the automated eligibility check has been completed. It is not recommended to change this value manually via API. This refers explicitly to the automated eligibility check that occurs a specific number of days before the appointment. work_queue: $ref: '#/components/schemas/type_pre-encounter_appointments_v1_AppointmentWorkQueue' description: The work queue that the appointment belongs to. It is not recommended to change this value manually via API. If status is NOT_READY, work_queue must be set. If status is READY, work_queue must be null. required: - patient_id - start_timestamp - service_duration - services description: An object representing a appointment. title: MutableAppointment type_service-lines_v2_DrugIdentification: type: object properties: service_id_qualifier: $ref: '#/components/schemas/type_service-lines_v2_ServiceIdQualifier' national_drug_code: type: string national_drug_unit_count: type: string measurement_unit_code: $ref: '#/components/schemas/type_service-lines_v2_MeasurementUnitCode' link_sequence_number: type: string pharmacy_prescription_number: type: string conversion_formula: type: string drug_description: type: string required: - service_id_qualifier - national_drug_code - national_drug_unit_count - measurement_unit_code title: DrugIdentification type_users_v2_UserMetadata: oneOf: - type: object properties: type: type: string enum: - machine_user_metadata description: 'Discriminator value: machine_user_metadata' name: type: string required: - type - name - type: object properties: type: type: string enum: - human_user_metadata description: 'Discriminator value: human_user_metadata' first_name: type: string last_name: type: string email: type: string required: - type - first_name - last_name - email discriminator: propertyName: type title: UserMetadata type_pre-encounter_common_ContactPoint: type: object properties: value: type: string use: $ref: '#/components/schemas/type_pre-encounter_common_ContactPointUse' period: $ref: '#/components/schemas/type_pre-encounter_common_Period' required: - value - use title: ContactPoint type_pre-encounter_eligibilityChecks_v1_Encounter: type: object properties: date_of_service: type: string format: date description: Defaults to the current date if not provided. service_type_codes: type: array items: type: string description: 'Defaults to HealthBenefitPlanCoverage (30) if not provided. Not all payers support multiple service type codes, so it is recommended to only include a single code per request.' title: Encounter type_health-care-code-information_v1_OccurrenceSpanCodeQualifier: type: string enum: - BI title: OccurrenceSpanCodeQualifier type_encounter-providers_v2_InitialReferringProviderUpdateWithOptionalAddress: type: object properties: first_name: type: string description: If the provider is an individual, this should be set instead of organization name last_name: type: string description: If the provider is an individual, this should be set instead of organization name organization_name: type: string description: If the provider is an organization, this should be set instead of first + last name npi: type: string description: 'A National Provider Identifier is a unique 10-digit identification number issued to health care providers in the United States' taxonomy_code: type: string address: $ref: '#/components/schemas/type_commons_StreetAddressShortZipOptional' qualifier: $ref: '#/components/schemas/type_commons_QualifierCode' secondary_identification: $ref: '#/components/schemas/type_encounter-providers_v2_ReferringProviderSecondaryIdentificationOptional' title: InitialReferringProviderUpdateWithOptionalAddress type_encounter-attachments_v1_EncounterAttachmentType: type: string enum: - DOCUMENTATION - EOB - OTHER title: EncounterAttachmentType type_encounter-providers_v2_ReferringProviderUpdateWithOptionalAddress: type: object properties: first_name: type: string description: If the provider is an individual, this should be set instead of organization name last_name: type: string description: If the provider is an individual, this should be set instead of organization name organization_name: type: string description: If the provider is an organization, this should be set instead of first + last name npi: type: string description: 'A National Provider Identifier is a unique 10-digit identification number issued to health care providers in the United States' taxonomy_code: type: string address: $ref: '#/components/schemas/type_commons_StreetAddressShortZipOptional' secondary_identification: $ref: '#/components/schemas/type_encounter-providers_v2_ReferringProviderSecondaryIdentificationOptional' title: ReferringProviderUpdateWithOptionalAddress type_commons_EncounterId: type: string format: uuid title: EncounterId type_pre-encounter_common_SortDirection: type: string enum: - asc - desc title: SortDirection type_payers_v3_PayerIdentifier: oneOf: - type: object properties: type: type: string enum: - payer_info description: 'Discriminator value: payer_info' payer_id: $ref: '#/components/schemas/type_payers_v3_PayerId' payer_name: $ref: '#/components/schemas/type_payers_v3_PayerName' required: - type - payer_id - payer_name - type: object properties: type: type: string enum: - payer_uuid description: 'Discriminator value: payer_uuid' value: $ref: '#/components/schemas/type_payers_v3_PayerUuid' required: - type - value discriminator: propertyName: type title: PayerIdentifier type_diagnoses_DiagnosisTypeCode: type: string enum: - ABF - ABJ - ABK - APR - BF - BJ - BK - PR - DR - LOI title: DiagnosisTypeCode type_non-insurance-payer-refunds_v1_NonInsurancePayerRefundCreate: type: object properties: non_insurance_payer_id: $ref: '#/components/schemas/type_non-insurance-payers_v1_NonInsurancePayerId' invoice_id: $ref: '#/components/schemas/type_commons_InvoiceId' amount_cents: type: integer refund_timestamp: type: string format: date-time refund_note: type: string check_number: type: string allocations: type: array items: $ref: '#/components/schemas/type_financials_AllocationCreate' refund_reason: $ref: '#/components/schemas/type_financials_RefundReason' required: - non_insurance_payer_id - amount_cents - allocations title: NonInsurancePayerRefundCreate type_health-care-code-information_v1_RD8Date: type: object properties: start: type: string format: date end: type: string format: date required: - start - end title: RD8Date type_pre-encounter_lists_v1_AppointmentListPage: type: object properties: next_page_token: $ref: '#/components/schemas/type_pre-encounter_common_PageToken' prev_page_token: $ref: '#/components/schemas/type_pre-encounter_common_PageToken' total: type: integer items: type: array items: $ref: '#/components/schemas/type_pre-encounter_lists_v1_AppointmentListItem' required: - total - items title: AppointmentListPage type_clinical-trials_v1_MutableClinicalTrial: type: object properties: name: type: string clinical_trial_number: type: string description: Must be 8 characters long clinical_trial_phase: $ref: '#/components/schemas/type_clinical-trials_v1_ClinicalTrialPhase' required: - name - clinical_trial_number title: MutableClinicalTrial type_pre-encounter_coverages_v1_CoverageValueUnit: type: string enum: - PERCENT - CURRENCY - COUNT title: CoverageValueUnit type_commons_Decimal: type: string description: String representation of a Decimal that can be parsed by most libraries. title: Decimal type_commons_Date: type: string description: ISO 8601 date; formatted YYYY-MM-DD (i.e. 2012-02-01) title: Date type_pre-encounter_eligibilityChecks_v1_InsuranceDiscoveryAddress: type: object properties: address_1: type: string address_2: type: string city: type: string state: type: string postal_code: type: string country_code: type: string description: The patient's address. Providing a zip code improves the probability of finding matching coverage. title: InsuranceDiscoveryAddress type_service-lines_v2_ServiceIdQualifier: type: string enum: - EN - EO - HI - N4 - 'ON' - UK - UP title: ServiceIdQualifier type_pre-encounter_eligibilityChecks_v1_StediPayerItem: type: object properties: score: type: integer payer: $ref: '#/components/schemas/type_pre-encounter_eligibilityChecks_v1_StediPayer' required: - score - payer title: StediPayerItem type_pre-encounter_common_CanonicalClinicalTrialId: type: string description: The unique identifier for a clinical trial configured in the Candid system title: CanonicalClinicalTrialId type_pre-encounter_patientMerges_v1_MutablePatientMerge: type: object properties: alternative_patient_mrn: type: string description: The MRN of the patient that was merged. primary_patient_mrn: type: string description: The MRN of the patient that is getting a patient merged into them. required: - alternative_patient_mrn - primary_patient_mrn description: An object representing a patient merge mapping. title: MutablePatientMerge type_charge-capture_v1_ChargeCapturePostBilledChange: type: object properties: id: $ref: '#/components/schemas/type_commons_ChargeCapturePostBilledChangeId' message: type: string resolved: type: boolean required: - id - message - resolved description: ChargeCapturePostBilledChange represents a change to a ChargeCapture that occurred after the ChargeCapture's status moved to BILLED. Action must be taken to resolve the update, and then the update should be marked as resolved. title: ChargeCapturePostBilledChange type_non-insurance-payer-payments_v1_NonInsurancePayerPaymentsPage: type: object properties: prev_page_token: $ref: '#/components/schemas/type_commons_PageToken' next_page_token: $ref: '#/components/schemas/type_commons_PageToken' items: type: array items: $ref: '#/components/schemas/type_non-insurance-payer-payments_v1_NonInsurancePayerPayment' required: - items title: NonInsurancePayerPaymentsPage type_commons_UnauthorizedErrorMessage: type: object properties: message: type: string title: UnauthorizedErrorMessage type_non-insurance-payer-refunds_v1_NonInsurancePayerRefund: type: object properties: non_insurance_payer_refund_id: $ref: '#/components/schemas/type_non-insurance-payer-refunds_v1_NonInsurancePayerRefundId' non_insurance_payer: $ref: '#/components/schemas/type_non-insurance-payers_v1_NonInsurancePayer' amount_cents: type: integer refund_timestamp: type: string format: date-time refund_note: type: string check_number: type: string allocations: type: array items: $ref: '#/components/schemas/type_financials_Allocation' refund_reason: $ref: '#/components/schemas/type_financials_RefundReason' invoice_id: $ref: '#/components/schemas/type_commons_InvoiceId' required: - non_insurance_payer_refund_id - non_insurance_payer - amount_cents - allocations title: NonInsurancePayerRefund type_invoices_v2_ClaimInvoiceItemInfo: type: object properties: claim_invoice_item: $ref: '#/components/schemas/type_invoices_v2_ClaimInvoiceItem' service_line_invoice_items: type: object additionalProperties: $ref: '#/components/schemas/type_invoices_v2_ServiceLineInvoiceItem' required: - service_line_invoice_items title: ClaimInvoiceItemInfo type_custom-schemas_v1_SchemaGetMultiResponse: type: object properties: schemas: type: array items: $ref: '#/components/schemas/type_custom-schemas_v1_Schema' required: - schemas title: SchemaGetMultiResponse type_pre-encounter_eligibilityChecks_v1_EligibilityCheckErrorSource: type: string enum: - CANDID - STEDI description: enum to represent the source of an error in an eligibility check title: EligibilityCheckErrorSource type_health-care-code-information_v1_ConditionCode: type: string enum: - '01' - '02' - '03' - '04' - '05' - '06' - '07' - 08 - 09 - '10' - '11' - '17' - '18' - '19' - '20' - '21' - '22' - '23' - '24' - '25' - '26' - '27' - '28' - '29' - '30' - '31' - '32' - '33' - '34' - '35' - '36' - '37' - '38' - '39' - '40' - '41' - '42' - '43' - '44' - '45' - '46' - '47' - '48' - '49' - '50' - '51' - '52' - '53' - '54' - '55' - '56' - '57' - '58' - '59' - '60' - '61' - '66' - '67' - '68' - '69' - '70' - '71' - '72' - '73' - '74' - '75' - '76' - '77' - '78' - '79' - '80' - '81' - '82' - '83' - '84' - '85' - '86' - '87' - '88' - '89' - '90' - '91' - '92' - A0 - A1 - A2 - A3 - A4 - A5 - A6 - A7 - A9 - AA - AB - AC - AD - AE - AF - AG - AH - AI - AJ - AK - AL - AM - AN - B0 - B1 - B2 - B3 - B4 - BP - C1 - C2 - C3 - C4 - C5 - C6 - C7 - D0 - D1 - D2 - D3 - D4 - D5 - D6 - D7 - D8 - D9 - DR(a) - E0 - G0 - H0 - H2 - H3 - H4 - H5 - P1 - P7 - R1 - R2 - R3 - R4 - R5 - R6 - R7 - R8 - R9 - W0 - W2 - W3 - W4 - W5 description: ' FL 18-28 - Condition Codes Source: UB-04 Manual 2025, Pages 64-81 (FL18-28, Pages 1-18) Excludes codes designated as "Payer Codes" or "FOR PUBLIC HEALTH DATA REPORTING ONLY" unless usage on claims is indicated.' title: ConditionCode type_encounter-providers_v2_BillingProviderUpdateWithOptionalAddress: type: object properties: first_name: type: string description: If the provider is an individual, this should be set instead of organization name last_name: type: string description: If the provider is an individual, this should be set instead of organization name organization_name: type: string description: If the provider is an organization, this should be set instead of first + last name address: $ref: '#/components/schemas/type_commons_StreetAddressShortZipOptional' tax_id: type: string description: If the provider has a contract with insurance, this must be the same tax ID given to the payer on an IRS W-9 form completed during contracting. npi: type: string taxonomy_code: type: string provider_commercial_license_type: $ref: '#/components/schemas/type_commons_BillingProviderCommercialLicenseType' description: '837i Loop2010BB G2 Provider Commercial Number' secondary_identification: $ref: '#/components/schemas/type_encounter-providers_v2_BillingProviderSecondaryIdentificationOptional' description: 'Only one of provider_commercial_license_type or secondary_identification may be provided 837i Loop2010BB G2 Secondary Identification' description: 'The billing provider is the provider or business entity submitting the claim. Billing provider may be, but is not necessarily, the same person/NPI as the rendering provider. From a payer''s perspective, this represents the person or entity being reimbursed. When a contract exists with the target payer, the billing provider should be the entity contracted with the payer. In some circumstances, this will be an individual provider. In that case, submit that provider''s NPI and the tax ID (TIN) that the provider gave to the payer during contracting. In other cases, the billing entity will be a medical group. If so, submit the group NPI and the group''s tax ID. Box 33 on the CMS-1500 claim or Form Locator 1 on a UB-04 claim form. The address fields here are optional.' title: BillingProviderUpdateWithOptionalAddress type_pre-encounter_eligibilityChecks_v1_UserConfiguredPromptsRecommendationPayload: type: object properties: results: type: array items: $ref: '#/components/schemas/type_pre-encounter_eligibilityChecks_v1_UserConfiguredPromptsResult' description: Array of results from all enabled user-configured prompts required: - results description: Payload for user-configured prompt recommendations from AI analysis title: UserConfiguredPromptsRecommendationPayload type_encounters_v4_IntakeResponseAndFollowUpsOptional: type: object properties: response: type: string follow_ups: type: array items: $ref: '#/components/schemas/type_encounters_v4_IntakeFollowUpOptional' title: IntakeResponseAndFollowUpsOptional type_service-lines_v2_DenialReasonContent: type: string enum: - Authorization Required - Referral Required - Medical Records Requested - Timely Filing - Duplicate Claim - Full Contractual Adjustment - Incorrect Place of Service - Incorrect Patient Gender - Incorrect Patient Info - Bundled - Exceeded Billable Time - Invalid Provider Information - Invalid Diagnosis Code - Incorrect Procedure Code - Invalid Modifier - Missing NDC Code - Invalid Insurance Data - No Active Coverage - Coordination of Benefits - Incorrect Payer - Credentialing - No Effective Contract - Missing W-9 - Missing Contract Linkage - Non-Covered Benefit - Experimental Procedure - Not Medically Necessary - Info Requested from Provider - Info Requested from Patient - Billing Error - Unknown - Max Benefit Reached title: DenialReasonContent type_pre-encounter_patients_v1_Referral: type: object properties: provider: $ref: '#/components/schemas/type_pre-encounter_common_ExternalProvider' referral_number: type: string period: $ref: '#/components/schemas/type_pre-encounter_common_Period' notes: type: string serviceFacility: $ref: '#/components/schemas/type_pre-encounter_common_PatientServiceFacility' units: $ref: '#/components/schemas/type_pre-encounter_patients_v1_ReferralUnit' quantity: type: integer cptCodes: type: array items: type: string applyForAllCptCodes: type: boolean required: - provider - referral_number title: Referral type_pre-encounter_patients_v1_MaritalStatus: type: string enum: - ANNULLED - DIVORCED - INTERLOCUTORY - SEPARATED - MARRIED - COMMON_LAW - POLYGAMOUS - DOMESTIC_PARTNER - UNMARRIED - NEVER_MARRIED - WIDOWED - UNKNOWN title: MaritalStatus type_encounters_v4_SynchronicityType: type: string enum: - Synchronous - Asynchronous title: SynchronicityType type_health-care-code-information_v1_ValueCodeQualifier: type: string enum: - BE title: ValueCodeQualifier type_invoices_v2_InvoiceItemAttributionCreate: oneOf: - type: object properties: type: type: string enum: - service_line_id description: 'Discriminator value: service_line_id' value: $ref: '#/components/schemas/type_commons_ServiceLineId' required: - type - value - type: object properties: type: type: string enum: - claim_id description: 'Discriminator value: claim_id' value: $ref: '#/components/schemas/type_commons_ClaimId' required: - type - value - type: object properties: type: type: string enum: - unattributed description: 'Discriminator value: unattributed' required: - type discriminator: propertyName: type description: Points to the claim or service line that this invoice is attributed to title: InvoiceItemAttributionCreate type_pre-encounter_coverages_v1_PayerPlanGroupFields: type: object properties: payer_plan_group_id: $ref: '#/components/schemas/type_pre-encounter_common_PayerPlanGroupId' payer_id: $ref: '#/components/schemas/type_pre-encounter_common_PayerId' payer_name: type: string plan_type: $ref: '#/components/schemas/type_pre-encounter_coverages_v1_NetworkType' required: - payer_plan_group_id - payer_id - payer_name - plan_type title: PayerPlanGroupFields type_pre-encounter_coverages_v1_BenefitType: type: string enum: - DEDUCTIBLE - DEDUCTIBLE_CONTRACT - DEDUCTIBLE_REMAINING - DEDUCTIBLE_YEAR_TO_DATE - OOP_MAX - OOP_MAX_CONTRACT - OOP_MAX_REMAINING - OOP_MAX_YEAR_TO_DATE - COPAY - COINSURANCE - NON_COVERED - LIMITATION title: BenefitType type_encounters_v4_PriorAuthorizationNumber: type: string title: PriorAuthorizationNumber type_encounter-attachments_v1_AttachmentId: type: string format: uuid title: AttachmentId type_health-care-code-information_v1_TreatmentCodeQualifier: type: string enum: - TC title: TreatmentCodeQualifier type_non-insurance-payers_v1_ToggleNonInsurancePayerEnablementRequest: type: object properties: enabled: type: boolean required: - enabled title: ToggleNonInsurancePayerEnablementRequest type_pre-encounter_organizationExternalProviders_v1_OrganizationExternalProviderSortField: type: string description: 'The field to order by. Valid values are keys on the provider object (e.g., name.family, npi, updatedAt, createdAt) or a special ordering "similar_name:" (Ex: similar_name:John). Similar name ordering uses trigrams to fuzzy match provider name to the search criteria.' title: OrganizationExternalProviderSortField type_billing-notes_v2_BillingNote: type: object properties: text: type: string description: Empty string not allowed. billing_note_id: $ref: '#/components/schemas/type_billing-notes_v2_BillingNoteId' encounter_id: $ref: '#/components/schemas/type_commons_EncounterId' created_at: type: string format: date-time description: 'An [RFC 3339, section 5.6 datetime](https://ijmacd.github.io/rfc3339-iso8601/). For example, 2017-07-21T17:32:28Z.' author_auth0_id: type: string author_name: type: string billing_note_type: $ref: '#/components/schemas/type_billing-notes_v2_BillingNoteType' billing_note_metadata: $ref: '#/components/schemas/type_billing-notes_v2_BillingNoteMetadata' required: - text - billing_note_id - encounter_id - created_at title: BillingNote type_health-care-code-information_v1_SetOrClearDiagnosisRelatedGroup: type: object properties: value: $ref: '#/components/schemas/type_health-care-code-information_v1_DiagnosisRelatedGroup' title: SetOrClearDiagnosisRelatedGroup type_guarantor_v1_GuarantorOptional: type: object properties: first_name: type: string last_name: type: string external_id: type: string description: A unique identifier for the guarantor assigned by an external system. date_of_birth: type: string format: date description: 'Date formatted as YYYY-MM-DD; eg: 2019-08-25.' address: $ref: '#/components/schemas/type_commons_StreetAddressShortZipOptional' phone_numbers: type: array items: $ref: '#/components/schemas/type_commons_PhoneNumberOptional' phone_consent: type: boolean email: $ref: '#/components/schemas/type_commons_Email' email_consent: type: boolean auto_charge_consent: type: boolean title: GuarantorOptional type_billing-notes_v2_BillingNoteId: type: string format: uuid title: BillingNoteId type_pre-encounter_appointments_v1_VisitsPage: type: object properties: next_page_token: $ref: '#/components/schemas/type_pre-encounter_common_PageToken' prev_page_token: $ref: '#/components/schemas/type_pre-encounter_common_PageToken' total: type: integer items: type: array items: $ref: '#/components/schemas/type_pre-encounter_appointments_v1_Visit' required: - total - items title: VisitsPage type_commons_NextResponsibleParty: type: string enum: - primary - secondary - tertiary - patient - non_insurance - none title: NextResponsibleParty type_encounters_v4_EncounterSubmissionExpectation: type: string enum: - TARGET_PROFESSIONAL - TARGET_INSTITUTIONAL description: 'Used to describe the currently expected target form for this encounter. This affects what validations and queues the form is processed under. Before submission, this value will be required by some rules or user intervention. It can be changed at any time, although doing so may incur other rules.' title: EncounterSubmissionExpectation type_encounters_v4_CodingAttributionType: type: string enum: - CANDID - CUSTOMER - TCN - PJF title: CodingAttributionType type_payers_v3_PayerName: type: string title: PayerName type_commons_EncounterExternalId: type: string title: EncounterExternalId type_pre-encounter_eligibilityChecks_v1_InsuranceDiscoveryProvider: type: object properties: npi: type: string description: The provider's National Provider Identifier (NPI). required: - npi description: Information about the provider requesting the insurance discovery check. title: InsuranceDiscoveryProvider type_encounters_v4_ServiceAuthorizationExceptionCode: type: string enum: - '1' - '2' - '3' - '4' - '5' - '6' - '7' description: 'Required when mandated by government law or regulation to obtain authorization for specific service(s) but, for the reasons listed in one of the enum values, the service was performed without obtaining the authorization.' title: ServiceAuthorizationExceptionCode type_encounters_v4_ClinicalNote: type: object properties: text: type: string author_name: type: string author_npi: $ref: '#/components/schemas/type_commons_Npi' timestamp: type: string format: date-time required: - text - author_name - timestamp title: ClinicalNote type_custom-schemas_v1_SchemaValidationError: oneOf: - type: object properties: type: type: string enum: - schema_name_already_exists description: 'Discriminator value: schema_name_already_exists' name: type: string id: $ref: '#/components/schemas/type_commons_SchemaId' required: - type - name - id - type: object properties: type: type: string enum: - key_name_already_exists description: 'Discriminator value: key_name_already_exists' key: type: string value_type: $ref: '#/components/schemas/type_commons_Primitive' required: - type - key - value_type discriminator: propertyName: type title: SchemaValidationError type_charge-capture_v1_ChargeExternalIdConflictErrorMessage: type: object properties: message: type: string title: ChargeExternalIdConflictErrorMessage type_related-causes_v1_RelatedCausesCode: type: string enum: - AA - AB - AP - EM - OA - ZZ title: RelatedCausesCode type_pre-encounter_coverages_v1_InsuranceTypeCode: type: string enum: - '01' - '12' - '13' - '14' - '15' - '16' - '17' - '18' - '19' - '41' - '42' - '43' - '47' - AP - C1 - CO - CP - D - DB - E - EP - FF - GP - HA - HB - HD - HG - HM - HN - HP - HS - IN - IP - LC - LD - LI - LT - M - MA - MB - MC - MD - ME - MF - MH - MI - MJ - MK - ML - MM - MN - MO - MP - MR - MT - MV - OA - OT - PE - PL - PP - PR - PS - QM - RP - SP - TF - U - WC - WU description: Code identifying the type of insurance policy within a specific insurance program (X12 008020 Element 1336) title: InsuranceTypeCode type_non-insurance-payer-refunds_v1_NonInsurancePayerRefundsPage: type: object properties: prev_page_token: $ref: '#/components/schemas/type_commons_PageToken' next_page_token: $ref: '#/components/schemas/type_commons_PageToken' items: type: array items: $ref: '#/components/schemas/type_non-insurance-payer-refunds_v1_NonInsurancePayerRefund' required: - items title: NonInsurancePayerRefundsPage type_patient-ar_v1_PatientARStatus: type: string enum: - invoiceable - non_invoiceable title: PatientARStatus type_pre-encounter_appointments_v1_AppointmentWorkQueue: type: string enum: - EMERGENT_ISSUE - NEW_PATIENT - RETURNING_PATIENT - MANUAL_ESCALATION title: AppointmentWorkQueue type_pre-encounter_eligibilityChecks_v1_CobAddress: type: object properties: address_1: type: string address_2: type: string city: type: string state: type: string description: 'The US state or Canadian province code. Kept as a string rather than an enum because, per Stedi, payers may sometimes return non-compliant values.' postal_code: type: string country_code: type: string country_sub_division_code: type: string description: A patient's address as returned in a coordination of benefits response. title: CobAddress type_encounters_v4_MedicationOptional: type: object properties: name: type: string rx_cui: $ref: '#/components/schemas/type_encounters_v4_RxCui' dosage: type: string dosage_form: type: string frequency: type: string as_needed: type: boolean title: MedicationOptional type_patient-ar_v1_InsuranceAdjustmentInfo: type: object properties: total_adjustment_cents: type: integer description: The total amount of insurance adjustments in cents for the service line. required: - total_adjustment_cents title: InsuranceAdjustmentInfo type_write-offs_v1_PatientWriteOffReason: type: string enum: - SMALL_BALANCE - CHARITY_OR_FINANCIAL_ASSISTANCE - PATIENT_EXPERIENCE_OR_SERVICE_RECOVERY - OON_COURTESY_ADJUSTMENT - PROMPT_PAY_DISCOUNT - BAD_DEBT - COLLECTION_AGENCY - OTHER - UNKNOWN - UNCOLLECTIBLE_OR_NON_BILLABLE - DECEASED - BANKRUPTCY title: PatientWriteOffReason type_pre-encounter_patients_v1_Contact: type: object properties: relationship: type: array items: $ref: '#/components/schemas/type_pre-encounter_common_Relationship' name: $ref: '#/components/schemas/type_pre-encounter_common_HumanName' telecoms: type: array items: $ref: '#/components/schemas/type_pre-encounter_common_ContactPoint' addresses: type: array items: $ref: '#/components/schemas/type_pre-encounter_common_Address' period: $ref: '#/components/schemas/type_pre-encounter_common_Period' hipaa_authorization: type: boolean required: - relationship - name - telecoms - addresses title: Contact type_pre-encounter_eligibilityChecks_v1_CobProvider: type: object properties: organization_name: type: string description: The provider's business name. Required if the provider is an organization. first_name: type: string description: The provider's first name. Required if the provider is an individual. last_name: type: string description: The provider's last name. Required if the provider is an individual. npi: type: string description: The provider's National Provider Identifier (NPI). required: - npi description: 'Information about the entity requesting the COB check. Provide either organization_name (for organizations) or first_name and last_name (for individuals), plus npi.' title: CobProvider type_invoices_v2_Invoice: type: object properties: amount_cents: type: integer description: Total monetary amount (in cents) of all Invoice Items created_at: type: string format: date-time updated_at: type: string format: date-time organization_id: $ref: '#/components/schemas/type_commons_OrganizationId' invoice_destination_metadata: $ref: '#/components/schemas/type_invoices_v2_InvoiceDestinationMetadata' description: Contains all relevant information from the third-party service this invoice was created in patient_external_id: $ref: '#/components/schemas/type_commons_PatientExternalId' note: type: string due_date: type: string format: date status: $ref: '#/components/schemas/type_invoices_v2_InvoiceStatus' url: type: string description: Link to the admin view of the invoice in the third-party service customer_invoice_url: type: string description: Link to the patient view of the invoice in the third-party service items: $ref: '#/components/schemas/type_invoices_v2_InvoiceItemInfo' description: The InvoiceItem rollup which contains all claim and service line invoice items required: - amount_cents - created_at - updated_at - organization_id - invoice_destination_metadata - patient_external_id - due_date - status - items title: Invoice type_write-offs_v1_WriteOffCreate: oneOf: - type: object properties: type: type: string enum: - patient description: 'Discriminator value: patient' write_off_timestamp: type: string format: date-time write_off_note: type: string write_off_reason: $ref: '#/components/schemas/type_write-offs_v1_PatientWriteOffReason' service_line_id: $ref: '#/components/schemas/type_commons_ServiceLineId' amount_cents: type: integer required: - type - write_off_timestamp - write_off_reason - service_line_id - amount_cents - type: object properties: type: type: string enum: - insurance description: 'Discriminator value: insurance' payer_identifier: $ref: '#/components/schemas/type_payers_v3_PayerIdentifier' write_off_target: $ref: '#/components/schemas/type_write-offs_v1_InsuranceWriteOffTarget' write_off_timestamp: type: string format: date-time write_off_note: type: string write_off_reason: $ref: '#/components/schemas/type_write-offs_v1_InsuranceWriteOffReason' amount_cents: type: integer required: - type - payer_identifier - write_off_target - write_off_timestamp - write_off_reason - amount_cents - type: object properties: type: type: string enum: - non_insurance_payer description: 'Discriminator value: non_insurance_payer' non_insurance_payer_id: $ref: '#/components/schemas/type_non-insurance-payers_v1_NonInsurancePayerId' service_line_id: $ref: '#/components/schemas/type_commons_ServiceLineId' write_off_timestamp: type: string format: date-time write_off_note: type: string write_off_reason: $ref: '#/components/schemas/type_write-offs_v1_InsuranceWriteOffReason' amount_cents: type: integer required: - type - non_insurance_payer_id - service_line_id - write_off_timestamp - write_off_reason - amount_cents discriminator: propertyName: type title: WriteOffCreate type_encounter-providers_v2_TreatingProviderUpdateWithOptionalAddress: type: object properties: first_name: type: string last_name: type: string npi: type: string description: 'A National Provider Identifier is a unique 10-digit identification number issued to health care providers in the United States' taxonomy_code: type: string address: $ref: '#/components/schemas/type_commons_StreetAddressLongZipOptional' license_type: $ref: '#/components/schemas/type_organization-providers_v2_LicenseType' description: The license type of the treating provider (e.g., MD, NP, PA, LCSW). description: Update type for the treating provider with optional address fields. Used in contexts where address fields may be partially provided. title: TreatingProviderUpdateWithOptionalAddress type_pre-encounter_common_CanonicalServiceFacilityId: type: string description: The unique identifier for a service facility configured in the Candid system title: CanonicalServiceFacilityId type_individual_PatientClinicalTrialInfoCreateOptional: type: object properties: clinical_trial_arm: type: string clinical_trial_id: $ref: '#/components/schemas/type_commons_ClinicalTrialId' title: PatientClinicalTrialInfoCreateOptional type_pre-encounter_tags_v1_Tag: type: object properties: organization_id: $ref: '#/components/schemas/type_pre-encounter_common_OrganizationId' description: The organization that owns this object. deactivated: type: boolean description: True if the object is deactivated. Deactivated objects are not returned in search results but are returned in all other endpoints including scan. version: type: integer description: The version of the object. Any update to any property of an object object will create a new version. updated_at: type: string format: date-time updating_user_id: $ref: '#/components/schemas/type_pre-encounter_common_UserId' description: The user ID of the user who last updated the object. value: type: string description: type: string alert: type: boolean id: $ref: '#/components/schemas/type_pre-encounter_common_TagId' required: - organization_id - deactivated - version - updated_at - updating_user_id - value - id description: A Tag object with immutable server-owned properties. title: Tag type_health-care-code-information_v1_OccurrenceSpanCode: type: string enum: - '70' - '71' - '72' - '73' - '74' - '75' - '76' - '77' - '78' - '80' - '81' - '82' - M0 - M1 - M2 - M3 - M4 title: OccurrenceSpanCode type_encounter-attachments_v1_ChargeCaptureAttachment: type: object properties: attachment_id: $ref: '#/components/schemas/type_encounter-attachments_v1_AttachmentId' file_name: type: string description: type: string content_type: type: string authed_url: $ref: '#/components/schemas/type_commons_LinkUrl' attachment_type: $ref: '#/components/schemas/type_encounter-attachments_v1_EncounterAttachmentType' required: - attachment_id - file_name - description - content_type - authed_url - attachment_type title: ChargeCaptureAttachment type_patient-ar_v1_InsurancePaymentInfo: type: object properties: total_payment_cents: type: integer description: The total amount of insurance payments in cents for the service line. required: - total_payment_cents title: InsurancePaymentInfo type_service-lines_v2_ServiceLineCreateOptional: type: object properties: modifiers: type: array items: $ref: '#/components/schemas/type_commons_ProcedureModifier' has_epsdt_indicator: type: boolean description: 'Maps to SV1-11 on the 837-P and Box 24H on the CMS-1500. If the value is true, the box will be populated with "Y". Otherwise, the box will not be populated.' has_family_planning_indicator: type: boolean description: 'Maps to SV1-12 on the 837-P and Box 24I on the CMS-1500. If the value is true, the box will be populated with "Y". Otherwise, the box will not be populated.' procedure_code: type: string quantity: $ref: '#/components/schemas/type_commons_Decimal' description: 'String representation of a Decimal that can be parsed by most libraries. For professional claims, a ServiceLine quantity cannot contain more than one digit of precision (Example: 1.1 is valid, 1.11 is not). For institutional claims, a ServiceLine quantity cannot contain more than three decimal digits of precision.' units: $ref: '#/components/schemas/type_commons_ServiceLineUnits' charge_amount_cents: type: integer description: The total amount charged for this service line, factoring in quantity. If procedure_code is updated and this is not, the system will attempt to set it based on chargemasters entries and the service line’s quantity. For example, if a single unit has an entry of 100 cents and 2 units were rendered, the charge_amount_cents will be set to 200, if there is no chargemaster entry, it will default to the amount set in this field. diagnosis_pointers: type: array items: type: integer description: Indices (zero-indexed) of all the diagnoses this service line references drug_identification: $ref: '#/components/schemas/type_service-lines_v2_DrugIdentificationOptional' place_of_service_code: $ref: '#/components/schemas/type_commons_FacilityTypeCode' description: 837p Loop2300, SV105. This enum is not used or required in 837i claims. If your organization does not intend to submit claims with a different place of service at the service line level, this field should not be populated. 02 for telemedicine, 11 for in-person. Full list [here](https://www.cms.gov/Medicare/Coding/place-of-service-codes/Place_of_Service_Code_Set). description: type: string description: A free-form description to clarify the related data elements and their content. Maps to SV1-01, C003-07 on a 837-P and SV2-02, C003-07 on a 837-I form. date_of_service: type: string format: date end_date_of_service: type: string format: date ordering_provider: $ref: '#/components/schemas/type_encounter-providers_v2_OrderingProviderOptional' description: 'Required when the service or supply was ordered by a provider who is different than the rendering provider for this service line. If not required by this implementation guide, do not send.' test_results: type: array items: $ref: '#/components/schemas/type_service-lines_v2_TestResultOptional' description: 'Contains a list of test results. Test result types may map to MEA-02 on the 837-P (ex: Hemoglobin, Hematocrit). This is unused by 837-i and ignored for institutional service lines. No more than 5 MEA-02 test results may be submitted per service line.' note: type: string description: Maps to NTE02 loop 2400 on the EDI 837. revenue_code: type: string description: A 4 digit code that specifies facility department or type of service arrangement for institutional service line items (837i). This code is not required for professional claim billing (837p). prior_authorization_number: type: string description: Prior authorization number for this service line. Maps to the appropriate REF segment on Loop 2400 of the EDI 837p. This is not used for institutional claims (EDI 837i). external_id: type: string description: 'An external identifier for this service line. This is not used in the EDI 837, but can be used to identify the service line in external systems. This field should not contain PHI. Must be unique on a given claim.' title: ServiceLineCreateOptional type_individual_PatientClinicalTrialInfo: type: object properties: clinical_trial_arm: type: string clinical_trial: $ref: '#/components/schemas/type_clinical-trials_v1_ClinicalTrial' required: - clinical_trial title: PatientClinicalTrialInfo type_encounters_v4_LabOptional: type: object properties: name: type: string code: type: string code_type: $ref: '#/components/schemas/type_encounters_v4_LabCodeType' title: LabOptional type_health-care-code-information_v1_ExternalCauseOfInjury: type: object properties: id: type: string format: uuid description: 'The id of this health care code information if it is already stored. If this is not set, this is referring to a new health care code information to be added to the encounter. If it is set, this refers to an update of an existing health care code information object on the encounter.' encounter_id: $ref: '#/components/schemas/type_commons_EncounterId' description: 'The encounter_id of this health care code information if it is already stored. This will be set by the server in responses, but clients are not expected to set it.' external_cause_of_injury_code_qualifier: $ref: '#/components/schemas/type_health-care-code-information_v1_ExternalCauseOfInjuryCodeQualifier' external_cause_of_injury_code: $ref: '#/components/schemas/type_health-care-code-information_v1_ICDCode' present_on_admission_indicator: $ref: '#/components/schemas/type_health-care-code-information_v1_PresentOnAdmissionIndicatorCode' required: - external_cause_of_injury_code_qualifier - external_cause_of_injury_code description: This corresponds to BN or ABN code qualifier values. title: ExternalCauseOfInjury type_financials_Allocation: type: object properties: allocation_id: $ref: '#/components/schemas/type_commons_AllocationId' amount_cents: type: integer target: $ref: '#/components/schemas/type_financials_AllocationTarget' earmark: $ref: '#/components/schemas/type_financials_BalanceEarmark' description: The active earmark created by this allocation, if any. Only present when this allocation created an earmark for future auto-allocation and the earmark has not been deleted. allocated_on: type: string format: date-time required: - amount_cents - target title: Allocation type_pre-encounter_patients_v1_OriginationDetail: type: object properties: referral_source: $ref: '#/components/schemas/type_pre-encounter_patients_v1_ReferralSource' referring_provider: $ref: '#/components/schemas/type_pre-encounter_common_ExternalProvider' specialization_categories: type: array items: $ref: '#/components/schemas/type_pre-encounter_patients_v1_SpecializationCategory' referral_type: $ref: '#/components/schemas/type_pre-encounter_patients_v1_ReferralType' required: - referral_source title: OriginationDetail type_charge-capture_v1_ChargeCaptureSortField: type: string enum: - created_at - date_of_service title: ChargeCaptureSortField type_patient-payments_v3_PatientPayment: type: object properties: patient_payment_id: $ref: '#/components/schemas/type_patient-payments_v3_PatientPaymentId' organization_id: $ref: '#/components/schemas/type_commons_OrganizationId' source_internal_id: type: string source: $ref: '#/components/schemas/type_patient-payments_v3_PatientPaymentSource' amount_cents: type: integer payment_timestamp: type: string format: date-time status: $ref: '#/components/schemas/type_patient-payments_v3_PatientPaymentStatus' payment_name: type: string payment_note: type: string patient_external_id: $ref: '#/components/schemas/type_commons_PatientExternalId' encounter_external_id: $ref: '#/components/schemas/type_commons_EncounterExternalId' service_line_id: $ref: '#/components/schemas/type_commons_ServiceLineId' required: - patient_payment_id - organization_id - source_internal_id - source - amount_cents title: PatientPayment type_events_v1_EventId: type: string format: uuid title: EventId type_financials_AllocationOverdraftDetail: type: object properties: allocation_target: $ref: '#/components/schemas/type_financials_AllocationTarget' description: The allocation target that would be overdrafted (service_line, claim, unattributed, etc.) patient_paid_amount_cents: type: integer description: The amount in cents that the patient has currently paid toward this target (available to reallocate from) current_balance_cents: type: integer description: The current balance in cents on this entity before the reallocation overage_amount_cents: type: integer description: The amount in cents by which the reallocation would overdraft (always positive) error_message: type: string description: A descriptive error message explaining the overdraft condition required: - allocation_target - patient_paid_amount_cents - current_balance_cents - overage_amount_cents - error_message description: 'Structured information about an allocation that would be overdrafted. Provides entity-specific details to display in a table format.' title: AllocationOverdraftDetail type_commons_PageToken: type: string title: PageToken type_pre-encounter_common_PatientMergeId: type: string description: The unique identifier for a PatientMerge record. title: PatientMergeId type_pre-encounter_patients_v1_ElectronicCommunicationConsent: type: object properties: text_communication_consent: type: boolean description: Consent for text/SMS communication. email_communication_consent: type: boolean description: Consent for email communication. description: Granular consent for electronic communication channels. title: ElectronicCommunicationConsent type_encounters_v4_IntakeQuestion: type: object properties: id: $ref: '#/components/schemas/type_encounters_v4_IntakeQuestionId' text: type: string responses: type: array items: $ref: '#/components/schemas/type_encounters_v4_IntakeResponseAndFollowUps' required: - id - text title: IntakeQuestion type_x12_v1_Carc: type: string enum: - '1' - '2' - '3' - '4' - '5' - '6' - '7' - '8' - '9' - '10' - '11' - '12' - '13' - '14' - '16' - '18' - '19' - '20' - '21' - '22' - '23' - '24' - '26' - '27' - '29' - '31' - '32' - '33' - '34' - '35' - '39' - '40' - '44' - '45' - '49' - '50' - '51' - '53' - '54' - '55' - '56' - '58' - '59' - '60' - '61' - '66' - '69' - '70' - '74' - '75' - '76' - '78' - '85' - '89' - '90' - '91' - '94' - '95' - '96' - '97' - '100' - '101' - '102' - '103' - '104' - '105' - '106' - '107' - '108' - '109' - '110' - '111' - '112' - '114' - '115' - '116' - '117' - '118' - '119' - '121' - '122' - '125' - '128' - '129' - '130' - '131' - '132' - '133' - '134' - '135' - '136' - '137' - '139' - '140' - '142' - '143' - '144' - '146' - '147' - '148' - '149' - '150' - '151' - '152' - '153' - '154' - '155' - '157' - '158' - '159' - '160' - '161' - '163' - '164' - '166' - '167' - '169' - '170' - '171' - '172' - '173' - '174' - '175' - '176' - '177' - '178' - '179' - '180' - '181' - '182' - '183' - '184' - '185' - '186' - '187' - '188' - '189' - '190' - '192' - '193' - '194' - '195' - '197' - '198' - '199' - '200' - '201' - '202' - '203' - '204' - '205' - '206' - '207' - '208' - '209' - '210' - '211' - '212' - '213' - '215' - '216' - '219' - '222' - '223' - '224' - '225' - '226' - '227' - '228' - '229' - '231' - '232' - '233' - '234' - '235' - '236' - '237' - '238' - '239' - '240' - '241' - '242' - '243' - '245' - '246' - '247' - '248' - '249' - '250' - '251' - '252' - '253' - '254' - '256' - '257' - '258' - '259' - '260' - '261' - '262' - '263' - '264' - '265' - '266' - '267' - '268' - '269' - '270' - '271' - '272' - '273' - '274' - '275' - '276' - '277' - '278' - '279' - '280' - '281' - '282' - '283' - '284' - '285' - '286' - '287' - '288' - '289' - '290' - '291' - '292' - '293' - '294' - '295' - '296' - '297' - '298' - '299' - '300' - '301' - '302' - '303' - '304' - '305' - A0 - A1 - A5 - A6 - A8 - B1 - B4 - B7 - B8 - B9 - B10 - B11 - B12 - B13 - B14 - B15 - B16 - B20 - B22 - B23 - P1 - P2 - P3 - P4 - P5 - P6 - P7 - P8 - P9 - P10 - P11 - P12 - P13 - P14 - P15 - P16 - P17 - P18 - P19 - P20 - P21 - P22 - P23 - P24 - P25 - P26 - P27 - P28 - P29 - P30 - P31 - P32 - '15' - '17' - '25' - '28' - '30' - '36' - '37' - '38' - '41' - '42' - '43' - '46' - '47' - '48' - '52' - '57' - '62' - '63' - '64' - '65' - '67' - '68' - '71' - '72' - '73' - '77' - '79' - '80' - '81' - '82' - '83' - '84' - '86' - '87' - '88' - '92' - '93' - '98' - '99' - '113' - '120' - '123' - '124' - '126' - '127' - '138' - '141' - '145' - '156' - '162' - '165' - '168' - '191' - '196' - '214' - '217' - '218' - '220' - '221' - '230' - '244' - '255' - A2 - A3 - A4 - A7 - B2 - B3 - B5 - B6 - B17 - B18 - B19 - B21 - D1 - D2 - D3 - D4 - D5 - D6 - D7 - D8 - D9 - D10 - D11 - D12 - D14 - D15 - D16 - D17 - D18 - D19 - D20 - D21 - D22 - D23 - W1 - W2 - W3 - W4 - W5 - W6 - W7 - W8 - W9 - Y1 - Y2 - Y3 - UNKNOWN title: Carc type_property-and-casualty_v1_PropertyCasualtyPatientIdentifierQualifier: type: string enum: - 1W - SY title: PropertyCasualtyPatientIdentifierQualifier type_diagnoses_Diagnosis: type: object properties: name: type: string description: Empty string not allowed. code_type: $ref: '#/components/schemas/type_diagnoses_DiagnosisTypeCode' description: Typically, providers submitting claims to Candid are using ICD-10 diagnosis codes. If you are using ICD-10 codes, the primary diagnosis code listed on the claim should use the ABK code_type. If more than one diagnosis is being submitted on a claim, please use ABF for the rest of the listed diagnoses. If you are using ICD-9 diagnosis codes, use BK and BF for the principal and following diagnosis code(s) respectively. code: type: string description: "Empty string not allowed.\nShould be of the appropriate format for the provided `code_type`.\nMust obey the ICD-10 format if an ICD-10 code_type is provided, specifically:\n - Letter\n - Digit\n - Digit or the letter `A` or `B`\n - (Optional) Period `.`\n - Up to 4 (or as few as 0) letters and digits" present_on_admission_indicator: $ref: '#/components/schemas/type_yes-no-indicator_YesNoIndicator' description: 'For Institutional claims only. A "Y" indicates that the onset occurred prior to admission to the hospital. An "N" indicates that the onset did NOT occur prior to admission to the hospital. A "U" indicates that it is unknown whether the onset occurred prior to admission to the hospital or not.' encounter_id: $ref: '#/components/schemas/type_commons_EncounterId' diagnosis_id: $ref: '#/components/schemas/type_diagnoses_DiagnosisId' created_at: type: string format: date-time updated_at: type: string format: date-time required: - code_type - code - encounter_id - diagnosis_id - created_at - updated_at title: Diagnosis type_pre-encounter_eligibilityChecks_v1_EligibilityCheck: type: object properties: batch_id: type: string errors: type: array items: $ref: '#/components/schemas/type_pre-encounter_eligibilityChecks_v1_EligibilityCheckError' request: $ref: '#/components/schemas/type_pre-encounter_eligibilityChecks_v1_EligibilityRequest' response: description: Any type parsed_response: $ref: '#/components/schemas/type_pre-encounter_eligibilityChecks_v1_ParsedResponse' request_corrections: type: array items: $ref: '#/components/schemas/type_pre-encounter_eligibilityChecks_v1_RequestCorrection' required: - response title: EligibilityCheck type_commons_UserId: type: string format: uuid title: UserId type_pre-encounter_appointments_v1_UniversalServiceIdentifier: type: string enum: - MD_Visit - Treatment - Tests - Activity title: UniversalServiceIdentifier type_users_v2_UserV2: type: object properties: user_id: $ref: '#/components/schemas/type_commons_UserId' idp_metadata: type: array items: $ref: '#/components/schemas/type_users_v2_IdpUserMetadata' primary_organization_id: $ref: '#/components/schemas/type_commons_OrganizationId' user_metadata: $ref: '#/components/schemas/type_users_v2_UserMetadata' required: - user_id - idp_metadata - user_metadata title: UserV2 type_encounters_v4_InterventionCategory: type: string enum: - allopathic - naturopathic - tests - lifestyle title: InterventionCategory type_pre-encounter_eligibilityChecks_v1_InsuranceDiscoveryRequest: type: object properties: provider: $ref: '#/components/schemas/type_pre-encounter_eligibilityChecks_v1_InsuranceDiscoveryProvider' subscriber: $ref: '#/components/schemas/type_pre-encounter_eligibilityChecks_v1_InsuranceDiscoverySubscriber' dependent: $ref: '#/components/schemas/type_pre-encounter_eligibilityChecks_v1_InsuranceDiscoveryDependent' encounter: $ref: '#/components/schemas/type_pre-encounter_eligibilityChecks_v1_InsuranceDiscoveryEncounter' required: - provider - subscriber description: An object representing the data for an insurance discovery request. title: InsuranceDiscoveryRequest type_invoices_InvoiceItem: type: object properties: service_line_id: $ref: '#/components/schemas/type_commons_ServiceLineId' amount_cents: type: integer required: - service_line_id - amount_cents title: InvoiceItem type_commons_StreetAddressLongZip: 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 - zip_plus_four_code title: StreetAddressLongZip type_pre-encounter_common_PatientId: type: string description: The unique identifier for a Patient title: PatientId type_pre-encounter_eligibilityChecks_v1_VoteValue: type: string enum: - UPVOTE - DOWNVOTE description: Possible vote values for recommendation quality title: VoteValue type_service-lines_v2_TestResultOptional: type: object properties: value: type: number format: double result_type: $ref: '#/components/schemas/type_service-lines_v2_TestResultType' title: TestResultOptional 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_pre-encounter_common_AddressUse: type: string enum: - HOME - WORK - TEMP - OLD - BILLING title: AddressUse type_encounters_v4_Medication: type: object properties: name: type: string rx_cui: $ref: '#/components/schemas/type_encounters_v4_RxCui' dosage: type: string dosage_form: type: string frequency: type: string as_needed: type: boolean required: - name title: Medication type_non-insurance-payers_v1_NonInsurancePayerSortField: type: string enum: - NAME - CATEGORY - ENABLED - UPDATED_AT title: NonInsurancePayerSortField type_health-care-code-information_v1_HealthCareCodeInformationGetAllResponse: type: object properties: principal_diagnosis: $ref: '#/components/schemas/type_health-care-code-information_v1_PrincipalDiagnosis' other_diagnosis_information: type: array items: $ref: '#/components/schemas/type_health-care-code-information_v1_OtherDiagnosisInformation' admitting_diagnosis: $ref: '#/components/schemas/type_health-care-code-information_v1_AdmittingDiagnosis' description: This object only applies to 837i institutional claim forms. patient_reasons_for_visit: type: array items: $ref: '#/components/schemas/type_health-care-code-information_v1_PatientReasonForVisit' description: This object only applies to 837i institutional claim forms. external_causes_of_injury: type: array items: $ref: '#/components/schemas/type_health-care-code-information_v1_ExternalCauseOfInjury' description: This object only applies to 837i institutional claim forms. diagnosis_related_groups: $ref: '#/components/schemas/type_health-care-code-information_v1_DiagnosisRelatedGroup' description: This object only applies to 837i institutional claim forms. principal_procedure: $ref: '#/components/schemas/type_health-care-code-information_v1_PrincipalProcedureInformation' description: This object only applies to 837i institutional claim forms. other_procedure_information: type: array items: $ref: '#/components/schemas/type_health-care-code-information_v1_OtherProcedureInformation' description: This object only applies to 837i institutional claim forms. occurrence_span_information: type: array items: $ref: '#/components/schemas/type_health-care-code-information_v1_OccurrenceSpanInformation' description: This object only applies to 837i institutional claim forms. occurrence_information: type: array items: $ref: '#/components/schemas/type_health-care-code-information_v1_OccurrenceInformation' description: This object only applies to 837i institutional claim forms. treatment_code_information: type: array items: $ref: '#/components/schemas/type_health-care-code-information_v1_TreatmentCodeInformation' description: This object only applies to 837i institutional claim forms. value_information: type: array items: $ref: '#/components/schemas/type_health-care-code-information_v1_ValueInformation' description: This object only applies to 837i institutional claim forms. condition_information: type: array items: $ref: '#/components/schemas/type_health-care-code-information_v1_ConditionInformation' description: This object only applies to 837i institutional claim forms. required: - other_diagnosis_information - patient_reasons_for_visit - external_causes_of_injury - other_procedure_information - occurrence_span_information - occurrence_information - treatment_code_information - value_information - condition_information title: HealthCareCodeInformationGetAllResponse type_pre-encounter_eligibilityChecks_v1_MedicareAdvantageRecommendationPayload: type: object properties: ma_benefit: description: Any type payer_id: type: string payer_name: type: string member_id: type: string description: An object representing the payload for a Medicare Advantage recommendation. title: MedicareAdvantageRecommendationPayload type_invoices_Invoice: type: object properties: id: $ref: '#/components/schemas/type_commons_InvoiceId' created_at: type: string format: date-time updated_at: type: string format: date-time organzation_id: $ref: '#/components/schemas/type_commons_OrganizationId' source_id: type: string source_customer_id: type: string patient_external_id: $ref: '#/components/schemas/type_commons_PatientExternalId' note: type: string due_date: $ref: '#/components/schemas/type_commons_Date' status: $ref: '#/components/schemas/type_invoices_InvoiceStatus' url: type: string customer_invoice_url: type: string items: type: array items: $ref: '#/components/schemas/type_invoices_InvoiceItem' required: - id - created_at - updated_at - organzation_id - source_id - source_customer_id - patient_external_id - due_date - status - items title: Invoice type_pre-encounter_images_v1_ImageStatus: type: string enum: - PENDING - UPLOADED - FAILED title: ImageStatus type_invoices_v2_ClaimInvoiceItem: type: object properties: claim_id: $ref: '#/components/schemas/type_commons_ClaimId' amount_cents: type: integer required: - claim_id - amount_cents title: ClaimInvoiceItem type_pre-encounter_common_PatientServiceFacility: type: object properties: service_facility_id: $ref: '#/components/schemas/type_pre-encounter_common_CanonicalServiceFacilityId' required: - service_facility_id description: Represents a canonical service facility attached to a patient or patient dependent object title: PatientServiceFacility type_invoices_v2_InvoiceItemInfo: type: object properties: claim_invoice_items: type: object additionalProperties: $ref: '#/components/schemas/type_invoices_v2_ClaimInvoiceItemInfo' unattributed_items: type: array items: $ref: '#/components/schemas/type_invoices_v2_UnattributedInvoiceItem' required: - claim_invoice_items - unattributed_items title: InvoiceItemInfo type_patient-ar_v1_InventoryRecord: type: object properties: claim_id: $ref: '#/components/schemas/type_commons_ClaimId' encounter_id: $ref: '#/components/schemas/type_commons_EncounterId' timestamp: type: string format: date-time patient_external_id: $ref: '#/components/schemas/type_commons_PatientExternalId' patient_ar_status: $ref: '#/components/schemas/type_patient-ar_v1_PatientARStatus' required: - claim_id - encounter_id - timestamp - patient_external_id - patient_ar_status title: InventoryRecord type_commons_InsuranceTypeCode: type: string enum: - '01' - '12' - '13' - '14' - '15' - '16' - '17' - '18' - '19' - '41' - '42' - '43' - '47' - AP - C1 - CO - CP - D - DB - E - EP - FF - GP - HA - HB - HD - HG - HM - HN - HP - HS - IN - IP - LC - LD - LI - LT - M - MA - MB - MC - MD - ME - MF - MH - MI - MJ - MK - ML - MM - MN - MO - MP - MR - MT - MV - OA - OT - PE - PL - PP - PR - PS - QM - RP - SP - TF - U - WC - WU description: Code identifying the type of insurance policy within a specific insurance program (X12 008020 Element 1336) title: InsuranceTypeCode type_eras_EraId: type: string format: uuid title: EraId type_encounters_v4_ResponsiblePartyType: type: string enum: - INSURANCE_PAY - SELF_PAY - UNKNOWN title: ResponsiblePartyType type_commons_WorkQueueId: type: string title: WorkQueueId type_x12_v1_TypeOfCareCode: type: string enum: - '1' - '2' - '3' - '4' - '5' - '6' - '7' - '8' - '9' title: TypeOfCareCode type_pre-encounter_eligibilityChecks_v1_EligibilityCheckError: type: object properties: source: $ref: '#/components/schemas/type_pre-encounter_eligibilityChecks_v1_EligibilityCheckErrorSource' errorDetails: $ref: '#/components/schemas/type_pre-encounter_eligibilityChecks_v1_EligibilityCheckErrorDetails' required: - source - errorDetails title: EligibilityCheckError type_pre-encounter_organizationExternalProviders_v1_OrganizationExternalProviderType: type: string enum: - REFERRING - PRIMARY - TREATING title: OrganizationExternalProviderType type_clinical-trials_v1_ClinicalTrial: type: object properties: name: type: string clinical_trial_number: type: string description: Must be 8 characters long clinical_trial_phase: $ref: '#/components/schemas/type_clinical-trials_v1_ClinicalTrialPhase' clinical_trial_id: $ref: '#/components/schemas/type_commons_ClinicalTrialId' non_insurance_payer_id: $ref: '#/components/schemas/type_non-insurance-payers_v1_NonInsurancePayerId' is_active: type: boolean required: - name - clinical_trial_number - clinical_trial_id - non_insurance_payer_id - is_active title: ClinicalTrial type_pre-encounter_eligibilityChecks_v1_InsuranceDiscoveryResponse: type: object properties: discovery_id: type: string description: A unique ID for this insurance discovery check. status: $ref: '#/components/schemas/type_pre-encounter_eligibilityChecks_v1_InsuranceDiscoveryStatus' description: The status of the discovery check. COMPLETE means items are populated. PENDING means the check is still in progress. items: type: array items: description: Any type description: "An array of potential coverage matches for the patient. Only populated when status is COMPLETE.\nEach item is a raw passthrough of Stedi's deeply nested coverage-match object (provider, subscriber, \npayer, plan, and benefits details)." coverages_found: type: integer description: The number of potential coverage matches found. 0 if no matching coverage was found. errors: type: array items: $ref: '#/components/schemas/type_pre-encounter_eligibilityChecks_v1_EligibilityCheckErrorDetails' description: An object representing the data for an insurance discovery response. title: InsuranceDiscoveryResponse type_pre-encounter_common_AppointmentId: type: string description: The unique identifier for an Appointment. title: AppointmentId type_commons_StreetAddressShortZipOptional: 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 title: StreetAddressShortZipOptional type_pre-encounter_patients_v1_ReferralType: type: string enum: - DIRECTED - ROTATION - OVERNIGHT title: ReferralType type_pre-encounter_coverages_v1_ExpandedMemberInfo: type: object properties: member_id: type: string group_number: type: string first_name: type: string middle_name: type: string last_name: type: string date_of_birth: type: string gender: type: string address: $ref: '#/components/schemas/type_pre-encounter_coverages_v1_Address' title: ExpandedMemberInfo type_patient-payments_v3_PatientPaymentSource: type: string enum: - MANUAL_ENTRY - CHARGEBEE_PAYMENTS - CHARGEBEE MANUALLY VOIDED BY CANDID - CHARGEBEE_REFUNDS - SQUARE_REFUNDS - SQUARE_PAYMENTS - STRIPE_CHARGES - STRIPE_REFUNDS - ELATION_PAYMENTS title: PatientPaymentSource type_non-insurance-payer-payments_v1_NonInsurancePayerPaymentCreate: type: object properties: non_insurance_payer_id: $ref: '#/components/schemas/type_non-insurance-payers_v1_NonInsurancePayerId' amount_cents: type: integer payment_timestamp: type: string format: date-time payment_note: type: string check_number: type: string allocations: type: array items: $ref: '#/components/schemas/type_financials_AllocationCreate' invoice_id: $ref: '#/components/schemas/type_commons_InvoiceId' required: - non_insurance_payer_id - amount_cents - allocations title: NonInsurancePayerPaymentCreate type_payer-plan-groups_v1_MutablePayerPlanGroup: type: object properties: plan_group_name: type: string payer_uuid: $ref: '#/components/schemas/type_payers_v3_PayerUuid' plan_type: $ref: '#/components/schemas/type_commons_SourceOfPaymentCode' required: - plan_group_name - payer_uuid - plan_type title: MutablePayerPlanGroup type_custom-schemas_v1_Schema: type: object properties: id: $ref: '#/components/schemas/type_commons_SchemaId' name: type: string description: type: string fields: type: array items: $ref: '#/components/schemas/type_custom-schemas_v1_SchemaField' required: - id - name - fields title: Schema type_pre-encounter_images_v1_MutableImage: type: object properties: file_name: type: string display_name: type: string file_type: type: string status: $ref: '#/components/schemas/type_pre-encounter_images_v1_ImageStatus' coverage: $ref: '#/components/schemas/type_pre-encounter_images_v1_CoverageAssociation' patient: $ref: '#/components/schemas/type_pre-encounter_images_v1_PatientAssociation' required: - file_name - display_name - file_type - status description: An object representing an Image. title: MutableImage type_yes-no-indicator_YesNoIndicator: type: string enum: - 'YES' - 'NO' - UNKNOWN - NOT_APPLICABLE title: YesNoIndicator type_pre-encounter_common_ErrorBase5xx: type: object properties: message: type: string data: description: Any type required: - message title: ErrorBase5xx type_pre-encounter_images_v1_PatientAssociation: type: object properties: id: $ref: '#/components/schemas/type_pre-encounter_common_PatientId' notes: type: string required: - id description: An association to a Patient. title: PatientAssociation type_encounters_v4_VitalsUpdate: type: object properties: height_in: type: integer weight_lbs: type: integer blood_pressure_systolic_mmhg: type: integer blood_pressure_diastolic_mmhg: type: integer body_temperature_f: type: number format: double hemoglobin_gdl: type: number format: double hematocrit_pct: type: number format: double title: VitalsUpdate type_pre-encounter_common_PayerId: type: string description: The unique identifier for a Payer in the database title: PayerId type_organization-providers_v2_LicenseType: type: string enum: - MD - NP - PA - LMFT - LCPC - LCSW - PMHNP - FNP - LPCC - DO - RD - SLP - APRN - LPC - PHD - PSYD - LMSW - LMHC - OTHER_MASTERS - BCBA - UNKNOWN - RPH - PHT - LAC - LMT - DC - ND - MA - PT - IBCLC - RN - DPT - LCMHC - CNM - RNFA - ACSW - APC - BCABA - BHA - OD - DPM - DA - DDS - DEH - DMD - PTA - LCADC - LCAT - LCMHCS - LCMHCA - LCSWA - LICSW - LISW - LMFTS - LMFTA - LPCI - LSCSW - MHCA - MHT - RBT - RCSWI - RHMCI - LPN - OTD - OMS - MFTA - APCC - DNP - AGNPBC - ANP - FNPPP - LCSWR - ALC - RMFTI - LAMFT - LPCA - LSWI - CSW - CPC - LGMFT - LLPC - PLPC - PLMFT - LMHCA - CIT - CT - MFT - LSW - PLMHP - PCMSW - LMHP - OTR/L - RPA - COTA - CRNP - SLP-CF - NP-C - PA-C - AMFT - CDN - CGC - CNS - MDPHD - AuD - ATC - LAT - OTA - LSSP - SLPA title: LicenseType type_external-payment-account-config_v1_ExternalPaymentAccountConfig: type: object properties: id: $ref: '#/components/schemas/type_payment-account-configs_PaymentAccountConfigId' account_name: type: string required: - id - account_name title: ExternalPaymentAccountConfig type_commons_ProviderId: type: string format: uuid title: ProviderId type_encounters_v4_EPSDTReferralOptional: type: object properties: condition_indicator1: $ref: '#/components/schemas/type_commons_EPSDTReferralConditionIndicatorCode' condition_indicator2: $ref: '#/components/schemas/type_commons_EPSDTReferralConditionIndicatorCode' condition_indicator3: $ref: '#/components/schemas/type_commons_EPSDTReferralConditionIndicatorCode' title: EPSDTReferralOptional type_pre-encounter_coverages_v1_RelatedEntityContact: type: object properties: mode: type: string value: type: string title: RelatedEntityContact type_commons_BillingProviderCommercialLicenseType: type: string enum: - '0' - A - B - C - D - E - F - G - H - I title: BillingProviderCommercialLicenseType type_pre-encounter_appointments_v1_Appointment: type: object properties: organization_id: $ref: '#/components/schemas/type_pre-encounter_common_OrganizationId' description: The organization that owns this object. deactivated: type: boolean description: True if the object is deactivated. Deactivated objects are not returned in search results but are returned in all other endpoints including scan. version: type: integer description: The version of the object. Any update to any property of an object object will create a new version. updated_at: type: string format: date-time updating_user_id: $ref: '#/components/schemas/type_pre-encounter_common_UserId' description: The user ID of the user who last updated the object. patient_id: $ref: '#/components/schemas/type_pre-encounter_common_PatientId' description: The Candid-defined patient identifier. start_timestamp: type: string format: date-time status: $ref: '#/components/schemas/type_pre-encounter_appointments_v1_AppointmentStatus' description: Defaults to PENDING. If status is NOT_READY, work_queue must be set. If status is READY or CHECKED_IN, work_queue must be null. If status is CHECKED_IN, checked_in_timestamp must be set. If checked_in_timestamp is set, status must be CHECKED_IN. not_ready_reason: $ref: '#/components/schemas/type_pre-encounter_appointments_v1_NotReadyReason' description: The reason the appointment is NOT_READY. Must only be set when status is NOT_READY; it is cleared otherwise. It is not recommended to change this value manually via API. ready_source: $ref: '#/components/schemas/type_pre-encounter_appointments_v1_ReadySource' description: The method that set the appointment status to READY. It is not recommended to change this value manually via API. Must only be set when the status is READY or CHECKED_IN, it is cleared otherwise. service_duration: type: integer description: The requested length of time allotted for the appointment. The units are in minutes. services: type: array items: $ref: '#/components/schemas/type_pre-encounter_appointments_v1_Service' placer_appointment_id: type: string description: ID for the appointment/order for the event. attending_doctor: $ref: '#/components/schemas/type_pre-encounter_common_ExternalProvider' description: Attending physician information. The attending physician will be stored as the Current MD for the patient. estimated_copay_cents: type: integer estimated_patient_responsibility_cents: type: integer description: The estimated amount the patient will be responsible for paying at the time of service. This does not include the copay. patient_deposit_cents: type: integer appointment_details: type: string checked_in_timestamp: type: string format: date-time description: The timestamp when the patient checked in for their appointment. If status is CHECKED_IN, checked_in_timestamp must be set. If checked_in_timestamp is set, status must be CHECKED_IN. notes: type: string location_resource_id: type: string description: 'Contains the coded identification of the location being scheduled. Components: ^' automated_eligibility_check_complete: type: boolean description: True if the automated eligibility check has been completed. It is not recommended to change this value manually via API. This refers explicitly to the automated eligibility check that occurs a specific number of days before the appointment. work_queue: $ref: '#/components/schemas/type_pre-encounter_appointments_v1_AppointmentWorkQueue' description: The work queue that the appointment belongs to. It is not recommended to change this value manually via API. If status is NOT_READY, work_queue must be set. If status is READY, work_queue must be null. id: $ref: '#/components/schemas/type_pre-encounter_common_AppointmentId' required: - organization_id - deactivated - version - updated_at - updating_user_id - patient_id - start_timestamp - service_duration - services - id description: An appointment object with immutable server-owned properties. title: Appointment securitySchemes: OAuthScheme: type: http scheme: bearer description: OAuth 2.0 authentication