Руководство к использованию стандарта FHIR в ЦИСЗ
0.2.6803 - ci-build

OperationDefinition: Операция получения идентификатора электронного документа

Официальный URL: https://fhir.by/OperationDefinition/get-document-id
Unknown as of 2026-06-25 Имя: get-document-id

Операция получения идентификатора электронного документа ЦИСЗ. Позволяет получить идентификатор для электронных документов, которые должны быть переданы в ЦИСЗ

Уникальный идентификатор формируется в ЦИСЗ согласно следующей структуре:

DD-GGGGGGGGG-YYYYNNNNNNNNNNNN,

где:
DD - код вида электронного документа (2 цифры);
GGGGGGGGG – УНП ОЗ (9 цифр);
YYYYNNNNNNNNNNNN – уникальный порядковый номер электронного документа в рамках ОЗ/МИС ОЗ (16 цифр, первые 4 цифры - год).

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

Например: 02-196098789-2025000000000001 - уникальный идентификатор электронной справки о рождении, выданной в ОЗ с УНП 196098789 в 2025 году с порядковым номером “1”.

Перед созданием Bundle электронного документа (зависит от профиля) необходимо получить уникальный идентификатор из ЦИСЗ выполнив операцию $get-document-id с указанием параметров document-code. В параметрах document-code указывается код вида электронного документа, который необходимо создать, и справочник DigitalDocumentKind.

Получение идентификатора электронного листка нетрудоспособности (ЭЛН) с помощью настоящего метода невозможно. Для присвоения ЭЛН идентификатора используется другой механизм: смотри описание профиля BundleTD.

Программные интерфейсы ЦИСЗ защищены сервером авторизации с использованием технологии OAuth 2.0 (Авторизация в ЦИСЗ). При каждом вызове операции клиентское приложение (МИС ОЗ) должно передавать токен доступа (токен организации) в заголовке запроса.

Вызов метода получения идентификатора электронного документа осуществляется с помощью HTTP POST команды:

POST [FHIR_BASE]/$get-document-id
Request Headers
    Accept: application/json 
    Authorization: Bearer [access_token]

Пример тела запроса на получение уникального идентификатора электронной справки о рождении:

Body
{
"resourceType" : "Parameters",
"parameter" : [{
    "name" : "document-code",
    "valueCoding" : {
        "system": "https://fhir.by/ValueSet/DigitalDocumentKind",
        "code": "02"
    }
}]
}

Метод возвращает:

  • HTTP-статус «200 ОК» и уникальный идентификатор электронного документа в теле ответа в виде ресурса Parameters (identifier - DD-UUUUUUUUU-YYYYNNNNNNNNNNNN). Полученный уникальный идентификатор электронного документа необходимо использовать при передаче электронного документа в ЦИСЗ в качестве идентификатора Bundle;

  • HTTP-статус «404 Bad Request»: неверно задан параметр.

URL: [base]/$get-document-id

Параметры

ИспользоватьНаименованиеСфера действияКардинальностьТипПривязкаДокументация
INdocument-code1..1Coding

Код электронного документа из справочника DigitalDocumentKind

OUTidentifier1..1id

Уникальный идентификатор электронного документа

Примечания:

Результатом успешного запроса является ресурс Parameters.

Пример ответа:

{
  "resourceType" : "Parameters",
  "parameter" : [{
    "name" : "identifier",
    "valueString" : "02-196098789-2025000000000001"
  }]
}