Skip to documentation
ResMed AirView integration

Get Best Compliance Report

Perform Get Best Compliance Report through ResMed AirView.

View as Markdown
resmed_airview_best_compliance_report
readresmed_airview

Use in a workflow

Copy the discovered node config and fill its params from the input contract. Validate the complete graph before publishing. Integration results use {{node_id.default.field}}. Check business success before dependent writes; completion alone does not prove success.

{
  "_group": "ResMed AirView",
  "params": {
    "period_days": 30,
    "lookback_days": 88,
    "skip_if_empty": false
  },
  "handler": "resmed_airview_best_compliance_report"
}

Action contracts and connections · Run recovery

Inputs

  • airview_patient_id
    expressionrequired
    Airview Patient Id

    Required literal value or workflow expression.

  • lookback_end_date
    expression
    Lookback End Date

    Optional literal value or workflow expression.

  • lookback_days
    number
    Lookback Days

    Optional numeric value.

    Default: 88

  • period_days
    number
    Period Days

    Optional numeric value.

    Default: 30

  • skip_if_empty
    boolean
    Skip If Empty

    Optional true-or-false value.

    Default: false

Outputs

  • successSuccess
  • skippedSkipped
  • failure_categoryFailure Category
  • document_idDocument Id
  • requested_period_beginRequested Period Begin
  • requested_period_endRequested Period End
  • requested_period_daysRequested Period Days
  • report_start_dateReport Start Date
  • report_end_dateReport End Date
  • days_in_periodDays In Period
  • days_usedDays Used
  • days_used_percentDays Used Percent
  • usage_threshold_hoursUsage Threshold Hours
  • days_at_or_above_thresholdDays At Or Above Threshold
  • days_at_or_above_threshold_percentDays At Or Above Threshold Percent
  • days_below_thresholdDays Below Threshold
  • days_below_threshold_percentDays Below Threshold Percent
  • average_usage_all_days_minutesAverage Usage All Days Minutes
  • average_usage_days_used_minutesAverage Usage Days Used Minutes
  • ai_events_per_hourAi Events Per Hour
  • hi_events_per_hourHi Events Per Hour
  • ahi_events_per_hourAhi Events Per Hour
  • total_usage_minutesTotal Usage Minutes
  • median_usage_days_used_minutesMedian Usage Days Used Minutes
  • compliance_payorCompliance Payor
  • device_nameDevice Name
  • therapy_modeTherapy Mode
  • min_pressure_cmh2oMin Pressure Cmh2O
  • max_pressure_cmh2oMax Pressure Cmh2O
  • eprEpr
  • epr_levelEpr Level
  • responseResponse
  • pressure_median_cmh2oPressure Median Cmh2O
  • pressure_95th_percentile_cmh2oPressure 95Th Percentile Cmh2O
  • pressure_maximum_cmh2oPressure Maximum Cmh2O
  • leak_median_l_per_minLeak Median L Per Min
  • leak_95th_percentile_l_per_minLeak 95Th Percentile L Per Min
  • leak_maximum_l_per_minLeak Maximum L Per Min
  • central_apnea_indexCentral Apnea Index
  • obstructive_apnea_indexObstructive Apnea Index
  • unknown_apnea_indexUnknown Apnea Index
  • rera_indexRera Index
  • cheyne_stokes_minutes_per_nightCheyne Stokes Minutes Per Night
  • cheyne_stokes_percentCheyne Stokes Percent
  • windows_checkedWindows Checked
  • windows_readWindows Read
  • retryableRetryable
  • 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": [
    "airview_patient_id"
  ],
  "properties": {
    "period_days": {
      "type": "number",
      "default": 30,
      "description": "Optional numeric value.",
      "x-workflow-field-type": "number"
    },
    "lookback_days": {
      "type": "number",
      "default": 88,
      "description": "Optional numeric value.",
      "x-workflow-field-type": "number"
    },
    "skip_if_empty": {
      "type": "boolean",
      "default": false,
      "description": "Optional true-or-false value.",
      "x-workflow-field-type": "boolean"
    },
    "lookback_end_date": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "airview_patient_id": {
      "description": "Required literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    }
  },
  "additionalProperties": false
}
Output schema
{
  "type": "object",
  "properties": {
    "epr": {},
    "error": {},
    "skipped": {},
    "success": {},
    "response": {},
    "days_used": {},
    "epr_level": {},
    "retryable": {},
    "rera_index": {},
    "device_name": {},
    "document_id": {},
    "therapy_mode": {},
    "windows_read": {},
    "days_in_period": {},
    "report_end_date": {},
    "windows_checked": {},
    "compliance_payor": {},
    "failure_category": {},
    "days_used_percent": {},
    "report_start_date": {},
    "ai_events_per_hour": {},
    "hi_events_per_hour": {},
    "max_pressure_cmh2o": {},
    "min_pressure_cmh2o": {},
    "ahi_events_per_hour": {},
    "central_apnea_index": {},
    "total_usage_minutes": {},
    "unknown_apnea_index": {},
    "days_below_threshold": {},
    "requested_period_end": {},
    "cheyne_stokes_percent": {},
    "leak_median_l_per_min": {},
    "pressure_median_cmh2o": {},
    "requested_period_days": {},
    "usage_threshold_hours": {},
    "leak_maximum_l_per_min": {},
    "pressure_maximum_cmh2o": {},
    "requested_period_begin": {},
    "obstructive_apnea_index": {},
    "days_at_or_above_threshold": {},
    "days_below_threshold_percent": {},
    "average_usage_all_days_minutes": {},
    "leak_95th_percentile_l_per_min": {},
    "median_usage_days_used_minutes": {},
    "pressure_95th_percentile_cmh2o": {},
    "average_usage_days_used_minutes": {},
    "cheyne_stokes_minutes_per_night": {},
    "days_at_or_above_threshold_percent": {}
  },
  "additionalProperties": true
}
View all ResMed AirView actions