Запрос
Адрес запроса
GET: {{url}}/labs/serviceList |
Ответ сервера
В случае успешного выполнения сервер вернет ответ в формате JSON со следующими данными:
Модель:
№ п/п | Наименование параметра | Кратность | Обязательность | Тип данных | Описание |
---|---|---|---|---|---|
1 | resourceType | 1..1 | обязательно | Строка | Отображает тип ресурса, для данного запроса всегда "Parameters" |
2 | parameter | 1..* | обязательно | Объект | Контейнер с результатами операции |
3 | parameter.name | 1..1 | обязательно | Строка | Тип возвращаемого параметра. Для данного запроса всегда значение "return" |
4 | parameter.resource | 1..1 | обязательно | Объект | Контейнер описывает ресурс для справочника |
5 | parameter.resource.resourceType | 1..1 | обязательно | Строка | Отображает тип ресурса, для данного контейнера всегда "ValueSet" |
7 | parameter.resource.url | 1..1 | обязательно | Строка | URL-адрес справочника в системе. Формируется как urn:oid:oid справочника |
8 | parameter.resource.version | 0..1 | необязательно | Строка | Версия справочника в системе (если указана) |
9 | parameter.resource.name | 1..1 | обязательно | Строка | Наименование справочника в системе |
11 | parameter.resource.publisher | 1..1 | обязательно | Строка | Владелец справочника, всегда указывается OID Передающей системы. Выдаётся стороной БАРС ЛИС |
16 | parameter.resource.status | 1..1 | обязательно | Строка | Статус актуальности справочника. Возможные значения параметра: draft - черновик active - активный retired - удален unknown - не известен |
12 | parameter.resource.expansion | 1..1 | обязательно | Объект | Контейнер содержит значения справочника |
13 | parameter.resource.expansion.timestamp | 1..1 | обязательно | Строка | Дата формирования ответа в формате ISO8601 |
18 | parameter.resource.expansion.contains | 1..* | обязательно | Объект | Контейнер содержит код и наименование значения справочника |
19 | parameter.resource.expansion.contains.code | 1..1 | обязательно | Строка | Код значения |
20 | parameter.resource.expansion.contains.display | 1..1 | обязательно | Строка | Наименование значения |
Пример ответа:
{ "resourceType": "Parameters", "parameter": [ { "name": "return", "resource": { "resourceType": "ValueSet", "version": "1", "name": "Медицинские услуги", "status": "active", "publisher": "123654789", "expansion": { "timestamp": "2020-03-31T11:45:27+03:00", "contains": [ { "code": "A05.03.003", "display": "Магнитно-резонансная томография основания черепа" }, { "code": "A05.03.003.001", "display": "Магнитно-резонансная томография основания черепа с ангиографией" }, { "code": "A05.04.001", "display": "Магнитно-резонансная томография суставов (один сустав)" } ] } } } ] }
Возможные ошибки
В случае возникновения ошибок будет возвращен стандартный ответ сервера;
В случае возникновения ошибок валидации сервер вернет стандартное сообщение валидации.