Versions Compared

Old Version 5

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

Saved on

compared with

New Version Current

changes.mady.by.user Natalia Horodytska (SoE eHealth)

Saved on

Key

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

Required parameters are marked with "*"

...

Purpose*

API paragraph not found

...

Purpose

This web service is designed to return conditions by episode_id.

Specification

Page Properties

Link

https://ehealthmedicaleventsapimedicaleventsmisapi.docs.apiary.io/#reference/medical-events/episode-of-care/get-conditions-in-episode-context

Resource

/api/patients/{{patient_id}}/episodes/{{episode_id}}/conditions

Scope

episode:read

Components

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

Microservices

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

Protocol type

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

Request type

GET

Sync/Async

Async

Logic*

...

Public/Private/Internal

Public

Filters

Filter

Values

Type

Description

Example

patient_id

String

Patient identifier

70a9e15b-b71b-4caf-8f2e-ff247e8a5677

episode_id

String

Episode identifier

a10aeafb-0df2-4091-bc83-f07e92a100ae

code

String

A20

onset_date_from

String

1990-01-01

onset_date_to

String

2000-01-01

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

...

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{{secret}}

Request data validation*

API paragraph not found

Processing

...

API paragraph not found

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": "6fe6d880-f100-4e39-a278-1d14eb8472ef",
      "primary_source": true,
      "asserter": {
        "identifier": {
          "type": {
            "coding": [
              {
                "system": "eHealth/resources",
                "code": "employee"
              }
            ],
            "text": ""
          },
          "value": "97d57238-ffbe-4335-92ea-28d4de117ea2"
        }
      },
      "context": {
        "identifier": {
          "type": {
            "coding": [
              {
                "system": "eHealth/resources",
                "code": "encounter"
              }
            ]
          },
          "value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
        },
        "display_value": "null"
      },
      "code": {
        "coding": [
          {
            "system": "eHealth/ICD10/condition_codes",
            "code": "K87"
          }
        ]
      },
      "clinical_status": "active",
      "verification_status": "provisional",
      "severity": {
        "coding": [
          {
            "system": "eHealth/condition_severities",
            "code": "55604002"
          }
        ]
      },
      "body_sites": [
        {
          "coding": [
            {
              "system": "eHealth/body_sites",
              "code": "head"
            }
          ]
        }
      ],
      "onset_date": "2018-10-08T09:46:37.694Z",
      "asserted_date": "2018-10-08T09:46:37.694Z",
      "inserted_at": "2018-08-02T10:45:16.000Z",
      "updated_at": "2018-08-02T10:45:16.000Z",
      "stage": {
        "summary": {
          "coding": [
            {
              "system": "eHealth/condition_stages",
              "code": "14803004"
            }
          ]
        }
      },
      "evidences": [
        {
          "codes": [
            {
              "coding": [
                {
                  "system": "eHealth/ICPC2/reasons",
                  "code": "169068008"
                }
              ]
            }
          ],
          "details": [
            {
              "identifier": {
                "type": {
                  "coding": [
                    {
                      "system": "eHealth/resources",
                      "code": "observation"
                    }
                  ]
                },
                "value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
              },
              "display_value": "null"
            }
          ]
        }
      ]
    }
  ],
  "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

 

 

401

 

Access token validation failed

403

 

Invalid scope