Properties of a REST API method document

Purpose

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

Logic

N/A (Not applicable)

Configuration parameters

N/A (Not applicable)

Dictionaries

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

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

3. eHealth/resources - employee (parameter “asserter“ in response)

4. eHealth/report_origins (parameter “patient“ in response)

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

6. eHealth/ICD10/condition_codes (parameter “code“ in response)

7. eHealth/condition_clinical_statuses (parameter “clinical_status“ in response)

8. eHealth/condition_verification_statuses (parameter “verification_status“ in response)

9. eHealth/condition_severities (parameter “severity“ in response)

10. eHealth/body_sites (parameter “body_sites“ in response)

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

12. eHealth/ICPC2/reasons (parameter “evidences:codes“ in response)

13. eHealth/resources - observations (parameter “evidences:details“ 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

Validate condition

• Validate condition exists in MongoDB

  • In case of error return 404 not found

• Check condition belongs to patient

  • In case of error return 404 not found

Processing

1. Get condition by ID

2. Ensure that requested condition relates to requested Patient

3. Filter using Forbidden Groups

4. Filter using configuration param SUMMARY_CONDITIONS_ALLOWED in order to return only allowed codes

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)