Versions Compared

Old Version 13

changes.mady.by.user Serhii.Matiushyn

Saved on

compared with

New Version Current

changes.mady.by.user Serhii.Matiushyn

Saved on

Key

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

...

https://e-health-ua.atlassian.net/wiki/spaces/EH/pages/583402009/Medical+Events+Dictionaries+and+configurations#ME_ALLOWED_TRANSACTIONS_LE_TYPES

Input parameters

Input parameter

Values

Type

Description

Example

patient_id

String

MPI identifier of the patient

7c3da506-804d-4550-8993-bf17f9ee0402

id

String

Care Plan identifier

7c3da506-804d-4550-8993-bf17f9ee0403

Filters

No

Dictionaries

eHealth/care_plan_categories

...

Expand
titleRequest example
Code Block
{
  "id": "90a9e15b-b71b-4caf-8f2e-ff247e8a5600",
  "based_on": {
    "identifier": {
      "type": {
        "coding": [
          {
            "system": "eHealth/resources",
            "code": "care_plan"
          }
        ]
      },
      "value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
    }
  },
  "part_of": {
    "identifier": {
      "type": {
        "coding": [
          {
            "system": "eHealth/resources",
            "code": "care_plan"
          }
        ]
      },
      "value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
    }
  },
  "category": {
    "coding": [
      {
        "system": "eHealth/care_plan_categories",
        "code": "diabetics"
      }
    ]
  },
  "title": "Diabetics health plan",
  "description": "Some description of the care plan",
  "period": {
    "start": "2018-08-02T10:45:16.000Z",
    "end": "2018-08-02T11:00:00.000Z"
  },
  "supporting_info": [
    {
      "identifier": {
        "type": {
          "coding": [
            {
              "system": "eHealth/resources",
              "code": "episode_of_care"
            }
          ]
        },
        "value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
      }
    }
  ],
  "note": "Some notes",
  "intent": "order",
  "encounter": {
    "identifier": {
      "type": {
        "coding": [
          {
            "system": "eHealth/resources",
            "code": "encounter"
          }
        ]
      },
      "value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
    }
  },
  "addresses": [
    {
      "coding": [
        {
          "system": "eHealth/ICD10_AM/condition_codes",
          "code": "E11.9"
        }
      ]
    }
  ],
  "author": {
    "identifier": {
      "type": {
        "coding": [
          {
            "system": "eHealth/resources",
            "code": "employee"
          }
        ]
      },
      "value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
    }
  },
  "contributor": [
    {
      "identifier": {
        "type": {
          "coding": [
            {
              "system": "eHealth/resources",
              "code": "employee"
            }
          ]
        },
        "value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
      }
    }
  ],
  "terms_of_service": {
    "coding": [
      {
        "system": "PROVIDING_CONDITION",
        "code": "INPATIENT"
      }
    ]
  },
  "inform_with": {
    "auth_method_id": "cc949559-5dfe-420f-ac05-065e443b2cc6"
  },
  "status": "active",
  "subject": {
    "identifier": {
      "type": {
        "coding": [
          {
            "system": "eHealth/resources",
            "code": "patient"
          }
        ]
      },
      "value": "7c3da506-804d-4550-8993-bf17f9ee0403"
    }
  },
  "status_history": [
    {
      "status": "active",
      "status_reason": {
        "coding": [
          {
            "system": "eHealth/care_plan_cancel_reasons",
            "code": "some code"
          }
        ]
      },
      "inserted_at": "2018-08-02T10:45:16.000Z",
      "inserted_by": "e1453f4c-1077-4e85-8c98-c13ffca0063e"
    }
  ],
  "requisition": "0123-4567-89AB-CEIK",
  "inserted_at": "2017-04-20T19:14:13Z",
  "inserted_by": "e1453f4c-1077-4e85-8c98-c13ffca0063e",
  "updated_at": "2017-04-20T19:14:13Z",
  "updated_by": "2922a240-63db-404e-b730-09222bfeb2dd",
  "status_reason": {
    "coding": [
      {
        "system": "eHealth/care_plan_cancel_reasons",
        "code": "some code"
      }
    ]
  }
}

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

Headers

Наприклад:

Content-Type:application/json
Authorization:Bearer

...

{{access_token}}
API-key:{{mis_client_secret}}

Request data validation and processing

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 ('Action is not allowed for the legal entity type')

Validate User

  1. Extract user_id from token.

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

    1. is specified as Author of the Care plan and 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 not specified as author of the care plan, or has no Approval on write

Validate data consistency

  1. Ensure that submitted Care plan relates to the Patient (from URL)

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

Validate Digital Sign

  1. Check DS is valid and not expired

  2. Validate that DS belongs to the user

    1. Check that DRFO from DS and user's party.tax_id matches

      1. in case of error - return 409 (“Signer DRFO doesn't match with requester tax_id“)

Validate status transition

  1. Get Care plan by id

  2. Check status:

    1. Care plan status should be changed according to Care plan status model.

      1. Return 409 ('Care plan in status <cancelled/completed> cannot be cancelled') in case of error

Validate status reason

Validate value in the field $.status_reason, required

  1. Validate field type is codeable concept

  2. Check that codeable concept refers to eHealth/care_plan_cancel_reasons dictionary

  3. Validate value within dictionary specified above

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

Validate activities

  1. Get Care plan activities

  2. Check Care plan has no activities or all activities has final status. 

    1. Return 409 ('Care plan has unfinished activities') in case if found at least one activity not in final status

Validate content

Signed content must match with Care plan in DB in order to be changed

...

Expand
titleResponse example
Code Block
{
  "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"
  }
}

...

API paragraph not found
HTTP status codes
 Page Properties
HTTP status code
Message
What caused the error
 201
 use payload from response
 sync
 202
 use Get job details to get processing result. Response payload will be returned in the job details
 async: default method
401
Invalid access token
  • validation fails
  • token is expired
403
  • Your scope does not allow to access this resource. Missing allowances: care_plan:write
  • Access denied
  • invalid scope(s)
  • employee has no Approval on write
404
not found
The submitted Care Plan is not related to the Patient
409
  • Legal entity must be ACTIVE
  • Action is not allowed for the legal entity type
  • Care plan in status <cancelled/completed> cannot be cancelled
  • Care plan has unfinished activities
  • Signer DRFO doesn't match with requester tax_id
Validation error
422
  • Signed content doesn't match with previously created care plan
  • value is not allowed in enum
Validation error