Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents
minLevel1
maxLevel3

...

This method is used to deactivate Medication. Fields descriptions are listed in request Example view.

Input parameters

Input parameter

Values

Type

Description

Example

id

String

d290f1ee-6c54-4b01-90e6-d701748f0851

Authorize

  1. Verify the validity of access token

  2. Check user scope (scope = 'medication:deactivate') in order to perform this action

    1. In case error - generate 401 response

Request to process the request using a token in the headers

Headers

Наприклад:

  • Content-Type:application/json

  • Authorization:Bearer c2778f3064753ea70de870a53795f5c9

...

  1. Check exist Medication by $.id.

    1. if invalid - return 404 error (message: "Medication is not found!")

  2. Medication should't have active program medications

    1. Check that no active program medications exist in program_medications table in PRM DB with medication_id = $.id

      1. if invalid  - return 409 error (‘Medication is participant of an active Medical Program’)

Validate status

Purpose validation:  Medication should be active (is_active == TRUE)

...

Update medication record by $.id  set values:

Destination

Source

is_active

FALSE

updated_at

:timestamp

updated_by

user_id

Response structure

See on Apiary

...