/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

Key Points

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

Logic

Service logic

1. Define template id

   1. Get Composition by id from ME

   2. Get template id from configuration based on Composition.type and form_type:

      1. COMPOSITION_{{Composition.type}}_{{form_type}}_TEMPLATE_ID (ex. COMPOSITION_ADOPTION_INFO_CERTIFICATE_TEMPLATE_ID)

2. Prepare request parameters for MAN based on mapping bellow

3. Add display for codeable concept elements where it says enrich with display value

   1. Get dictionary value by dictionary key from corresponding dictionary

   2. Set dictionary value as coding[].display for this element

4. Call Render Template(MAN) to render printout form

5. Return response with generated pdf to the client

Print form mapping

Print form examples

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

Validations

• Check Compositions with such id exists in patients collection

  • in case of error - Return 404 ('not_found')

• Validate query parameter form_type corresponds to appropriate dictionary COMPOSITION_PRINTFORM_CODES

  • in case of error - Return 404 ('value is not allowed in enum')

• Validate that in this method is allowed such form_type

  • get config parameter COMPOSITION_PRINTFORM_ALLOW_CODES

  • in condition array find condition that corresponds query parameter form_type

  • in check array must be filled “rest“ - item

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