LinkWatch
  • Documentation
    • Authorization
    • UserAccount
    • HealthProfessional
    • Patient
    • TypeIdentifier
    • Observation
    • Measurement
    • Questionnaire
    • GenericResponse
  • API
  • Postman

Observation description

An observation corresponds to all measurement taken with one single device. E.g. blood pressure device measures systolic, diastolic and pulse rate, while a blood glucose device only measure the glucose level. Parameters marked with optional in the API documentation, can be ignored and left out from the queries.

POST

Mehtods call to post observation in to the LinkWatch API.

ObservationCollection

Post a single or a collection of observations. Observation

Example

Post of a blood pressure observation.

POST: {baseurl}/api/v1/observation

Request
Body
[
 {
 "Typeid": 528391,
 "Timestamp": "2017-05-03T12:00:00.000+02:00",
 "Inputtype": "TEST",
 "Equipmentid": "5C313EFFFE020E12",
 "Measurements": [
  {
   "TypeId": 150021,
   "Value": "125",
   "UnitCode": 266016
  },
  {
   "TypeId": 150022,
   "Value": "80",
   "UnitCode": 266016
  },
  {
   "TypeId": 149546,
   "Value": "65",
   "UnitCode": 264864
  }
 ],
 "Comment": null,
 "Contexts": null
 }
]
Headers

Accept: application/json
Content-Type: application/json
Token: 09FDA49F-1D96-4A8E-9F99-FD7A4DED103C

Response
Body
[
 {
  "Result": "AA",
  "Message": ""
 }
]
Headers

Content-Type: application/json

CommunicatePCDData

Post a HL7 formated ORUR01 message as an observation, following IHE-PCD01 standard. CommunicatePCDData

Example

Post of an HL7 formated ORUR01 message for a blood pressure observavtion.

POST: {baseurl}/api/v1/observation/CommunicatePCDData

Request
Body
MSH|^~\&|LinkWatchAndroid||||20170503120000+0200||ORU^R01^ORU_R01|323031363131323330373031333638393930313030|P|2.6|||NE|AL|||||IHE PCD ORU-R012006^HL7^2.16.840.1.113883.9.n.m^HL7
OBR|1|||182777000^monitoring of patient^SNOMED-CT|||20170503120000+0200
OBX|1||528391^MDC_DEV_SPEC_PROFILE_BP^MDC|1|||||||X|||||||5C313EFFFE020E12^EUI64
OBX|2|NM|150021^MDC_PRESS_BLD_NONINV_SYS^MDC|1.0.1.1|125|266016^MDC_DIM_MMHG^MDC|||||R|||20170503120000+0200
OBX|3|NM|150022^MDC_PRESS_BLD_NONINV_DIA^MDC|1.0.1.2|80|266016^MDC_DIM_MMHG^MDC|||||R|||20170503120000+0200
OBX|4|NM|149546^MDC_PULS_RATE_NON_INV^MDC|1.0.0.2|66|264864^MDC_DIM_BEAT_PER_MIN^MDC|||||R|||20170503120000+0200
Headers

Accept: text/plain
Content-Type: text/plain

Response
Body
MSH|^~\&|LinKWatch backend||||20170503120001+0200||ACK^R01^ACK_R01||P|2.6|||NE|AL|||||IHE PCD ORU-R012006^HL7^2.16.840.1.113883.9.n.m^HL7
MSA|AA|323031363131323330373031333638393930313030"
Headers

Content-Type: text/plain

GET

Mehtods call to get observations in to the LinkWatch API.

Between

Return a collection of observations between two timestamps. Between

Example

Retrieve observations of blood pressure ove between two timestamps.

GET: {baseurl}/api/v1/observation/value/528391/between?StartTime=2017-05-03&EndTime=2017-05-03&Order=desc&Offset=true

Request
Headers

Accept: application/json
Token: 09FDA49F-1D96-4A8E-9F99-FD7A4DED103C

Response
Body
[
 {
 "Typeid": 528391,
 "Timestamp": "2017-05-03T12:00:00.000+02:00",
 "Inputtype": "TEST",
 "Equipmentid": "5C313EFFFE020E12",
 "Measurements": [
  {
   "TypeId": 150021,
   "Value": "125",
   "UnitCode": 266016
  },
  {
   "TypeId": 150022,
   "Value": "80",
   "UnitCode": 266016
  },
  {
   "TypeId": 149546,
   "Value": "65",
   "UnitCode": 264864
  }
 ],
 "Comment": null,
 "Contexts": null
 }
]
Headers

Content-Type: application/json

Period

Returns a collection of observations based on a period (transforms to start/end time). Operation can be used to aggregate the observation over a defined group, (e.g. average grouped by days). Period

Example

Retrieve an aggregated average for blood pressure with the period of one day and grouped per day.

GET: {baseurl}/api/v1/observation/avg/528391/period?Value=1&Type=Day&GroupedBy=Day

Request
Headers

Accept: application/json
Token: 09FDA49F-1D96-4A8E-9F99-FD7A4DED103C

Response
Body
[
 {
  "GroupedBy": {
  "Year": 2017,
  "Value": 3,
  "ValueType": "Day",
  "NumberOfObservations": 1,
  "StartDate": "2017-05-03T00:00:00",
  "EndDate": "2017-05-03T11:00:59"
 },
 {
  "Observation":
  {
   "Typeid": 528391,
   "Timestamp": "2017-05-03T10:00:00Z",
    "Inputtype": null,
   "Equipmentid": null,
   "Measurements": [
    {
     "TypeId": 150021,
     "Value": "125",
      "UnitCode": 266016
    },
    {
     "TypeId": 150022,
     "Value": "80",
     "UnitCode": 266016
    },
    {
     "TypeId": 149546,
     "Value": "65",
     "UnitCode": 264864
    }
   ],
  "Comment": null,
  "Contexts": null
  }
 }
]
Headers

Content-Type: application/json

Overview

Returns the latest observation for each device type. Overview


© 2025 - LinkWatch API