Versions Compared

Key

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

Purpose

API paragraph not foundThis web service is designed to return allergy intolerances info by episode_id.

Specification

Page Properties

Link

https://medicaleventsmisapi.docs.apiary.io/#reference/medical-events/episode-of-care/get-allergy-intolerances-in-episode-context

Resource

/api/patients/{{patient_id}}/episodes/{{episode_id}}/allergy_intolerances

Scope

episode: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

patient_id

String

Patient identifier

70a9e15b-b71b-4caf-8f2e-ff247e8a5677

episode_id

String

Episode identifier

a10aeafb-0df2-4091-bc83-f07e92a100ae

code

String

227493005

onset_date_time_from

String

1990-01-01

onset_date_time_to

String

2000-01-01

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

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

    • Return 403 in case invalid scope(s)

Headers

Наприклад:

  • Content-Type:application/json

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

  • API-key:aFBLVTZ6Z2dON1V{{secret}}

Request data validation

API paragraph not found

...

HTTP status code

Message

What caused the error

 200

 

 

401

 

Access token validation failed

403

 

Invalid scope