Versions Compared

Version Old Version 28 New Version Current
Changes made by

Mykhaylo Khapchyk (SoE eHealth)

Mykhaylo Khapchyk (SoE eHealth)

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Page Properties
idpage_properties_method_REST API

Document type

Метод REST API

Document title

[DRAFT] Get Allergy Intolerance by id (Patient Summary) [API-007-008-001-0279]

Guideline ID

GUI-0011

Author

@Mykhaylo Khapchyk (SoE eHealth)

Document version

1

Document status

DRAFT

Date of creation

ХХ.ХХ.ХХХХ (дата фінальної версії документа – RC або PROD)

Date of update

ХХ.ХХ.ХХХХ (дата зміни версії)

Method API ID

API-007-008-001-0279

Microservices (namespace)

ME

Component

Patient Summary

Component ID

COM-007-008

Link на API-специфікацію

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

Resource

{{host}}/api/patients/{{patient_id}}/summary/allergy_intolerances/{{id}}

Scope

patient_summary:read

Protocol type

REST

Request type

GET

Sync/Async

Sync

Public/Private

Public

...

N/A (Not applicable)

Dictionaries

  1. eHealth/resources - patient (parameter “patient_id“ in request)

  2. eHealth/resources - allergy_intolerance (parameter “id“ “id“ in request)

  3. eHealth/allergy_intolerance_clinical_statuses (parameter “clinical_status“ in response)

  4. eHealth/allergy_intolerance_verification_statuses (parameter “verification_status“ in response)

  5. eHealth/allergy_intolerance_types (parameter “type“ “type“ in response)

  6. eHealth/allergy_intolerance_categories (parameter “category“ “category“ in response)

  7. eHealth/allergy_intolerance_criticalities (parameter “criticality“ “criticality“ in response)

  8. eHealth/resources - encounter (parameter “context“ in response)

  9. eHealth/allergy_intolerance_codes(parameter “code“ in request / response)

  10. eHealth/resources - employee (parameter “asserter“ in response)

  11. eHealth/report_origins (parameter “report_origin“ in response)

...

Input parameter

Mandatory

Type

Description

Example

1

patient_id

 M

String

Unique MPI patient identifier

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

2

id

 M

String

Unique allergy intolerance identifier

340b86fd-23f3-4a33-94c5-8ec19d116c33

Request structure

See on API-specification

Headers

See on Headers

...

Authorize

Request to process the request using a token in the headers

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 

...

Response structure examples

See on API-specification

Expand
titleExample
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"
  }
}

HTTP status codes

Response code

HTTP Status code

Message

Internal name

Description

1

Базові

2

200

Response

3

401

Access token validation failed

4

 

401

 

Access token expired

 

5

 

403

 

Invalid scopeYour scope does not allow to access this resource. Missing allowances: patient_summary:read 

Forbiden

6

404

 

Not found

7

Специфічні

...