ЕСОЗ - публічна документація

Skip to end of banner Go to start of banner

[DRAFT] Search for a Service requests [API-007-010-001-0315]

Skip to end of metadata

Created by Serhii Boldin (SoE eHealth), last modified by Anzhela Kovalenko (SoE eHealth) on Nov 28, 2024

Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Сторінка знаходиться в процесі розробки. Інформація на ній може бути застарілою.

/wiki/spaces/EN/pages/17591304241 (remove the link block before publishing the document)

Properties of a REST API method document

Document type	Метод REST API
Document title	[DRAFT] Search for a Service requests [API-007-010-001-0315]
Guideline ID	GUI-0011
Author	@
Document version	1
Document status	DRAFT
Date of creation	ХХ.ХХ.ХХХХ (дата фінальної версії документа – RC або PROD)
Date of update	ХХ.ХХ.ХХХХ (дата зміни версії)
Method API ID	API-007-010-001-0315
Microservices (namespace)	ME
Component	Service request
Component ID	COM-007-010
Link на API-специфікацію	https://medicaleventsmisapi.docs.apiary.io/#reference/service-requests/manage-service-requests/search-for-a-service-requests
Resource	{{host}}/api/service_requests
Scope	service_request:read
Protocol type	REST
Request type	GET
Sync/Async	Sync
Public/Private	Public

Purpose

This service must be used to discover service requests by requisition number.

Logic

This service must be used to discover service requests by requisition number. If nothing found by requisition number - it will return empty list

Service logic

Return all service requests filtered by request parameters
1. exact match for requisition number and status

Configuration parameters

N/A

Dictionaries

N/A

Input parameters

	Input parameter	Mandatory	Type	Description	Example
1	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`
2	status		String	The status of the service request. Default: active	`active`
3	page		Number	Page number	`2`
4	page_size		Number	A limit on the number of objects to be returned, between 1 and 100. Default: 50	`50`

Request structure

See on API-specification

Example

Headers

Request data validation

Authorize

Verify the validity of access token
- Return (401, 'unauthorized') in case of validation fails
Verify that token is not expired
- in case of error - return (401, 'unauthorized')
Check user scopes in order to perform this action (scope = 'service_request:read')
1. Return (403, 'invalid scopes') in case of invalid scope(s)

Request to process the request using a token in the headers

Processing

A list of processes related to receiving, changing or transmitting data according to the logic defined in the REST API

Response structure examples

See on API-specification

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

HTTP status codes

	Response code	HTTP Status code	Message	Internal name	Description
1	Базові
2		401	Unauthorized		Помилка підтвердження
3		403	Invalid scopes
4	Специфічні
5

Post-processing processes

N/A

Technical modules where the method is used

List of pages describing technical modules where the method is used

No labels

ЕСОЗ - публічна документація