Versions Compared

Key

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

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-005-001-0266

Microservices (namespace)

ME

Component

EDP

Component ID

COM-007-005

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

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

Resource

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

Scope

allergy_intolerance:read

Protocol type

REST

Request type

GET

Sync/Async

Sync

Public/Private

Public

...

This web service is designed to return allergy intolerances info by id.

Logic

Description of the working algorithm of the API method and the interaction of services with each other add Service logic (if necessary)

Configuration parameters

Description of the configuration parameters that are used when processing a request in the system

Dictionaries

Provides a list of links to dictionaries that are available in Confluence

Input parameters

Input parameter

Mandatory

Type

Description

Example

1

patient_id

 

String

Patient identifier

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

2

allergy_intolerance_id

 

String

Allergy intolerance identifier

a10aeafb-0df2-4091-bc83-f07e92a100ae

...

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

...

Post-processing processes

Description of actions performed on data after processing

Technical modules where the method is used

List of pages describing technical modules where the method is used