Properties of a REST API method document

Purpose

This web service is designed to return observations by patient_id, episode_id or encouner_id.

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

N/A (Not applicable)

Dictionaries

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Input parameters

Request structure

See on API-specification

Headers

Request data validation

Authorize

Request to process the request using a token in the headers

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 = 'observation:read')

  1. Return 403 in case invalid scope(s)

Validate patient

• Validate patient exists in MongoDB

  • In case of error return 404 not found

Access to the resource is also managed by ABAC module.

Processing

In case episode_id was submitted as a search param:

1. Select all encounters.id where ME.patinents{patient_id}.encounters{*}.episode.identifier.value== episode_id

2. Select all observations where ME.patients{patient_id}.observationd{*}.context.identifier.value == Select 1

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)