Required parameters are marked with "*"

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

Purpose*

Return a list of short Encounter info filtered by search params

Specification*

Project Name	COVID-certificate
Project abreviation	SVC
Developer	Розробник методу API. Наприклад, Edenlab
Project Manager	@Єлизавета Гессен-Дармштадська
Tech Lead	@Іоанн Воїнов
Product Owner	@Нікодім Святогорцев
Вusiness analyst	@Пантелеймон Нікомедійський
Status	APPROVED
Version	1.0
Date of release	22 Jun 2022
Link	https://ehealthmedicaleventsapi.docs.apiary.io/#reference/medical-events/patient-summary/get-short-encounters-by-search-params
Resource	/api/patients/{{patient_id}}/summary/encounters
Scope	patient_summary:read
Components	Зазначається перелік бізнес компонентів, які використовують цей метод, наприклад: ePrescription
Microservices	Перелік мікросервісів, які використовує метод API. Наприклад: Auth, ABAC
Protocol type	Тип протоколу, який використовується запитом, наприклад: SOAP \| REST
Request type	GET
Sync/Async	Метод є синхронним чи асинхронним?

Logic*

The endpoint returns a list of short Encounter info filtered by search params

Filters

Filter	Type	Description	Example
patient_id	String	Unique patient identifier	`7075e0e2-6b57-47fd-aff7-324806efa7e5`
date_from	String		`1990-01-01`
date_to	String		`2000-01-01`
episode_id	String		`f48d1b6c-a021-4d6a-a5a4-aee93e152ecc`
status	String		`finished`
type	String		`discharge`
class	String		`INPATIENT`
performer_speciality	String		`VIROLOGY`
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`

Request structure*

API paragraph not found

Authorize*

Request to process the request using a token in the headers

Headers*

Наприклад:

Content-Type:application/json
Authorization:Bearer mF_9.B5f-4.1JqM
api-key:aFBLVTZ6Z2dON1V

Validate request*

API paragraph not found

Request data validation*

API paragraph not found

Processing*

API paragraph not found

Response structure*

See on Apiary

Example:

Response example

{
  "meta": {
    "code": 200,
    "url": "http://example.com/resource",
    "type": "object",
    "request_id": "req-adasdoijasdojsda"
  },
  "data": [
    {
      "id": "465fb6fe-2dea-4b8a-9ef7-58379d1eaab0",
      "status": "finised",
      "date": "2018-08-02T10:45:16.000Z",
      "episode": {
        "identifier": {
          "type": {
            "coding": [
              {
                "system": "eHealth/resources",
                "code": "episode"
              }
            ]
          },
          "value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
        }
      },
      "class": {
        "system": "eHealth/encounter_classes",
        "code": "inpatient"
      },
      "type": {
        "coding": [
          {
            "system": "eHealth/encounter_types",
            "code": "discharge"
          }
        ]
      },
      "performer_speciality": {
        "coding": [
          {
            "system": "SPECIALITY_TYPE",
            "code": "VIROLOGY"
          }
        ]
      }
    }
  ],
  "paging": {
    "page": 2,
    "page_size": 50,
    "total_entries": 1000,
    "total_pages": 20
  }
}

Post-processing processes*

Що має відбутися в ЦБД після опрацювання та відправлення відповіді, тощо

HTTP status codes*

HTTP status code	Message	What caused the error
200

Get Short Encounters by search params_NEW

Required parameters are marked with "*"

Purpose*

Specification*

Logic*

Filters

Request structure*

Authorize*

Headers*

Validate request*

Request data validation*

Processing*

Response structure*

Post-processing processes*

HTTP status codes*