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-immunizations-by-search-params

Resource

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

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

...

Filters

Filter

Values

Type

Description

Example

page

Number

Page number

2

page_size

Number

A limit on the number of objects to be returned, between 1 and 100. Default: 50

50

vaccine_code

String

wex-10

encounter_id

String

09dc3ed7-2169-45d8-8fa3-d918c6839bf9

episode_id

String

f48d1b6c-a021-4d6a-a5a4-aee93e152ecc

date_from

String

1990-01-01

date_to

String

2000-01-01

Request structure

API paragraph not foundSee on Apiary

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

    • Return 403 in case invalid scope(s)

 

Headers

Наприклад:

  • Content-Type:application/json

  • Authorization:Bearer {{access_token}}

  • API-key:{{secret}}

...