ЕСОЗ - публічна документація

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 3 Next »

Required parameters are marked with "*"

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

Purpose*

API paragraph not found

Specification*

Link

https://ehealthmedicaleventsapi.docs.apiary.io/#reference/medical-events/allergy-intolerance/get-allergy-intolerances-by-search-params

Resource

/api/patients/{{patient_id}}/allergy_intolerances

Scope

allergy_intolerance:read

Components

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

Microservices

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

Protocol type

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

Request type

GET

Sync/Async

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

Logic*

API paragraph not found

Filters

Filter

Values

Type

Description

Example

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

code

String

227493005

encounter_id

String

09dc3ed7-2169-45d8-8fa3-d918c6839bf9

episode_id

String

f48d1b6c-a021-4d6a-a5a4-aee93e152ecc

onset_date_time_from

String

1990-01-01

onset_date_time_to

String

2000-01-01

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

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": "90a9e15b-b71b-4caf-8f2e-ff247e8a5600",
      "clinical_status": "active",
      "verification_status": "confirmed",
      "type": "allergy",
      "category": "food",
      "criticality": "low",
      "context": {
        "identifier": {
          "type": {
            "coding": [
              {
                "system": "eHealth/resources",
                "code": "encounter"
              }
            ]
          },
          "value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
        },
        "display_value": "null"
      },
      "code": {
        "coding": [
          {
            "system": "eHealth/resources",
            "code": "patient"
          }
        ]
      },
      "onset_date_time": "2016-01-01T00:00:00.000Z",
      "asserted_date": "2018-08-02T10:45:00.000Z",
      "inserted_at": "2018-08-02T10:45:16.000Z",
      "updated_at": "2018-08-02T10:45:16.000Z",
      "primary_source": true,
      "asserter": {
        "identifier": {
          "type": {
            "coding": [
              {
                "system": "eHealth/resources",
                "code": "employee"
              }
            ],
            "text": ""
          },
          "value": "97d57238-ffbe-4335-92ea-28d4de117ea2"
        }
      },
      "last_occurrence": "2018-07-02T00:00:00.000Z"
    }
  ],
  "paging": {
    "page": 2,
    "page_size": 50,
    "total_entries": 1000,
    "total_pages": 20
  }
}

Post-processing processes*

API paragraph not found

HTTP status codes*

HTTP status code

Message

What caused the error

 200

 

 

  • No labels