ЕСОЗ - публічна документація

Update Program Medication

Owned by Bogdana Konovalenko (Unlicensed)
Last updated: Feb 28, 2023 by Oleksandr Zhuk (SoE eHealth)
4 min read

Purpose

This WS allows to update existing medication program participant

Key points

  1. This is a graphQl method used in Administration panel only

  2. Only authenticated and authorized NHS employee with appropriate scope can update a Program medication.

 

Specification

Link

https://uaehealthapi.docs.apiary.io/#reference/internal.-nhs-admin/program-medications/update-program-medication

Resource

graphQl method

Scope

program_medication:write

Components

Drugs and Program medications

Microservices

API paragraph not found

Protocol type

API paragraph not found

Request type

REST

Sync/Async

Sync

Public/Private/Internal

Internal. NHS Admin

"Updates a single `ProgramMedication` using its globally unique ID and a patch." updateProgramMedication( input: UpdateProgramMedicationInput! ): UpdateProgramMedicationPayload
""" Input for `updateProgramMedication` mutation. User must have a scope **program_medication:write** """ input UpdateProgramMedicationInput { "The ID of an object." id: ID! "Whether `ProgramMedication` is active or not?" isActive: Boolean "Whether requesting medications allowed for the `ProgramMedication` or not?" medicationRequestAllowed: Boolean "Whether creating care plan activity allowed for the `ProgramMedication` or not?" medicationCarePlanActivityAllowed: Boolean! "Reimbursement information." reimbursement: UpdateReimbursementInput "Start date of action for this entry" startDate: Date "End date for this entry" endDate: Date "General registry identifier" registryNumber: String "Reimbursement daily dosage" reimbursementDailyDosage: Float "Consumer price" consumerPrice: Float "Wholesale price" wholesalePrice: Float "Estimated payment amount" estimatedPaymentAmount: Float }
""" Input for `Reimbursement` of `updateProgramMedication` mutation. """ input UpdateReimbursementInput { "Amount to reimburse for medication package by `MedicalProgram`." reimbursementAmount: Float "Percentage to reimburse for medication package by `MedicalProgram`." percentageDiscount: Float } """ Return type for `updateProgramMedication` mutation. """ type UpdateProgramMedicationPayload { "Updated `ProgramMedication`." programMedication: ProgramMedication }

 

 

Logic

  1. Update params submitted on input in the program medication entity. Also, set:

    1. updated_by = current user (from token)

    2. updated_at = current date and time

 

Authorize

  • 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 scopes in order to perform this action (scope = 'program_medication:write')

    • return 403 (“Your scope does not allow to access this resource. Missing allowances: program_medication:read”) in case of invalid scope(s)

 

Request data validation

Validate legal entity

  • Extract client_id from token.

  • Check client scopes in order to perform this action (scope = 'program_medication:write')

    • in case of error - return 403 (“Your scope does not allow to access this resource. Missing allowances: program_medication:write”)

  • Check legal entity type (type = NHS)

    • In case of error - return 403 ('You don’t have permission to access this resource')

Validate medication

  1. Get medication by program_medications.medication_id

  2. Check medication is_active = true

    1. in case of error - return 409 ('Medication is not active')

Validate request

  1. Check program medication id exists in DB

    1. in case of error - return 404 ('not_found')

  2. If medicationRequestAllowed submitted, than check program medication is_active = true 

    1. in case of error - return 409 ('To allow medication request firstly enable program medication')

  3. If medicationCarePlanActivityAllowed submitted, than check program medication is_active = true 

    1. in case of error - return 409 ('To allow create care plan activity firstly enable program medication')

  4. If is_active submitted as false to deactivate program medication, than check medication_request_allowed = false

    1. in case of error - return 409 ('To deactivate medication brand within the program firstly disable medical_request_allowed')

  5. if reimbursement structure submitted, than check program medication is_active = true 

    1. in case of error - return 409 ('To update reimbursement firstly enable program medication')

 

HTTP status codes

HTTP status code

Message

What caused the error

HTTP status code

Message

What caused the error

401

 Invalid access token

 

403

  • Your scope does not allow to access this resource. Missing allowances: program_medication:read

  • You don’t have permission to access this resource

 

404

not_found

Check program medication id exists in DB failed

409

 

  • Medication is not active

  • To allow medication request firstly enable program medication

  • To allow create care plan activity firstly enable program medication

  • To deactivate medication brand within the program firstly disable medical_request_allowed

  • To update reimbursement firstly enable program medication

 

ЕСОЗ - публічна документація