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

Patient description

A resource that handle information about the patient in the LinkWatch API, which is needed to store observation or other data that belongs to a specific patient. The service expose access to update or get information about a patient.

In order to create a patient, this is done with an health professional account.

Update

Update the information for the specific patient Update

Example

POST: {baseurl}/api/v1/patient/update

Request
Body
{
 "UserAccountId": 1,
 "Patient": {
  "PatientId": "1234567",
  "DateOfBirth": "2000-01-01T00:00:00",
  "Gender": "Male",
  "Height": 180
 },
 "Person": {
  "FirstName": "John",
  "LastName": "Doe",
  "Phone": null,
  "MobilePhone": null,
  "Email": "John.Doe@linkwatch.se",
  "Address": 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

Get

Retrieve the information for the specific patient. Get

Example

GET: {baseurl}/api/v1/patient

Request
Headers

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

Response
Body
{
 "UserAccountId": 1,
 "Patient": {
  "PatientId": "1234567",
  "DateOfBirth": "2000-01-01T00:00:00",
  "Gender": "Male",
  "Height": 180
 },
 "Person": {
  "FirstName": "John",
  "LastName": "Doe",
  "Phone": null,
  "MobilePhone": null,
  "Email": "John.Doe@linkwatch.se",
  "Address": null
 }
}
Headers

Content-Type: application/json

Height

Retrieve the height for the specific patient. Height

Example

POST: {baseurl}/api/v1/authentication/logout

Request
Headers

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

Response
Body
180
Headers

Content-Type: application/json

Age

Retrieve the calculated age for the specific patient based on date of birth. Age

Example

POST: {baseurl}/api/v1/authentication/logout

Request
Headers

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

Response
Body
17
Headers

Content-Type: application/json

Device

Sub part of the patient resource. Makes it possible to create, update or get information about a device for a patient. The patient needs to have the manual device flag set to true in order to allow this.

The device information is needed to be able to receive data from services that don’t require the user to login first. The device equipment identifier will be used to identify from whom the received that belongs to.

Create Device

Creates a new device and allocates it to a patient. The patient needs to have the manual device flag enable in ordet to be allowed to do this. Requires a valid access token present for the correct patient. CreateDevice

Example

The patient is identified from the Token header, this will also be used to set the device to correct patient.

POST: {baseurl}/api/v1/patient/device/create

Request
Body
{
 "TypeId": 528391,
 "EquipmentId": "5C313E020E12",
 "AcquisitionDate": "2017-05-02T12:00:00.000",
 "Status": "Allocated",
 "Manufacturer": "AND Medical",
 "Model": "UA-651BLE",
 "SerialNumber": "5C313EFFFE020E12",
 "LatestSync": 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

Update Device

Updates the information about the device. The patient needs to have the manual device flag enable in ordet to be allowed to do this. UpdateDevice

Example

The patient is identified from the Token header, this will also be used to control that device is allocated to that patient.

POST: {baseurl}/api/v1/patient/device/update

Request
Body
{
 "Id": "5C313EFFFE020E12",
 "TypeId": 528391,
 "EquipmentId": "5C313E020E12",
 "AcquisitionDate": "2017-05-02T12:00:00.000",
 "Status": "Allocated",
 "Manufacturer": "AND Medical",
 "Model": "UA-651BLE",
 "SerialNumber": "SN5150400579",
 "LatestSync": 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

Get Device

Retrieve the information of the device, can be filtered through the query parameters. GetDevice

Example

The patient is identified from the Token header

GET: api/v1/patient/devices?DeviceTypeId=528399&Id=00091FFFFE801289&Status=Allocated

Request
Headers

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

Response
Body
{
 "Id": "5C313EFFFE020E12",
 "TypeId": 528391,
 "EquipmentId": "5C313E020E12",
 "AcquisitionDate": "2017-05-02T12:00:00.000",
 "Status": "Allocated",
 "Manufacturer": "AND Medical",
 "Model": "UA-651BLE",
 "SerialNumber": "SN5150400579",
 "PatientId": "1234567",
 "LatestSync": null
}
Headers

Content-Type: application/json


© 2025 - LinkWatch API