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

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

Purpose

This WS allows to update existing medical program and add specific medical program settings for the program.

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 Medical program.

  3. This method allows to add/change medical program settings for the program.

Specification

 updateMedicalProgram
  "Update a single `MedicalProgram`."
  updateMedicalProgram(
    input: UpdateMedicalProgramInput!
  ): UpdateMedicalProgramPayload
"""
Input for `updateMedicalProgram` mutation.
User must have a scope **medical_program:write**
"""
input UpdateMedicalProgramInput {
  "The ID of an object."
  id: ID!
  "Whether it is possible to create `Medication Request`"
  medicationRequestAllowed: Boolean
  "Medication request allowed status description"
  medicationRequestAllowedText: String
  "Whether it is possible to create `Medication Dispense`"
  medicationDispenseAllowed: Boolean
  "Medication dispense allowed status description"
  medicationDispenseAllowedText: String
  "Medical program settings"
  medicalProgramSettings: MedicalProgramSettingsInput
  "Medical program settings description"
  medicalProgramSettingsText: String
}

"""
Input for `MedicalProgramSettings` of `updateMedicalProgram` mutation.
"""
input MedicalProgramSettingsInput {
  "Skip MNN in treatment period requirement flag"
  skipMnnInTreatmentPeriod: Boolean
  "Care plan requirement flag"
  carePlanRequired: Boolean!
  "Skip employee validation requirement flag"
  skipEmployeeValidation: Boolean
  "Allowed employee types to create medication request"
  employeeTypesToCreateMedicationRequest: [String]
  "Speciality types allowed"
  specialityTypesAllowed: [String]
  "conditions ICD10_AM allowed"
  conditionsIcd10AmAllowed: [String]
  "Conditions ICPC2 allowed"
  conditionsIcpc2Allowed: [String]
  "Maximum length in days of treatment period for `Medication Request` created with the program"
  medicationRequestMaxPeriodDay: Int
  "Providing conditions allowed"
  providingConditionsAllowed: [String]
  "Skip declaration verification for employee on create `Medication Request`"
  skipMedicationRequestEmployeeDeclarationVerify: Boolean
  "Skip declaration verification for legal entity on create `Medication Request`"
  skipMedicationRequestLegalEntityDeclarationVerify: Boolean
  "Allows multi dispense for `Medication Request`"
  multiMedicationDispenseAllowed: Boolean
  "Allows to process `Medication Dispense` without digital sign"
  skipMedicationDispenseSign: Boolean
  "Disables patient notification on operations with `Medication Request`"
  medicationRequestNotificationDisabled: Boolean
  "Specifies medication dispense period in days"
  medicationDispensePeriodDay: Int
  "Skip Contract and Medical Program Provision verification in medication dispense flow"
  skipContractProvisionVerify: Boolean
  "Allows to change medical program on create `Medication Dispense`"
  medicalProgramChangeOnDispenseAllowed: Boolean
  "Patient category requirement flag"
  patientCategoryRequired: Boolean!
  "Patient categories allowed. From `eHealth/clinical_impression_patient_categories` dictionary"
  patientCategoriesAllowed: [String]  
}

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

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

Validate legal entity

  • Extract client_id from token.

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

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

  • Check client type = NHS

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

Validate medical program ID

  1. Check id exists in DB

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

Service logic

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

    1. updated_by = current user (from token)

    2. updated_at = current date and time

  • No labels