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

Page Properties

id	page_properties_method_REST API

Document type	Метод REST API
Document title	[ARDRAFT] Get Medication Administration by search params context [API-007-004-006-02630264]
Guideline ID	GUI-0011
Author	@
Document version	1
Document status	DRAFT
Date of creation	ХХ.ХХ.ХХХХ (дата фінальної версії документа – RC або PROD)
Date of update	ХХ.ХХ.ХХХХ (дата зміни версії)
Method API ID	API-007-004-006-02630264
Microservices (namespace)	ME
Component	EDP
Component ID	COM-007-004
Link на API-специфікацію	https://medicaleventsmisapi.docs.apiary.io/#reference/medical-events/medication-administration/get-medication-administration-by-search-paramscontext
Resource	{{host}}/api/patients/{{patient_id}}/medication_administrations/{{medication_administration_id}}/context
Scope	medicationmedical_event_administrationcontext:read
Protocol type	REST
Request type	GET
Sync/Async	SyncAsync
Public/Private	Public

Purpose

This web service is designed to return records about patient's medication administrations by patient_id or search_params.

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 Confluencemethod allows to get the context of Medication Administration in order to create approval on episode and receive access to other medical events.

Logic

Service returns context (episode), medication administration based on:

Get Medication Administration object bymedication_administration_id from medication_administrations (MongoDB)
Get medication_administration.context.identifier from Medication Administration object
Call Get Encounter context :
- Get Encounter objectby medication_administration.context.identifier (medication_administration.context.identifier = encounter._id)
  AFTER
- Get encounter.episode from Encounter object
Render a response according to specification

Configuration parameters

N/A

Dictionaries

N/A

Input parameters

	Input parameter	Mandatory	Type	Description	Example
1	patient_id		String	Patient identifier	`70a9e15b-b71b-4caf-8f2e-ff247e8a5677`
2	medication_administration_id		String	Medication Administration identifier	`a10aeafb-0df2-4091-bc83-f07e92a100ae`

Request structure

See on API-specification

Expand

title	Example

Code Block

Headers

...

Key

...

Value

...

Mandatory

...

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

language	json

Headers

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 Return (401, 'Invalid access token') in case of validation fails
Verify that token is not expired
- in case of error return 401

...

- - return (401, 'Invalid access token')
Check user scopes in order to perform this action (scope = 'medicationmedical_event_administrationcontext:read')
- Return (403, 'Your scope does not allow to access this resource. Missing allowances: medical_event_context:read') in case of invalid scope(s)

Access to the resource is also managed by ABAC module

Processing

...

Validate Person

Get Person identifier from the URL
Check it exists in DB
- Return 404 ('not_found') in case of error

Validate Encounter

Get Medication Administration identifier from the URL
- Check it exists in DB
  - Return 404 ('not_found') in case of error
- Check Medication Administration belongs to patient
  - Return 404 ('not_found') in case of error

Processing

N/A

Response structure examples

See on API-specification

Expand

title	Example

Code Block

{
  "meta": {
    "code": 200,
    "url": "http://example.com/resource",
 
  "type": "object",
    "request_id": "req-adasdoijasdojsda"
  },
  "data": [     {
 
    "id": "90a9e15b-b71b-4caf-8f2e-ff247e8a5600",
      "part_of": [
        {
   episode": {
      "identifier": {

           "type": {
              "coding": [
 
              {
   
              "system": "eHealth/resources",
 
                "code": "Procedure|Medication administration"
   episode"
            }
   
          ]
            },
   
        "value": "9183a36b7c3da506-4d45804d-42444550-93398993-63d81cd08d9cbf17f9ee0403"
   
      },
   
      "display_value": "null"
   
    }
 
    ],
      "status": "completed",
      "status_reason": {
        "coding": [
          {
            "system": "eHealth/resources",
            "code": "patient"
          }
        ]
      },
      "categorymeta": {
        "coding": [
          {
            "system": "eHealth/SNOMED/medication_administration_categories",
            "code": "409063005"
          }
        ]
      },
 200,
    "medicationurl": {
        "identifier": {
          "type": {
            "coding": [
              {
                "system": "eHealth/resources",
                "code": "medication"
              }
            ]
          },
          "value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
        },
        "display_value": "null"
      },
      "context": {
        "identifier": {
          "type": {
            "coding": [
              {
                "system": "eHealth/resources",
                "code": "encounter"
              }
            ]
          },
          "value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
        },
        "display_value": "null"
      },
      "performed_date_time": "2018-08-02T10:55:00.000Z",
      "performer": {
        "identifier": {
          "type": {
            "coding": [
              {
                "system": "eHealth/resources",
                "code": "employee"
              }
            ]
          },
          "value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
        },
        "display_value": "Опанасенко Олексій Володимирович"
      },
      "managing_organization": {
        "identifier": {
          "type": {
            "coding": [
              {
                "system": "eHealth/resources",
                "code": "legal_entity"
              }
            ]
          },
          "value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
        },
        "display_value": "Київська обласна лікарня №1"
      },
      "reason_references": [
        {
          "identifier": {
            "type": {
              "coding": [
                {
                  "system": "eHealth/resources",
                  "code": "condition|Observation|Diagnostic_report"
                }
              ]
            },
            "value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
          },
          "display_value": "null"
        }
      ],
      "request": {
        "identifier": {
          "type": {
            "coding": [
              {
                "system": "eHealth/resources",
                "code": "medication_request"
              }
            ]
          },
          "value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
        },
        "display_value": "null"
      },
      "note": "Some notes",
      "dosage": [
        {
          "text": "Rapid daily-dose escalation, until tolerated, from 3 mg/d, and then 10 mg/d, to the recommended maintenance dose of 30 mg IV over 120 min, 3 times per wk on alternate days for up to 12 wk",
          "site": {
            "coding": [
              {
                "system": "eHealth/SNOMED/anatomical_structure_administration_site_codes",
                "code": "344001"
              }
            ]
          },
          "route": {
            "coding": [
              {
                "system": "eHealth/SNOMED/route_codes",
                "code": "46713006"
              }
            ]
          },
          "method": {
            "coding": [
              {
                "system": "eHealth/SNOMED/administration_methods",
                "code": "419747000"
              }
            ]
          },
          "dose": {
            "value": 0,
            "unit": "mg",
            "system": "eHealth/ucum/units",
            "code": "mg"
          },
          "rate_ratio": {
            "numerator": {
              "value": 0,
              "unit": "mg",
              "system": "eHealth/ucum/units",
              "code": "mg"
            },
            "denominator": {
              "value": 0,
              "unit": "mg",
              "system": "eHealth/ucum/units",
              "code": "mg"
            }
          }
        }
      ]
    }
  ],
  "paging": {
    "page": 2,
    "page_size": 50,
    "total_entries": 1000,
    "total_pages": 20
  }
}http://example.com/resource",
    "type": "object",
    "request_id": "req-adasdoijasdojsda"
  }
}

HTTP status codes

	Response code	HTTP Status code
1	Базові
2		200
3	Специфічні
4

Post-processing processes

Description of actions performed on data after processing

Technical modules where the method is used

List of pages describing technical N/A

Technical modules where the method is used

Page Properties Report

headings	ID ТМ, Статус
cql	label = "tr-mis"

...

Version	Old Version 1	New Version Current
Changes made by	Anzhela Kovalenko (SoE eHealth)	Anzhela Kovalenko (SoE eHealth)
Saved on	Dec 24, 2024	Dec 24, 2024

Page Comparison

Versions Compared

Key

Purpose

Logic

Configuration parameters

Dictionaries

Logic

Configuration parameters

Dictionaries

Input parameters

Request structure

Headers

Headers

Request data validation

Authorize

Validate token

Processing

Validate Person

Validate Encounter

Processing

Response structure examples

HTTP status codes

Post-processing processes

Technical modules where the method is used

Technical modules where the method is used