https://e-health-ua.atlassian.net/wiki/spaces/EN/pages/17591304241 (remove the link block before publishing the document)

• Properties of a REST API method document

• Purpose

• Logic

• Configuration parameters

• Dictionaries

• Input parameters

• Request structure

• Headers

• Request data validation

• Authorize

  • Validate token

  • Validate scopes

• Processing

• Response structure examples

• HTTP status codes

• Post-processing processes

• Technical modules where the method is used

Properties of a REST API method document

Purpose

This web service is designed to return devices list for a specified patient.

Logic

 N/A (Not applicable)

Configuration parameters

N/A (Not applicable)

Dictionaries

1. eHealth/resources - patient (parameter “patient_id“ in request)

2. device_name_type (parameter “name:type“ in request / response)

3. external_system - employee (parameter “identifier“ in response)

4. eHealth/device_statuses (parameter “status“ in response)

5. device_properties (parameter “property:code“ in response)

6. eHealth/ucum/units (parameter “property:value_quantity:low:system“ in response)

7. eHealth/ucum/units (parameter “property:value_range:high:system“ in response)

8. device_definition_classification_type (parameter “type“ in response)

9. eHealth/resources - device_definition(parameter “definition“ in response)

10. eHealth/resources - device(parameter “parent“ in response)

11. eHealth/resources - employee(parameter “recordet“ in response)

12. eHealth/resources - encounter (parameter “context“ in response)

13. device_status_reasons (parameter “status_reason“ in response)

Input parameters

Request structure

See on API-specification

Headers

See on Headers

Authorize

Request to process the request using a token in the headers

Request data validation

Validate token

• Verify the validity of access token

  • Return 401 in case validation fails

• Verify token is not expired

  • in case error return 401 

Validate scopes

• Check user scopes in order to perform this action (scope = 'patient_summary:read')

  1. Return 403 in case invalid scope(s)

Access to the resource is also managed by ABAC module.

Validate patient

• Validate patient exists in MongoDB

  • In case of error return 404 not found

Processing

1. Get all patient's devices

2. Apply filters provided by user

3. Render a response according to specification

Response structure examples

See on API-specification

HTTP status codes

Post-processing processes

N/A (Not applicable)

Technical modules where the method is used

N/A (Not applicable)