Dataset: Oxygen Saturation Log

Dataset name: ds_oxygen_saturation_log

Description

Oxygen Saturation Log Data

Fields in this dataset

Name	Field Name	Description	Field Type	Field Example
ID	id	The machine name for a record. Internal to PDS and Mydex	int	1
Measurement Group	measurement_group	The top level group activity belongs to	varchar	Activity
Measurement Log ID	measurement_id	The key that links to Measurement Log	int	1
Oxygen saturation	oxygen_saturation	The blood oxygen saturation reading as a percentage	floating point	95%
Oxygen saturation measurement method	oxygen_saturation_measurement_method	How oxygen saturation is measured.	int	1
Oxygen saturation measurement method Description	oxygen_saturation_measurement_method_description	Description of how oxygen saturation is measured.	varchar	Pulse oximetry
Measurement End timestamp	oxygen_saturation_measurement_timestamp_end	Oxygen Saturation measurement date and time	int	1648633780
Measurement Start timestamp	oxygen_saturation_measurement_timestamp_start	Oxygen Saturation measurement date and time	int	1648633780
Oxygen saturation system	oxygen_saturation_system	Where oxygen saturation is measured	int	1
Oxygen saturation system description	oxygen_saturation_system_description	Description of where oxygen saturation is measured	varchar	Peripheral capillaries
Oxygen therapy administration mode	oxygen_therapy_administration_mode	How oxygen therapy is administered	int	1
Oxygen therapy administration mode description	oxygen_therapy_administration_mode_description	Description of How oxygen therapy is administered	varchar	Nasal Canula
Created Timestamp	record_created_timestamp	Date record added to PDS	int	1648633780
Updated Timestamp	record_updated_timestamp	Date record updated in the PDS	int	1648633780
Source Device Type	source_device_type	States the type of source device	varchar	PDA
Source ID	source_id	The unique ID of source of the data	varchar	3621-29756
Source Instance	source_instance	The instance of the source type	int	Google Account 1
Source Name	source_name	The Name given to source	varchar	Google Fit
Supplemental oxygen flow rate	supplemental_oxygen_flow_rate	The rate additional oxygen is supplied to a user in liters per minute. Set to zero if no supplemental	floating point	0

---

Making an API request for this Dataset

Example Request to the Sandbox Server

http://sbx-api.mydex.org/api/pds/transaction/UID.json
  ?key=KEY
  &api_key=API_KEY
  &con_id=CON_ID
  &source_type=connection
  &dataset=ds_oxygen_saturation_log
  &instance=N

Replace the following with your own details: UID KEY, API_KEY, CON_ID and instance N.

Replace sbx-api with api when making a connection to a real member on the production server (must be authenticated).

To return the data in XML, change UID.json to UID.xml.

Example Response

A response to this API request will be structured as follows.

{
  "1": {
    "id": "1",
    "ds_id": "1",
    "measurement_group": "Activity",
    "measurement_id": "1",
    "oxygen_saturation": "95%",
    "oxygen_saturation_measurement_method": "1",
    "oxygen_saturation_measurement_method_description": "Pulse oximetry",
    "oxygen_saturation_measurement_timestamp_end": "1648633780",
    "oxygen_saturation_measurement_timestamp_start": "1648633780",
    "oxygen_saturation_system": "1",
    "oxygen_saturation_system_description": "Peripheral capillaries",
    "oxygen_therapy_administration_mode": "1",
    "oxygen_therapy_administration_mode_description": "Nasal Canula",
    "record_created_timestamp": "1648633780",
    "record_updated_timestamp": "1648633780",
    "source_device_type": "PDA",
    "source_id": "3621-29756",
    "source_instance": "Google Account 1",
    "source_name": "Google Fit",
    "supplemental_oxygen_flow_rate": "0"
  }
}