v3
post/api/tasks/v3

Request

  • Base URL
    https://pre-api.joincandidhealth.com
  • URL
    https://pre-api.joincandidhealth.com/api/tasks/v3
  • Auth
    HTTP bearer

Request body

encounter_idstring uuid required
task_type'CUSTOMER_DATA_REQUEST' | 'CLAIM_SUBMISSION_RUN_VALIDATIONS_FAILURE' | 'CLAIM_SUBMISSION_SUBMIT_CLAIM_FAILURE' | 'CLAIM_SUBMISSION_TRANSFORM_FAILURE' | 'CODE_CLAIM' | 'CODE_CLAIM_REVIEW' | 'ELIGIBILITY' | 'CLAIM_FOLLOW_UP' | 'REJECTION_RESOLUTION' | 'PAYER_CONFIGURATION_ERROR' | 'DENIAL_RESOLUTION' | 'MISSING_ENROLLMENT' | 'CHARGE_CAPTURE_UPDATE' required
descriptionstring required
blocks_claim_submissionboolean
assignee_user_idstring uuid
category'other' | 'provider_credentialing' | 'authorization_required' | 'inactive_coverage' | 'unknown_eligibility_or_patient_not_found' | 'incorrect_member_id' | 'documentation_addendum_request' | 'coordination_of_benefits' | 'missing_or_incorrect_gender' | 'incorrect_date_of_birth' | 'incorrect_payer' | 'incorrect_name' | 'invalid_diagnosis_code' | 'non_covered_diagnosis_codes' | 'information_requested_from_patient' | 'incorrect_rendering_provider_info' | 'missing_or_incorrect_modifier' | 'coding_frequency_error' | 'incorrect_patient_address' | 'multiple_em_claims' | 'missing_or_incorrect_charge_amount' | 'medical_records_request' | 'provider_enrollment_or_contracting' | 'missing_or_incorrect_group_number' | 'missing_diagnosis_codes' | 'missing_patient_authorization' | 'incorrect_billing_provider_info' | 'incorrect_procedure_code' | 'incorrect_quantity' | 'incorrect_place_of_service_code' | 'incorrect_service_facility_info' | 'incorrect_date_of_service' | 'missing_or_incorrect_ndc' | 'patient_collections' | 'submit_to_secondary' | 'transient_server_error' | 'missing_remittance_enrollment' | 'missing_claims_enrollment' | 'held_by_customer' | 'pending_manual_remit_posting' | 'incorrect_referring_provider_info' | 'payer_configuration_error' | 'downcoding_review'
work_queue_idstring required

Response

Response with status 200

task_idstring uuid required
encounter_idstring uuid required
task_type'CUSTOMER_DATA_REQUEST' | 'CLAIM_SUBMISSION_RUN_VALIDATIONS_FAILURE' | 'CLAIM_SUBMISSION_SUBMIT_CLAIM_FAILURE' | 'CLAIM_SUBMISSION_TRANSFORM_FAILURE' | 'CODE_CLAIM' | 'CODE_CLAIM_REVIEW' | 'ELIGIBILITY' | 'CLAIM_FOLLOW_UP' | 'REJECTION_RESOLUTION' | 'PAYER_CONFIGURATION_ERROR' | 'DENIAL_RESOLUTION' | 'MISSING_ENROLLMENT' | 'CHARGE_CAPTURE_UPDATE' required
descriptionstring required
blocks_claim_submissionboolean required
external_idstring required
patient_namestring required
patient_external_idstring required
payer_namestring
payer_idstring
status'finished' | 'addressed_by_provider_group' | 'sent_to_provider_group' | 'open' | 'blocked' | 'waiting_for_review' | 'in_progress' required
created_atstring date-time required
updated_atstring date-time required

The time of most recent update to the task only

agg_updated_atstring date-time required

The time of most recent update to the task or any of its notes

date_of_servicestring date required
category'other' | 'provider_credentialing' | 'authorization_required' | 'inactive_coverage' | 'unknown_eligibility_or_patient_not_found' | 'incorrect_member_id' | 'documentation_addendum_request' | 'coordination_of_benefits' | 'missing_or_incorrect_gender' | 'incorrect_date_of_birth' | 'incorrect_payer' | 'incorrect_name' | 'invalid_diagnosis_code' | 'non_covered_diagnosis_codes' | 'information_requested_from_patient' | 'incorrect_rendering_provider_info' | 'missing_or_incorrect_modifier' | 'coding_frequency_error' | 'incorrect_patient_address' | 'multiple_em_claims' | 'missing_or_incorrect_charge_amount' | 'medical_records_request' | 'provider_enrollment_or_contracting' | 'missing_or_incorrect_group_number' | 'missing_diagnosis_codes' | 'missing_patient_authorization' | 'incorrect_billing_provider_info' | 'incorrect_procedure_code' | 'incorrect_quantity' | 'incorrect_place_of_service_code' | 'incorrect_service_facility_info' | 'incorrect_date_of_service' | 'missing_or_incorrect_ndc' | 'patient_collections' | 'submit_to_secondary' | 'transient_server_error' | 'missing_remittance_enrollment' | 'missing_claims_enrollment' | 'held_by_customer' | 'pending_manual_remit_posting' | 'incorrect_referring_provider_info' | 'payer_configuration_error' | 'downcoding_review'
configurable_rule_idstring uuid
persisted_rule_idstring uuid
organization_idstring uuid

Changes

    • breaking

      added the new required request property

    • breaking

      added the new required request property

    • breaking

      added the new required request property

    • breaking

      added the new required request property

    • breaking

      the request's body type changed from no type to object

    • breaking

      the response's body type changed from no type to object for status

    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security OAuthScheme was added to the API

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      api operation id create removed and replaced with v3_create_3