Versions Compared

Version Old Version 1 New Version Current
Changes made by

Serhii Boldin (SoE eHealth) (Unlicensed)

Serhii Boldin (SoE eHealth) (Unlicensed)

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents
minLevel1
maxLevel3

Required parameters are marked with "*"

...

Purpose

API paragraph not found”.

...

This WS allows to get detailed condition info from Admin panel.

Specification

...

@Єлизавета Гессен-Дармштадська
Page Properties

Project Name

COVID-certificate

Project abreviation

SVC

Developer

Розробник методу API. Наприклад, Edenlab

Project Manager

Tech Lead

@Іоанн Воїнов

Product Owner

@Нікодім Святогорцев

Вusiness analyst

@Пантелеймон Нікомедійський

Status

Status
colourGreen
titleAPPROVED

Version

1.0

Date of release

Link

https://ehealthmedicaleventsapimedicaleventsmisapi.docs.apiary.io/#reference/medical-events/patient-summary/get-condition-by-id

Resource

/api/patients/{{patient_id}}/summary/conditions/{{id}}

Scope

patient_summary:read

Components

Зазначається перелік бізнес компонентів, які використовують цей метод, наприклад: ePrescriptionPatient Summary

Microservices

Перелік мікросервісів, які використовує метод API. Наприклад: Auth, ABACAPI paragraph not found

Protocol type

Тип протоколу, який використовується запитом, наприклад: SOAP | REST

Request type

GET

Sync/Async

Метод є синхронним чи асинхронним?

...

Async

Public/Private/Internal

Public

Logic

API paragraph not found

Preconditions

Key points

...

This is a graphQl query used in Administration panel only

...

Only authenticated and authorized NHS employee with appropriate scope can get condition details.

...

Query returns single condition by person (mpi id) and condition identifier.

...

Filtration with forbidden group items is worked here. So NHS employee should have an approval from patient to see a condition with forbidden elements.

...

Input parameters

Input parameter

Values

Type

Description

Example

patient_id

String

Unique patient identifier

7a489bbd-d8e2-48d9-92fd-fcf0102f7b08

id

String

Unique condition identifier

340b86fd-23f3-4a33-94c5-8ec19d116c33

Request structure

...

API paragraph not found

Authorize

...

Verify the validity of access token

  • in case of error - return 401 (“Invalid access token”) in case of validation fails

Verify that token is not expired

...

...

Check user scopes in order to perform this action (scope = 'condition:practical_monitor')

  • return 403 (“Your scope does not allow to access this resource. Missing allowances: condition:practical_monitor”) in case of invalid scope(s)

...

Check user has access to resource according to @rule_-2 in ABAC

  • return 403 (“Access denied. Justification required“) in case of error

Request to process the request using a token in the headers

Headers

...

Наприклад:

  • Content-Type:application/json

  • Authorization:Bearer mF_9.B5f-4.1JqM

...

Request data validation

API paragraph not found

Request data validation*

Validate legal entity

  • Extract client_id from token.

  • Check client scopes in order to perform this action (scope = 'condition:practical_monitor')

    • in case of error - return 403 (“Your scope does not allow to access this resource. Missing allowances: condition:practical_monitor”)

  • Check legal entity status (status = ACTIVE)

    • In case of error - return 409 ('client_id refers to legal entity that is not active')

Validate request

  • Check required personId submitted.

    • return 404 (“not found“) in case not exist

  • Check required condition Id submitted.

    • return 404 (“not found“) in case not exist or not related to the person

    • return 403 (“Access denied“) in case condition has forbidden group items. Take into account approvals granted to NHS employee on forbidden groups (look at Medical Events filtration by Forbidden groups for details)

Processing*

Service logic

  1. Get condition by id and patient_id

  2. Render detailed condition data according to schema

...

Processing

API paragraph not found

Response structure

See on Apiary

Example:

Expand
titleResponse 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"
  }
}

Post-processing processes

...

API paragraph not found

HTTP status codes

...

Page Properties

HTTP status code

Message

What caused the error

 200

 

 

...