Properties of a REST API method document

Purpose

This web service is designed to return diagnostic reports 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. eHealth/resources - service (parameter “code“ in request / response)

3. eHealth/resources - service_request (parameter “based_on“ in response)

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

5. eHealth/diagnostic_report_categories (parameter “category“ in response)

6. eHealth/ICD10_AM/condition_codes (parameter “conclusion_code“ in response)

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

8. eHealth/resources - equipment (parameter “used_references“ in response)

9. eHealth/resources - employee (parameter “recorded_by“ in response)

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

11. eHealth/resources - episode (parameter “origin_episode“ in response)

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

13. eHealth/resources - legal_enity (parameter “managing_organization“ in response)

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

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

16. eHealth/resources - employee (parameter “results_interpreter“ in response)

17. eHealth/cancellation_reasons (parameter “cancellation_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 diagnostic reports

2. Filter using Forbidden Groups

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

4. Apply filters provided by user

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