Versions Compared

Old Version 16

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

Purpose

...

This web service is designed to return allergy intolerances info by patient_ id, episode_id or encouner_id.

Specification

...

Page Properties

Link

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

Resource

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

Scope

allergy_intolerance:read

Components

Episode of Care

Microservices

API paragraph not found

Protocol type

REST

Request type

GET

Sync/Async

Async

Public/Private/Internal

Public

Logic*

...

Input parameters

Input parameter

Values

Type

Description

Example

patient_id

String

Patient identifier

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

allergy_intolerance_id

String

Allergy intolerance identifier

a10aeafb-0df2-4091-bc83-f07e92a100ae

Request structure

...

See on Apiary

Authorize

...

Request to process the request using a token in the headers

...

Наприклад:

  • Content-Type:application/json

  • Authorization:Bearer mF_9.B5f-4.1JqM

Request data validation*

Validate token

  • Verify the validity of access token

    • Return 401 in case validation fails

  • Verify token is not expired

    • in case error return 401 

Validate scopes

  • Check user scopes in order to perform this action (scope = 'allergy_intolerance:read')

    • Return 403 in case invalid scope(s)

Headers

  • Content-Type:application/json

  • Authorization:Bearer {{access_token}}

  • API-key:{{secret}}

Request data validation

Access to the resource is also managed by ABAC module.

Processing

...

API paragraph not found

Response structure

...

See on Apiary

Example:

Expand
titleResponse example
Code Block
{
  "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"
  },
  "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