Purpose
Use this method to obtain full information about Person Request.
Key features
Only authenticated and authorized user can use person request
Service returns only person request related to the same legal entity as the user.
Specification
Link | https://ehealthmisapi1.docs.apiary.io/#reference/public.-medical-service-provider-integration-layer/person-requests/get-person-request-by-id | Посилання на Apiary або Swagger |
Resource | /api/person_requests/{{id}} | Посилання на ресурс, наприклад: /api/persons/create |
Scope | person_request:read | Scope для доступу |
Components | Patient registry | Зазначається перелік бізнес компонентів, які використовують цей метод, наприклад: ePrescription |
Microservices | il/api fe/admin-web | Перелік мікросервісів, які використовує метод API, наприклад: Auth, ABAC |
Protocol type | REST | Тип протоколу, який використовується запитом, наприклад: SOAP | REST |
Request type | GET | Тип запиту API, наприклад: GET, POST, PATCH… |
Sync/Async | Sync | Метод є синхронним чи асинхронним? |
Public/Private/Internal | Public | |
| | | | |
|---|
id | | String | Request identifier. Required | eeebb86d-5cba-43c9-885b-6482ecaf826b |
Dictionaries
Request structure
See on Apiary
Authorize
Verify the validity of access token
Return 401 in case validation fails
Check scopes in order to perform this action (scope = 'person_request:read')
Return 403 in case invalid scope(s)
Content-Type:application/json
Authorization:Bearer {{access_token}}
api-key::{{secret}}
Response structure
Example:
{
"meta": {
"code": 201,
"url": "https://example.com/resource",
"type": "object",
"request_id": "6617aeec-15e2-4d6f-b9bd-53559c358f97#17810"
},
"data": {
"status": "SIGNED",
"id": "eeebb86d-5cba-43c9-885b-6482ecaf826b",
"person": {
"id": "13001c60-45a0-4b5a-b425-9505e1de18bd",
"first_name": "Петро",
"last_name": "Іванов",
"second_name": "Миколайович",
"birth_date": "2009-07-05",
"birth_country": "Україна",
"birth_settlement": "Вінниця",
"gender": "MALE",
"email": "email@example.com",
"no_tax_id": false,
"tax_id": "3999869394",
"secret": "secret",
"documents": [
{
"type": "BIRTH_CERTIFICATE",
"number": "АА120518",
"issued_by": "Рокитнянським РВ ГУ МВС Київської області",
"issued_at": "2017-02-28",
"expiration_date": "2027-02-28"
}
],
"addresses": [
{
"type": "RESIDENCE",
"country": "UA",
"area": "Житомирська",
"region": "Бердичівський",
"settlement": "Київ",
"settlement_type": "CITY",
"settlement_id": "b075f148",
"street_type": "STREET",
"street": "вул. Ніжинська",
"building": "15",
"apartment": "23",
"zip": "02090"
}
],
"phones": [
{
"type": "MOBILE",
"number": "+380503410870"
}
],
"authentication_methods": [
{
"type": "THIRD_PERSON",
"phone_number": "+380508887700",
"value": "c282f8a9-e709-40aa-94b4-dde1402bf4b6",
"alias": "husband"
}
],
"unzr": "20090705-00011",
"emergency_contact": {
"first_name": "Петро",
"last_name": "Іванов",
"second_name": "Миколайович",
"phones": [
{
"type": "MOBILE",
"number": "+380503410870"
}
]
},
"confidant_person": [
{
"relation_type": "PRIMARY",
"first_name": "Петро",
"last_name": "Іванов",
"second_name": "Миколайович",
"birth_date": "1972-10-26",
"birth_country": "Україна",
"birth_settlement": "Вінниця",
"gender": "MALE",
"tax_id": "2659719350",
"secret": "secret",
"unzr": "19900101-00099",
"preferred_way_communication": "email",
"documents_person": [
{
"type": "PASSPORT",
"number": "АА120518",
"expiration_date": "2021-02-28",
"issued_by": "Рокитнянським РВ ГУ МВС Київської області",
"issued_at": "2017-02-28"
}
],
"documents_relationship": [
{
"type": "BIRTH_CERTIFICATE",
"number": "АА120518",
"issued_by": "Рокитнянським РВ ГУ МВС Київської області",
"issued_at": "2017-02-28"
}
],
"phones": [
{
"type": "MOBILE",
"number": "+380503410870"
}
],
"email": "emaill@example.com"
}
],
"preferred_way_communication": "email"
},
"patient_signed": false,
"process_disclosure_data_consent": true,
"content": "Person content",
"channel": "MIS",
"authorize_with": "cc949559-5dfe-420f-ac05-065e443b2cc6"
},
"urgent": {
"authentication_method_current": [
{
"type": "OTP",
"phone_number": "+38093*****85"
}
],
"documents": [
{
"type": "PASSPORT",
"url": "https://storage.ehealth.world"
}
]
}
}HTTP status codes
| | |
|---|
200 | Response | |
401 | | Validation failed |
403 | | Invalid scope |