ЕСОЗ - публічна документація

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 8 Current »

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

/wiki/spaces/EN/pages/17591304241 (remove the link block before publishing the document)

Properties of a REST API method document

Document type

Метод REST API

Document title

[DRAFT] Complete Care Plan Activity [API-007-001-002-0229]

Guideline ID

GUI-0011

Author

@

Document version

1

Document status

DRAFT

Date of creation

ХХ.ХХ.ХХХХ (дата фінальної версії документа – RC або PROD)

Date of update

ХХ.ХХ.ХХХХ (дата зміни версії)

Method API ID

API-007-001-002-0229

Microservices (namespace)

ME

Component

Care plan

Component ID

COM-007-001

Link на API-специфікацію

https://medicaleventsmisapi.docs.apiary.io/#reference/care-plan/complete-care-plan-activity/complete-care-plan-activity

Resource

{{host}}/api/patients/{{patient_id}}/care_plans/{{care_plan_id}}/activities/{{id}}/actions/complete

Scope

care_plan:write

Protocol type

REST

Request type

PATCH

Sync/Async

Async(def)/Sync

Public/Private

Public

Purpose

This method must be used to complete of existing activity from patient's Care plan.

Процеси роботи з планом лікування (care plan) | Завершення первинного призначення

Key points

  1. Status can be changed by employee who has an Approval granted by the patient on write Care plan resource.

  2. Activity completes without using DS.

  3. Activities status has changed in async way. The result of the job should be a link on the Care plan activity details.

Logic

This method must be used to complete of existing activity from patient's Care plan.

It can be processed in both sync and async methods depends on Server decision.

Service logic

  1. Update activity status to completed (update also updated_at, updated_by)

  2. Set outcome_codeable_concept

Configuration parameters

N/A

Dictionaries

eHealth/care_plan_activity_complete_reasons

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

 Example
{
  "outcome_codeable_concept": [
    {
      "coding": [
        {
          "system": "eHealth/care_plan_activity_outcomes",
          "code": "some code"
        }
      ]
    }
  ],
  "detail": {
    "status_reason": {
      "coding": [
        {
          "system": "eHealth/care_plan_activity_complete_reasons",
          "code": "some code"
        }
      ]
    }
  }
}

Headers

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)

Request to process the request using a token in the headers

Validate legal entity

  1. Extract client_id from token

  2. Check legal entity status is ACTIVE

    1. In case of error - return 409 (Legal entity must be ACTIVE)

  3. Check legal entity type in ME_ALLOWED_TRANSACTIONS_LE_TYPES config parameter

    1. in case of error - return 409 ('client_id refers to legal entity with type that is not allowed to create medical events transactions')

Validate User

  1. Extract user_id from token.

  2. Check user has an active and approved employee that:

    1. has an active Approval granted by the Patient on write the Care plan resource (care plan id from URL)

      1. Return 403 ('Access denied') in case employee has no Approval on write

Validate data consistency

  1. Ensure that submitted activity relates to the Patient and Care Plan (from URL)

    1. Return 404 (not found) in case of error

Validate status transition

  1. Get activity by id

  2. Check activity.detail.status: activity status should be changed according to activity status model.

    1. Return 409 (Invalid activity status) in case of error

Validate status reason

Validate value in the field $.detail.status_reason, required

  1. Validate field type is codeable concept

  2. Check that codeable concept refers to the eHealth/care_plan_activity_complete_reasons dictionary

  3. Validate value within dictionary specified above

    1. in case of error - return 422 ('value is not allowed in enum')

Validate related entities

  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

  1. Validate field type is array of codeable concepts

  2. Validate each value in array:

    1. it refers to the eHealth/care_plan_activity_outcomes dictionary

    2. value within dictionary

      1. in case of error - return 422 ('value is not allowed in enum')

Processing

N/A

Response structure examples

See on API-specification

 Response Example
{
  "data": {
    "id": "75a5d991-0bf7-476f-b3cf-bec73f044b2e",
    "author": {
      "identifier": {
        "type": {
          "coding": [
            {
              "system": "eHealth/resources",
              "code": "employee"
            }
          ]
        },
        "value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
      }
    },
    "care_plan": {
      "identifier": {
        "type": {
          "coding": [
            {
              "system": "eHealth/resources",
              "code": "care_plan"
            }
          ]
        },
        "value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
      }
    },
    "detail": {
      "kind": "service_request",
      "product_reference": {
        "identifier": {
          "type": {
            "coding": [
              {
                "system": "eHealth/resources",
                "code": "service"
              }
            ],
            "text": ""
          },
          "value": "97d57238-ffbe-4335-92ea-28d4de117ea3"
        }
      },
      "reason_code": [
        {
          "coding": [
            {
              "system": "eHealth/ICD10_AM/condition_codes",
              "code": "X85"
            }
          ]
        }
      ],
      "reason_reference": [
        {
          "identifier": {
            "type": {
              "coding": [
                {
                  "system": "eHealth/resources",
                  "code": "condition"
                }
              ]
            },
            "value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
          }
        }
      ],
      "goal": [
        {
          "coding": [
            {
              "system": "eHealth/care_plan_activity_goals",
              "code": "diabetes_treatment"
            }
          ]
        }
      ],
      "quantity": {
        "value": 13,
        "system": "MEDICATION_UNIT",
        "code": "MG",
        "unit": "мг"
      },
      "scheduled_timing": {
        "event": [
          "2018-08-02T10:45:16Z"
        ],
        "repeat": {
          "bounds_duration": {
            "value": 10,
            "comparator": ">",
            "unit": "доба",
            "system": "eHealth/ucum/units",
            "code": "day"
          },
          "count": 10,
          "count_max": 20,
          "duration": 15,
          "duration_max": 25,
          "duration_unit": "day",
          "frequency": 1,
          "frequency_max": 4,
          "period": 1,
          "period_max": 3,
          "period_unit": "day",
          "day_of_week": [
            "mon"
          ],
          "time_of_day": [
            "16:00:00"
          ],
          "when": [
            "WAKE"
          ],
          "offset": 20
        },
        "code": {
          "coding": [
            {
              "system": "TIMING_ABBREVIATION",
              "code": "Q4H"
            }
          ]
        }
      },
      "location": {
        "identifier": {
          "type": {
            "coding": [
              {
                "system": "eHealth/resources",
                "code": "division"
              }
            ]
          },
          "value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
        }
      },
      "performer": {
        "identifier": {
          "type": {
            "coding": [
              {
                "system": "eHealth/resources",
                "code": "employee"
              }
            ]
          },
          "value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
        }
      },
      "daily_amount": {
        "value": 13.5,
        "system": "MEDICATION_UNIT",
        "code": "MG",
        "unit": "мг"
      },
      "description": "Some activity description",
      "do_not_perform": false,
      "program": {
        "identifier": {
          "type": {
            "coding": [
              {
                "system": "eHealth/resources",
                "code": "medical_program"
              }
            ]
          },
          "value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
        }
      },
      "status": "completed",
      "status_reason": {
        "coding": [
          {
            "system": "eHealth/care_plan_activity_cancel_reasons",
            "code": "some code"
          }
        ]
      },
      "remaining_quantity": {
        "value": 12,
        "system": "MEDICATION_UNIT",
        "code": "MG",
        "unit": "мг"
      }
    },
    "outcome_reference": [
      {
        "identifier": {
          "type": {
            "coding": [
              {
                "system": "eHealth/resources",
                "code": "encounter"
              }
            ]
          },
          "value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
        }
      }
    ],
    "outcome_codeable_concept": [
      {
        "coding": [
          {
            "system": "eHealth/care_plan_activity_outcomes",
            "code": "some code"
          }
        ]
      }
    ]
  },
  "meta": {
    "code": 201,
    "url": "http://example.com/resource",
    "type": "object",
    "request_id": "req-adasdoijasdojsda"
  }
}HTTP status codes
 Response Example
{
  "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

N/A

Technical modules where the method is used

Generating page properties report...

  • No labels

ЕСОЗ - публічна документація