ЕСОЗ - публічна документація
Get Procedures by search params
Purpose
This metod is designed to return records about procedures by patient_id or/and search_params.
Specification
Link | |
Resource | /api/patients/{{patient_id}}/procedures |
Scope | procedure:read |
Components | Episode of Care |
Microservices | API paragraph not found |
Protocol type | REST |
Request type | GET |
Sync/Async | Async |
Public/Private/Internal | Public |
Filters
Filter | Values | Type | Description | Example |
---|---|---|---|---|
patient_id |
| String | Unique patient identifier |
|
episode_id |
| String | Unique episode identifier, look into episode in encounter |
|
status |
| Enum | status of procedure |
|
based_on |
| String | Unique service request identifier |
|
code |
| String |
|
|
managing_organization_id |
| String | Unique legal entity identifier |
|
encounter_id |
| String | Unique encounter identifier |
|
origin_episode_id |
| String | Unique episode identifier, look into episode in procedures.origin_episode |
|
Request structure
See on Apiary
Authorize
Request to process the request using a token in the headers
Verify the validity of access token
Return 401 in case validation fails
Verify token is not expired
in case error return 401
Check user scopes in order to perform this action (scope = 'procedure:read')
Return 403 in case invalid scope(s)
Headers
Наприклад:
Content-Type:application/json
Authorization:Bearer {{access_token}}
API-key:{{secret}}
Request data validation
Access to the resource is also managed by ABAC module.
Validation
validate person_id
validate $person_id is existing ID in mpi.persons.id And person is_active=true and status='active
in case error return 404, "Person not found"
Processing
API paragraph not found
Response structure
See on Apiary
Example:
Return response according to json schema
Filter response using submitted query params
Query param
device_id
must be applied tofocal_device
Return procedures where
managing_organization.identifier.value=$Client_id
consumer_id is a doctor with active declaration for current patient ($.person_id)
Post-processing processes
API paragraph not found
HTTP status codes
HTTP status code | Message | What caused the error |
---|---|---|
200 |
|
|
401 | Access denied |
|
403 | Invalid scopes |
|
404 | Patient not found |
|
ЕСОЗ - публічна документація