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 necessaryThis web service is designed to return immunizations 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/vaccine_codes(parameter “vaccine_code“ in request/response)

3. eHealth/resources - episode (parameter “status“ in response)

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

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

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

7. eHealth/immunization_body_sites (parameter “site“ in response)

8. eHealth/vaccination_routes (parameter “route“ in response)

9. eHealth/immunization_dosage_units (parameter “dose_quantity:system“ in response)

10. eHealth/reason_explanations (parameter “explanation:reasons“ in response)

11. eHealth/reason_not_given_explanations (parameter “explanation:reasons_not_given“ in response)

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

13. eHealth/vaccination_authorities(parameter “vaccination_protocol:authority“ in response)

14. eHealth/vaccination_target_diseases(parameter “vaccination_protocol:authority“ in response)

Input parameters

Request structure

See on API-specification

Headers

...

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 401401 

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 immunizations

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)