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

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-008-003-0282
Microservices (namespace)	ME
Component	Patient Summary
Component ID	COM-007-008
Link на API-специфікацію	https://medicaleventsmisapi.docs.apiary.io/#reference/medical-events/patient-summary/get-conditions
Resource	{{host}}/api/patients/{{patient_id}}summary/conditions
Scope	patient_summary:read
Protocol type	REST
Request type	GET
Sync/Async	SyncAsync
Public/Private	Public

Purpose

This web service is designed to return conditions by episode_id or encouner_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

...

Configuration parameters

N/A (Not applicable)

Dictionaries

eHealth/resources - employee (parameter “asserter“ in response)
eHealth/report_origins (parameter “patient“ in response)
eHealth/resources - encounter (parameter “context“ in response)
eHealth/ICD10/condition_codes(parameter “code“ in response)
eHealth/condition_clinical_statuses (parameter “clinical_status“ in response)
eHealth/condition_verification_statuses (parameter “verification_status“ in response)
eHealth/condition_severities (parameter “severity“ in response)
eHealth/body_sites(parameter “body_sites“ in response)
eHealth/condition_stages(parameter “body_sites“ in response)
eHealth/ICPC2/reasons(parameter “evidences:codes“ in response)
eHealth/resources - observations (parameter “evidences:details“ 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
1 2

Request structure

See on API-specification

...

title	Example

	patient_id	M	String	Unique MPI patient identifier	`70a9e15b-b71b-4caf-8f2e-ff247e8a5677`
2	code		String	Condition code	`A20`
3	onset_date_time_from		String		`2017-01-01`
4	onset_date_time_to		String		`2017-01-01`
5	page		Number	Page number	`2`
6	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

See on Headers

Request data validation

Authorize

Request to process the request using a token in the headers

Validate token

Verify the validity of access token
- Return 401 in case validation fails
Verify token is not expired
- in case error return 401

Validate scopes

Check user scopes in order to perform this action (scope = 'condition:read')
1. Return 403 in case invalid scope(s)

Access to the resource is also managed by ABAC module

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

Expand

title	Example

Code Block

{
  "meta": {
    "code": 200,
    "url": "http://example.com/resource",
    "type": "object",
    "request_id": "req-adasdoijasdojsda"
  },
  "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"
            }
          ]
        }
      ]
    }
  ],
  "paging": {
    "page": 2,
    "page_size": 50,
    "total_entries": 1000,
    "total_pages": 20
  }
}

HTTP status codes

	Response code	HTTP Status code	Internal name
1	Базові
2		200	Response
3	Специфічні			4	401	Access token validation failed
4		401	Access token expired
5		403	Invalid scope
6		404	Patient not found
7	Специфічні

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)

Versions Compared

Old Version 5

New Version Current

Key

Properties of a REST API method document

Purpose

Logic

Configuration parameters

Dictionaries

Configuration parameters

Dictionaries

Input parameters

Headers

Request structure

Request structure

Headers

Request data validation

Authorize

Validate token

Validate scopes

Processing

Response structure examples

HTTP status codes

Post-processing processes

Technical modules where the method is used

Page Comparison

Versions Compared

Old Version 5

New Version Current

Key

Properties of a REST API method document

Purpose

Logic

Configuration parameters

Dictionaries

Configuration parameters

Dictionaries

Input parameters

Headers

Request structure

Request structure

Headers

Request data validation

Authorize

Validate token

Validate scopes

Processing

Response structure examples

HTTP status codes

Post-processing processes

Technical modules where the method is used