Properties of a REST API method document

Purpose

This method allows to get web service is designed to return detailed information of the patient’s Clinical clinical impression.

Logic

N/A (Not applicable)

Configuration parameters

N/A (Not applicable)

Dictionaries

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

2. eHealth/resources - clinical_impression (parameter “clinical_impression_id“ in request)

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

4. eHealth/clinical_impression_patient_categories(parameter “code“ in response)

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

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

7. eHealth/resources - clinical_impression (parameter “previous“ in response)

8. eHealth/resources - condition(parameter “problems“ in response)

9. eHealth/resources - condition | observation (parameter “findings“ in response)

10. eHealth/resources - condition | observation | diagnostic_report | encounter (parameter “supporting_info“ 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, 'Invalid access token') Return 401 in case of validation fails

• Verify that token is not expired

  • in case of error - return (401, 'Invalid access token')return 401 

Validate scopes

• Check user scopes in order to perform this action (scope = 'clinicalpatient_impressionsummary:read')

  1. Return

  (

  1. 403

  , 'Your scope does not allow to access this resource. Missing allowances: clinical_impression:read')

  1. in case

  of

  1. invalid scope(s)

Access to the resource is also managed by by ABAC module

Request to process the request using a token in the headers

Validate Patient

• Get Patient identifier from the URL

• Check it exists in DB

  • Return 404 ('not found') in case of error

Validate Clinical impression

• Get Clinical impression identifier from the URL

• Check it exists in DB

  • Return 404 ('not found') in case of error

• Check Clinical impression belongs to patient

  • Return 404 ('not found') in case of error

Processing

Service returns specified Clinical impression related to the patient:

...

Get Clinical impression by ID from clinical_impression collection (MongoDB)

...

Validate data consistency:

• Ensure that requested Clinical impression relates to requested Patient (from URL)

  • Return 404 ('not found') in case of error

.

Validate patient

• Validate patient exists in MongoDB

  • In case of error return 404 not found

Validate сlinical impression

• Validate сlinical impression exists in MongoDB

  • In case of error return 404 not found

• Check сlinical impression belongs to patient

  • In case of error return 404 not found

Processing

1. Get сlinical impression by ID

2. Ensure that requested сlinical impression relates to requested Patient

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)