Versions Compared

Key

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

Purpose

This WS metod is designed to return records about procedures by patient_id or/and search_params.

...

Page Properties

Link

https://medicaleventsmisapi.docs.apiary.io/#reference/medical-events/procedures/get-procedures-by-search-params

Resource

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

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 metod is designed to return records about procedures by patient_id or/and search_params.

Filters

Filter

Values

Type

Description

Example

patient_id

String

Unique patient identifier

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

episode_id

String

Unique episode identifier, look into episode in encounter

ef30f210-5328-4f48-bfe6-c7150d4737a6

status

Enum

status of procedure

COMPLETED

based_on

String

Unique service request identifier

ef30f210-5328-4f48-bfe6-c7150d4737a6

code

String

9075e0e2-6b57-47fd-aff7-324806efa7e6

managing_organization_id

String

Unique legal entity identifier

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

encounter_id

String

Unique encounter identifier

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

origin_episode_id

String

Unique episode identifier, look into episode in procedures.origin_episode

ef30f210-5328-4f48-bfe6-c7150d4737a6

...

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

Request data validation

...

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

HTTP status code

Message

What caused the error

200

 

 

401

Access denied

 

403

Invalid scopes

 

404

Patient not found