Table of Contents

minLevel	1
maxLevel	3

Required parameters are marked with "*"

...

Purpose*

API paragraph not found

Specification*

...

Project Name

...

COVID-certificate

...

Project abreviation

...

SVC

...

Developer

...

Розробник методу API. Наприклад, Edenlab

...

Project Manager

...

@Єлизавета Гессен-Дармштадська

...

Tech Lead

...

@Іоанн Воїнов

...

Product Owner

...

@Нікодім Святогорцев

...

Вusiness analyst

...

@Пантелеймон Нікомедійський

...

Status

Status

colour	Green
title	APPROVED

...

Version

...

1.0

...

Date of release

...

22 Jun 2022

Purpose

This web service is designed to return immunizations details by episode_id.

Specification

Page Properties

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

Logic*

...

Async
Public/Private/Internal	Public

Input parameters

Input parameter	Type	Description	Example
patient_id	String	Patient identifier	`70a9e15b-b71b-4caf-8f2e-ff247e8a5677`
episode_id	String	Episode identifier	`a10aeafb-0df2-4091-bc83-f07e92a100ae`
immunization_id	String	Immunization identifier	`7075e0e2-6b57-47fd-aff7-324806efa7e5`

Request structure

...

See on Apiary

Authorize

...

Request to process the request using a token in the headers
...
Verify the validity of access token
Return 401 in case validation fails
Verify token is not expired
in case error return 401
Check user scopes in order to perform this action (scope = 'episode:read')
Return 403 in case invalid scope(s)

Headers

Наприклад:

Content-Type:application/json
Authorization:Bearer mF_9.B5f-4.1JqMapi{{access_token}}
API-key:aFBLVTZ6Z2dON1V

Validate request*

API paragraph not found

{{secret}}

Request data validation

...

API paragraph not found

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

Versions Compared

Old Version 2

New Version Current

Key

Required parameters are marked with "*"

Purpose*

Specification*

Purpose

Specification

Logic*

Input parameters

Request structure

See on Apiary

Authorize

Request to process the request using a token in the headers
...
Verify the validity of access token
Return 401 in case validation fails
Verify token is not expired
in case error return 401
Check user scopes in order to perform this action (scope = 'episode:read')
Return 403 in case invalid scope(s)

Headers

Validate request*

Request data validation

API paragraph not found

Processing

API paragraph not found

Response structure

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

Page Comparison

Versions Compared

Old Version 2

New Version Current

Key

Required parameters are marked with "*"

Purpose*

Specification*

Purpose

Specification

Logic*

Input parameters

Request structure

See on Apiary

Authorize

Request to process the request using a token in the headers...Verify the validity of access tokenReturn 401 in case validation failsVerify token is not expiredin case error return 401 Check user scopes in order to perform this action (scope = 'episode:read')Return 403 in case invalid scope(s)

Headers

Validate request*

Request data validation

API paragraph not found

Processing

API paragraph not found

Response structure

Post-processing processes

API paragraph not found

HTTP status codes

HTTP status codeMessageWhat caused the error 200 401 Access token validation failed403 Invalid scope

Request to process the request using a token in the headers
...
Verify the validity of access token
Return 401 in case validation fails
Verify token is not expired
in case error return 401
Check user scopes in order to perform this action (scope = 'episode:read')
Return 403 in case invalid scope(s)

HTTP status code
Message
What caused the error
200

401

Access token validation failed
403

Invalid scope