REST API method / Метод REST API (настанова) (remove the link block before publishing the document)

• Properties of a REST API method document

• Purpose

• Logic

• Configuration parameters

• Dictionaries

• Input parameters

• Request structure

• Headers

• Request data validation

• Processing

• Response structure examples

• HTTP status codes

• Post-processing processes

• Technical modules where the method is used

Properties of a REST API method document

Purpose

This method allows to get Composition in patient context by composition identifier. It is designed to provide access to Composition in case user has access to such Composition aсcording to ABAC rules

Key points

1. Only authenticated and authorized employee with appropriate scope can use this method

2. Method returns all information of Composition that belongs to the specified patient (exclude forbidden groups) context only in case user has access to such Composition aсcording to ABAC rules

3. ABAC rules are used here:

   1. Employee with active declaration (declaration) - @rule_1

   2. Composition created in the employee's MSP (also author and attester) (recorder_legal_entity_id) - @rule_2

   3. Employee can read all the composition data of episodes created in the employee's MSP (also author) (context_episode_id) - @rule_3

   4. Employee with active approval can read all the data (including merged persons/prepersons data) of specified in approval patient - @rule_4

   5. Employee with active approval can read all the data of specified in approval episodes (context_episode_id) - @rule_5

   6. Employee with active approval can read all the data of specified in approval composition - @rule_18

Logic

Service logic

Service returns specified Composition related to the patient:

• Get Composition by ID from compositions collection (MongoDB)

  • Check it exists in DB

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

• Validate data consistency:

  • Ensure that requested Composition relates to requested Patient (from URL)

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

• Render a response according to specification

Configuration parameters

N/A

Dictionaries

N/A

Input parameters

Request structure

See on API-specification

Headers

Headers

Request data validation

Authorization

• Verify the validity of access token

  • in case of error - return 401 “Invalid access token” in case of validation fails

• Verify that token is not expired

  • in case of error - return 401 “Invalid access token”

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

  • return 403 “Your scope does not allow to access this resource. Missing allowances: composition:read” in case of invalid scope(s)

• Access to the resource is also managed by ABAC module

Validate Patient

• Get Patient identifier from the URL

• Check it exists in Mongo DB

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

Validate Composition

• Get Composition identifier from the URL

• Check it exists in DB

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

• Check Composition belongs to patient

  • Return 403 ('forbidden') in case of error

Processing

N/A

Response structure examples

See on API-specification

HTTP status codes

Post-processing processes

N/A

Technical modules where the method is used