Versions Compared

Version Old Version 6 New Version 7
Changes made by

Anastasiia Prokhorova (SoE eHealth) (Unlicensed)

Mykhaylo Khapchyk (SoE eHealth)

Saved on

Key

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

/wiki/spaces/EN/pages/17591304241 (remove the link block before publishing the 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-010-0295

Microservices (namespace)

ME

Component

Patient Summary

Component ID

COM-007-008

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

https://medicaleventsmisapi.docs.apiary.io/#reference/medical-events/patient-summary/get-medication-statement-by-search-params

Resource

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

Scope

patient_summary:read

Protocol type

REST

Request type

GET

Sync/Async

Sync

Public/Private

Public

Purpose

Describe the purpose of the API method, add Key points (if necessary)

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 ConfluenceN/A (Not applicable)

Dictionaries

  1. eHealth/resources - medication_request (parameter “based_on“ in response)

  2. eHealth/medication_satement_statuses (parameter “status“ in response)

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

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

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

  6. eHealth/medical_statement_medications (parameter “medication_code“ in request/response)

Input parameters

...

Headers

Key

Value

Mandatory

Description

Example

1

Content-Type

application/json

M

Тип контенту

Content-Type:application/json

2

Authorization

Bearer mF_9.B5f-4.1JqM

Authorization:Bearer mF_9.B5f-4.1JqM

Input parameter

Mandatory

Type

Description

Example

12

Request structure

See on API-specification

...

titleExample

patient_id

 M

String

Unique patient identifier

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

2

medication_code

 

String

 

wex-10

3

asserted_date_from

 

String

 

2017-01-01

4

asserted_date_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 headersPI

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 ApiarySee on API-specification

...

titleExample

...

HTTP status codes

Response code

HTTP Status code

Message

Internal name

Description

1

Базові

2

 

200

 

Response

 

3

Специфічні

4

 

401

 

Access token validation failed

 

4

 

401

 

Access token expired

 

5

 

403

 

Invalid scope

 

6

 

404

 

Patient not found

 

7

Специфічні

Post-processing processes

Description of actions performed on data after processingN/A (Not applicable)

Technical modules where the method is used

List of pages describing technical modules where the method is used

...

N/A (Not applicable)