Required parameters are marked with "*"

Якщо інформації по відповідному параметру немає, потрібно зазначити: “APIparagraph not found”.

Purpose*

This WS allows to get detailed immunization info from Admin panel.API paragraph not found

Specification*

Logic*

API paragraph not found

Key points

...

This is a graphQl query used in Administration panel only

...

Only authenticated and authorized NHS employee with appropriate scope can get immunization details.

...

Query returns single immunization by person (mpi id) and immunization identifier.

...

...

Query should be invoked only if /wiki/spaces/AFC/pages/16680386561 for monitoring exists for current user and corresponding patient (ABAC rule_-2).

Input parameters

...

API paragraph not found

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 = 'immunization:practical_monitor')

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

• Check user has access to resource according to @rule_-2 in ABAC

  • return 403 (“Access denied. Justification required“) in case of error

Request to process the request using a token in the headers

Headers*

Наприклад:

• Content-Type:application/json

• Authorization:Bearer mF_9.B5f-4.1JqM

Request data validation*

Validate legal entity

• Extract client_id from token.

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

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

• Check legal entity status (status = ACTIVE)

  • In case of error - return 409 ('client_id refers to legal entity that is not active')

Validate request

• Check required personId submitted.

  • return 404 (“not found“) in case not exist

• Check required immunization Id submitted.

  • return 404 (“not found“) in case not exist or not related to person

Processing*

Service logic

...

Get immunization by id and patient_id

...

API paragraph not found

Processing*

API paragraph not found

Response structure*

See on Apiary

...