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)

Table of Contents

Properties of a REST API method document

...

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-003-001-0242

...

Microservices (namespace)

...

ME

...

Component

...

Diagnostic Report Data Package

...

Component ID

...

COM-007-003

...

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

...

https://ehealthmedicaleventsapi.docs.apiary.io/#reference/medical-events/diagnostic-report/get-approved-diagnostic-reports

...

Resource

...

{{host}}/api/patients/{{patient_id}}/diagnostic_reports/approved

...

Scope

...

diagnostic_report:read

...

Protocol type

...

REST

...

Request type

...

GET

...

Sync/Async

...

Sync

...

Public/Private

...

Public

Purpose

This web service is designed to return only diagnostic reports that were allowed to read by patient's approval to the current user.

Logic

  1. Select all diagnostic reports(approvals.granted_resources.identifier.value) from patients approvals that meet the requirements:

    1. patient_id= hashed patient_id from URL

    2. status= 'active'

    3. granted_to contains one of user's employees' id

    4. granted_resources.identifier.type.coding[].code="diagnostic_report"

  2. Select this diagnostic reports from ME.patients.diagnostic_reports

  3. Add filters requested by the user (search params)

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

...

Authorization

...

Bearer {{access_token}}

...

Authorization:Bearer {{access_token}}

...

Content-Type

...

application/json

...

Content-Type:application/json

...

API-key

...

{{secret}}

...

API-key:{{secret}}

Request structure

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

Description of the REST API request structure, example

...

titleExample

...

Headers

...

Key

...

Value

...

Mandatory

...

Description

...

Example

...

Content-Type

...

application/json

...

M

...

Тип контенту

...

Content-Type:application/json

...

Authorization

...

Bearer c2778f3064753ea70de870a53795f5c9

...

M

...

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

...

Authorization:Bearer c2778f3064753ea70de870a53795f5c9

...

Request data validation

Describe the process of checking the input data transmitted in the request for compliance with the given rules and restrictions set in the API

Processing

...

Note

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

Info

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

Table of Contents

Properties of a REST API method document

Page Properties
idpage_properties_method_REST API

Document type

Метод REST API

Document title

[DRAFT] Get Approved Diagnostic Reports [API-007-003-001-0242]

Guideline ID

GUI-0011

Author

@

Document version

1

Document status

DRAFT

Date of creation

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

Date of update

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

Method API ID

API-007-003-001-0242

Microservices (namespace)

ME

Component

Diagnostic Report Data Package

Component ID

COM-007-003

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

https://medicaleventsmisapi.docs.apiary.io/#reference/medical-events/diagnostic-report/get-approved-diagnostic-reports

Resource

{{host}}/api/patients/{{patient_id}}/diagnostic_reports/approved

Scope

diagnostic_report:read

Protocol type

REST

Request type

GET

Sync/Async

Sync

Public/Private

Public

Purpose

This web service is designed to return only diagnostic reports that were allowed to read by patient's approval to the current user.

Logic

  1. Select all diagnostic reports(approvals.granted_resources.identifier.value) from patients approvals that meet the requirements:

    1. patient_id= hashed patient_id from URL

    2. status= 'active'

    3. granted_to contains one of user's employees' id

    4. granted_resources.identifier.type.coding[].code="diagnostic_report"

  2. Select this diagnostic reports from ME.patients.diagnostic_reports

  3. Add filters requested by the user (search params)

Configuration parameters

N/A

Dictionaries

N/A

Input parameters

Input parameter

Mandatory

Type

Description

Example

1

2

Request structure

See on API-specification

Expand
titleExample
Code Block

Headers

Headers

Request data validation

Authorize

Request to process the request using a token in the headers

  • Verify the validity of access token

    • Return 401 in case validation fails

  • Verify token is not expired

    • in case error return 401 

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

    1. Return 403 in case invalid scope(s)

Processing

N/A

Response structure examples

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

Description of the REST API response structure, example

Expand
titleExample
Code Block
languagejson
{
  "meta": {
    "code": 200,
    "url": "http://example.com/resource",
    "type": "object",
    "request_id": "req-adasdoijasdojsda"
  },
  "data": [
    {
      "id": "90a9e15b-b71b-4caf-8f2e-ff247e8a5600",
      "based_on (Reference_response, optional)": {
        "identifier": {
          "type": {
            "coding": [
              {
                "system": "eHealth/resources",
                "code": "service_request"
              }
            ]
          },
          "value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
        }
      },
      "paper_referral": {
        "requisition": "1111-2222-3333-4444",
        "requester_legal_entity_name": "Some clinic",
        "requester_legal_entity_edrpou": "12345678",
        "requester_employee_name": "John",
        "service_request_date": "2018-10-08",
        "note": "Some notes"
      },
      "status": "final",
      "code": {
        "identifier": {
          "type": {
            "coding": [
              {
                "system": "eHealth/resources",
                "code": "service"
              }
            ]
          },
          "value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
        },
        "display_value": "null"
      },
      "category": [
        {
          "coding": [
            {
              "system": "eHealth/diagnostic_report_categories",
              "code": "diagnostic_procedure"
            }
          ]
        }
      ],
      "effective_period": {
        "start": "2018-08-02T10:45:16.000Z",
        "end": "2018-08-02T11:00:00.000Z"
      },
      "issued": "2018-10-08T09:46:37.694Z",
      "conclusion": "At risk of osteoporotic fracture",
      "conclusion_code": {
        "coding": [
          {
            "system": "eHealth/ICD10_AM/condition_codes",
            "code": "H04.2"
          }
        ]
      },
      "recorded_by (Reference_response, required)": {
        "identifier": {
          "type": {
            "coding": [
              {
                "system": "eHealth/resources",
                "code": "employee"
              }
            ]
          },
          "value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
        },
        "display_value": "Опанасенко Олексій Володимирович"
      },
      "inserted_at": "2018-08-02T10:55:00.000Z",
      "updated_at": "2018-08-02T10:55:00.000Z",
      "encounter": {
        "identifier": {
          "type": {
            "coding": [
              {
                "system": "eHealth/resources",
                "code": "encounter"
              }
            ]
          },
          "value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
        },
        "display_value": "null"
      },
      "origin_episode (Reference_response, optional)": {
        "identifier": {
          "type": {
            "coding": [
              {
                "system": "eHealth/resources",
                "code": "episode"
              }
            ]
          },
          "value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
        }
      },
      "division": {
        "identifier": {
          "type": {
            "coding": [
              {
                "system": "eHealth/resources",
                "code": "division"
              }
            ]
          },
          "value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
        },
        "display_value": "Перше відділення обласної лікарня №1"
      },
      "managing_organization (Reference_response, optional)": {
        "identifier": {
          "type": {
            "coding": [
              {
                "system": "eHealth/resources",
                "code": "patient"
              }
            ]
          },
          "value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
        },
        "display_value": "Київська обласна лікарня №1"
      },
      "results_interpreter": {
        "reference": {
          "identifier": {
            "type": {
              "coding": [
                {
                  "system": "eHealth/resources",
                  "code": "employee"
                }
              ]
            },
            "value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
          },
          "display_value": "Опанасенко Олексій Володимирович"
        }
      },
      "primary_source": true,
      "explanatory_letter": "Звіт був відмінений у зв'язку з помилкою при виборі пацієнта",
      "cancellation_reason": {
        "coding": [
          {
            "system": "eHealth/cancellation_reasons",
            "code": "misspelling"
          }
        ],
        "text": ""
      }
    }
  ],
  "paging": {
    "page": 2,
    "page_size": 50,
    "total_entries": 1000,
    "total_pages": 20
  }
}

HTTP status codes

Only for active MPI record can be created medication request!

Response code

HTTP Status code

Message

Internal name

Description

1

Базові

2

200

 

 

3

401

Unauthorized Unauthorized

Помилка підтвердження 

4

403

Invalid scopes

 

5

1000

404

Composition not found

COMPOSITION_NOT_FOUND_404

Не знайдено медичний висновок

6

Специфічні

7

422

Специфічні

6

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
headingsID ТМ, Статус
cqllabel = "tr-mis"

...