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

Skip to end of banner Go to start of banner

[DRAFT] Get Procedures by ID [API-007-009-001-0303]

Skip to end of metadata

Created by Serhii Boldin (SoE eHealth), last modified by Oksana Demchenko on Nov 26, 2024

Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

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

/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	[Document status] REST API [Назва методу] [ID методу]
Guideline ID	GUI-0011
Author	@
Document version	1
Document status	DRAFT
Date of creation	ХХ.ХХ.ХХХХ (дата фінальної версії документа – RC або PROD)
Date of update	ХХ.ХХ.ХХХХ (дата зміни версії)
Method API ID	API-007-009-001-0303
Microservices (namespace)	ME
Component	Procedure
Component ID	COM-007-009
Link на API-специфікацію	https://medicaleventsmisapi.docs.apiary.io/#reference/medical-events/procedures/get-procedures-by-id
Resource	{{host}}/api/patients/{{patient_id}}/procedures/{{id}}
Scope	procedure:read
Protocol type	REST
Request type	GET
Sync/Async	Sync
Public/Private	Public

Purpose

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

Logic

Description of the working algorithm of the API method and the interaction of services with each other add Service logic (if necessary)

Configuration parameters

Description of the configuration parameters that are used when processing a request in the system

Dictionaries

Provides a list of links to dictionaries that are available in Confluence

Input parameters

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

Request structure

See on Apiary

See on API-specification

Example

Headers

	Key	Value	Mandatory	Description	Example
1	Content-Type	application/json	M	Тип контенту	Content-Type:application/json
2	Authorization	Bearer {{access_token}}			Authorization:Bearer {{access_token}}
3	API-key	{{secret}}			API-key:{{secret}}

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 = 'procedure:read')
- Return 403 in case invalid scope(s)

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

A list of processes related to receiving, changing or transmitting data according to the logic defined in the REST API

Response structure examples

See on Apiary

See on API-specification

Response Example

{
  "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"
    }
  ]
}

Response Example

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

HTTP status codes

	Response code	HTTP Status code	Message	Internal name	Description
1	Базові
2		200
3		401	Access denied
4		403	Invalid scopes
5		404	Patient not found
6	Специфічні
7

Post-processing processes

Description of actions performed on data after processing

Technical modules where the method is used

List of pages describing technical modules where the method is used

No labels

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