URL _format

не задан

json

xml

HEADER
Content-Type

не задан

xml

json

xml

application/json

json

json

400 Bad Request

application/xml

xml

400 Bad Request

xml

1.       

Root

2.       

/entry

array

Массив параметров ответа

3.       

entry/resource

object

Паспорт справочника

4.       

resource

id

guid

Идентификатор справочника в сервисе терминологии

5.       

resource

url

string

Url-адрес справочника

6.       

resource

status

string

Статус справочника. Возможные значения:

• draft – черновой;
• active – активный;
• retired – архивный.

7.       

resource

version

string

Значение актуальной версии справочника

8.       

resource

publisher

string

Издатель справочника

9.       

resource/meta

Метаданные справочника

10.   

meta

versionId

guid

Идентификатор версии справочника

11.   

meta

lastUpdated

datetime

Дата-время последнего обновления справочника

12.   

resource/expansion/parameter

array

Расширение справочника

13.   

parameter

name

string

Название параметра "version_comment" (комментарий к версии)

14.   

parameter

valueString

string

Текстовый комментарий к версии справочника

15.   

resource/extension

array

Расширенные параметры паспорта справочника

16.   

extension

url

string

Индикатор дополнительного OID справочника

17.   

extension

valueUri

string

OID справочника

18.   

resource/useContext/coding

array

Расширенные параметры описания справочника: тип справочника

19.   

coding

code

integer

Уникальный идентификатор типа справочника

20.   

coding

system

string

OID справочника, содержащего все доступные пары «код»-«значение» для типов справочников

21.   

coding

display

string

Наименование типа справочника

№ п/п

Контейнер

Параметр

Тип

Описание

1.       

Root

2.       

/parameter

array

Параметры ответа

3.       

parameter

name

string

Наименование параметра (result)

4.       

parameter

valueString

string

Номера версий справочника и даты создания версий в формате «версия справочника (дата формирования), версия справочника (дата формирования)…»

№ п/п

Контейнер

Параметр

Тип

Кратность

Описание

1.       

Root

2.       

/parameter

array

1..1

Параметры запроса

3.       

parameter

system

string

1..1

Значение кодовой системы (url-адрес справочника)

4.       

parameter

version

string

0..1

Номер версии справочника. Если номер версии не указан, то возвращаются значения из актуальной версии

5.       

parameter

date

datetime

0..1

Дата в формате ГГГГ-ММ-ДД

6.       

parameter

filter

string

0..1

Будут возвращены только те записи справочника, которые в коде и/или наименовании записи (атрибуты code и display) содержат указанное значение

7.       

parameter

count

integer

0..1

Количество выводимых элементов на странице результата

8.       

parameter

offset

integer

0..1

Смещение при выводе элементов

9.       

parameter

profile

string

1..1

Кодовое значение атрибута справочника

1.       

Root

2.       

/parameter

array

Параметры ответа

3.       

parameter /resource

array

Найденный ресурс

4.       

resource

id

guid

Идентификатор справочника в сервисе терминологии

5.       

resource

url

string

url-адрес справочника

6.       

resource

status

string

Статус справочника. Возможные значения:

• draft – черновой;
• active – активный;
• retired – архивный.

7.       

resource

name

string

Наименование справочника

8.       

resource

version

string

Значение актуальной версии справочника

9.       

resource

publisher

string

Издатель справочника

10.   

resource/expansion/parameter

array

Расширение справочника

11.   

parameter

name

string

Название параметра "version_comment" (комментарий к версии)

12.   

parameter

valueString

string

Текстовый комментарий к версии справочника

13.   

resource/useContext/coding

array

Расширенные параметры описания справочника: тип справочника

14.   

coding

code

integer

Уникальный идентификатор типа справочника

15.   

coding

system

string

OID справочника, содержащего все доступные пары «код»-«значение» для типов справочников

16.   

coding

display

string

Наименование типа справочника

17.   

resource/meta

Метаданные справочника

18.   

meta

versionId

guid

Идентификатор версии справочника

19.   

meta

lastUpdated

datetime

Дата-время последнего обновления справочника

20.   

resource/expansion/contains

array

Массив записей справочника

21.   

contains

code

string

Код записи

22.   

contains

display

string

Значение, соответствующее коду записи

23.   

contains

version

string

Номер версии справочника, соответствующий выведенной записи

24.   

contains/contains

array

Дополнительные атрибуты записи

25.   

contains

code

string

Код атрибута

26.   

contains

display

string

Значение атрибута

Сценарий

HEADER «api-version» не задан

HEADER «api-version» = 2

Код статуса HTTP

BODY

Код статуса HTTP

BODY

Получение записей справочника

200 OK

Структура и параметры согласно таблице 3.2

200 OK

Структура и параметры согласно таблице 3.2

Получение записей по несуществующему публичному уникальному идентификатору справочника (OID справочника)

500 Internal Server Error

{"Message":"An error has occurred."}

404 Not Found

{"resourceType": "OperationOutcome",
    "issue": [{
            "severity": "error",
            "code": "not-found",
            "diagnostics": "No resource was found"
        }]}

Получение записей несуществующей версии справочника

500 Internal Server Error

{"Message":"An error has occurred."}

404 Not Found

{"resourceType": "OperationOutcome",
    "issue": [{
            "severity": "error",
            "code": "not-found",
            "diagnostics": "No resource was found"
        }]}

1.       

Root

2.       

/parameter

array

1..1

Параметры запроса

3.       

parameter

system

string

1..1

Значение кодовой системы (url-адрес справочника)

4.       

parameter

version

string

0..1

Номер версии справочника. Если номер версии не указан, то возвращаются значения из актуальной версии

5.       

parameter

code

string

1..1

Код значения в справочнике

№ п/п

Контейнер

Параметр

Тип

Описание

1.       

Root

2.       

/parameter

array

Параметры ответа

3.       

parameter

name

string

Наименование параметра для запрошенного значения справочника

4.       

parameter

valueString

string

Значение дополнительного параметра

Получение записи справочника

200 OK

Структура и параметры согласно таблице 4.2

200 OK

Структура и параметры согласно таблице 4.2

Получение записи по несуществующему публичному уникальному идентификатору справочника (OID справочника)

500 Internal Server Error

{"Message":"An error has occurred."}

404 Not Found

{"resourceType": "OperationOutcome",
    "issue": [{
            "severity": "error",
            "code": "not-found",
            "diagnostics": "No resource was found"
        }]}

Получение записи несуществующей версии справочника

500 Internal Server Error

{"Message":"An error has occurred."}

404 Not Found

{"resourceType": "OperationOutcome",
    "issue": [{
            "severity": "error",
            "code": "not-found",
            "diagnostics": "No resource was found"
        }]}

Получение записи по несуществующему коду записи

500 Internal Server Error

{"Message":"An error has occurred."}

404 Not Found

{"resourceType": "OperationOutcome",
    "issue": [{
            "severity": "error",
            "code": "not-found",
            "diagnostics": "No resource was found"
        }]}

1.       

Root

2.       

/parameter

array

1..1

Параметры запроса

3.       

parameter

system

string

1..1

Значение кодовой системы (url-адрес справочника)

4.       

parameter

version

string

0..1

Номер версии справочника. Если номер версии не указан, то возвращаются значения из актуальной версии

5.       

parameter

code

string

1..1

Код значения в справочнике

№ п/п

Контейнер

Параметр

Тип

Описание

1.       

Root

2.       

/parameter

array

Параметры ответа

3.       

parameter

name

string

Наименование параметра (result)

4.       

parameter

valueBoolean

string

Результат проверки (true / false)

Получение записи справочника

200 OK

Структура и параметры согласно таблице 5.2

200 OK

Структура и параметры согласно таблице 5.2

Получение записи по несуществующему публичному уникальному идентификатору справочника (OID справочника)

500 Internal Server Error

{"Message":"An error has occurred."}

404 Not Found

{"resourceType": "OperationOutcome",
    "issue": [{
            "severity": "error",
            "code": "not-found",
            "diagnostics": "No resource was found"
        }]}

Получение записи несуществующей версии справочника

500 Internal Server Error

{"Message":"An error has occurred."}

404 Not Found

{"resourceType": "OperationOutcome",
    "issue": [{
            "severity": "error",
            "code": "not-found",
            "diagnostics": "No resource was found"
        }]}

1.

Root

2.

Parameter

array

1..1

Параметры запроса

3.

Parameter

system

string

1..1

Публичные идентификатор справочника 1 (один из пары по поиску соответствий)

4.

Parameter

code

string

1..1

Кодовое значение из справочника 1

5.

Parameter

target

string

1..1

Публичные идентификатор справочника 2 (один из пары по поиску соответствий)

6.

Parameter

reverse

boolean

0..1

Признак поиска обратного соответствия:

• False – поиск соответствия кодового значения из справочника 1 в справочнике 2;
• True - поиск соответствия кодового значения из справочника 2 в справочнике 1;
• По умолчанию значение «false».

7.

Parameter

date

datetime

0..1

Поиск соответствий на конкретную дату по историческим данным справочника соответствия кодовых значений  

8.

Parameter

coding

object

0..1

Описание справочника, содержащего данные соответствия. Обозначение справочника представляется в формате "system":"OID", где OID- публичный идентификатор справочника соответствия.

Указание публичного идентификатора справочника обязательно в том случае, если в системе имеется несколько справочников соответствия кодовых значений пары справочников*  

1.

Root

2.

/parameter

array

Параметры ответа

3.

parameter

name

sting

Название параметра:

• «result»: параметр определяет успешность выполнения операции поиска соответствий кодовых значений;
• «match»: параметр, определяющий найденное соответствие

4.

parameter

valueBoolean

boolean

Результат поиска:

• true – соответствие найдено;
• false – соответствие не найдено;

5.

parameter

valueString

sting

Найденное кодовой соответствие

1.

Root

2.

/parameter

array

Параметры ответа

3.

parameter

name

sting

Название параметра:

• «result»: параметр определяет успешность выполнения операции поиска соответствий кодовых значений

4.

parameter

valueBoolean

boolean

Результат поиска:

• true – соответствие найдено;
• false – соответствие не найдено;

5.

parameter

name

sting

Название параметра: «match». Определяет найденные соответствия.

6.

parameter/ part

array

Массив из найденных пар «code»-«значение»

7.

part

name

string

Наименование параметра: «code»

8.

part

valueString

string

Значение параметра «code» - найденный код соответствующего значения

1.       

Root

2.       

type

string

1..1

Название параметра выполняемой операции «batch»

3.       

/entry

array

1..1

Массив операций, объединяемых в пакет

4.       

entry/request

object

1..1

Описание выполняемого метода

5.       

request

method

string

1..1

Наименование типа запроса: «POST»

6.       

request

url

string

1..1

Выполняемая операция:

• «ValueSet/$lookup» - получение информации о значении;
• «ValueSet/$validate-code» - проверка наличия значения в справочнике;
• «translate» - получение соответствий кодовых значений.

7.       

entry/resource

object

1..1

Объект дублирующий структуру и входные параметры выполняемого метода. Структуру и состав параметров см. в описании конкретного метода

№ п/п

Контейнер

Параметр

Тип

Описание

1.       

Root

2.       

type

string

Название выполненной операции: «batch-response»

3.       

entry

array

Массив объектов «resource». Каждый объект массива – ответ на одну операцию. Структура и состав полей соответствует описанию ответа конкретного метода.

№ п/п

Параметр

Тип

Кратность

Описание

1.       

system

string

1..1

OID справочника, по которому осуществляется поиск значений

2.       

version

string

0..1

Версия справочника, в рамках которой осуществляется поиск значений. Если версия не указана поиск по умолчанию осуществляется по актуальной версии

3.       

attribute

string

1..1

Код атрибута, по которому осуществляется поиск значения

4.       

operation

string

0..1

Варианты поиска значения:

Для текстовых атрибутов и атрибута типа «ссылка М:1» при поиске по display ссылочного справочника:

• по вхождению подстроки без учета регистра – значение по умолчанию;
• по вхождению подстроки с учетом регистра «cs»;
• по точному вхождению строки с учетом регистра «eq»;
• по точному вхождению строки без учета регистра «eqncs»;
• расширенный контекстный поиск (поиск происходит по вхождению введенных букв и цифр*) «ext».

Для атрибутов типа «ссылка М:1» и «ссылка М:М» при поиске по кодовому значению ссылочного справочника:

• по строгому соответствию с учетом регистра кодового значения из ссылочного справочника «eqpcode».

5.       

value

string

1..1

Может содержать:

• Искомое значение;
• Массив искомых значений. Поиск по указанным значениям будет происходить с учетом операции ИЛИ, то есть будут найдены записи справочника, которые содержат какое-либо значение из предложенного массива значений. Перечисление значений происходит через запятую**

6.       

_count

integer

0..1

Количество элементов (записей справочника), выводимых на одной странице результирующего ответа

7.       

_page

integer

0..1

Номер страницы результирующего ответа

1.       

Root

2.       

/total

integer

Количество найденных записей

3.       

/entry

array

Массив найденных записей

4.       

entry/resource

object

Найденная запись

5.       

resource/parameter

array

Массив параметров записи

6.       

parameter

name

string

Код атрибута записи

7.       

parameter

valueString

string

Значение атрибута записи простого типа

8.       

parameter/valueCodeableConcept

object

Структура описания значения записи для ссылочных полей

9.       

valueCodeableConcept/coding

array

Массив параметров ссылочного поля

10.   

coding

code

string

Код записи

11.   

coding

system

string

OID справочника

12.   

coding

display

string

Наименование записи

13.   

coding

version

string

Версия справочника

1.       

Root

2.       

type

string

Название параметра: «searchset».

Параметр возвращается только при выполнении метода (search)

3.       

total

integer

Количество доступных ресурсов. Параметр возвращается только при выполнении метода (search)

4.       

/entry

array

Массив найденных ресурсов.

Контейнер возвращается только при выполнении метода (search)

5.       

entry/resource

object

Найденный ресурс.

Контейнер возвращается только при выполнении метода (search)

6.       

resource

id

string

Уникальный guid-идентификатор организации

7.       

resource

active

boolean

Признак активности полученного ресурса:

• true – активен;
• false – неактивен.

8.       

resource/address

array

Описание адреса организации

9.       

address

text

string

Адрес организации

10.   

resource/partOf

object

Описание родительской записи ресурса

11.   

partOf

display

string

Наименование родительской организаций

12.   

partOf

reference

string

Ссылка на родительскую организацию (ресурс)

13.   

resource/identifier

array

Описание дополнительных строковых параметров организации

14.   

identifier

system

string

Наименование параметра:

• «orgid»: GUID головной организации, стоящей на первом уровне иерархии;
• «oid»: OID медицинской организации.

15.   

identifier

value

string

Значение параметра

16.   

resource/type

object

Описание дополнительных ссылочных параметров организации

17.   

type/coding

array

Описание ссылочного параметра

18.   

coding

system

string

Ссылочный справочник: «medorgtype» (тип медицинского учреждения)

19.   

coding

code

string

Код записи

20.   

coding

display

string

Наименование записи

21.   

resource/extension

array

Массив дополнительной информации об организации

22.   

extension

url

string

Значение параметра: «http://hl7.org/fhir/StructureDefinition/organization-alias». Сокращенное наименование организации

23.   

extension

valueString

string

Краткое наименование организации

№ п/п

Параметр

Тип

Кратность

Описание

1.       

oid

string

1..1

OID справочника, по которому осуществляется вычисление истории изменений

2.       

low_version

string

0..1

Младшая версия справочника, относительно которой вычисляются изменения.

Если версия не задана, то изменения вычисляются относительно нулевой версии справочника.

3.       

low_version_datetime

datetime

0..1

Нижняя граница временного интервала, относительно которой вычисляются изменения.

Если дата:время не заданы, то изменения вычисляются относительно нулевой версии справочника.

4.       

high_version

string

0..1

Старшая версия справочника, относительно которой вычисляются изменения.

Если версия не задана, то изменения вычисляются относительно актуальной версии справочника.

5.       

high_version_datetime

datetime

0..1

Верхняя граница временного интервала, относительно которой вычисляются изменения.

Если дата:время не заданы, то изменения вычисляются относительно акутальной версии справочника.

6.       

count

integer

0..1

Количество элементов (записей справочника), выводимых на одной странице результирующего ответа

7.       

page

integer

0..1

Номер страницы результирующего ответа

1.       

Root

2.       

/total

integer

Общее количество элементов ответа

3.       

/entry

array

Массив найденных записей

4.       

entry/resource

object

Описания изменений по одной записи

5.       

resource/parameter

array

Массив параметров записи

6.       

parameter

name

string

Код атрибута записи

7.       

parameter

valueString

string

Значение атрибута записи простого типа

8.       

parameter

name

string

Значение «operation». Операция произведенная с записью

9.       

parameter

valueString

string

Возможные значения:

created – запись создана;

updated – запись обновлена;

deleted – запись удалена.