| Table of Contents | ||||
|---|---|---|---|---|
|
...
Returns care plan list filtered by submitted parameters withtin specified patient. List should be returned without activities.
Specification
| Page Properties | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Preconditions
Які передумови мають бути виконані системою/користувачем. Наприклад:
...
створений запис в MedicationRequest;
...
Logic
Returns care plan list filtered by submitted parameters within specified patient.
Input parameters
Filter
Values
Type
Description
Example
Input parameter | Values | Type | Description | Example | asyncJobId | String | Async Job Object ID |
|---|
Filters
patient_id | String | MPI identifier of the patient |
|
Filters
Filter | Values | Type | Description | Example |
|---|---|---|---|---|
period_date | Date | date within Care plan's period incleuding start and end dates |
| |
encounter_id | String | identifier of the encounter in Care plan |
| |
based_on | String | Care Plan identifier on which returned Care plans are based on |
| |
part_of | String | parent Care Plan identifier which includes returned Care plans |
| |
status | String | Care plan's status |
| |
page | Number | Page number |
| |
page_size | Number | A limit on the number of objects to be returned, between 1 and 100. Default: 50 |
|
Dictionaries
Потрібно вказати посилання на сторінки довідників, які використовує метод API
Request structure
API paragraph not foundeHealth/care_plan_categories
eHealth/ICD10_AM/condition_codes
PROVIDING_CONDITION
Authorize
Verify the validity of access token
Return (401, 'unauthorized') in case of validation fails
Verify that token is not expired
in case of error - return (401, 'unauthorized')
Check user scopes in order to perform this action (scope = 'care_plan:read')
Return (403, 'invalid scopes') in case of invalid scope(s)
Request to process the request using a token in the headers
...
Headers
...
:
Content-Type:application/json
Authorization:Bearer c2778f3064753ea70de870a53795f5c9
api-key:uXhEczJ56adsfh3Ri9SUkc4en
...
Post-processing processes
API paragraph not foundNo
HTTP status codes
| Page Properties | |||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|