Required parameters are marked with "*"

Якщо інформації по відповідному параметру немає, потрібно зазначити: “API paragraph not found”.

Purpose*

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

Specification*

Link	https://ehealthmedicaleventsapi.docs.apiary.io/#reference/medical-events/patient-summary/get-procedure-by-id
Resource	/api/patients/{{patient_id}}/summary/procedures/{{procedure_id}}
Scope	patient_summary:read
Components	Зазначається перелік бізнес компонентів, які використовують цей метод, наприклад: ePrescription
Microservices	Перелік мікросервісів, які використовує метод API. Наприклад: Auth, ABAC
Protocol type	Тип протоколу, який використовується запитом, наприклад: SOAP \| REST
Request type	GET
Sync/Async	Метод є синхронним чи асинхронним?

Logic*

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

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
patient_id		String	Unique patient identifier	`e549c257-232e-4dab-9f1e-b2322cac3968`
procedure_id		String	Unique procedure 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
- 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
- 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*

Validate legal entity

Extract client_id from token.
Check client 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*

Service logic

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

Response structure*

See on Apiary

Example:

Response example

{
  "data": {
    "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"
      }
    ]
  },
  "meta": {
    "code": 200,
    "url": "http://example.com/resource",
    "type": "object",
    "request_id": "req-adasdoijasdojsda"
  }
}

Post-processing processes*