Resolves a view to it's EncounterSummaries

Beta

POST

/api/claim-dynamic-views/v1/:claim_dynamic_view_id/resolve

POST

/api/claim-dynamic-views/v1/:claim_dynamic_view_id/resolve

curl -X POST https://api.joincandidhealth.com/api/claim-dynamic-views/v1/d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32/resolve \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{}'

{
  "items": [
    {
      "encounter_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
      "claim_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
      "claim_status": "biller_received",
      "billing_provider_npi": "billing_provider_npi",
      "billing_provider_name": "billing_provider_name",
      "rendering_provider_npi": "rendering_provider_npi",
      "rendering_provider_name": "rendering_provider_name",
      "patient_first_name": "patient_first_name",
      "patient_last_name": "patient_last_name",
      "sum_allowed_amount_cents": 1,
      "sum_charge_amount_cents": 1,
      "sum_paid_amount_cents": 1,
      "sum_patient_responsibility_cents": 1,
      "procedure_codes": [
        "procedure_codes"
      ],
      "procedure_modifiers": [
        "AV"
      ],
      "carcs": [
        "carcs"
      ],
      "rarcs": [
        "rarcs"
      ],
      "tag_ids": [
        "tag_ids",
        "tag_ids"
      ],
      "date_of_service": "2023-01-15",
      "service_facility": {
        "service_facility_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
        "organization_name": "organization_name",
        "address": {
          "address1": "address1",
          "city": "city",
          "state": "AA",
          "zip_code": "zip_code",
          "zip_plus_four_code": "zip_plus_four_code",
          "address2": "address2"
        },
        "npi": "npi",
        "secondary_identification": "secondary_identification",
        "mammography_certification_number": "mammography_certification_number"
      },
      "diagnosis_codes": [
        "diagnosis_codes"
      ],
      "billable_status": "BILLABLE",
      "responsible_party": "INSURANCE_PAY",
      "owner_of_next_action": "CANDID",
      "has_active_job": true,
      "claim_updated_at": "2024-01-15T09:30:00Z",
      "patient_control_number": "patient_control_number",
      "billing_provider_tin": "billing_provider_tin",
      "rendering_provider_tin": "rendering_provider_tin",
      "optional_rendering_provider_npi": "optional_rendering_provider_npi",
      "optional_rendering_provider_name": "optional_rendering_provider_name",
      "patient_external_id": "patient_external_id",
      "patient_state": "AA",
      "primary_payer_id": "primary_payer_id",
      "primary_payer_name": "primary_payer_name",
      "primary_payer_plan_group_name": "primary_payer_plan_group_name",
      "primary_payer_plan_name": "primary_payer_plan_name",
      "primary_group_number": "primary_group_number",
      "secondary_payer_id": "secondary_payer_id",
      "secondary_payer_name": "secondary_payer_name",
      "secondary_payer_plan_group_name": "secondary_payer_plan_group_name",
      "secondary_payer_plan_name": "secondary_payer_plan_name",
      "secondary_group_number": "secondary_group_number",
      "primary_member_id": "primary_member_id",
      "primary_plan_type": "09",
      "secondary_plan_type": "09",
      "primary_insurance_paid_cents": 1,
      "secondary_insurance_paid_cents": 1,
      "tertiary_insurance_paid_cents": 1,
      "sum_insurance_balance_amount_cents": 1,
      "sum_insurance_adjustment_amount_cents": 1,
      "sum_patient_paid_amount_cents": 1,
      "sum_patient_balance_amount_cents": 1,
      "sum_total_balance_amount_cents": 1,
      "sum_patient_write_off_amount_cents": 1,
      "sum_non_insurance_paid_cents": 1,
      "claim_balance_amount_cents": 1,
      "denial_reasons": [
        "Authorization Required",
        "Authorization Required"
      ],
      "rejection_reason": "DUPLICATE_CLAIM",
      "end_date_of_service": "2023-01-15",
      "timely_filing_deadline": "2023-01-15",
      "place_of_service_code": "01",
      "service_line_place_of_service_codes": [
        "01",
        "01"
      ],
      "service_line_total_quantity": 1.1,
      "encounter_external_id": "encounter_external_id",
      "work_queue_id": "work_queue_id",
      "work_queue_name": "work_queue_name",
      "work_queue_membership_activated_at": "2024-01-15T09:30:00Z",
      "task_category": "other",
      "task_type": "CUSTOMER_DATA_REQUEST",
      "active_snooze": {
        "id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
        "created_by": "created_by",
        "snooze_reason": "Pending Appeal",
        "start_date": "2023-01-15",
        "end_date": "2023-01-15",
        "updated_by": "updated_by",
        "comments": "comments"
      },
      "days_since_unsnoozed": 1,
      "task_assignees": [
        "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
        "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
      ],
      "task_assignees_by_name": [
        "task_assignees_by_name",
        "task_assignees_by_name"
      ],
      "task_description": "task_description",
      "next_responsible_party": "primary",
      "non_insurance_payer_categories": [
        "non_insurance_payer_categories",
        "non_insurance_payer_categories"
      ],
      "non_insurance_payer_names": [
        "non_insurance_payer_names",
        "non_insurance_payer_names"
      ],
      "clinical_trial_phases": [
        "Phase 1"
      ],
      "attending_provider_npi": "attending_provider_npi",
      "attending_provider_name": "attending_provider_name",
      "revenue_codes": [
        "revenue_codes",
        "revenue_codes"
      ],
      "organization_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
      "submission_expectation": "TARGET_PROFESSIONAL",
      "type_of_bill": {
        "code": "code",
        "frequency_code": "0",
        "type_of_care": "1",
        "type_of_facility": "1"
      }
    },
    {
      "encounter_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
      "claim_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
      "claim_status": "biller_received",
      "billing_provider_npi": "billing_provider_npi",
      "billing_provider_name": "billing_provider_name",
      "rendering_provider_npi": "rendering_provider_npi",
      "rendering_provider_name": "rendering_provider_name",
      "patient_first_name": "patient_first_name",
      "patient_last_name": "patient_last_name",
      "sum_allowed_amount_cents": 1,
      "sum_charge_amount_cents": 1,
      "sum_paid_amount_cents": 1,
      "sum_patient_responsibility_cents": 1,
      "procedure_codes": [
        "procedure_codes"
      ],
      "procedure_modifiers": [
        "AV"
      ],
      "carcs": [
        "carcs"
      ],
      "rarcs": [
        "rarcs"
      ],
      "tag_ids": [
        "tag_ids",
        "tag_ids"
      ],
      "date_of_service": "2023-01-15",
      "service_facility": {
        "service_facility_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
        "organization_name": "organization_name",
        "address": {
          "address1": "address1",
          "city": "city",
          "state": "AA",
          "zip_code": "zip_code",
          "zip_plus_four_code": "zip_plus_four_code",
          "address2": "address2"
        },
        "npi": "npi",
        "secondary_identification": "secondary_identification",
        "mammography_certification_number": "mammography_certification_number"
      },
      "diagnosis_codes": [
        "diagnosis_codes"
      ],
      "billable_status": "BILLABLE",
      "responsible_party": "INSURANCE_PAY",
      "owner_of_next_action": "CANDID",
      "has_active_job": true,
      "claim_updated_at": "2024-01-15T09:30:00Z",
      "patient_control_number": "patient_control_number",
      "billing_provider_tin": "billing_provider_tin",
      "rendering_provider_tin": "rendering_provider_tin",
      "optional_rendering_provider_npi": "optional_rendering_provider_npi",
      "optional_rendering_provider_name": "optional_rendering_provider_name",
      "patient_external_id": "patient_external_id",
      "patient_state": "AA",
      "primary_payer_id": "primary_payer_id",
      "primary_payer_name": "primary_payer_name",
      "primary_payer_plan_group_name": "primary_payer_plan_group_name",
      "primary_payer_plan_name": "primary_payer_plan_name",
      "primary_group_number": "primary_group_number",
      "secondary_payer_id": "secondary_payer_id",
      "secondary_payer_name": "secondary_payer_name",
      "secondary_payer_plan_group_name": "secondary_payer_plan_group_name",
      "secondary_payer_plan_name": "secondary_payer_plan_name",
      "secondary_group_number": "secondary_group_number",
      "primary_member_id": "primary_member_id",
      "primary_plan_type": "09",
      "secondary_plan_type": "09",
      "primary_insurance_paid_cents": 1,
      "secondary_insurance_paid_cents": 1,
      "tertiary_insurance_paid_cents": 1,
      "sum_insurance_balance_amount_cents": 1,
      "sum_insurance_adjustment_amount_cents": 1,
      "sum_patient_paid_amount_cents": 1,
      "sum_patient_balance_amount_cents": 1,
      "sum_total_balance_amount_cents": 1,
      "sum_patient_write_off_amount_cents": 1,
      "sum_non_insurance_paid_cents": 1,
      "claim_balance_amount_cents": 1,
      "denial_reasons": [
        "Authorization Required",
        "Authorization Required"
      ],
      "rejection_reason": "DUPLICATE_CLAIM",
      "end_date_of_service": "2023-01-15",
      "timely_filing_deadline": "2023-01-15",
      "place_of_service_code": "01",
      "service_line_place_of_service_codes": [
        "01",
        "01"
      ],
      "service_line_total_quantity": 1.1,
      "encounter_external_id": "encounter_external_id",
      "work_queue_id": "work_queue_id",
      "work_queue_name": "work_queue_name",
      "work_queue_membership_activated_at": "2024-01-15T09:30:00Z",
      "task_category": "other",
      "task_type": "CUSTOMER_DATA_REQUEST",
      "active_snooze": {
        "id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
        "created_by": "created_by",
        "snooze_reason": "Pending Appeal",
        "start_date": "2023-01-15",
        "end_date": "2023-01-15",
        "updated_by": "updated_by",
        "comments": "comments"
      },
      "days_since_unsnoozed": 1,
      "task_assignees": [
        "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
        "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
      ],
      "task_assignees_by_name": [
        "task_assignees_by_name",
        "task_assignees_by_name"
      ],
      "task_description": "task_description",
      "next_responsible_party": "primary",
      "non_insurance_payer_categories": [
        "non_insurance_payer_categories",
        "non_insurance_payer_categories"
      ],
      "non_insurance_payer_names": [
        "non_insurance_payer_names",
        "non_insurance_payer_names"
      ],
      "clinical_trial_phases": [
        "Phase 1"
      ],
      "attending_provider_npi": "attending_provider_npi",
      "attending_provider_name": "attending_provider_name",
      "revenue_codes": [
        "revenue_codes",
        "revenue_codes"
      ],
      "organization_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
      "submission_expectation": "TARGET_PROFESSIONAL",
      "type_of_bill": {
        "code": "code",
        "frequency_code": "0",
        "type_of_care": "1",
        "type_of_facility": "1"
      }
    }
  ],
  "next_page_token": "next_page_token",
  "prev_page_token": "prev_page_token"
}

Resolves a dynamic view to the EncounterSummaries currently present in this view. Body parameters can include sorting controls.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Path parameters

claim_dynamic_view_idUUIDRequired

Request

This endpoint expects an object.

filtersobjectOptional

Structured filter for searching encounter summaries. Each field accepts an operator-tagged filter object. Omit a field to not filter on it. All specified filters are combined with AND.

limitintegerOptional

Defaults to 100

page_tokenstringOptional

sortlist of objectsOptional

Sort criteria applied in order. Defaults to created_at descending.

Response

This endpoint returns an object.

itemslist of objects

next_page_tokenstringOptional

prev_page_tokenstringOptional

Errors

404

Entity Not Found Error

422

Unprocessable Entity Error