ГОСТ Р HCO/HL7 27951—2016
10.3.1 Системы кодирования, поддерживаемые API
10.3.1.1 Структура класса CodeSystem
Класс CodeSystem имеет следующие поля:
- codeSystemJd — уникальный идентификатор системы кодирования, которым обычно служит
объектный идентификатор ИСО (ОИД);
- codeSystem_name — офицальное имя системы кодирования;
- copyright — информация об авторских правах на систему кодирования, если таковые имеются;
- codeSystem_versions — версия или версии системы кодирования, поддерживаемые службой.
Этот список может быть пуст, если система кодирования не имеет отдельных идентификаторов версий.
10.3.1.2 Метод getSupportedCodeSystems
Метод getSupportedCodeSystems возвращает список всех систем кодирования и их версий, под
держиваемых службой.
Входные параметры;
- timeout — время в миллисекундах, в течение которого клиент готов ждать завершения опера
ции. Значение 0 параметра timeout указывает, что на время ее выполнения ограничения не наклады
ваются;
- sizeLimit — максимальное число элементов, которое служба может вернуть. Если число возвра
щенных элементов совпадает с sizeLimit, то клиент предполагает, что существуют дополнительные эле
менты. которые не были возвращены. Значение 0 параметра sizeLimit указывает, что число элементов,
которые могут быть возвращены, не ограничивается.
Исключения:
- TimeoutError;
- UnexpectedError.
10.3.2 Обозревание идентифицирующей информации системы кодирования
10.3.2.1 Структура, возвращаемая методом lookupCodeSystemInfo
Структура, возвращаемая методом lookupCodeSystemlnfo. имеет следующие поля:
- CodeSystem — идентификатор системы кодирования, ее имя и поддерживаемая версия (вер
сии);
- fullName — полное имя системы кодирования;
- codeSystemDescription — описание содержания системы кодирования;
- supportedLanguages — список всех языков, которые полностью или частично поддерживаются
системой кодирования. «Поддерживаемый» язык распознается системой кодирования и на нем доступ на
хотя бы часть обозначений или свойств понятий. Все системы кодирования должны поддерживать хотя
бы один язык. В то время как служба должна возвращать перечисление всех субтегов основного языка,
который она поддерживает, она не обязана перечислять вторичные языки. (Например, если она
поддерживает язык «еп-UK», ома должна возвращать тег «еп». но может возвращать или не возвра
щать «en-UK»);
- supportedRelations — список всех отношений, поддерживаемых службой в системе кодирова
ния. «Поддерживаемое» отношение распознается системой кодирования, которая способна опреде
лить, являются ли два принадлежащих ей кода понятий связанными этим отношением.
Неиерархи ческая система кодирования не нуждается в поддержке каких-либо отношений.
Отношение подтипа представлено кодом отношения hasSubtype;
- supportedProperties — список всех свойств, поддерживаемых системой кодирования. Свойство
считается «поддерживаемым», если система кодирования распознает его и по меньшей мере одно ко
дированное понятие ассоциировано с этим свойством и необязательным значением;
- supportedMimeTypes — список типов среды MIME, поддерживаемых системой кодирования. Все
системы кодирования должны поддерживать тип среды text/plain (неформатированный текст), даже
если в ней нет ни одного свойства с этим типом;
- supportedRelationshipQualifiers — список квалификаторов отношений, распознаваемых систе
мой кодирования (если таковые имеются).
10.3.2.2 Метод lookupCodeSystemlnfo
Метод lookupCodeSystemlnfo получает идентификатор системы кодирования (ОИД) иУили ее имя
и возвращает детальное описание системы кодирования и элементов, поддерживаемых службой.
Входные параметры:
- codeSystemJd — идентификатор ИСО ОИД. присвоеный системе кодирования.
- codeSystem_name — уникальное имя системы кодирования.
44