Versions Compared

Old Version 6

changes.mady.by.user Anastasiia Prokhorova (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-010-0294

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-id

Resource

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

Scope

patient_summary:read

Protocol type

REST

Request type

GET

Sync/Async

SyncAsync

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_statement (parameter “medication_statement_id“ in request)

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

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

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

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

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

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

Input parameters

Input parameter

Mandatory

Type

Description

Example

1

patient_id

  M

String

Unique MPI patient identifier

e549c257-232e-4dab-9f1e-b2322cac3968

2

medication_statement_id

  M

String

Unique device identifier

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

Request structure

See on API-specification

...

...

titleExample

...

Headers

...

Key

...

Value

...

...

Description

...

Example

...

Content-Type

...

application/json

...

M

...

Тип контенту

...

Content-Type:application/json

...

Authorization

...

Bearer mF_9.B5f-4.1JqM

...

Authorization:Bearer mF_9.B5f-4.1JqM

Request data validation

Authorize

Request to process the request using a token in the headers

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

Expand
titleExample
Code Block
{
  "data": {
    "id": "80a9e15b-b71b-4caf-8f2e-ff247e8a5600",
    "based_on": {
      "identifier": {
        "type": {
          "coding": [
            {
              "system": "eHealth/resources",
              "code": "medication_request"
            }
          ]
        },
        "value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
      }
    },
    "asserted_date": "2018-08-02T10:45:00.000Z",
    "status": "active",
    "context": {
      "identifier": {
        "type": {
          "coding": [
            {
              "system": "eHealth/resources",
              "code": "encounter"
            }
          ]
        },
        "value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
      }
    },
    "primary_source": true,
    "asserter": {
      "identifier": {
        "type": {
          "coding": [
            {
              "system": "eHealth/resources",
              "code": "employee"
            }
          ],
          "text": ""
        },
        "value": "97d57238-ffbe-4335-92ea-28d4de117ea2"
      }
    },
    "effective_period": "Вживає з 2017-го року регулярно",
    "medication_code": {
      "coding": [
        {
          "system": "eHealth/medical_statement_medications",
          "code": "Spine_board"
        }
      ]
    },
    "note": "Some text",
    "dosage": "5 ml/day",
    "inserted_at": "2018-08-02T10:55:00.000Z",
    "updated_at": "2018-08-02T10:55: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

Специфічні

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)