Versions Compared

Old Version 2

changes.mady.by.user Serhii.Matiushyn

Saved on

compared with

New Version 3

changes.mady.by.user Anzhela Kovalenko (SoE eHealth)

Saved on

Key

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

/wiki/wiki/spaces/EN/pages/17591304241 (remove the link block before publishing the document)

...

Properties of a REST API method document

Document type

Метод REST API

Document title

[Document statusDRAFT] REST API [Назва методу] [ID методуNEW] Generate Composition print form [API-007-011-001-0473]

Guideline ID

GUI-0011

Author

@

Document version

1

Document status

DRAFT

Date of creation

ХХ.ХХ.ХХХХ (дата фінальної версії документа – RC або PROD)

Date of update

ХХ.ХХ.ХХХХ (дата зміни версії)

Method API ID

API-007-011-001-0473

Microservices (namespace)

MPIME

Component

AuthComposition_ME

Component ID

COM-007-011

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

https://ehealthmisapi1.docs.apiary.io/#reference/public.-medical-service-provider-integration-layer/manage-client-configuration/get-client-details

Resource

{{host}}//api.ehealth.gov.ua/api/patients/id/encounter_package

Scope

Protocol type

REST

Request type

Sync/Async

Public/Private

Purpose

Key Points

ABAC rules are used here:

...

MAN Request parameter

Source value

Сomposition

Select Composition from ME by id = composition_id from the request

Composition.type

ME.composition.type (enrich with display value)

Composition.category

ME.composition.category (enrich with display value)

Composition.date

ME.composition.date (cast datetime to date only)

Composition.title

ME.composition.title

Composition.event

ME.composition.event[].code (enrich ME.composition.event[].code with display value)

Composition.extension

ME.composition.extension (enrich composition.extension[].code, enrich composition.extension[].valueCodeableConcept.coding[].code with display value)

Employee

Select Employee from PRM by id = composition.attester.[0].party.identifier.value

Employee.id

PRM.employee.id

Employee.position

PRM.employee.position (enrich with display value)

Party

Select Party from PRM by id = Employee.party_id

Party.last_name

PRM.party.last_name

Party.first_name

PRM.party.first_name

Party.second_name

PRM.party.second_name

Legal_entity

Select Legal Entity from PRM by id = Composition.custodian.identifier.value

Legal_entity.name

PRM.legal_entity.name

Legal_entity.edrpou

PRM.legal_entity.edrpou

Person

Select Person from MPI by id = patient_id from request

Person.id

Person.id

Person.last_name

PRM.person.last_name

Person.first_name

PRM.person.first_name

Person.second_name

PRM.person.second_name

Person.tax_id

PRM.person.tax_id

Person.unzr

PRM.person.unzr

Person.birth_date

PRM.person.birth_date

...

View file
namemvku.pdf
View file
namedrivers.pdf

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

Description of input parameters

Input parameter

Mandatory

Type

Description

Example

1

composition_id

 M

String ($uuid) (path)

Composition object ID

 89678f60-4cdc-4fe3-ae83-e8b3ebd35c59

2

 

 

 

 

 

Request structure

See on API-specification (посилання на сторінку з API-специфікацією)

Description of the REST API request structure, example

Expand
titleExample
Code Block
...
Key
Value
Mandatory
Description
Example
1
Content-Type
application/json
M
Тип контенту
Content-Type:application/json
2
Authorization
Bearer c2778f3064753ea70de870a53795f5c9
M
Перевірка користувача
Authorization:Bearer c2778f3064753ea70de870a53795f5c9
3
 
 
 
 
 
Request data validation
Validations
...
Check Compositions with such id exists in patients collection
  • in case of error - Return 404 ('not_found')
...
:application/json
2
Authorization
Bearer c2778f3064753ea70de870a53795f5c9
M
Перевірка користувача
Authorization:Bearer c2778f3064753ea70de870a53795f5c9
3
 
 
 
 
 
Request data validation
Validations
  • Check Compositions with such id exists in patients collection
    • in case of error - Return 404 ('not_found')
  • Validate query parameter form_type corresponds to appropriate dictionary COMPOSITION_PRINTFORM_CODES
    • in case of error - Return 404 ('value is not allowed in enum')
  • Validate that in this method is allowed such form_type
    • get config parameter COMPOSITION_PRINTFORM_ALLOW_CODES
    • in condition array find condition that corresponds query parameter form_type
    • in check array must be filled “rest“ - item
Authorization
  • Verify the validity of access token
    • in case of error - return 401 (“Invalid access token”) in case of validation fails
  • Verify that token is not expired
    • in case of error - Return 404 ('value is not allowed in enum')
    Validate that in this method is allowed such form_type
    • get config parameter COMPOSITION_PRINTFORM_ALLOW_CODES
    • in condition array find condition that corresponds query parameter form_type
    • in check array must be filled “rest“ - itemreturn 401 (“Invalid access token”)
  • Check user and client scopes in order to perform this action (scope = 'composition:read')
    • return 403 (“Your scope does not allow to access this resource. Missing allowances: composition:read”) in case of invalid scope(s)
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 (посилання на сторінку з API-специфікацією)
Description of the REST API response structure, example
 Expand
titleExample
 Code Block
...
Response code
HTTP Status code
Message
Internal name
Description
1
Базові
2
401
Invalid access token
3
401
Unauthorized
 
Помилка підтвердження
4
403
Your scope does not allow to access this resource. Missing allowances: composition:read
5
1000
404
Composition not found
COMPOSITION_NOT_FOUND_404
Не знайдено медичний висновок
6
404
not_found
7
 
404
value is not allowed in enum
8
Специфічні
9
 
422
Only for active MPI record can be created medication request!
 
 
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
Название
ID ТМ
Статус
/wiki/spaces/ESOZ/pages/17378181218
TM0112
/wiki/spaces/YK/pages/17837688354