Exchange data per therapy session
Therapy data is sent after each therapy session. One ORU message is generated for each session. Each OBX segment reflects the metric recorded for that session. No normalization or averaging is applied.
The response payload includes:
OBX-5—the raw session-level value.
OBX-11—code
F(Finalized).
Downstream systems may aggregate session-level data into reporting intervals.
Therapy data ORUs
For therapy data results, the following additional HL7 segments are expected:
Segment | Expected value/contents |
|---|---|
OBR-25 | Result status ("Resulted") |
OBR-2 or OBR-3 | Order ID |
PV1-19 or PV1-51 | Visit number |
NTE segment(s) | User messages |
Observation/Result (OBX) fields
The discrete data is sent across in HL7 OBX segments. Each OBX segment has the below components populated:
OBX field | Description | Comments |
|---|---|---|
OBX-1 | Set ID | |
OBX-2 | Value type | "NM" or "ST", based on the observation value |
OBX-3.1 | Identifier | Discrete data identifier |
OBX-3.2 | Text | Discrete data description |
OBX-5 | Observation value | |
OBX-11 | Observation result status | "F"- Finalized |
Therapy data fields
The following therapy data fields are available:
OBX data type (OBX-2) | OBX component (OBX-3.1) | OBX description (OBX-3.2) |
|---|---|---|
ST | receiptTime | System time of data receipt to AirView. |
ST | sessionDate | Date the data was collected. |
ST | deviceID_mode | Therapy mode setting of the device on the session date. |
ST | deviceID_device_serialNo | Serial number of the device used by the patient on the session date. |
ST | deviceID_device_deviceType | Type of device used by the patient on the session date. |
ST | deviceID_device_deviceTypeDesc | Description of the type of device used by the patient on the session date. |
ST | usage_duration | Total usage in minutes of the device on the session date. |
ST | usage_maskOn | Represents the number of times a user put their mask on. |
ST | usage_maskOff | Represents the number of times a user took their mask off. |
ST | usage_programNumber | The program this data applies to. |
ST | usage_programUsage | Total usage of the program in minutes. |
ST | set_press | The set pressure in cmH2O. |
ST | set_startPress | The start pressure in cmH2O. |
ST | set_maxPress | The maximum allowable pressure in cmH2O. |
ST | set_minPress | The minimum allowable pressure in cmH2O. |
ST | set_EPRType | Expiratory Pressure Relief (EPR) type. |
ST | set_EPRLevel | EPR Level (EPRType must not be |
ST | set_ODIThreshold | Desaturation Rule Threshold setting. |
ST | set_iBREnable | Intelligent Backup Rate enabled setting. |
ST | set_tgtPatientRate | Target Respiratory Rate/Target Patient Rate setting in breaths per minute. |
ST | set_EPAPAutoEnable | Auto Expiratory Positive Airway Pressure (EPAP) enabled setting. |
ST | set_IPAP | Inspiratory Positive Airway Pressure (IPAP) setting in cmH2O. |
ST | set_maxIPAP | Maximum IPAP setting in cmH2O. |
ST | set_EPAP | EPAP setting in cmH2O. |
ST | set_startEPAP | Start EPAP pressure setting in cmH2O. |
ST | set_autosetResponse | AutoSet Response setting. This can be: |
ST | set_minEPAP | Minimum EPAP setting in cmH2O. |
ST | set_maxEPAP | Maximum EPAP setting in cmH2O. |
ST | set_minPS | Minimum Pressure Support (PS) setting in cmH2O. |
ST | set_maxPS | Maximum Pressure Support/P Control Max setting in cmH2O. |
ST | set_easyBreathe | The Easy Breathe setting can be either |
ST | set_circuit | Breathing Circuit Type setting. This can be: |
ST | set_interface | Patient Interface Type setting. This can be: |
ST | set_mask | Mask Type setting on the device. This can be: |
ST | set_pressureAssist | Pressure Assist setting in cmH2O. Note: This is also known as Pressure Control or P Control. |
ST | set_safetyTidalVolume | Safety Tidal Volume setting in mL. |
ST | set_apneaVent_tidalVolume | The Tidal Volume setting in mL for apnea ventilation. |
ST | set_tidalVolume | Tidal Volume setting in mL. |
ST | set_ti | Inspiratory time (Ti) setting in seconds. |
ST | set_apneaVent_ti | The Ti setting in seconds for apnea ventilation. |
ST | set_tiMin | The Ti minimum setting in seconds. |
ST | set_tiMax | The Ti maximum setting in seconds. |
ST | set_riseTime | Rise Time setting in milliseconds. |
ST | set_triggerSensitivity | Trigger Sensitivity setting. This can be: |
ST | set_cycleSensitivity | Cycle Sensitivity setting. This can be: |
ST | set_respRate | Respiratory Rate/Backup Rate in breaths per minute. |
ST | set_apneaVent_respRate | The Respiratory Rate setting in breaths per minute for apnea ventilation. |
ST | set_tgtAlveolarVent | Target Alveolar Ventilation settings in liters per minute. |
ST | set_triggerThreshold | Trigger Threshold setting in liters per minute. |
ST | set_triggerType | Trigger Type setting. This can be: |
ST | set_cycleThreshold | Cycle Threshold setting in percent. |
ST | set_patientType | Patient Type setting. This can be: |
ST | set_heightCm | Height setting in centimeters. |
ST | set_pressSupport | Pressure Support setting in cmH2O. |
ST | set_volumeBreathOptions | Volume Breath Options setting. This can be: |
ST | set_flowShape | Flow Shape setting. This can be: |
ST | set_manualBreath | Manual Breath enable setting. |
ST | set_manualMagnitude | Magnitude setting in percent. Note: Manual Breath must be enabled. |
ST | set_peakFlow | Peak Flow setting in liters per minute. Note: PIF must be selected as the Volume Breath option. |
ST | set_sigh_enable | The sigh enable setting. |
ST | set_sigh_alert | The sigh alert setting. Note: The sigh enable setting must be on. |
ST | set_sigh_interval | The sigh interval setting in minutes. Note: The sigh enable setting must be on. |
ST | alarmSettings_apnea_interval | The Interval/T Apnea setting in seconds for apnea alarms. |
ST | set_sigh_magnitude | The sigh magnitude setting in percent. Note: This sigh enable setting must be on. |
ST | set_apneaVent_peakInspFlow | PIF setting in liters per minute for apnea ventilation. |
ST | set_apneaVent_pressureControl | The Pressure Control/P Control setting in cmH2O for apnea ventilation. |
ST | alarmSettings_apnea_breathType | The Breath Type/Detection setting for apnea alarms. |
ST | alarmSettings_apnea_response | The Response setting for apnea alarms. |
ST | clinicalMetrics_tgtlPAP_5 | 5% of target IPAP in cmH2O. |
ST | clinicalMetrics_tgtlPAP_95 | 95% of target IPAP in cmH2O. |
ST | clinicalMetrics_tgtlPAP_50 | Median target IPAP in cmH2O. |
ST | clinicalMetrics_tgtlPAP_max | Maximum target IPAP in cmH2O. |
ST | clinicalMetrics_tgtEPAP_5 | 5% of target EPAP in cmH2O. |
ST | clinicalMetrics_tgtEPAP_95 | 95% of target EPAP in cmH2O. |
ST | clinicalMetrics_tgtEPAP_50 | Median target EPAP in cmH2O. |
ST | clinicalMetrics_tgtEPAP_max | Maximum target EPAP in cmH2O. |
ST | clinicalMetrics_leak_5 | 5% of leak in liters per second. |
ST | clinicalMetrics_leak_95 | 95% of leak in liters per second. |
ST | clinicalMetrics_leak_50 | Median leak in liters per second. |
ST | clinicalMetrics_leak_max | Maximum leak in liters per second. |
ST | clinicalMetrics_leakpermin_5 | 5% of leak in liters per minute. |
ST | clinicalMetrics_leakpermin_95 | 95% of leak in liters per minute. |
ST | clinicalMetrics_leakpermin_50 | Median leak in liters per minute. |
ST | clinicalMetrics_leakpermin_max | Maximum leak in liters per minute. |
ST | clinicalMetrics_leakValved_5 | 5% of valved leak in percent. |
ST | clinicalMetrics_leakValved_95 | 95% of valved leak in percent. |
ST | clinicalMetrics_leakValved_50 | Median valved leak in percent. |
ST | clinicalMetrics_respRate_5 | 5% of respiratory rate in breaths per minute. |
ST | clinicalMetrics_respRate_95 | 95% of respiratory rate in breaths per minute. |
ST | clinicalMetrics_respRate_50 | Median respiratory rate in breaths per minute. |
ST | clinicalMetrics_respRate_max | Maximum respiratory rate in breaths per minute. |
ST | clinicalMetrics_ieRatio_5 | 5% of inhalation:exhalation ratio. |
ST | clinicalMetrics_ieRatio_95 | 95% of inhalation:exhalation ratio. |
ST | clinicalMetrics_ieRatio_50 | Median inhalation:exhalation ratio. |
ST | clinicalMetrics_ieRatio_max | Maximum inhalation:exhalation ratio. |
ST | clinicalMetrics_minuteVent_5 | 5% of minute ventilation in liters per minute. |
ST | clinicalMetrics_minuteVent_95 | 95% of minute ventilation in liters per minute. |
ST | clinicalMetrics_minuteVent_50 | Median minute ventilation in liters per minute. |
ST | clinicalMetrics_minuteVent_max | Maximum minute ventilation in liters per minute. |
ST | clinicalMetrics_tidalVol_5 | 5% of tidal volume in liters. |
ST | clinicalMetrics_tidalVol_95 | 95% of tidal volume in liters. |
ST | clinicalMetrics_tidalVol_50 | Median tidal volume in liters. |
ST | clinicalMetrics_tidalVol_max | Maximum tidal volume in liters. |
ST | clinicalMetrics_tidalVolml_5 | 5% of tidal volume in milliliters. |
ST | clinicalMetrics_tidalVolml_95 | 95% of tidal volume in milliliters. |
ST | clinicalMetrics_tidalVolml_50 | Median tidal volume in milliliters. |
ST | clinicalMetrics_tidalVolml_max | Maximum tidal volume in milliliters. |
ST | clinicalMetrics_SPO2_min | Minimum SpO2. |
ST | clinicalMetrics_SPO2_5 | 5% SpO2. |
ST | clinicalMetrics_SPO2_95 | 95% SpO2. |
ST | clinicalMetrics_SPO2_50 | 50% SpO2. |
ST | clinicalMetrics_SPO2_minutesBelow88percent | SpO2 minutes under the 88% threshold. |
ST | clinicalMetrics_SPO2_secondsBelowDynamicThreshold | SpO2 (sec) under dynamic threshold. |
ST | clinicalMetrics_alveolarVentilation_5 | 5% of alveolar ventilation in liters per minute. |
ST | clinicalMetrics_alveolarVentilation_95 | 95% of alveolar ventilation in liters per minute. |
ST | clinicalMetrics_alveolarVentilation_50 | Median alveolar ventilation in liters per minute. |
ST | clinicalMetrics_alveolarVentilation_max | Maximum alveolar ventilation in liters per minute. |
ST | clinicalMetrics_spontTriggBreaths | Percentage of spontaneous triggered breaths. |
ST | clinicalMetrics_SpontCycledBreaths | Percentage of spontaneous cycled breaths. |
ST | respEvents_AHI | Apnea-Hypopnea Index in events per hour. |
ST | respEvents_HI | Hypopnea Index in events per hour. |
ST | respEvents_AI | Apnea Index in events per hour. |
ST | respEvents_OAI | Obstructive Apnea Index in events per hour. |
ST | respEvents_CAI | Central Apnea Index in events per hour. |
ST | respEvents_UAI | Unknown Apnea Index in events per hour. |
ST | respEvents_ODI | Oxygen Desaturation Index. |
ST | respEvents_CSR | Cheyne-Stokes Respiration in minutes. |
ST | respEvents_RERA | Respiratory Effort Related Arousal in events per hour. |
ST | patientInterface_humidifier | Type of humidifier used on this session date. |
ST | patientInterface_heatedTube | Type of heated tube used on this session date. |
ST | patientInterface_ambHumidity | Absolute ambient humidity for the session in milligrams of water per liter. |
MSH|^~\&|SOMNOWARE|SOMNOWARE|HC|HC|20260330131022||ORU^R01|20260330131022|T|2.3 PID|1||16288888322||Sawyer^Tom^||20090325||||^^^^||^^^ruby.gold@somno.com PV1|1||||||^^|||||||||||| ORC|RE||||||||20260330131022 OBR|1||||||20260330131022 OBX|1|ST|receiptTime^System time of data receipt to AirView||2024-03-18T09:26:17 OBX|2|ST|sessionDate^Date the data was collected||2024-03-17 OBX|3|ST|deviceID_mode^Therapy mode setting of the device on the session date||AUTOSET OBX|4|ST|deviceID_device_serialNo^Serial number of the device used by the patient on the session date||23172404800 OBX|5|ST|deviceID_device_deviceType^Type of device used by the patient on the session date||036039 OBX|6|ST|deviceID_device_deviceTypeDesc^Description of the type of device used by the patient on the session date||AirSense 10 AutoSet OBX|7|ST|usage_duration^Total usage in minutes of the device on the session date||392 OBX|8|ST|usage_maskOn^Represents the number of times a user put their mask on||2 OBX|9|ST|usage_maskOff^Represents the number of times a user took their mask off||2 OBX|10|ST|usage_programNumber^The program this data applies to||1 OBX|11|ST|usage_programUsage^Total usage of the program in minutes||392 OBX|12|ST|set_press^The set pressure in cmH2O||10.0 OBX|13|ST|set_startPress^The start pressure in cmH2O||4.0 OBX|14|ST|set_maxPress^The maximum allowable pressure in cmH2O||15.0 OBX|15|ST|set_minPress^The minimum allowable pressure in cmH2O|| OBX|16|ST|set_EPRType^Expiratory Pressure Relief (EPR) type||FULLTIME OBX|17|ST|set_EPRLevel^EPR Level (EPRType must not be OFF)||THREE OBX|18|ST|set_ODIThreshold^Desaturation Rule Threshold setting||3 OBX|19|ST|set_iBREnable^Intelligent Backup Rate enabled setting||true OBX|20|ST|set_tgtPatientRate^Target Respiratory Rate/Target Patient Rate setting in breaths per minute|| OBX|21|ST|set_EPAPAutoEnable^Auto Expiratory Positive Airway Pressure (EPAP) enabled setting||true OBX|22|ST|set_IPAP^Inspiratory Positive Airway Pressure (IPAP) setting in cmH2O||12.0 OBX|23|ST|set_maxIPAP^Maximum IPAP setting in cmH2O||20.0 OBX|24|ST|set_EPAP^EPAP setting in cmH2O||6.0 OBX|25|ST|set_startEPAP^Start EPAP pressure setting in cmH2O||4.0 OBX|26|ST|set_autosetResponse^AutoSet Response setting This can be On (Soft) or Off (Standard)||OFF OBX|27|ST|set_minEPAP^Minimum EPAP setting in cmH2O||4.0 OBX|28|ST|set_maxEPAP^Maximum EPAP setting in cmH2O||10.0 OBX|29|ST|set_minPS^Minimum Pressure Support (PS) setting in cmH2O||3.0 OBX|30|ST|set_maxPS^Maximum Pressure Support/P Control Max setting in cmH2O||10.0 OBX|31|ST|set_easyBreathe^The Easy Breathe setting can be either On or Off||On OBX|32|ST|set_circuit^Breathing Circuit Type setting This can be: SingleValved, DualValved, SingleVented||SingleVented OBX|33|ST|set_interface^Patient Interface Type setting This can be: Invasive, Mask, Mouthpiece||Mask OBX|34|ST|set_mask^Mask Type setting on the device This can be: FullFace, Nasal, NasalUltra, Pillows, Pediatric, InLineVent, Infant||Nasal OBX|35|ST|set_pressureAssist^Pressure Assist setting in cmH2O Note: This is also known as Pressure Control or P Control||5.0 OBX|36|ST|set_safetyTidalVolume^Safety Tidal Volume setting in mL||400 OBX|37|ST|set_apneaVent_tidalVolume^The Tidal Volume setting in mL for apnea ventilation||401 OBX|38|ST|set_tidalVolume^Tidal Volume setting in mL||500 OBX|39|ST|set_ti^Inspiratory time (Ti) setting in seconds||1.2 OBX|40|ST|set_apneaVent_ti^The Ti setting in seconds for apnea ventilation||1.2 OBX|41|ST|set_tiMin^The Ti minimum setting in seconds||0.8 OBX|42|ST|set_tiMax^The Ti maximum setting in seconds||1.5 OBX|43|ST|set_riseTime^Rise Time setting in milliseconds||300 OBX|44|ST|set_triggerSensitivity^Trigger Sensitivity setting This can be: VHi, Hi, Med, Lo, VLo, Off||Med OBX|45|ST|set_cycleSensitivity^Cycle Sensitivity setting This can be: VLo, Lo, Med, Hi, VHi||Med OBX|46|ST|set_respRate^Respiratory Rate/Backup Rate in breaths per minute||14 OBX|47|ST|set_apneaVent_respRate^The Respiratory Rate setting in breaths per minute for apnea ventilation||10 OBX|48|ST|set_tgtAlveolarVent^Target Alveolar Ventilation settings in liters per minute||6.0 OBX|49|ST|set_triggerThreshold^Trigger Threshold setting in liters per minute||2.5 OBX|50|ST|set_triggerType^Trigger Type setting This can be: None (off), Absolute (Flow), Relative (Pressure)||Absolute (Flow) OBX|51|ST|set_cycleThreshold^Cycle Threshold setting in percent||25 OBX|52|ST|set_patientType^Patient Type setting This can be: Adult, Pediatric||Adult OBX|53|ST|set_heightCm^Height setting in centimeters||175 OBX|54|ST|set_pressSupport^Pressure Support setting in cmH2O||6.0 OBX|55|ST|set_volumeBreathOptions^Volume Breath Options setting This can be: TiOption (Ti), PifOption (PIF)||TiOption (Ti) OBX|56|ST|set_flowShape^Flow Shape setting This can be: Constant, Dec75%, Dec50%, Dec25%||Dec50% OBX|57|ST|set_manualBreath^Manual Breath enable setting||true OBX|58|ST|set_manualMagnitude^Magnitude setting in percent Manual Breath must be enabled||50 OBX|59|ST|set_peakFlow^Peak Flow setting in liters per minute PIF must be selected as the Volume Breath option||40 OBX|60|ST|set_sigh_enable^The sigh enable setting||true OBX|61|ST|set_sigh_alert^The sigh alert setting The sigh enable setting must be on||true OBX|62|ST|set_sigh_interval^The sigh interval setting in minutes The sigh enable setting must be on||30 OBX|63|ST|alarmSettings_apnea_interval^The Interval/T Apnea setting in seconds for apnea alarms||1 OBX|64|ST|set_sigh_magnitude^The sigh magnitude setting in percent This sigh enable setting must be on||20 OBX|65|ST|set_apneaVent_peakInspFlow^PIF setting in liters per minute for apnea ventilation||35 OBX|66|ST|set_apneaVent_pressureControl^The Pressure Control/P Control setting in cmH2O for apnea ventilation||8.0 OBX|67|ST|alarmSettings_apnea_breathType^The Breath Type/Detection setting for apnea alarms||NoBreath OBX|68|ST|alarmSettings_apnea_response^The Response setting for apnea alarms||AlarmOnly OBX|69|ST|clinicalMetrics_tgtlPAP_5^5% of target IPAP in cmH2O||8.5 OBX|70|ST|clinicalMetrics_tgtlPAP_95^95% of target IPAP in cmH2O||12.24 OBX|71|ST|clinicalMetrics_tgtlPAP_50^Median target IPAP in cmH2O||9.0 OBX|72|ST|clinicalMetrics_tgtlPAP_max^Maximum target IPAP in cmH2O||13.8 OBX|73|ST|clinicalMetrics_tgtEPAP_5^5% of target EPAP in cmH2O||5.0 OBX|74|ST|clinicalMetrics_tgtEPAP_95^95% of target EPAP in cmH2O||8.5 OBX|75|ST|clinicalMetrics_tgtEPAP_50^Median target EPAP in cmH2O||6.5 OBX|76|ST|clinicalMetrics_tgtEPAP_max^Maximum target EPAP in cmH2O||10.0 OBX|77|ST|clinicalMetrics_leak_5^5% of leak in liters per second||0.05 OBX|78|ST|clinicalMetrics_leak_95^95% of leak in liters per second||0.48 OBX|79|ST|clinicalMetrics_leak_50^Median leak in liters per second||0.16 OBX|80|ST|clinicalMetrics_leak_max^Maximum leak in liters per second||0.78 OBX|81|ST|clinicalMetrics_leakpermin_5^5% of leak in liters per minute||3.0 OBX|82|ST|clinicalMetrics_leakpermin_95^95% of leak in liters per minute||28.8 OBX|83|ST|clinicalMetrics_leakpermin_50^Median leak in liters per minute||9.6 OBX|84|ST|clinicalMetrics_leakpermin_max^Maximum leak in liters per minute||46.8 OBX|85|ST|clinicalMetrics_leakValved_5^5% of valved leak in percent||2 OBX|86|ST|clinicalMetrics_leakValved_95^95% of valved leak in percent||10 OBX|87|ST|clinicalMetrics_leakValved_50^Median valved leak in percent||5 OBX|88|ST|clinicalMetrics_respRate_5^5% of respiratory rate in breaths per minute||10 OBX|89|ST|clinicalMetrics_respRate_95^95% of respiratory rate in breaths per minute||18 OBX|90|ST|clinicalMetrics_respRate_50^Median respiratory rate in breaths per minute||14 OBX|91|ST|clinicalMetrics_respRate_max^Maximum respiratory rate in breaths per minute||22 OBX|92|ST|clinicalMetrics_ieRatio_5^5% of inhalation:exhalation ratio||1.0 OBX|93|ST|clinicalMetrics_ieRatio_95^95% of inhalation:exhalation ratio||2.0 OBX|94|ST|clinicalMetrics_ieRatio_50^Median inhalation:exhalation ratio||1.5 OBX|95|ST|clinicalMetrics_ieRatio_max^Maximum inhalation:exhalation ratio||2.5 OBX|96|ST|clinicalMetrics_minuteVent_5^5% of minute ventilation in liters per minute||4.5 OBX|97|ST|clinicalMetrics_minuteVent_95^95% of minute ventilation in liters per minute||8.2 OBX|98|ST|clinicalMetrics_minuteVent_50^Median minute ventilation in liters per minute||6.0 OBX|99|ST|clinicalMetrics_minuteVent_max^Maximum minute ventilation in liters per minute||10.0 OBX|100|ST|clinicalMetrics_tidalVol_5^5% of tidal volume in liters||0.3 OBX|101|ST|clinicalMetrics_tidalVol_95^95% of tidal volume in liters||0.6 OBX|102|ST|clinicalMetrics_tidalVol_50^Median tidal volume in liters||0.45 OBX|103|ST|clinicalMetrics_tidalVol_max^Maximum tidal volume in liters||0.8 OBX|104|ST|clinicalMetrics_tidalVolml_5^5% of tidal volume in milliliters||300 OBX|105|ST|clinicalMetrics_tidalVolml_95^95% of tidal volume in milliliters||600 OBX|106|ST|clinicalMetrics_tidalVolml_50^Median tidal volume in milliliters||450 OBX|107|ST|clinicalMetrics_tidalVolml_max^Maximum tidal volume in milliliters||800 OBX|108|ST|clinicalMetrics_SPO2_min^Minimum SpO2||88 OBX|109|ST|clinicalMetrics_SPO2_5^5% SpO2||90 OBX|110|ST|clinicalMetrics_SPO2_95^95% SpO2||98 OBX|111|ST|clinicalMetrics_SPO2_50^50% SpO2||95 OBX|112|ST|clinicalMetrics_SPO2_minutesBelow88percent^SpO2 minutes under the 88% threshold||5 OBX|113|ST|clinicalMetrics_SPO2_secondsBelowDynamicThreshold^SpO2 (sec) under dynamic threshold||120 OBX|114|ST|clinicalMetrics_alveolarVentilation_5^5% of alveolar ventilation in liters per minute||3.5 OBX|115|ST|clinicalMetrics_alveolarVentilation_95^95% of alveolar ventilation in liters per minute||7.5 OBX|116|ST|clinicalMetrics_alveolarVentilation_50^Median alveolar ventilation in liters per minute||5.5 OBX|117|ST|clinicalMetrics_alveolarVentilation_max^Maximum alveolar ventilation in liters per minute||9.0 OBX|118|ST|clinicalMetrics_spontTriggBreaths^Percentage of spontaneous triggered breaths||85 OBX|119|ST|clinicalMetrics_SpontCycledBreaths^Percentage of spontaneous cycled breaths||80 OBX|120|ST|respEvents_AHI^Apnea-Hypopnea Index in events per hour||2.1 OBX|121|ST|respEvents_HI^Hypopnea Index in events per hour||0.6 OBX|122|ST|respEvents_AI^Apnea Index in events per hour||1.5 OBX|123|ST|respEvents_OAI^Obstructive Apnea Index in events per hour||1.5 OBX|124|ST|respEvents_CAI^Central Apnea Index in events per hour||0.0 OBX|125|ST|respEvents_UAI^Unknown Apnea Index in events per hour||0.0 OBX|126|ST|respEvents_ODI^Oxygen Desaturation Index||1.8 OBX|127|ST|respEvents_CSR^Cheyne-Stokes Respiration in minutes||0 OBX|128|ST|respEvents_RERA^Respiratory Effort Related Arousal in events per hour||0.0 OBX|129|ST|patientInterface_humidifier^Type of humidifier used on this session date||internal OBX|130|ST|patientInterface_heatedTube^Type of heated tube used on this session date||None OBX|131|ST|patientInterface_ambHumidity^Absolute ambient humidity for the session in milligrams of water per liter||7
Report request ORMs
This order provides the information to get an unsolicited PDF report from AirView for a patient. You can request Compliance and Therapy reports.
For report request orders, the following additional HL7 segments are expected:
Segment | Expected value\Contents | Required |
|---|---|---|
OBX-3 (code) and OBX-5 | The report is delivered in English (en-us) unless a language is specified (see Supported PDF languages). | |
OBX-3 (code) and OBX-5 | If If | Yes |
OBX-3 (code) and OBX-5 | If If | Yes |
OBX-3 (code) and OBX-5 | Must be one of the following two values:
| Yes |
Supported PDF languages
Language value | Language of generated report |
|---|---|
de | German |
en | UK English |
en-us | US English |
es | Spanish |
fr | French |
fr-ca | French Canadian |
ja | Japanese |
pt | Portuguese (Portugal) |
sv | Swedish |
it | Italian |
MSH|^~\&|HCP1|HCP1|Resmed|Resmed|20250313092149||ORM^O01|21020683|T|2.5||||||||| PID|1||257^^^MRN|||||||||||||||||||||||||||||||||||| PV1|1|U|||||||||||||||||||||||||||||||||||||||||||||||||| ORC|NW|21028683|||||||20250313||||||||||||||||||||| OBR|1|21020683||RES104^THERAPY REPORT|3|20250313|||||||||||||||||||||||||||||||||||||||||| OBX|1|DT|startDate^Report Start Date:^RESLQL||2025-11-30||||||F|||||||| OBX|2|DT|endDate^Report End Date:^RESLQL||2025-12-10||||||F|||||||| OBX|3|TX|periodType^Period Type:^RESLQL||USERDEFINED||||||F||||||||