ЕСОЗ - публічна документація

[DRAFT] Get Procedure contexts [API-007-008-012-0300]

Owned by Anzhela Kovalenko (SoE eHealth)
Dec 25, 2024
2 min read

Сторінка знаходиться в процесі розробки. Інформація на ній може бути застарілою.

 

https://e-health-ua.atlassian.net/wiki/spaces/EN/pages/17591304241 (remove the link block before publishing the document)

Properties of a REST API method document

Document type

Метод REST API

Document title

[DRAFT] Get Procedure contexts [API-007-008-012-0300]

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-012-0300

Microservices (namespace)

ME

Component

Patient Summary

Component ID

COM-007-008

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

https://medicaleventsmisapi.docs.apiary.io/#reference/medical-events/procedures/get-procedure-contexts

Resource

{{host}}/api/patients/{{patient_id}}/procedures/{{procedure_id}}/context

Scope

medical_event_context:read

Protocol type

REST

Request type

GET

Sync/Async

Async

Public/Private

Public

Purpose

This method allows to get contexts of Procedure in order to create approval on episode and receive access to other medical events.

Logic

Service returns contexts (episode and origin_episode), procedure based on:

Configuration parameters

N/A

Dictionaries

N/A

Input parameters

Input parameter

Mandatory

Type

Description

Example

Input parameter

Mandatory

Type

Description

Example

1

patient_id

 

String

Patient identifier

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

2

procedure_id

 

String

Procedure identifier

a10aeafb-0df2-4091-bc83-f07e92a100ae

Request structure

See on API-specification

Headers

See on Headers

Request data validation

Authorize

  • Verify the validity of access token

    • 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 = 'medical_event_context:read')

    • Return (403, 'Your scope does not allow to access this resource. Missing allowances: medical_event_context:read') in case of invalid scope(s)

Validate Person

  • Get Person identifier from the URL

  • Check it exists in DB

    • Return 404 ('not_found') in case of error

Validate Encounter

  • Get Procedure identifier from the URL

    • Check it exists in DB

      • Return 404 ('not_found') in case of error

    • Check Procedure belongs to patient

      • Return 404 ('not_found') in case of error

Processing

N/A

Response structure examples

See on API-specification

{ "data": { "episode": { "identifier": { "type": { "coding": [ { "system": "eHealth/resources", "code": "episode" } ] }, "value": "7c3da506-804d-4550-8993-bf17f9ee0403" }, "display_value": "null" }, "origin_episode": { "identifier": { "type": { "coding": [ { "system": "eHealth/resources", "code": "episode" } ] }, "value": "7c3da506-804d-4550-8993-bf17f9ee0403" }, "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

Response code

HTTP Status code

Message

Internal name

Description

1

Базові

2

 

200

 

Response

 

3

Специфічні

Post-processing processes

N/A

Technical modules where the method is used

 

ЕСОЗ - публічна документація