Skip to documentation
Brightree integration

List CMN Recertification Candidates

Perform List CMN Recertification Candidates through Brightree.

View as Markdown
brightree_list_cmn_recertification_candidates
readbrightree

Inputs

  • branch_name
    textrequired
    Branch Name

    Required text value.

  • as_of_date
    daterequired
    As Of Date

    Required date in YYYY-MM-DD format.

  • window_days
    number
    Window Days

    Optional numeric value.

    Default: 60

  • exclude_faxed_this_cycle
    boolean
    Exclude Faxed This Cycle

    Optional true-or-false value.

    Default: true

  • maximum_candidates
    number
    Maximum Candidates

    Optional numeric value.

    Default: 500

Outputs

  • successSuccess
  • report_idReport Id
  • as_of_dateAs Of Date
  • window_end_dateWindow End Date
  • window_daysWindow Days
  • export_row_countExport Row Count
  • scoped_row_countScoped Row Count
  • candidate_countCandidate Count
  • distinct_patient_countDistinct Patient Count
  • distinct_provider_countDistinct Provider Count
  • multi_cmn_patient_countMulti Cmn Patient Count
  • maximum_cmns_per_patientMaximum Cmns Per Patient
  • zero_to_seven_day_countZero To Seven Day Count
  • eight_to_thirty_day_countEight To Thirty Day Count
  • thirty_one_plus_day_countThirty One Plus Day Count
  • missing_expiration_countMissing Expiration Count
  • malformed_expiration_countMalformed Expiration Count
  • expired_countExpired Count
  • beyond_window_countBeyond Window Count
  • invalid_identity_countInvalid Identity Count
  • missing_ordering_doctor_countMissing Ordering Doctor Count
  • branch_mismatch_countBranch Mismatch Count
  • inactive_status_countInactive Status Count
  • placeholder_countPlaceholder Count
  • duplicate_cycle_countDuplicate Cycle Count
  • report_missing_provider_fax_countReport Missing Provider Fax Count
  • fax_history_countFax History Count
  • faxed_this_cycle_countFaxed This Cycle Count
  • failed_delivery_countFailed Delivery Count
  • data_quality_exception_countData Quality Exception Count
  • excluded_row_countExcluded Row Count
  • candidatesCandidates
  • failed_delivery_cmnsFailed Delivery Cmns
  • retryableRetryable
  • manual_review_requiredManual Review Required
  • report_job_idReport Job Id
  • report_job_resume_stateReport Job Resume State
  • errorError

Output schema completeness: best_effort_declared

Safety

External effect
read
Confirmation recommended
No
Retry safe
Yes
Dry run supported
No

Schemas

These schemas are first-pass authoring guidance. Runtime validation remains authoritative.

Input schema
{
  "type": "object",
  "required": [
    "branch_name",
    "as_of_date"
  ],
  "properties": {
    "as_of_date": {
      "type": "string",
      "format": "date",
      "description": "Required date in YYYY-MM-DD format.",
      "x-workflow-field-type": "date"
    },
    "branch_name": {
      "type": "string",
      "description": "Required text value.",
      "x-workflow-field-type": "text"
    },
    "window_days": {
      "type": "number",
      "default": 60,
      "description": "Optional numeric value.",
      "x-workflow-field-type": "number"
    },
    "maximum_candidates": {
      "type": "number",
      "default": 500,
      "description": "Optional numeric value.",
      "x-workflow-field-type": "number"
    },
    "exclude_faxed_this_cycle": {
      "type": "boolean",
      "default": true,
      "description": "Optional true-or-false value.",
      "x-workflow-field-type": "boolean"
    }
  },
  "additionalProperties": false
}
Output schema
{
  "type": "object",
  "properties": {
    "error": {},
    "success": {},
    "report_id": {},
    "retryable": {},
    "as_of_date": {},
    "candidates": {},
    "window_days": {},
    "expired_count": {},
    "report_job_id": {},
    "candidate_count": {},
    "window_end_date": {},
    "export_row_count": {},
    "scoped_row_count": {},
    "fax_history_count": {},
    "placeholder_count": {},
    "excluded_row_count": {},
    "beyond_window_count": {},
    "failed_delivery_cmns": {},
    "branch_mismatch_count": {},
    "duplicate_cycle_count": {},
    "failed_delivery_count": {},
    "inactive_status_count": {},
    "distinct_patient_count": {},
    "faxed_this_cycle_count": {},
    "invalid_identity_count": {},
    "manual_review_required": {},
    "distinct_provider_count": {},
    "multi_cmn_patient_count": {},
    "report_job_resume_state": {},
    "zero_to_seven_day_count": {},
    "maximum_cmns_per_patient": {},
    "missing_expiration_count": {},
    "eight_to_thirty_day_count": {},
    "thirty_one_plus_day_count": {},
    "malformed_expiration_count": {},
    "data_quality_exception_count": {},
    "missing_ordering_doctor_count": {},
    "report_missing_provider_fax_count": {}
  },
  "additionalProperties": true
}
View all Brightree actions