Versions Compared

Key

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

...

Page Properties
idAPI_Specification

Link

https://ehealthmedicaleventsapi.docs.apiary.io/#reference/medical-events/clinical-impression/get-clinical-impression-by-id

Resource

/api/patients/{{patient_id}}/clinical_impressions/{{clinical_impression_id}}

Scope

clinical_impression:read

Components

Microservices

Protocol type

REST

Request type

GET

Sync/Async

Async

Public/Private/Internal

Public

...

Input parameter

Values

Type

Description

Example

patient_id

String

Unique patient identifier

e549c257-232e-4dab-9f1e-b2322cac3968

clinical_impression_id

String

Unique clinical impression identifie

340b86fd-23f3-4a33-94c5-8ec19d116c33

Request structure

...

See on Apiary

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

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

Access to the resource is also managed by ABAC module

Headers

Наприклад:

  • Content-Type:application/json

  • Authorization:Bearer mF_9.B5f-4.1JqM{{access_token}}

  • API-key:{{secret}}

Request data validation

Validate Patient

...

Page Properties
idAPI_HTTP status codes

HTTP status code

Message

What caused the error

 200

 

 

401

 

Access token validation failed

403

 

Invalid scope

404

 not found