Versions Compared

Old Version 5

changes.mady.by.user Vitalii Shydlovskyi (SoE eHealth)

Saved on

compared with

New Version 6

changes.mady.by.user Vitalii Shydlovskyi (SoE eHealth)

Saved on

Key

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

Purpose

This WS allows to create Specimen entity by employees without submitting Encounter Data Package.

...

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

HTTP status codes

HTTP status code

Message

What caused the error

200

400 

 

Invalid signed content

 

401 

401

Invalid access token

 

403

403 

Access denied. Party is not verified

403 

Access denied. Party is deceased

403 

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

cancel 

 

422

  • Does not match the signer drfo

  • Invalid signed content

  • Specimen with such id is not found

  • Invalid specimen status

  • value is not allowed in enum

  • Service request not found

  • Service request is not active or in progress

    • Service request is used by another legal entity

    write

    404

    not found

    409

    Patient is not verified

  • User is not allowed to perform actions with an enity that belongs to another legal entity

  • Employee is not the one who registered the specimen, doesn't have an approval or required employee type

  • Specimen in status <status> cannot be cancelled'

    • 409 

    'client_id refers to legal entity that is not active'

    409 

    'Patient is not active'

    422 

    Service request expiration date must be greater than or equal to current date

  • User is not allowed to register a specimen for the employee

  • Invalid employee status

  • Employee doesn't belong to your legal entity

  • Specimen with id <id> already exists

    • Only one of the parameters must be present

    422 

    Service request is not active or in progress

    422 

    Identifier already exists in the specimen

    422 

    Legal entity with such id is not found

  • Managing_organization does not correspond to user's legal_entity

  • Employee not found

  • Patient not found

  • Patient is not active

    • 422 

    Service request is used by another legal entity

    422 

    Service request not found

    422 

    Does not match the signer drfo

    422 

    Collected quantity must not be exceeded by the specimen quantity distributed among the containers

    422 

    Date must be greater than <current date - SPECIMEN_MAX_DAYS

    _PASSED>

  • Must be in past

    • Start date must be in past

    _PASSED>

    422 

    Does not match the code of the collected quantity

    422 

    Employee doesn't belong to your legal entity

    422 

    Employee not found

    422 

    End date must be greater than or equal the start date

    End  

    422 

    End date must be in past

    422 

    Invalid employee status

    422 

    Invalid specimen status

    422 

    Must be in past

    422 

    not allowed in enum

    422 

    Patient is not active

    422 

    Patient not found

    422 

    Specimen with such id is not found

    422 

    Start date must be in past

  • 'Collected quantity must not be exceeded by the specimen quantity distributed among the containers

  • Does not match the code of the collected quantity

    • 422 

    User is not allowed to register a specimen for the employee

    422 

    value is not allowed in enum

    422 

    schema validation error

    422 

    Managing_organization does not correspond to user's legal_entity

    422 

    Specimen with id <id> already exists

    422 

    Only one of the parameters must be present