Versions Compared

Key

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

/wiki/spaces/EN/pages/17591304241 (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-008-005-0286

Microservices (namespace)

ME

Component

Patient Summary

Component ID

COM-007-008

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

https://medicaleventsmisapi.docs.apiary.io/#reference/medical-events/patient-summary/get-active-diagnoses

Resource

{{host}}/api/patients/{{patient_id}}/summary/diagnoses

Scope

patient_summary:read

Protocol type

REST

Request type

GET

Sync/Async

SyncAsync

Public/Private

Public

Purpose

...

This endpoint returns current diagnoses related only to active episodes. In order to get specific condition details, use Get Condition by ID

Configuration parameters

Description of the configuration parameters that are used when processing a request in the system

Dictionaries

...

N/A (Not applicable)

Dictionaries

  1. eHealth/resources - condition (parameter “condition“ in response)

  2. eHealth/ICPC2/condition_codes or eHealth/ICD10/condition_codes (parameter “code“ in request/response)

  3. eHealth/diagnosis_roles (parameter “role“ in response)

Input parameters

...

Headers

Key

Value

Mandatory

Description

Example

1

Content-Type

application/json

M

Тип контенту

Content-Type:application/json

2

Authorization

Bearer mF_9.B5f-4.1JqM

Authorization:Bearer mF_9.B5f-4.1JqM

Input parameter

Mandatory

Type

Description

Example

12

Request structure

See on API-specification

...

titleExample

patient_id

 M

String

Unique MPI patient identifier

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

2

code

 

String

Diagnose code

A20

3

page

 

Number

Page number

2

4

page_size

 

Number

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

50

Request structure

See on API-specification

Headers

Request data validation

Authorize

Request to process the request using a token in the headers

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 ApiarySee on API-specification

...

...

titleExample

...

Code Block
{
  "meta": {
    "code": 200,
    "url": "http://example.com/resource",
    "type": "object",
    "request_id": "req-adasdoijasdojsda"
  },
  "data": [
    {
      "condition": {
        "identifier": {
          "type": {
            "coding": [
              {
                "system": "eHealth/resources",
                "code": "condition"
              }
            ]
          },
          "value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
        },
        "display_value": "null"
      },
      "code": {
        "coding": [
          {
            "system": "eHealth/ICPC2/conditions",
            "code": "A20"
          }
        ]
      },
      "role": {
        "coding": [
          {
            "system": "eHealth/diagnosis_roles",
            "code": "CC"
          }
        ]
      },
      "rank": 1
    },
    {
      "condition": {
        "identifier": {
          "type": {
            "coding": [
              {
                "system": "eHealth/resources",
                "code": "condition"
              }
            ]
          },
          "value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
        },
        "display_value": "null"
      },
      "code": {
        "coding": [
          {
            "system": "eHealth/ICPC2/conditions",
            "code": "A20"
          }
        ]
      },
      "role": {
        "coding": [
          {
            "system": "eHealth/diagnosis_roles",
            "code": "CC"
          }
        ]
      },
      "rank": 1
    }
  ],
  "paging": {
    "page": 2,
    "page_size": 50,
    "total_entries": 1000,
    "total_pages": 20
  }
}

HTTP status codes

Response code

HTTP Status code

Message

Internal name

Description

1

Базові

2

 200

3

Специфічні

4

Post-processing processes

Description of actions performed on data after processingN/A (Not applicable)

Technical modules where the method is used

List of pages describing technical modules where the method is used

...

N/A (Not applicable)