...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

Status

...

...

Purpose

This WS  is design to update reimbursement and/or flags "is_active", "medication_request_allowed" for Medication brand within Medical program. 

WS logic

Authorize

1. Verify the validity of access token
   1. In case of error - generate 401 response
2. Check user scope (scope = 'program_medication:write') in order to perform this action
   1. In case of error - generate 403 response

Verify the validity of access token

1. Check user scope (scope = 'program_medication:write') in order to perform this action
   1. In case of error - generate 401 response

Validate request (JSON schema)

1. Validate request using JSON schemas:
   1. Return 422 with list of validation errors in case validation fails (422 EView)

Validate PK Program Brands

1. Check participant (Program_medication) ($.id) exists in PRM.program_medications

In case of error - return 422 error (message: "ID for Medication brand within the Medical program is not found")

{:error, [{%{
        description: "ID for Medication brand within the Medical program is not found",
        params: [],
        rule: :invalid
      }, "$.id"}]}

Validate status

1. Validate `is_active` == TRUE

1. 1. if invalid  - return 409 eror (message: "Medication brand within the program is inactive")

Validate medical_request_allowed status

To deactivate Participant (to update is_active == FALSE for medication brand within the program with id={id}) medical_request_allowed must be inactive (medical_request_allowed == FALSE) 

1. Validate medical_request_allowed == FALSE

1. 1. if invalid  - return 409 eror (message: "To deactivate medication brand within the program firstly disable medical_request_allowed")

Update Program medication

Update program_medication record by $.id  set values:

...

Destination

...

Source

...

$.is_active

...

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 an appropriate scope can update a Program medication.

Specification

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.

Preconditions

API paragraph not found

Global and configurable parameters

API paragraph not found

Input parameters

API paragraph not found

Filters

API paragraph not found

Dictionaries

API paragraph not found

Specification

"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
  "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
}
"""
Program Medication linkes medication and medical program.
In order to obtain details user must have a scope **program_medication:read**
"""
type ProgramMedication implements Node {
  "The ID of an object."
  id: ID!
  "Primary key identifier from the database."
  databaseId: UUID!
  "MedicalProgram."
  medicalProgram: MedicalProgram!
  "Medication"
  medication: Medication!
  "Reimbursement information."
  reimbursement: Reimbursement!
  "Factory gate price for package of medications"
  wholesalePrice: Float
  "Consumer price for package of medications"
  consumerPrice: Float
  "Reimbuersement amount for recommended daily dosage of medication"
  reimbursementDailyDosage: Float
  "The estimatied amount which patient should pay for package of medications after reimbursement"
  estimatedPaymentAmount: Float
  "Start date of action for this entry"
  startDate: Date
  "End date for this entry"
  endDate: Date
  "General registry identifier"
  registryNumber: String
  "Whether `ProgramMedication` is active or not?"
  isActive: Boolean!
  "Whether requesting medications allowed for the `ProgramMedication` or not?"
  medicationRequestAllowed: Boolean!
  "Date and time when record was inserted"
  insertedAt: DateTime!
  "Date and time when record was updated"
  updatedAt: DateTime!
}

"""
Reimbursement information for current program medication.
"""
type Reimbursement {
  "Type of reimbursement"
  type: ReimbursementType!
  "Amount to reimburse for medication package by `MedicalProgram`."
  reimbursementAmount: Float
  "Percentage to reimburse for medication package by `MedicalProgram`."
  percentageDiscount: Float
}

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).

Headers

API paragraph not found

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 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').

4. 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').

Processing

API paragraph not found

Response structure

API paragraph not found

Post-processing processes

API paragraph not found

HTTP status codes

Backward compatibility

API paragraph not found