/wiki/spaces/EN/pages/17591304241 (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

Description of the configuration parameters that are used when processing a request in the system

Dictionaries

Provides a list of links to dictionaries that are available in Confluence

Input parameters

Description of input parameters

Request structure

See on API-specification (посилання на сторінку з API-специфікацією)

Description of the REST API request structure, example

Headers

Request data validation

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

A list of processes related to receiving, changing or transmitting data according to the logic defined in the REST API

Response structure examples

See on API-specification (посилання на сторінку з API-специфікацією)

Description of the REST API response structure, example

HTTP status codes

Post-processing processes

Description of actions performed on data after processing

Technical modules where the method is used

List of pages describing technical modules where the method is used