Versions Compared

Old Version 3

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

Saved on

compared with

New Version 4

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

Saved on

Key

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

REST API method / Метод REST API (настанова) (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-001-001-001-0001

Microservices (namespace)

MPI

Component

Auth

Component ID

COM-001-001

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

Request type

Sync/Async

Public/Private

...

Expand
titleSequence

MIS/Medical employee->Compositions: Create Composition POST/patients/composition
Compositions->Compositions: Check user scopes authorization composition:create
Compositions-->MIS/Medical employee: In case of error HTTP/401
Compositions->Compositions: Async job planning
Compositions->MIS/Medical employee: Async job details
Compositions<->eHealth:data clarification and verification about author, custodsan, diagnosis etc
Compositions->Compositions:Create and save Composition according to the XML template
Compositions->Compositions:Async job Completed
MIS/Medical employee->Compositions: GET/patients/composition/job/{asyncJobId}
Compositions->MIS/Medical employee:Async job completed (conclusionAsyncJobListItem.href)
MIS/Medical employee->Compositions:GET/patients/{patientId}/composition/{compositionId}/episode/{episodeId}/encounter/{encounterId}
Compositions->MIS/Medical employee: Composition in PRELIMINARY status
MIS/Medical employee->MIS/Medical employee:Signs document and gives to patient
MIS/Medical employee->Compositions:Sign Composition PATCH /patients/composition/{compositionId}/sign
Compositions->Compositions:Check user scopes authorization composition:sign
Compositions-->MIS/Medical employee: In case of error HTTP/401
Compositions->MIS/Medical employee: HTTP/200 Async job Created
Compositions<->eHealth:Signature and author validation
Compositions->Compositions:Save object on SWIFT/S3
Compositions->Compositions:Schedule of trigger interactions (DIIA,MJU_DRACZ,ERLN,MPI,Closure)
MIS/Medical employee->Compositions:GET /patients/composition/job/{asyncJobId}
Compositions->MIS/Medical employee:Async job completed (conclusionAsyncJobListItem.href)
MIS/Medical employee->Compositions:GET/patients/{patientId}/composition/{compositionId}/episode/{episodeId}/encounter/{encounterId}
Compositions->MIS/Medical employee:Composition in FINAL status

Configuration parameter

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

compositionId

 

String ($uuid)

(path)

Composition object ID

8c696fa4-6607-4aef-bab7-33cabc2dda2c

2

patientId

String ($uuid)

(path)

Patient object ID

6a524088-c3f6-44ef-bcea-12a8e2900431

3

episodeId

String ($uuid)

(path)

Episode of care object ID

e4f8c204-4879-4a90-a89f-707ffd7f02c4

4

encounterId

String ($uuid)

(path)

Encounter object ID

d44ac2e9-9c83-4f5a-9ce1-0b764f260fff

...

Key

Value

Mandatory

Description

Example

1

Content-Type

application/json

Тип контенту

Content-Type:application/json

2

Authorization

Bearer {token}

Перевірка користувача

Authorization: Bearer {token}

3

api-key

{secret}

Секретний ключ

api-key: {secret}

Request data validation

...

In case of wrong request data - return 404 “Not Found“ - “no Route matched with those values”

Processing

A list of processes related to receiving, changing or transmitting data according to the logic defined in the REST API

Response structure examples

...

Response code

HTTP Status code

Message

Internal name

Description

1

Базові

2

200

If the object exists and access is authorized

3

401

(Unauthorized) in case of invalid scope(s)

4

403

Access denied

In the case of access denied to view the Composition according to the rules of ABAK

45

404

In case the Composition does not exist

The Composition wasn’t found

56

Специфічні

67

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

Page Properties Report
headingsID ТМ, Статус
cqllabel = "tr-mis"

...