Versions Compared

Old Version 1

changes.mady.by.user Serhii Boldin (SoE eHealth)

Saved on

compared with

New Version Current

changes.mady.by.user Anastasiia Prokhorova (SoE eHealth)

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
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 conditions details in episode context [API-007-004-003-0251]

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-0251

Microservices (namespace)

ME

Component

EDP

Component ID

COM-007-004

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

https://medicaleventsmisapi.docs.apiary.io/#reference/medical-events/episode-of-care/get-conditions-details-in-episode-context

Resource

{{host}}/api/patients/{{patient_id}}/episodes/{{episode_id}}/conditions/{{condition_id}}

Scope

episode:read

Protocol type

REST

Request type

GET

Sync/Async

Sync

Public/Private

Public

Purpose

This web service is designed to return conditions details by episode_id.

Logic

N/A

Configuration parameters

N/A

Dictionaries

N/A

Input parameters

Input parameter

Mandatory

Type

Description

Example

1

patient_id

 

String

Patient identifier

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

2

episode_id

 

String

Episode identifier

a10aeafb-0df2-4091-bc83-f07e92a100ae

3

condition_id

 

String

Condition identifier

7075e0e2-6b57-47fd-aff7-324806efa7e5

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 = 'condition:read')
    • Return 403 in case invalid scope(s)
Processing
N/A
Response structure examples
See on API-specification 
 Expand
titleExample
 Code Block
languagejson
{
  "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"
  }
}
HTTP status codes
Response code
HTTP Status code
Message
Internal name
Description
1
Базові
2
200
 
 
3
401
 
Access token validation failed
4
403
 
Invalid scope
5
Специфічні
6
Post-processing processes
N/A
Technical modules where the method is used
 Page Properties Report
headingsID ТМ, Статус
cqllabel = "tr-mis"