Kligo
Search…
💫
WebSocket
Retrieving Observations from Kligo synchronously using a WebSocket client.
Server
ws://localhost:63336/Channel
There is only one channel you can subscribe to:
v3/ObservationThe Channel
v3/Observation provides Observation resources as defined in the FHIR STU3 release in real time.Here are two examples of payload you can retrieve from this channel.
Simple
Composed
Untitled
1
2
{
3
"category": [
4
{
5
"coding": [
6
{
7
"code": "vital-signs",
8
"display": "Vital Signs",
9
"system": "http://hl7.org/fhir/observation-category"
10
}
11
],
12
"text": "Vital Signs"
13
}
14
],
15
"code": {
16
"coding": [
17
{
18
"code": "8310-5",
19
"display": "body_temperature",
20
"system": "http://loinc.org"
21
}
22
],
23
"text": "Température"
24
},
25
"context": {
26
"reference": "863b08e6-601e-48ce-b71c-728421e16b95"
27
},
28
"device": {
29
"display": "thermometer",
30
"reference": "5d1a2fefa37f4d0017966643"
31
},
32
"effectiveDateTime": "2019-12-10T14:08:48.645Z",
33
"resourceType": "observation",
34
"status": "final",
35
"valueQuantity": {
36
"code": "C",
37
"system": "http://unitsofmeasure.org",
38
"unit": "C",
39
"value": 41.6
40
}
41
}
Copied!
1
{
2
"category": [
3
{
4
"coding": [
5
{
6
"code": "vital-signs",
7
"display": "Vital Signs",
8
"system": "http://hl7.org/fhir/observation-category"
9
}
10
],
11
"text": "Vital Signs"
12
}
13
],
14
"code": {
15
"coding": [
16
{
17
"code": "blood_pressure",
18
"display": "blood_pressure",
19
"system": "http://loinc.org"
20
}
21
],
22
"text": "blood_pressure"
23
},
24
"component": [
25
{
26
"code": {
27
"coding": [
28
{
29
"code": "8480-6",
30
"display": "systolic_blood_pressure",
31
"system": "http://loinc.org"
32
}
33
]
34
},
35
"valueQuantity": {
36
"system": "http://unitsofmeasure.org",
37
"unit": "mmHg",
38
"value": 141
39
}
40
},
41
{
42
"code": {
43
"coding": [
44
{
45
"code": "8462-4",
46
"display": "diastolic_blood_pressure",
47
"system": "http://loinc.org"
48
}
49
]
50
},
51
"valueQuantity": {
52
"system": "http://unitsofmeasure.org",
53
"unit": "mmHg",
54
"value": 83
55
}
56
},
57
{
58
"code": {
59
"coding": [
60
{
61
"code": "8867-4",
62
"display": "heart_rate",
63
"system": "http://loinc.org"
64
}
65
]
66
},
67
"valueQuantity": {
68
"system": "http://unitsofmeasure.org",
69
"unit": "bpm",
70
"value": 75
71
}
72
}
73
],
74
"context": {
75
"reference": "08281fa8-d8f2-4cac-b46b-d9cd951058e9"
76
},
77
"device": {
78
"display": "blood_pressure_monitor",
79
"reference": "5c98c120184d54001718d5ce"
80
},
81
"effectiveDateTime": "2019-12-10T17:24:04.227Z",
82
"resourceType": "Observation",
83
"status": "final"
84
}
Copied!
1
Copied!
Depending on the device you are using the observation can look a bit different:
- simple: When you use a simple device like a weight scale or a thermometer for instance, you will get only one simple measurement attached to the observation (e.g. weight for the scale or temperature for the thermometer). Therefore you can directly access the measurement in the
valueQuantityproperty. - composed: When you use a pulse oximeter or a blood pressure monitor for instance, you will get two or three different kinds of measurements (e.g. heart rate and spO2 for the pulse oximeter or systolic, diastolic blood pressure for the blood pressure monitor). Therefore the measurements are gathered in the
componentproperty.
For more details on how to retrieve information from the payload please refer to the schema section.
Schema
1
{
2
"resourceType" : "Observation",
3
// from Resource: id, meta, implicitRules, and language
4
// from DomainResource: text, contained, extension, and modifierExtension
5
"identifier" : [{ Identifier }], // Business Identifier for observation
6
"basedOn" : [{ Reference(CarePlan|DeviceRequest|ImmunizationRecommendation|
7
MedicationRequest|NutritionOrder|ProcedureRequest|ReferralRequest) }], // Fulfills plan, proposal or order
8
"status" : "<code>", // R! registered | preliminary | final | amended +
9
"category" : [{ CodeableConcept }], // Classification of type of observation
10
"code" : { CodeableConcept }, // R! Type of observation (code / type)
11
"subject" : { Reference(Patient|Group|Device|Location) }, // Who and/or what this is about
12
"context" : { Reference(Encounter|EpisodeOfCare) }, // Healthcare event during which this observation is made
13
// effective[x]: Clinically relevant time/time-period for observation. One of these 2:
14
"effectiveDateTime" : "<dateTime>",
15
"effectivePeriod" : { Period },
16
"issued" : "<instant>", // Date/Time this was made available
17
"performer" : [{ Reference(Practitioner|Organization|Patient|RelatedPerson) }], // Who is responsible for the observation
18
// value[x]: Actual result. One of these 11:
19
"valueQuantity" : { Quantity },
20
"valueCodeableConcept" : { CodeableConcept },
21
"valueString" : "<string>",
22
"valueBoolean" : <boolean>,
23
"valueRange" : { Range },
24
"valueRatio" : { Ratio },
25
"valueSampledData" : { SampledData },
26
"valueAttachment" : { Attachment },
27
"valueTime" : "<time>",
28
"valueDateTime" : "<dateTime>",
29
"valuePeriod" : { Period },
30
"dataAbsentReason" : { CodeableConcept }, // C? Why the result is missing
31
"interpretation" : { CodeableConcept }, // High, low, normal, etc.
32
"comment" : "<string>", // Comments about result
33
"bodySite" : { CodeableConcept }, // Observed body part
34
"method" : { CodeableConcept }, // How it was done
35
"specimen" : { Reference(Specimen) }, // Specimen used for this observation
36
"device" : { Reference(Device|DeviceMetric) }, // (Measurement) Device
37
"referenceRange" : [{ // Provides guide for interpretation
38
"low" : { Quantity(SimpleQuantity) }, // C? Low Range, if relevant
39
"high" : { Quantity(SimpleQuantity) }, // C? High Range, if relevant
40
"type" : { CodeableConcept }, // Reference range qualifier
41
"appliesTo" : [{ CodeableConcept }], // Reference range population
42
"age" : { Range }, // Applicable age range, if relevant
43
"text" : "<string>" // Text based reference range in an observation
44
}],
45
"related" : [{ // Resource related to this observation
46
"type" : "<code>", // has-member | derived-from | sequel-to | replaces | qualified-by | interfered-by
47
"target" : { Reference(Observation|QuestionnaireResponse|Sequence) } // R! Resource that is related to this one
48
}],
49
"component" : [{ // Component results
50
"code" : { CodeableConcept }, // R! Type of component observation (code / type)
51
// value[x]: Actual component result. One of these 10:
52
"valueQuantity" : { Quantity },
53
"valueCodeableConcept" : { CodeableConcept },
54
"valueString" : "<string>",
55
"valueRange" : { Range },
56
"valueRatio" : { Ratio },
57
"valueSampledData" : { SampledData },
58
"valueAttachment" : { Attachment },
59
"valueTime" : "<time>",
60
"valueDateTime" : "<dateTime>",
61
"valuePeriod" : { Period },
62
"dataAbsentReason" : { CodeableConcept }, // C? Why the component result is missing
63
"interpretation" : { CodeableConcept }, // High, low, normal, etc.
64
"referenceRange" : [{ Content as for Observation.referenceRange }] // Provides guide for interpretation of component result
65
}]
66
}
Copied!
Here are some of the noticeable properties:
property
description
valueQuantity
valueQuantity.system
defines the system defining the previous code
valueQuantity.unit
defines the unit in which the quantity is expressed
i.e. C for a body temperature
valueQuantity.value
defines the actual value of the quantity
i.e. 37 for a body temperature
device
device.reference
defines the id of the device used to take the measurement
i.e. 5d1a2fefa37f4d0017966643
device.display
defines the type of device used to take the measurement
i.e. thermometer
effectiveDateTime
represents the time at which the measurement was taken
i.e. 2019-12-10T14:08:48.645Z
code
code.coding
describes what the measure is and how we can reference it in a specific system.
code.coding.code
describes the code used to define the measurement
i.e. 8310-5
code.coding.system
defines the system related to the code
i.e. http://loinc.org
code.coding.display
a human readable version of the code
Receiving events from Kligo
Here is an example for listening to Observation using a simple web socket javascript client:
JavaScript
1
const ws = new WebSocket("ws://localhost:63336/v3/Observation");
2
3
ws.onopen = function open() {
4
console.log("opened");
5
setConnected(true);
6
};
7
ws.onclose = function close() {
8
console.log("closed");
9
setConnected(false);
10
};
11
12
ws.onmessage = function data(event) {
13
const observation = JSON.parse(event.data);
14
console.log(observation);
15
};
Copied!
Last modified 8mo ago
Copy link