Note

Сторінка знаходиться в процесі розробки. Інформація на ній може бути застарілою.

...

eHealth/care_plan_activity_outcomes

Input parameters

Input parameter

Mandatory

Type

Description

Example

1

patient_id

 

String

MPI identifier of the patient

7c3da506-804d-4550-8993-bf17f9ee0402

2

care_plan_id

 

String

Care Plan identifier

7c3da506-804d-4550-8993-bf17f9ee0403

3

id

 

String

activity identifier

7c3da506-804d-4550-8993-bf17f9ee0404

Request structure

See on API-specification

...

Headers

Request data validation

Authorize

  1. Verify the validity of access token

    1. Return (401, 'Invalid access token') in case of validation fails

  2. Verify that token is not expired

    1. in case of error - return (401, 'Invalid access token')

  3. Check user scopes in order to perform this action (scope = 'care_plan:write')

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

...

  1. if activity kind = medication_request:

    1. Check there is no medication request requests in status NEW based on the activity

      1. in case of error - return 409 (Unable to complete activity with new Medication Request requests).

    2. Check there is no medication requests in status ACTIVE based on the activity

      1. in case of error - return 409 (Unable to complete activity with active Medication requests).

  2. if activity kind = service_request:

    1. Check availability of service requests with status = active. If such service requests exist, then needs to check availability of service requests with program_processing_status:

      1. if program_processing_status is undefined (NULL), then return error 409 (Unable to complete activity with Service requests in status <status value> and program processing status is NULL or not completed)

      2. if program_processing_status is defined, then needs to check that program_processing_status = complete. Otherwise, return error 409 (Unable to complete activity with Service requests in status <status value> and program processing status is NULL or not completed)

    2. Check all related service requests in final status: completed, recalled or entered_in_error.

      1. in case at least one is active - return error 409 (Unable to complete activity with Service requests in active status)

Validate outcome

Validate value in the field $.outcome_codeable_concept, required

...

Expand
titleResponse Example
Code Block
languagejson
{
  "data": {
    "status": "pending",
    "eta": "2018-08-02T10:45:16.000Z",
    "links": [
      {
        "entity": "job",
        "href": "/Jobs/NBXk9EyErUZv1RhXgyvgg"
      }
    ]
  },
  "meta": {
    "code": 202,
    "url": "http://example.com/resource",
    "type": "object",
    "request_id": "req-adasdoijasdojsda"
  }
}

HTTP status codes

Response code

HTTP Status code

Message

Internal name

Description

1

Базові

2

201

 use payload from response

 sync

3

 202

 use Get job details to get processing result. Response payload will be returned in the job details

 async: default method

4

401

Invalid access token

  • validation fails

  • token is expired

5

403

Access denied

  • invalid scope(s)

  • employee has no Approval on write

6

403

Your scope does not allow to access this resource. Missing allowances: care_plan:write

7

404

not found

The submitted activity is not related to the Patient Care Plan

8

409

client_id refers to legal entity with type that is not allowed to create medical events transactions

Validation error

9

409

Invalid activity status

10

409

Legal entity must be ACTIVE

11

409

Unable to cancel activity with new Medication Request requests

12

409

Unable to cancel activity with active Medication requests

13

409

Unable to complete activity with new Medication Request requests

14

409

Unable to cancel activity with Service requests in active status

15

422

value is not allowed in enum

Validation error

16

Специфічні

17

Post-processing processes

...