Properties of a REST API method document

Purpose

This WS is designed to sign Request for Medication request (patch). If successful signed - automatically create Medication request

Key points

1. Only authenticated and authorized users with appropriate scope can Sign Medication request Request (MRR)

2. Request should be signed with DS.

3. MRR data should be changed when it has been submitted to the method.

Logic

Method receives signed message (pkcs7) including signed content, digital signature and signer public key in signed_content property. All signature fields will be validated (including signer certificate authority).

This service will store signed copy of Medication request Request in Media Content Storage and create Medication request if signature is all checks is passed.

Signed content MUST consists of JSON object with Medication request Request data. Object that need to be signed is returned by Get medication request requests details response, JSON.Path: $.data.

Important: Invoke Get Medication request Request by ID to obtain seed - Hash of previous block in Medication request Request chain or other random component that should be signed with Medication request Request.

Look at Dummy Sign Medication Request Requests for more details.

Configuration parameters

No

Dictionaries

• MEDICATION_REQUEST_INTENT

• MEDICATION_REQUEST_CATEGORY

• MEDICATION_REQUEST_PRIORITY

• eHealth/SNOMED/additional_dosage_instructions

• eHealth/SNOMED/anatomical_structure_administration_site_codes

• eHealth/SNOMED/route_codes

• eHealth/SNOMED/administration_methods

• eHealth/SNOMED/dose_and_rate

• eHealth/ICD10_AM/condition_codes

• eHealth/ICPC2/condition_codes

Input parameters

Description of input parameters

Request structure

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

Description of the REST API request structure, example

Request data validation

Validate employee

1. Validate employee from the medication request request relates to user from token.

   1. in case of error - return 403 “Only doctor that in Medication request Request can sign it“

2. Perform another validation described at Create MRR: Validate employee

Validate division

Validate division as described on Create MRR: Validate division

Validate context

Validate division as described on Create MRR: Validate context

Validate medical program

1. Validate medical_program_id: medical_program_id exists and has medication_request_allowed = true

   1. in case of error return 422 ("Forbidden to create medication request for this medical program!")

Validate existing medication request request

If medical program setting skip_mnn_in_treatment_period = false (absent), then validate division as described on PreQualify Medication request: 2. Check absence the same medications for the programs

Validate digital signature

Decode content that is encrypted in an electronic digital signature.
Use Digital signature WS. Method checks digital signature and returns result.

Validate request status

Purpose validation: Valid ability transition.

1. For info - status charts: Medication request status model

2. Get Medication request Request status by $.id

3. Check status == NEW

   1. if invalid - return 409 error (message: "Invalid status Medication request Request for sign transition!")'

Validate person

Validate person with it’s verification status as described on Create MRR: Validate person

Validate signed content

Purpose validation: Check equality decoded signed content with previously created on IL.db.

1. Get data 

   SELECT data FROM medication_request_requests WHERE id = $.id

2. If they are not equal with decoded signed content - generate 422 error (message: "Signed content does not match the previously created content!")

Processing

Save signed medication request request to media storage

1. Get url for medication request upload.

2. Upload signed medication request request to media storage

Create medication request

1.  Create new record in medication_requests with status ACTIVE

   1. if there is existing record in the medication_requests table with the same id and medication_request_request_id, return ok to IL

2. Mapping (where <rd> = medication_request_request.data )

Generate printout form

Invoke ael.api in order to render MEDICATION_REQUEST_TEMPLATE

Template parameters

Medication request form example: 

Open

 (new)

Update Medication request Request status

Update Medication request Request:

Send SMS for person 

If MR has program with medical program setting medication_request_notification_disabled = true, then don't send SMS.

Else:

1. Get authentication_method of MPI

2. If authentication_method == OTP -  send SMS:

   1. Generate text SMS (call Man method- templates rendering service with template "TEMPLATE_SMS_FOR_SIGN_MEDICATION_REQUEST".

   2. Sending SMS for MPI

3. If authentication_method == OFFLINE (or medication_request_notification_disabled = true)

   1. set medication_request_request.verification_code to MEDICATION_REQUEST_TEMPLATE

Calculate and set remaining quantity for the activity

1. If the medication request request is based on activity with quantity:

   1. recalculate and set remaining_quantity for the activity as described at Create Medication Request: Validate based_on (p. 2.d.1 )

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

No

Technical modules where the method is used

List of pages describing technical modules where the method is used