Skip to content

Observation Data Type

Samantha Chan edited this page Nov 17, 2017 · 4 revisions

One of the goals of the the Streams Healthcare Analytics Platform is to define a set of common data types so that regardless of which device is sending the observations, the data will be represented in a standard manner for downstream applications to analyze.

The following is the schema of the common Observation data type that all ingest services should use when publishing data.

Name Type Description
patientId string The patient ID
     
Device    
  id string The ID of the device that sent the observation
  locationId string A location ID that indicates where the device is physically located
     
ReadingSource
  id string An ID indicating the source on the device that sent the observation (i.e. channel #)
  sourceType string A descriptive name of the type of source on the device that sent the observation (i.e. "channel")
  deviceId string The ID of the device that sent the observation (for reference purposes)
     
Reading    
  ts long The timestamp of the reading
  readingType   The type of the reading (i.e. HR, ECG Lead I, temperature, etc)
    system string The name of the coding system being used (default: streams/1.0)
    code string The code representing the type of the reading (i.e. HR, ECG Lead I, etc)
  value float The value of the reading. Populated if the value can be represented as a float.
  valueStr string The value of the reading as string
  uom rstring The unit of measure for the reading

JSON Format

{
  "patientId" : string,
  "device" : {
    "id" : string,
    "locationId" : string
  },
  "readingSource" : {
    "id" : string,
    "sourceType" : string,
    "deviceId" : string
  },
  "reading" : {
    "ts" : numeric,
    "readingType" : {
      "system" : string,
      "code" : string
    },
    "value" : numeric,
    "valueStr": string,
    "uom" : string
  }
}