Versions Compared

Key

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

...

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 the Administration panel only.

  2. Only authenticated and authorized NHS employee with an appropriate scope can update a Medical program.

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

Specification

Page Properties

Link

graphQl methodSee GraphQl Specification

Посилання на Apiary або Swagger

Resource

graphQl methodSee GraphQl Specification

Посилання на ресурс, наприклад: /api/persons/create

Scope

API paragraph not found

Scope для доступу

Components

API paragraph not found

Зазначається перелік бізнес компонентів, які використовують цей метод, наприклад: ePrescription

Microservices

API paragraph not found

Перелік мікросервісів, які використовує метод API, наприклад: Auth, ABAC

Protocol type

API paragraph not found

Тип протоколу, який використовується запитом, наприклад: SOAP | REST

Request type

API paragraph not found

Тип запиту API, наприклад: GET, POST, PATCH…

Sync/Async

API paragraph not found

Метод є синхронним чи асинхронним?

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.

Preconditions

API paragraph not found

...

Validate medical program ID

  1. Check id exists in DB

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

Processing

API paragraph not found

...