Versions Compared

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-007-004-004-0258

Microservices (namespace)

ME

Component

Episode

Component ID

COM-007-008

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

https://ehealthmedicaleventsapi.docs.apiary.io/#reference/medical-events/encounter/get-encounter-context

Resource

{{host}}/api/patients/{{patient_id}}/encounters/{{encounter_id}}/context

Scope

medical_event_context:read

Protocol type

REST

Request type

GET

Sync/Async

Async

Public/Private

Public

...

This method allows to get the context of Encounter in order to create approval on episode and receive access to other medical events.

...

  • Get Encounter object byencounter_id from encounters (MongoDB)

  • Get encounter.episode from Encounter object

  • Render a response according to specification

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

...

parameters

Input parameter

Mandatory

Type

Description

Example

1

patient_id

 

String

Patient identifier

70a9e15b-b71b-4caf-8f2e-ff247e8a5677

2

encounter_id

 

String

Encounter identifier

a10aeafb-0df2-4091-bc83-f07e92a100ae

Request structure

See on API-specification

Expand
titleExample
Code Block

...

Key

Value

Mandatory

Description

Example

1

Content-Type

application/json

 

Тип контенту

Content-Type:application/json

2

Authorization

Bearer mF_9.B5f-4.1JqM

 

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

Authorization:Bearer mF_9.B5f-4.1JqM

3

Request data validation

Authorize

  • Verify the validity of access token

    • Return (401, 'Invalid access token') in case of validation fails

  • Verify that token is not expired

    • in case of error - return (401, 'Invalid access token')

  • Check user scopes in order to perform this action (scope = 'medical_event_context:read')

    • Return (403, 'Your scope does not allow to access this resource. Missing allowances: medical_event_context:read') in case of invalid scope(s)

Validate Person

  • Get Person identifier from the URL

  • Check it exists in DB

    • Return 404 ('not_found') in case of error

...

  • Get Encounter identifier from the URL

    • Check it exists in DB

      • Return 404 ('not_found') in case of error

    • Check Encounter belongs to patient

      • Return 404 ('not_found') in case of error

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": {
    "episode": {
      "identifier": {
        "type": {
          "coding": [
            {
              "system": "eHealth/resources",
              "code": "episode"
            }
          ]
        },
        "value": "7c3da506-804d-4550-8993-bf17f9ee0403"
      },
      "display_value": "null"
    }
  },
  "meta": {
    "code": 200,
    "url": "http://example.com/resource",
    "type": "object",
    "request_id": "req-adasdoijasdojsda"
  }
}

...

5

Response code

HTTP Status code

Message

Internal name

Description

1

Базові

2

404200

3

401

Invalid access token

4

403

Специфічні

Your scope does not allow to access this resource. Missing allowances: medical_event_context:read

5

404

not_found

6

Специфічні

7

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"

...