Required parameters are marked with "*"

...

Purpose

API paragraph not found”.

Purpose*

This WS allows to get detailed immunization info from Admin panel.

Specification

...

Page Properties

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

Logic

...

API paragraph not found

Key points

...

...

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.

...

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

Request structure

...

API paragraph not found

Authorize

...

Verify the validity of access token

...

...

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

...

Extract client_id from token.

...

token

• Verify the validity of access token

  • Return 401 in case validation fails

• Verify token is not expired

  • in case error return 401

Validate scopes

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

  1. Return 403 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)

  1. invalid scope(s)

Validate patient

• Validate patient exists in MongoDB

  • 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

1. Get immunization by id and patient_id

2. Render detailed Immunization data according to schema

...

• • not found

Processing

API paragraph not found

Response structure

See on Apiary

Example:

{
  "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

...

Page Properties
HTTP status code Message What caused the error  200

...