Versions Compared

Key

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

Purpose

This WS allows to get detailed procedure info from Admin panel.This WS method is designed to return records about procedures by patient_id or/and search_paramsa 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

Logic

API paragraph not foundThis method is designed to return a procedure record by id.

Input parameters

Input parameter

Values

Type

Description

Example

id

String

Unique procedure identifier

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

...

Request to process the request using a token in the headers

...

Наприклад:

  • Content-Type:application/json

  • Authorization:Bearer mF_9.B5f-4.1JqM

  • api-key:aFBLVTZ6Z2dON1V

Request data validation

Validate token

  • 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)

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.

...

Page Properties

HTTP status code

Message

What caused the error

 200200

 

 

 404401

Access denied

 

403

Invalid scopes

 

404

Patient not found