REST API method / Метод REST API (настанова) (remove the link block before publishing the

Info
Info
REST API method / Метод REST API (настанова) (remove the link block before publishing the document)

Table of Contents

...

Page Properties

id	page_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-003-0248
Microservices (namespace)	ME
Component	EDP
Component ID	COM-007-004
Link на API-специфікацію	https://ehealthmedicaleventsapi.docs.apiary.io/#reference/medical-events/conditions/get-condition-by-id
Resource	{{host}}/api/patients/{{patient_id}}/conditions/{{condition_id}}
Scope	condition:read
Protocol type	REST
Request type	GET
Sync/Async	Sync
Public/Private	Public

...

This web service is designed to return conditions by id.

Logic

Description of the working algorithm of the API method and the interaction of services with each other add Service logic (if necessary)

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	patient_id		String	Patient identifier	`70a9e15b-b71b-4caf-8f2e-ff247e8a5677`
2	condition_id		String	Condition identifier	`a10aeafb-0df2-4091-bc83-f07e92a100ae`

Request structure

See on Apiary

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

Expand

title	Example

Code Block

...

	Key	Value	Mandatory	Description	Example
1	Content-Type	application/json	M	Тип контенту	Content-Type:application/json
2	Authorization	Bearer {{access_token}}			Authorization:Bearer {{access_token}}
3	API-key	{{secret}}	API-key:{{secret}}

...

}}

API-key:{{secret}}

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 = 'condition:read')
- Return 403 in case invalid scope(s)

Access to the resource is also managed by ABAC module

...

Response structure examples

See on API-specification (посилання на сторінку з API-специфікацією)Description of the REST API response structure, example API-specification

Expand

title	Example

Code Block

{
  "data": {
    "id": "6fe6d880-f100-4e39-a278-1d14eb8472ef",
    "primary_source": true,
    "asserter": {
      "identifier": {
        "type": {
          "coding": [
            {
              "system": "eHealth/resources",
              "code": "employee"
            }
          ],
          "text": ""
        },
        "value": "97d57238-ffbe-4335-92ea-28d4de117ea2"
      }
    },
    "context": {
      "identifier": {
        "type": {
          "coding": [
            {
              "system": "eHealth/resources",
              "code": "encounter"
            }
          ]
        },
        "value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
      },
      "display_value": "null"
    },
    "code": {
      "coding": [
        {
          "system": "eHealth/ICD10/condition_codes",
          "code": "K87"
        }
      ]
    },
    "clinical_status": "active",
    "verification_status": "provisional",
    "severity": {
      "coding": [
        {
          "system": "eHealth/condition_severities",
          "code": "55604002"
        }
      ]
    },
    "body_sites": [
      {
        "coding": [
          {
            "system": "eHealth/body_sites",
            "code": "head"
          }
        ]
      }
    ],
    "onset_date": "2018-10-08T09:46:37.694Z",
    "asserted_date": "2018-10-08T09:46:37.694Z",
    "inserted_at": "2018-08-02T10:45:16.000Z",
    "updated_at": "2018-08-02T10:45:16.000Z",
    "stage": {
      "summary": {
        "coding": [
          {
            "system": "eHealth/condition_stages",
            "code": "14803004"
          }
        ]
      }
    },
    "evidences": [
      {
        "codes": [
          {
            "coding": [
              {
                "system": "eHealth/ICPC2/reasons",
                "code": "169068008"
              }
            ]
          }
        ],
        "details": [
          {
            "identifier": {
              "type": {
                "coding": [
                  {
                    "system": "eHealth/resources",
                    "code": "observation"
                  }
                ]
              },
              "value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
            },
            "display_value": "null"
          }
        ]
      }
    ]
  },
  "meta": {
    "code": 200,
    "url": "http://example.com/resource",
    "type": "object",
    "request_id": "req-adasdoijasdojsda"
  }
}

...

Only for active MPI record can be created medication request!

	Response code	HTTP Status code	Message	Internal name	Description
1	Базові
2		200
3		401		Access token validation failed
4	401	Unauthorized	Помилка підтвердження		5	403	Invalid scope
6	1000	404	Composition not found	COMPOSITION_NOT_FOUND_404	Не знайдено медичний висновок
7	Специфічні

8	422	5	Специфічні
6

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

headings	ID ТМ, Статус
cql	label = "tr-mis"

...

Versions Compared

Old Version 3

New Version 4

Key

Logic

Configuration parameters

Dictionaries

Input parameters

Request structure

Request data validation

Authorize

Response structure examples

Post-processing processes

Technical modules where the method is used

Page Comparison

Versions Compared

Old Version 3

New Version 4

Key

Logic

Configuration parameters

Dictionaries

Input parameters

Request structure

Request data validation

Authorize

Response structure examples

Post-processing processes

Technical modules where the method is used