Versions Compared

Key

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

...

Page Properties

Link

https://medicaleventsmisapi.docs.apiary.io/#reference/medical-events/immunization/get-immunization-by-id

Resource

/api/patients/{{patient_id}}/immunizations/{{immunization_id}}

Scope

immunization:read

Components

Episode of Care

Microservices

API paragraph not found

Protocol type

REST

Request type

GET

Sync/Async

Async

Public/Private/Internal

Public

Logic

...

Input parameters

Input parameter

Values

Type

Description

Example

patient_id

String

Unique patient identifier

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

immunization_id

String

Unique immunization identifier

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

Request structure

API paragraph not foundSee on Apiary

Authorize

Request to process the request using a token in the headers

Headers

Наприклад:

  • Content-Type:application/json

  • Authorization:Bearer mF_9.B5f-4.1JqM

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 = 'immunization: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

...

HTTP status code

Message

What caused the error

 200

 

 

401

 

Access token validation failed

403

 

Invalid scope