Versions Compared

Old Version 4

changes.mady.by.user Serhii Boldin (SoE eHealth)

Saved on

compared with

New Version Current

changes.mady.by.user Serhii Boldin (SoE eHealth)

Saved on

Key

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

...

Page Properties
idAPI_Specification

Link

https://ehealthmedicaleventsapi.docs.apiary.io/#reference/medical-events/patient-summary/get-immunizations

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

Resource

/api/patients/{{patient_id}}/summary/immunizations

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

Scope

patient_summary:read

Scope для доступу

Components

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

Microservices

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

Protocol type

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

Request type

GET

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

Sync/Async

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

Public/Private/Internal

Потрібно зазначити тип методу за ступенем доступності

Logic

API paragraph not found

...

Filter

Values

Type

Description

Example

patient_id

String

Unique patient identifier

7a489bbd-d8e2-48d9-92fd-fcf0102f7b08

page

Number

Page number

2

page_size

Number

A limit on the number of objects to be returned, between 1 and 100. Default: 50

50

vaccine_code

String

wex-10

date_from

String

1990-01-01

date_to

String

2000-01-01

Request structure

API paragraph not foundSee on Apiary

 

Authorize

Request to process the request using a token in the headers

...

  1. Get all patient's immunizations

  2. Apply filters provided by user

Response structure

See on Apiary

Example: 

Expand
titleResponse example
Code Block
{
  "meta": {
    "code": 200,
    "url": "http://example.com/resource",
    "type": "object",
    "request_id": "req-adasdoijasdojsda"
  },
  "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"
                }
              ]
            }
          ]
        }
      ]
    }
  ],
  "paging": {
    "page": 2,
    "page_size": 50,
    "total_entries": 1000,
    "total_pages": 20
  }
}

...