Required parameters are marked with "*"

...

Purpose

...

This WS allows to get detailed immunization info from Admin panelweb service is designed to return immunizations info by patient_id, episode_id or encouner_id.

Specification

...

Page Properties

Link https://ehealthmedicaleventsapimedicaleventsmisapi.docs.apiary.io/#reference/medical-events/immunization/get-immunization-by-id Resource /api/patients/{{patient_id}}/immunizations/{{immunization_id}} Scope immunization:read Components Зазначається перелік бізнес компонентів, які використовують цей метод, наприклад: ePrescriptionEpisode of Care Microservices Перелік мікросервісів, які використовує метод API. Наприклад: Auth, ABACAPI paragraph not found Protocol type Тип протоколу, який використовується запитом, наприклад: SOAP | REST Request type GET Sync/Async Метод є синхронним чи асинхронним?

Logic*

1. Get immunization by id and patient_id

2. Render detailed Immunization data according to schema

Preconditions

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.

...

Filtration with forbidden group items not implemented for immunizations, so it not used here.

...

Input parameters

Request structure

...

API paragraph not found

...

See on Apiary

Authorize

Request to process the request using a token in the headers

• Verify the validity of access token

  • in case of error - return 401 (“Invalid access token”) Return 401 in case of validation fails

• Verify that token is not expired

  • in case of error - return 401 (“Invalid access token”)return 401 

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

  • return 403 (“Your scope does not allow to access this resource. Missing allowances: immunization:practical_monitor”) in case of Return 403 in case 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

Validate request*

...

• {{access_token}}

• API-key:{{secret}}

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

...

Access to the resource is also managed by ABAC module

Processing

API paragraph not found

Response structure

...

See on Apiary

Example:

Expand
title Response example
Code Block { "data": { "id": "90a9e15b-b71b-4caf-8f2e-ff247e8a5600", "status": "completed", "not_given": false, "vaccine_code": { "coding": [ { "system": "eHealth/vaccine_codes", "code": "HepAHepB" } ] }, "context": { "identifier": { "type": { "coding": [ { "system": "eHealth/resources", "code": "encounter" } ] }, "value": "9183a36b-4d45-4244-9339-63d81cd08d9c" }, "display_value": "null" }, "date": "2018-10-08T09:46:37.694Z", "inserted_at": "2018-08-02T10:45:16.000Z", "updated_at": "2018-08-02T10:45:16.000Z", "primary_source": false, "performer": { "identifier": { "type": { "coding": [ { "system": "eHealth/resources", "code": "employee" } ], "text": "Галина Олександрівна" }, "value": "97d57238-ffbe-4335-92ea-28d4de117ea2" } }, "manufacturer": "VacinePro Manufacturer", "lot_number": "AAJN11K", "expiration_date": "2018-10-08T09:46:37.694Z", "site": { "coding": [ { "system": "eHealth/immunization_body_sites", "code": "oral" } ] }, "route": { "coding": [ { "system": "eHealth/vaccination_routes", "code": "IM" } ] }, "dose_quantity": { "value": 18, "unit": "mg", "system": "eHealth/immunization_dosage_units" }, "explanation": { "reasons": { "coding": [ { "system": "eHealth/reason_explanations", "code": "immunization_by_calendar" } ], "text": "Планове за календарем щеплень" } }, "reactions": [ { "detail": { "identifier": { "type": { "coding": [ { "system": "eHealth/resources", "code": "observation" } ] }, "value": "9183a36b-4d45-4244-9339-63d81cd08d9c" }, "display_value": "null" } } ], "vaccination_protocols": [ { "dose_sequence": 1, "description": "Vaccination Protocol Sequence 1", "authority": { "coding": [ { "system": "eHealth/vaccination_authorities", "code": "WVO" } ] }, "series": "Vaccination Series 1", "series_doses": 2, "target_diseases": [ { "coding": [ { "system": "eHealth/vaccination_target_diseases", "code": "1857005" } ] } ] } ] }, "meta": { "code": 200, "url": "http://example.com/resource", "type": "object", "request_id": "req-adasdoijasdojsda" } }

Post-processing processes

...

API paragraph not found

HTTP status codes

...

HTTP status code	Message	What caused the error
200
401		Access token validation failed
403		Invalid scope