...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

This web service allows to create a new episode of care for a patient.

Specification

Apiary

Validation

...

Purpose

This method is used to create an episode of care.

Specification

Logic

This method is used to create an episode of care.

Request structure

See on Apiary

Example:

{
  "id": "90a9e15b-b71b-4caf-8f2e-ff247e8a5600",
  "type": {
    "system": "eHealth/episode_types",
    "code": "primary_care"
  },
  "status": "active",
  "name": "Діабет 2018",
  "managing_organization": {
    "identifier": {
      "type": {
        "coding": [
          {
            "system": "eHealth/resources",
            "code": "legal_entity"
          }
        ]
      },
      "value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
    }
  },
  "period": {
    "start": "2018-08-02T10:45:16.000Z"
  },
  "care_manager": {
    "identifier": {
      "type": {
        "coding": [
          {
            "system": "eHealth/resources",
            "code": "employee"
          }
        ]
      },
      "value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
    }
  }
}

Authorize

• Verify the validity of access token

  Return

  • return 401 (“Invalid access token”) in case validation fails

• Verify token is not expired

  • in case of error

    return 401 

...

• • - return 401 (“Invalid access token”)

• Check user scopes in order to perform this action (scope = 'episode:write')

  • Return 403 in case invalid scope(s)

Validate declaration

In order to perform this action, primary doctor must have active declaration with the patient

• Validate declaration using Method
  • in case of error 403

• If BLOCK_UNVERIFIED_PARTY_USERS is true, then check user's party data match following condition: verification_status != NOT_VERIFIED or (verification_status = NOT_VERIFIED and updated_at <= current_date - UNVERIFIED_PARTY_PERIOD_DAYS_ALLOWED):

  • in case not match - return 403 ("Access denied. Party is not verified")

Headers

• Content-Type:application/json

• Authorization:Bearer {{access_token}}

• API-key:{{secret}}

Request data validation

1. Validate patient status

   1. Medical_data status for this patient must be in "active" status

      1. in case of error return 409 - "Patient is not active"

2. Validate episode id is unique

   1. $.id is unique 

      1.  in case of error return 422 - "Episode with such id already exists"

3. Validate that episode number is unique 

   1. $.number is unique 

      1. in case of error return 409 - "Episode with such number already exists. Episode number must be unique"

4. Validate request according to JSON Schema LINK

   1. in case of error return 422

5. Validate type

...

1. 1. according to legal entity type: Medical Events Dictionaries and configurations#legal_entity_episode_types

      1. in case of error return 409 "Episode type <type> is forbidden for your legal entity type"

   2. according to employee type: Medical Events Dictionaries and configurations#employee_episode_types

      1. in case of error return 409 "Episode type <type> is forbidden for your employee type"

2. Validate status= "active" - resolved by JSON schema

3. Validate managing_organization

   1. Only one item is allowed in coding array

      1. in case of error return 422 "Only one item is allowed in "coding" array " 

   2. $.managing_organization.identifier.type.coding.[0].code = "legal_entity"

      1. in case of error return 422 "Only legal_entity could be submitted as a managing_organization"

   3. $.managing_organization.identifier.value = token.client_id

      1. in case of error return

...

1. 1. 1. 422 "Managing_organization does not correspond to user`s legal_entity"

   2. $.managing_organization.identifier.type.coding.[0].system = "eHealth/resources"

      1. in case of error return 422 "Submitted system is not allowed for this field"

2. Validate period

   1. $.period.start <= current_date

      1. in case of error return 422 - "Start date of episode must be in past"

   2. $.period.end is absent

      1. in case of error return 422 - "End date of episode could not be submitted on creation"

3. Validate care_manager

   1. $.care_manager.identifier.type.coding.[0].code = "employee"

      1. in case of error return 422 "Only employee could be submitted as a care_manager"

   2. $.care_manager.identifier.type.coding.[0].system = "eHealth/resources"

      1. in case of error return 422 "Submitted system is not allowed for this field"

...

1. 2. PRM.employee.type =

...

1. 1. value from list of employee_types in configuration:
      ALLOWED_EPISODE_CARE_MANAGER_EMPLOYEE_TYPES

      1. in case of error return 409 "Employee submitted as a care_manager is not

...

1. 1. 1. in the list of allowed employee types" 

      2. PRM.employee.status= "active"

         1. in case of error return 409 "

...

1. 1. 1. 1. Employee submitted as a care_manager is not active"

      2. PRM.employee.legal_entity = token.client_id

         1. in case of error return 409 "User can create an episode only for the doctor that works for the same legal_entity"

   2. $.care_manager.identifier.value belongs to one of the user’s employee

      1. in case of error return 422 "Employee is not care manager of episode"

Error example:

...

Processing

1. Set episodes.care_manager.display_value = ((PRM.parties.first_name + PRM.parties.second_name  + PRM.parties.last_name) where PRM.parties.id == PRM.employees.party_id) where PRM.employees.id== $.care_manager.identifier.value

2. Set episodes.managing_organization.display_value = PRM.legal_entities.public_name where ( PRM.legal_entities.id == $.managing_organization.identifier.value) 

3. Create a record in status_hstr

Response structure

See on Apiary

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"
  }
}

{
  "meta": {
    "code": 404,
    "url": "http://example.com/resource",
    "type": "object",
    "request_id": "req-adasdoijasdojsda"
  },
  "error": {
    "type": "NOT_FOUND",
    "message": "Patient not found"
  }
}

Post-processing processes

API paragraph not found

HTTP status codes