Properties of a REST API method document

Purpose

Describe the purpose of the API method, add Key points (if necessary)

Logic

Description of the working algorithm of the API method and the interaction of services with each other add Service logic (if necessary)

Configuration parameters

Description of the configuration parameters that are used when processing a request in the system

...

This web service is designed to return detailed information of the patient’s observation.

Logic

N/A (Not applicable)

Configuration parameters

N/A (Not applicable)

Dictionaries

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

2. eHealth/resources - observation (parameter “id“ in request)

3. eHealth/observation_statuses(parameter “status“ in response)

4. eHealth/resources - diagnostic_report (parameter “diagnostic_report“ in response)

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

6. eHealth/observation_categories(parameter “categories“ in response)

7. eHealth/LOINC/observation_codes (parameter “code“ in request/response)

8. eHealth/resources - employee (parameter “performer“ in response)

9. eHealth/report_origins (parameter “report_origin“ in response)

10. eHealth/observation_interpretations (parameter “interpretation“ in response)

11. eHealth/body_sites (parameter “body_site“ in response)

12. eHealth/observation_methods (parameter “method“ in response)

13. eHealth/ucum/units (parameter “reference_ranges:low; reference_ranges:high;“ in response)

14. eHealth/reference_range_types (parameter “type“ in response)

15. eHealth/reference_range_applications (parameter “applies_to“ in response)

16. eHealth/ucum/units (parameter “age:low; age:high;“ in response)

17. eHealth/resources - specimen (parameter “specimen“ in response)

18. eHealth/resources - equipment (parameter “device“ in response)

Input parameters

Request structure

See on API-specification

Headers

See on Headers

Request data validation

Authorize

Request to process the request using a token in the headers

Processing

A list of processes related to receiving, changing or transmitting data according to the logic defined in the REST API

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

Validate observation

• Validate observation exists in MongoDB

  • In case of error return 404 not found

• Check observation belongs to patient

  • In case of error return 404 not found

Processing

1. Get observation by ID

2. Ensure that requested observation relates to requested Patient

3. Filter using configuration param SUMMARY_OBSERVATIONS_ALLOWEDin order to return only allowed codes

4. 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)