ЕСОЗ - публічна документація

Get Medication Administration by search params

Purpose

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

 

Specification

Link

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

Resource

/api/patients/{{patient_id}}/medication_administrations

Scope

medication_administration:read

Components

API paragraph not found

Microservices

API paragraph not found

Protocol type

REST

Request type

GET

Sync/Async

Async

Public/Private/Internal

Public

 

Logic

API paragraph not found

 

Filters

Filter

Values

Type

Description

Example

Filter

Values

Type

Description

Example

page

 

Number

Page number

2

page_size

 

Number

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

50

status

 

String

 

completed

category_code

 

String

 

409063005

encounter_id

 

String

 

09dc3ed7-2169-45d8-8fa3-d918c6839bf9

episode_id

 

String

 

09dc3ed7-2169-45d8-8fa3-d918c6839bf9

managing_organization_id

 

String

 

09dc3ed7-2169-45d8-8fa3-d918c6839bf9

medication_request_id

 

String

 

09dc3ed7-2169-45d8-8fa3-d918c6839bf9

performed_date_from

 

String

 

1990-01-01

performed_date_to

 

String

 

2000-01-01

 

Request structure

API paragraph not found

 

Authorize

Request to process the request using a token in the headers

 

Headers

Наприклад:

  • Content-Type:application/json

  • Authorization:Bearer mF_9.B5f-4.1JqM

 

Request data validation

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 = 'medication_administration:read')

    1. Return 403 in case invalid scope(s)

Access to the resource is also managed by ABAC module

 

Processing

API paragraph not found

 

Response structure

See on Apiary

Example:

{ "meta": { "code": 200, "url": "http://example.com/resource", "type": "object", "request_id": "req-adasdoijasdojsda" }, "data": [ { "id": "90a9e15b-b71b-4caf-8f2e-ff247e8a5600", "part_of": [ { "identifier": { "type": { "coding": [ { "system": "eHealth/resources", "code": "Procedure|Medication administration" } ] }, "value": "9183a36b-4d45-4244-9339-63d81cd08d9c" }, "display_value": "null" } ], "status": "completed", "status_reason": { "coding": [ { "system": "eHealth/resources", "code": "patient" } ] }, "category": { "coding": [ { "system": "eHealth/SNOMED/medication_administration_categories", "code": "409063005" } ] }, "medication": { "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 } }

 

Post-processing processes

API paragraph not found

 

HTTP status codes

HTTP status code

Message

What caused the error

HTTP status code

Message

What caused the error

 200

 

 

 

ЕСОЗ - публічна документація