Versions Compared

Key

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

...

Specification

Page Properties

Link

graphQl methodhttps://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

API paragraph not foundREST

Sync/Async

Sync

Public/Private/Internal

Internal. NHS Admin

...

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

...

Page Properties

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