Запрос

Адрес запроса

GET: {{url}}/clis/fhir/valueset/{id}

Заголовки запроса

ЗаголовокЗначение (тип/формат значения)
AuthorizationApiKey - ключ авторизации

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

НазваниеТипОписание

id

path

Идентификатор справочника в системе. Возможные коды можно получить методом 1.6 Получение списка справочников

Ответ

НазваниеКратностьОписание

resourceType

1..1

Отображает тип ресурса, для данного запроса всегда "Parameters".

parameter

0..1

Контейнер с результатами операции.

parameter.name

1-1

Тип возвращаемого параметра. Для данного запроса всегда значение "return".

parameter.resource

1-1

Контейнер описывает ресурс справочника.

resource.resourceType

1-1

Тип ресурса. Для данного запроса всегда ValueSet..

resource.id

1-1

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

resource.name

1-1

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

resource.type

1..1

Описывает предназначение ресурса Bundle. Для данного запроса всегда значение "searchset".

resource.version

1..1

Версия справочника в системе (если указана).

status

1..1

Статус актуальности справочника.

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

  • draft - черновик
  • active - активный
  • retired - удален
  • unknown - не известен

expansion

0..*

Контейнер содержит значения справочника.

parameter

0..1

Контейнер содержит описание дополнительных параметров для значений справочника.

parameter.name

1..1

Имя контейнера. Для данного запроса значение всегда nameAdditionalColumn.

parameter.value

1..1

Перечисление дополнительных полей через запятую.

expansion.contains

1..*

Элементы справочника.

contains.code

1-1

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

contains.display

1-1

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

Пример ответа в формате JSON 
{
    "resourceType": "Parameters",
    "parameter": [
        {
            "name": "return",
            "resource": {
                "resourceType": "ValueSet",
                "id": "CLIS_TaskType",
                "version": "1",
                "name": "Тип ресурса Task",
                "status": "active",
                "expansion": {
                    "parameter": [
                        {
                            "name": "nameAdditionalColumn",
                            "valueString": "field1"
                        }
                    ],
                    "contains": [
                        {
                            "code": "OrderProcessingTask",
                            "display": "Task уровня заказа",
                            "contains": [
                                {
                                    "code": "field1",
                                    "display": "value1"
                                }
                            ]
                        },
                        {
                            "code": "ProcedureRequestTask",
                            "display": "Task уровня услуги"
                        }
                    ]
                }
            }
        }
    ]
}

Описание ответа в случае возникновения ошибок

  • Нет меток