Table of Contents

minLevel	1
maxLevel	3

Required parameters are marked with "*"

...

Purpose*

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

Specification*

...

Project Name

...

COVID-certificate

...

Project abreviation

...

SVC

...

Developer

...

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

...

Project Manager

...

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

...

Tech Lead

...

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

...

Product Owner

...

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

...

Вusiness analyst

...

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

...

Status

Status

colour	Green
title	APPROVED

...

Version

...

1.0

...

Date of release

...

22 Jun 2022

...

Link

...

https://ehealthmedicaleventsapi.docs.apiary.io/#reference/medical-events/procedures/get-procedures-by-id

...

Resource

...

/api/patients/{{patient_id}}/procedures/{{id}}

...

Scope

...

procedure:read

...

Components

...

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

...

Microservices

...

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

...

Protocol type

...

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

...

Request type

...

GET

...

Sync/Async

...

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

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 details.
Query returns single procedure by person (mpi id) and procedure identifier.
Filtration with forbidden group items is worked here. So NHS employee should have an approval from patient to see a procedure with forbidden elements.
Query should be invoked only if /wiki/spaces/AFC/pages/16680386561 for monitoring exists for current user and corresponding patient (ABAC rule_-2).

Input parameters

...

Input parameter

...

Values

...

Type

...

Description

...

Example

...

id

...

String

...

Unique procedure identifier

...

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

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

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

...

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

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

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

...

Table of Contents

minLevel	1
maxLevel	3

Purpose

This method is designed to return a procedure record by id.

Specification

Page Properties

Link	https://medicaleventsmisapi.docs.apiary.io/#reference/medical-events/procedures/get-procedures-by-id
Resource	/api/patients/{{patient_id}}/procedures/{{id}}
Scope	procedure:read
Components	Episode of Care
Microservices	API paragraph not found
Protocol type	REST
Request type	GET
Sync/Async	Async
Public/Private/Internal	Public

Input parameters

Input parameter	Values	Type	Description	Example
id		String	Unique procedure identifier	`7075e0e2-6b57-47fd-aff7-324806efa7e5`

Request structure

See on Apiary

Authorize

Request to process the request using a token in the headers

Headers*

Наприклад:

Content-Type:application/json
Authorization:Bearer mF_9.B5f-4.1JqM
api-key:aFBLVTZ6Z2dON1V

Validate request*

API paragraph not found

Request data validation*

Validate legal entity

Extract client_id from token.
Check client 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 = 'procedure:practical_monitor')
- in case of error - return 403 (“Your scope does not allow to access this resource. Missing allowances: procedure: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 procedure Id submitted.
- return 404 (“not found“) in case not exist or not related to the person
- return 403 (“Access denied“) in case procedure 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*

Get procedure by id and patient_id
Render detailed procedure data according to schema.

...

read')
- Return 403 in case invalid scope(s)

Headers

Content-Type:application/json
Authorization:Bearer {{access_token}}
API-key:{{secret}}

Request data validation

Access to the resource is also managed by ABAC module.

Validation

validate person_id
1. validate $person_id is existing ID in mpi.persons.id And person is_active=true and status='active
  1. in case error return 404, "Person not found"

Processing

API paragraph not found

Response structure

See on Apiary

Example:

Expand

title	Response example

Code Block

{
  "id": "7075e0e2-6b57-47fd-aff7-324806efa7e5",
  "based_on": {
    "identifier": {
      "type": {
        "coding": [
          {
            "system": "eHealth/resources",
            "code": "service_request"
          }
        ]
      },
      "value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
    },
    "display_value": "null"
  },
  "paper_referral": {
    "requisition": "1111-2222-3333-4444",
    "requester_legal_entity_name": "Some clinic",
    "requester_legal_entity_edrpou": "12345678",
    "requester_employee_name": "John",
    "service_request_date": "2018-10-08",
    "note": "Some notes"
  },
  "status": "COMPLETED",
  "status_reason": {
    "coding": [
      {
        "system": "eHealth/procedure_status_reasons",
        "code": "default"
      }
    ]
  },
  "code": {
    "identifier": {
      "type": {
        "coding": [
          {
            "system": "eHealth/resources",
            "code": "service"
          }
        ]
      },
      "value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
    },
    "display_value": "null"
  },
  "performed_date_time": "2018-08-02T10:55:00.000Z",
  "recorded_by": {
    "identifier": {
      "type": {
        "coding": [
          {
            "system": "eHealth/resources",
            "code": "employee"
          }
        ]
      },
      "value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
    },
    "display_value": "Шевченко Олесь Вікторович"
  },
  "primary_source": true,
  "performer": {
    "identifier": {
      "type": {
        "coding": [
          {
            "system": "eHealth/resources",
            "code": "employee"
          }
        ],
        "text": "Галина Олександрівна"
      },
      "value": "97d57238-ffbe-4335-92ea-28d4de117ea2"
    }
  },
  "division": {
    "identifier": {
      "type": {
        "coding": [
          {
            "system": "eHealth/resources",
            "code": "division"
          }
        ]
      },
      "value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
    },
    "display_value": "null"
  },
  "managing_organization": {
    "identifier": {
      "type": {
        "coding": [
          {
            "system": "eHealth/resources",
            "code": "legal_entity"
          }
        ]
      },
      "value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
    },
    "display_value": "Перше відділення обласної лікарня №1"
  },
  "reason_references": [
    {
      "identifier": {
        "type": {
          "coding": [
            {
              "system": "eHealth/resources",
              "code": "condition"
            }
          ]
        },
        "value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
      }
    }
  ],
  "outcome": {
    "coding": [
      {
        "system": "eHealth/procedure_outcomes",
        "code": "default_outcome"
      }
    ]
  },
  "note": "Додаткова інформація по процедурі",
  "category": {
    "coding": [
      {
        "system": "eHealth/procedure_categories",
        "code": "default"
      }
    ]
  },
  "encounter": {
    "identifier": {
      "type": {
        "coding": [
          {
            "system": "eHealth/resources",
            "code": "encounter"
          }
        ]
      },
      "value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
    },
    "display_value": "null"
  },
  "explanatory_letter": "Процедура була відмінена у зв'язку з помилкою при виборі пацієнта",
  "origin_episode (Reference_response, optional)": {
    "identifier": {
      "type": {
        "coding": [
          {
            "system": "eHealth/resources",
            "code": "episode"
          }
        ]
      },
      "value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
    }
  },
  "complication_details": [
    {
      "identifier": {
        "type": {
          "coding": [
            {
              "system": "eHealth/resources",
              "code": "condition"
            }
          ]
        },
        "value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
      },
      "display_value": "null"
    }
  ]
}

Expand

title	Response example

Code Block

{
  "meta": {
    "code": 404,
    "url": "http://example.com/resource",
    "type": "object",
    "request_idid": "req-adasdoijasdojsda"
  },
  "error": {
    "type": "req-adasdoijasdojsda"
NOT_FOUND",
 },   "errormessage": "Patient {not found"
   "type": "NOT_FOUND",
    "message": "Patient not found"
  }
}}
}

Return response according to json schema
Return procedures where
1. managing_organization.identifier.value=$Client_id
2. consumer_id is a doctor with active declaration for current patient ($.person_id)

Post-processing processes

...

API paragraph not found

HTTP status codes

...

Page Properties
HTTP status code
Message
What caused the error
200200

404401
Access denied

403
Invalid scopes

404
Patient not found

Versions Compared

Old Version 3

New Version Current

Key

Required parameters are marked with "*"

Purpose*

Specification*

Logic*

Preconditions

Key points

Input parameters

Request structure*

Authorize*

Purpose

Specification

Input parameters

Request structure

Authorize

Headers*

Validate request*

Request data validation*

Validate legal entity

Validate request

Processing*

Headers

Request data validation

Validation

Processing

Response structure

Post-processing processes

API paragraph not found

HTTP status codes

Page Properties
HTTP status code
Message
What caused the error
200200

404401
Access denied

403
Invalid scopes

404
Patient not found

Page Comparison

Versions Compared

Old Version 3

New Version Current

Key

Required parameters are marked with "*"

Purpose*

Specification*

Logic*

Preconditions

Key points

Input parameters

Request structure*

Authorize*

Purpose

Specification

Input parameters

Request structure

Authorize

Headers*

Validate request*

Request data validation*

Validate legal entity

Validate request

Processing*

Headers

Request data validation

Validation

Processing

Response structure

Post-processing processes

API paragraph not found

HTTP status codes

Page PropertiesHTTP status codeMessageWhat caused the error 200200 404401Access denied 403Invalid scopes 404Patient not found

Page Properties
HTTP status code
Message
What caused the error
200200

404401
Access denied

403
Invalid scopes

404
Patient not found