Purpose This service must be used to discover service requests by requisition number.
Specification
Link
MEDICAL EVENTS MIS API · Apiary
Resource
/api/service_requests
Scope
service_request:read
Components
Service request
Microservices
API paragraph not found
Protocol type
REST
Request type
GET
Sync/Async
Async
Public/Private/Internal
Public
Logic This service must be used to discover service requests by requisition number. If nothing found by requisition number - it will return empty list
Filters
requisition
String
A shared identifier common to all service requests that were authorized more or less simultaneously by a single author, representing the composite or group identifier
AX654-654T
status
String
The status of the service request. Default: active
active
page
Number
Page number
2
page_size
Number
A limit on the number of objects to be returned, between 1 and 100. Default: 50
50
Request structure API paragraph not found
Authorize Verify the validity of access token
Verify that token is not expired
Check user scopes in order to perform this action (scope = 'service_request:read')
Return (403, 'invalid scopes') in case of invalid scope(s)
Request to process the request using a token in the headers
Headers Наприклад:
Request data validation API paragraph not found
Processing Service logic Return all service requests filtered by request parameters
exact match for requisition number status
Response structure* See on Apiary
Example:
Response example
{
"meta": {
"code": 200,
"url": "http://example.com/resource",
"type": "object",
"request_id": "req-adasdoijasdojsda"
},
"data": [
{
"id": "90a9e15b-b71b-4caf-8f2e-ff247e8a5600",
"requisition": "AX654654T",
"status": "active",
"program": {
"identifier": {
"type": {
"coding": [
{
"system": "eHealth/resources",
"code": "medical_program"
}
]
},
"value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
},
"display_value": "null"
},
"program_processing_status": "new",
"status_history": [
{
"status": "closed",
"status_reason": {
"coding": [
{
"system": "eHealth/service_request_recall_reasons",
"code": "cured"
}
]
},
"inserted_at": "2018-08-02T10:45:16.000Z"
}
],
"program_processing_status_history": [
{
"program_processing_status": "new",
"inserted_at": "2018-08-02T10:45:16.000Z",
"inserted_by": "f7bdce4c-9d6e-4b08-913c-97c4b972f9be"
}
],
"program_service": {
"identifier": {
"type": {
"coding": [
{
"system": "eHealth/resources",
"code": "program_service"
}
]
},
"value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
},
"display_value": "null"
},
"intent": "order",
"priority": "routine",
"based_on": [
{
"identifier": {
"type": {
"coding": [
{
"system": "eHealth/resources",
"code": "care_plan"
}
]
},
"value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
}
},
{
"identifier": {
"type": {
"coding": [
{
"system": "eHealth/resources",
"code": "activity"
}
]
},
"value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
}
}
],
"category": {
"coding": [
{
"system": "eHealth/SNOMED/service_request_categories",
"code": "409063005"
}
]
},
"code": {
"identifier": {
"type": {
"coding": [
{
"system": "eHealth/resources",
"code": "service"
}
]
},
"value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
},
"display_value": "null"
},
"subject": {
"identifier": {
"type": {
"coding": [
{
"system": "eHealth/resources",
"code": "patient"
}
]
},
"value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
},
"display_value": "null"
},
"context": {
"identifier": {
"type": {
"coding": [
{
"system": "eHealth/resources",
"code": "encounter"
}
]
},
"value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
},
"display_value": "null"
},
"occurrence_period": {
"start": "2018-08-02T10:45:16.000Z",
"end": "2018-08-02T11:00:00.000Z"
},
"requester_employee": {
"identifier": {
"type": {
"coding": [
{
"system": "eHealth/resources",
"code": "employee"
}
]
},
"value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
},
"display_value": "null"
},
"requester_legal_entity": {
"identifier": {
"type": {
"coding": [
{
"system": "eHealth/resources",
"code": "legal_entity"
}
]
},
"value": "75a6d991-0bf7-476f-b3cf-bec83f044b2a"
},
"display_value": "null"
},
"reason_references": [
{
"identifier": {
"type": {
"coding": [
{
"system": "eHealth/resources",
"code": "condition"
}
]
},
"value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
},
"display_value": "null"
}
],
"supporting_info": [
{
"identifier": {
"type": {
"coding": [
{
"system": "eHealth/resources",
"code": "episode_of_care"
}
]
},
"value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
},
"display_value": "null"
}
],
"note": "Some notes",
"patient_instruction": "Some patient instructions",
"expiration_date": "2018-08-02T10:45:16.000Z",
"permitted_resources": [
{
"identifier": {
"type": {
"coding": [
{
"system": "eHealth/resources",
"code": "episode_of_care"
}
]
},
"value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
},
"display_value": "null"
}
],
"used_by_employee": {
"identifier": {
"type": {
"coding": [
{
"system": "eHealth/resources",
"code": "legal_entity"
}
]
},
"value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
},
"display_value": "null"
},
"inserted_at": "2018-08-02T10:45:16.000Z",
"updated_at": "2018-08-02T10:45:16.000Z",
"completed_with": {
"identifier": {
"type": {
"coding": [
{
"system": "eHealth/resources",
"code": "diagnostic_report"
}
]
},
"value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
},
"display_value": "null"
},
"used_by_legal_entity": {
"identifier": {
"type": {
"coding": [
{
"system": "eHealth/resources",
"code": "legal_entity"
}
]
},
"value": "c5a6d991-0bf7-476f-b3cf-bec83f044b2a"
},
"display_value": "null"
},
"performer": {
"identifier": {
"type": {
"coding": [
{
"system": "eHealth/resources",
"code": "legal_entity"
}
]
},
"value": "c5a6d991-0bf7-476f-b3cf-bec83f044b2a"
},
"display_value": "Опанасенко Олексій Володимирович"
},
"location_reference": {
"identifier": {
"type": {
"coding": [
{
"system": "eHealth/resources",
"code": "division"
}
]
},
"value": "c5a6d991-0bf7-476f-b3cf-bec83f044b2a"
},
"display_value": "null"
},
"performer_type": {
"coding": [
{
"system": "SPECIALITY_TYPE",
"code": "DIETETICS"
}
]
},
"identity": {
"last_name": "Іванов",
"first_name": "І.",
"second_name": "І.",
"gender": "MALE",
"age": 35
}
}
],
"paging": {
"page": 2,
"page_size": 50,
"total_entries": 1000,
"total_pages": 20
}
}
Post-processing processes API paragraph not found
HTTP status codes
