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

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

N/A

Dictionaries

N/A

Input parameters

Request structure

See on API-specification

Headers

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 “MIS“ - item

    • in case of error - Return 409 ('Requested form type is not allowed')

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)

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