Versions Compared

Old Version 8

changes.mady.by.user Mykhaylo Khapchyk (SoE eHealth)

Saved on

compared with

New Version Current

changes.mady.by.user Anastasiia Prokhorova (SoE eHealth)

Saved on

Key

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

Сторінка знаходиться в процесі розробки. Інформація на ній може бути застарілою.

Info

/wiki/spaces/EN/pages/17591304241 (remove the link block before publishing the document)

Table of Contents

Properties of a REST API method document

Page Properties
idpage_properties_method_REST API

Document type

Метод REST API

Document title

[Document status] REST API [Назва методу] [ID методу]

Guideline ID

GUI-0011

Author

@

Document version

1

Document status

DRAFT

Date of creation

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

Date of update

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

Method API ID

API-007-008-001-0278

Microservices (namespace)

ME

Component

Patient Summary

Component ID

COM-007-008

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

https://medicaleventsmisapi.docs.apiary.io/#reference/medical-events/patient-summary/get-allergy-intolerances

Resource

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

Scope

patient_summary:read

Protocol type

REST

Request type

GET

Sync/Async

Async

Public/Private

Public

Purpose

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

Logic

Configuration parameters

N/A (Not applicable)

Dictionaries

...

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

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

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

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

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

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

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

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

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

Input parameters

50

Input parameter

Mandatory

Type

Description

Example

1

patient_id

 M

String

Patient Unique MPI patient identifier

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

2

page

 

Number

Page number

2

3

page_size

 

Number

A limit on the number of objects to be returned, between 1 and 100. Default: 50

4

code

 

String 

Allergy intolerances's code

227493005

53

onset_date_time_from

 

String

 

2017-01-01

64

onset_date_time_to

 

String

 

2017-01-01

5

page

 

Number

Page number

2

6

page_size

 

Number

A limit on the number of objects to be returned, between 1 and 100. Default: 50

50

Request structure

See on API-specification

Headers

See on Headers

Request data validation

Authorize

Request to process the request using a token in the headers

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')

    1. Return 403 in case invalid scope(s)

Access to the resource is also managed by ABAC module.

Processing

A list of processes related to receiving, changing or transmitting data according to the logic defined in the REST API

Response structure examples

See on API-specification

HTTP status codes

4

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 scope

6

404

Patient not found

 

7

Специфічні

Post-processing processes

N/A (Not applicable)

Technical modules where the method is used

N/A (Not applicable)