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

Профиль ресурса: EndpointServiceRequest - Детальное описание

Draft as of 2026-06-25

Определения EndpointServiceRequest профиль ресурса.

Рекомендации по толкованию содержимого этой таблицы можно найтиздесь-- no content: do not translate #97 --

0. Endpoint
2. Endpoint.meta
4. Endpoint.meta.profile
Значение шаблонаhttps://fhir.by/StructureDefinition/EndpointServiceRequest

Рекомендации по толкованию содержимого этой таблицы можно найтиздесь-- no content: do not translate #97 --

0. Endpoint
Определение

The technical details of an endpoint that can be used for electronic services, such as for web services providing XDS.b, a REST endpoint for another FHIR server, or a s/Mime email address. This may include any security context information.

КороткийThe technical details of an endpoint that can be used for electronic services
Контроль0..*
Модификаторfalse
Требуется поддержкаfalse
Summaryfalse
Инвариантыdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty())
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
dom-6: A resource should have narrative for robust management (text.`div`.exists())
2. Endpoint.id
Определение

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

КороткийЛогический идентификатор этого артефакта
Комментарии

Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.

Контроль0..1
Типid
Модификаторfalse
Требуется поддержкаfalse
Summarytrue
4. Endpoint.meta
Определение

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

КороткийМетаданные о ресурсе
Контроль1..1
ТипMeta
Модификаторfalse
Требуется поддержкаfalse
Summarytrue
Инвариантыele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
6. Endpoint.meta.id
Определение

Уникальный идентификатор элемента в ресурсе (для внутренних ссылок). Это может быть любое строковое значение, не содержащее пробелов.

КороткийУникальный идентификатор для межэлементных ссылок
Контроль0..0
На этот элемент влияют следующие инварианты: ele-1
Типid
Модификаторfalse
Формат XMLВ формате XML это свойство представлено в качестве атрибута.
Summaryfalse
8. Endpoint.meta.extension
Определение

An Extension

КороткийExtension
Контроль0..0
ТипExtension
Модификаторfalse
Summaryfalse
Инвариантыele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingЭтот элемент представляет набор разрезов на Endpoint.meta.extension. Разрезы бываютНе упорядочено и Open, и могут быть дифференцированы с помощью следующих дискриминаторов:
  • value @ url
  • 10. Endpoint.meta.versionId
    Определение

    Идентификатор конкретной версии, который отображается в части URL, относящейся к версии. Это значение изменяется при создании, обновлении или удалении ресурса.

    КороткийИдентификатор конкретной версии
    Комментарии

    Сервер присваивает это значение и игнорирует то, что указывает клиент, за исключением случая, когда сервер устанавливает целостность версии при обновлении/удалении.

    Контроль0..1
    Типid
    Модификаторfalse
    Примитивное значениеЭтот примитивный элемент может присутствовать или отсутствовать, или быть замененным расширением
    Summarytrue
    Инвариантыele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    12. Endpoint.meta.lastUpdated
    Определение

    Когда ресурс менялся в последний раз - например, когда изменилась версия.

    КороткийКогда в последний раз менялась версия ресурса
    Комментарии

    Этот элемент обычно опускается в экземплярах, отправляемых с помощью PUT или POST. Вместо этого он заполняется в экземпляре ответа и при получении информации с помощью GET. Это значение задается менеджером сервера / ресурсов; то, что предоставляет клиент, не имеет значения. Это эквивалентно последнему изменению HTTP и должно иметь такое же значение при взаимодействии read.

    Контроль0..0
    Типinstant
    Модификаторfalse
    Примитивное значениеЭтот примитивный элемент может присутствовать или отсутствовать, или быть замененным расширением
    Summarytrue
    Инвариантыele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    14. Endpoint.meta.source
    Определение

    uri, который идентифицирует систему-источник ресурса. Он предоставляет минимальный объем информации о [Provenance] (provenance.html#), которую можно использовать для отслеживания или определения источника информации на ресурсе. Источник может идентифицировать другой сервер FHIR, документ, сообщение, базу данных и т.д.

    КороткийОпределяет, откуда берется ресурс
    Комментарии

    Точное использование источника (и возможное подразумеваемое Provenance.entity.role и agent.role) остается на усмотрение разработчика. Допускается только один указанный источник; для получения дополнительной информации о происхождении следует использовать полный источник. Источник может соответствовать Provenance.entity.what[x] или Provenance.agent.who[x], хотя это может быть и более общая или абстрактная ссылка.

    Этот элемент может использоваться для указания текущего главного источника ресурса, имеющего канонический URL-адрес, если ресурс больше не размещен по каноническому URL-адресу.

    Контроль0..0
    Типuri
    Модификаторfalse
    Примитивное значениеЭтот примитивный элемент может присутствовать или отсутствовать, или быть замененным расширением
    Summarytrue
    Инвариантыele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    16. Endpoint.meta.profile
    Определение

    Список профилей (ссылок на StructureDefinition ресурсы), которым, как утверждается, соответствует этот ресурс. URL-адрес является ссылкой на StructureDefinition.url.

    КороткийСсылка на профиль
    Комментарии

    Сервер и/или другая инфраструктура политики должны определять, проверяются ли и/или обновляются ли эти утверждения с течением времени. Список URL-адресов профиля представляет собой набор.

    Контроль1..1
    Типcanonical(StructureDefinition)
    Модификаторfalse
    Примитивное значениеЭтот примитивный элемент может присутствовать или отсутствовать, или быть замененным расширением
    Summarytrue
    Значение шаблонаhttps://fhir.by/StructureDefinition/EndpointServiceRequest
    Инвариантыele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    18. Endpoint.meta.security
    Определение

    Метки безопасности, применяемые к данному ресурсу. Эти метки связывают определенные ресурсы с общей политикой безопасности и инфраструктурой.

    КороткийМетки безопасности, примененные к этому ресурсу
    Комментарии

    Метки безопасности могут быть обновлены без изменения указанной версии ресурса. Список меток безопасности представляет собой набор. Уникальность основана на системе/коде, а версия и отображение игнорируются.

    Контроль0..0
    ПривязкаЕсли они не подходят, эти коды ДОЛЖНЫ быть взяты из AllSecurityLabels
    (extensible to http://hl7.org/fhir/ValueSet/security-labels|5.0.0)

    Защитные этикетки из системы классификации конфиденциальности и безопасности в сфере здравоохранения.

    ТипCoding
    Модификаторfalse
    Summarytrue
    Инвариантыele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    20. Endpoint.meta.tag
    Определение

    Теги, применяемые к этому ресурсу. Теги предназначены для идентификации ресурсов и соотнесения их с процессами и документооборотом, и приложения не обязаны учитывать теги при интерпретации значения ресурса.

    КороткийТеги, применяемые к этому ресурсу
    Комментарии

    Теги могут быть обновлены без изменения заявленной версии ресурса. Список тегов представляет собой набор. Уникальность основана на системе/коде, а версия и отображение игнорируются.

    Контроль0..0
    ПривязкаНапример, коды см. CommonTags
    (example to http://hl7.org/fhir/ValueSet/common-tags|5.0.0)

    Коды, представляющие различные типы тегов, обычно связанные с рабочим процессом; например, "Требуется проверка доктором Джонсом".

    ТипCoding
    Модификаторfalse
    Summarytrue
    Инвариантыele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    22. Endpoint.implicitRules
    Определение

    A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

    КороткийНабор правил, в соответствии с которыми был создан этот контент
    Комментарии

    Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.

    Контроль0..1
    Типuri
    Модификаторtrue потому что This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation
    Примитивное значениеЭтот примитивный элемент может присутствовать или отсутствовать, или быть замененным расширением
    Требуется поддержкаfalse
    Summarytrue
    Инвариантыele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    24. Endpoint.language
    Определение

    The base language in which the resource is written.

    КороткийLanguage of the resource content
    Комментарии

    Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

    Контроль0..0
    ПривязкаКоды ДОЛЖНЫ быть взяты из AllLanguages
    (required to http://hl7.org/fhir/ValueSet/all-languages|5.0.0)

    Языковой тег IETF для человеческого языка

    Типcode
    Модификаторfalse
    Примитивное значениеЭтот примитивный элемент может присутствовать или отсутствовать, или быть замененным расширением
    Требуется поддержкаfalse
    Summaryfalse
    Инвариантыele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    26. Endpoint.text
    Определение

    A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

    КороткийКраткое изложение текста ресурса для интерпретации человеком
    Комментарии

    Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

    Контроль0..0
    На этот элемент влияют следующие инварианты: dom-6
    ТипNarrative
    Модификаторfalse
    Требуется поддержкаfalse
    Summaryfalse
    Альтернативные именаnarrative, html, xhtml, display
    Инвариантыele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    28. Endpoint.contained
    Определение

    These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

    КороткийАвтономные встроенные ресурсы
    Комментарии

    This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.

    Контроль0..0
    На этот элемент влияют следующие инварианты: dom-2, dom-4, dom-3, dom-5
    ТипResource
    Модификаторfalse
    Требуется поддержкаfalse
    Summaryfalse
    Альтернативные именаinline resources, anonymous resources, contained resources
    30. Endpoint.extension
    Определение

    An Extension

    КороткийExtension
    Контроль0..0
    ТипExtension
    Модификаторfalse
    Требуется поддержкаfalse
    Summaryfalse
    Инвариантыele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    32. Endpoint.modifierExtension
    Определение

    An Extension

    КороткийExtension
    Контроль0..0
    ТипExtension
    Модификаторtrue потому что Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
    Требуется поддержкаfalse
    Summarytrue
    Инвариантыele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    34. Endpoint.identifier
    Определение

    Identifier for the organization that is used to identify the endpoint across multiple disparate systems.

    КороткийIdentifies this endpoint across multiple systems
    ПримечаниеЭто бизнес-идентификатор, а не идентификатор ресурса (см. обсуждение)
    Контроль0..0
    ТипIdentifier
    Модификаторfalse
    Требуется поддержкаfalse
    Summarytrue
    Инвариантыele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    36. Endpoint.status
    Определение

    The endpoint status represents the general expected availability of an endpoint.

    Короткийactive | suspended | error | off | entered-in-error | test
    Комментарии

    This element is labeled as a modifier because the status contains codes that mark the endpoint as not currently valid. Temporary downtimes or other unexpected short-term changes in availability would not be represented in this property.

    Контроль1..1
    ПривязкаКоды ДОЛЖНЫ быть взяты из EndpointStatus
    (required to http://hl7.org/fhir/ValueSet/endpoint-status|5.0.0)

    The status of the endpoint.

    Типcode
    Модификаторtrue потому что This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
    Примитивное значениеЭтот примитивный элемент может присутствовать или отсутствовать, или быть замененным расширением
    Требуется поддержкаfalse
    Summarytrue
    Инвариантыele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    38. Endpoint.connectionType
    Определение

    A coded value that represents the technical details of the usage of this endpoint, such as what WSDLs should be used in what way. (e.g. XDS.b/DICOM/cds-hook).

    КороткийProtocol/Profile/Standard to be used with this endpoint connection
    Комментарии

    For additional connectivity details for the protocol, extensions will be used at this point, as in the XDS example. If there are multiple payload types or mimetypes they are all applicable for all connection types, and all have the same status.

    Контроль1..1
    ПривязкаКоды ДОЛЖНЫ быть взяты из Тип подключения для endpoint
    (required to https://fhir.by/ValueSet/EndpointConnectionTypeCode)
    ТипCodeableConcept
    Модификаторfalse
    Требуется поддержкаfalse
    Summarytrue
    Инвариантыele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    40. Endpoint.name
    Определение

    A friendly name that this endpoint can be referred to with.

    КороткийA name that this endpoint can be identified by
    Контроль0..0
    Типstring
    Модификаторfalse
    Примитивное значениеЭтот примитивный элемент может присутствовать или отсутствовать, или быть замененным расширением
    Требуется поддержкаfalse
    Summarytrue
    Инвариантыele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    42. Endpoint.description
    Определение

    The description of the endpoint and what it is for (typically used as supplemental information in an endpoint directory describing its usage/purpose).

    КороткийAdditional details about the endpoint that could be displayed as further information to identify the description beyond its name
    Контроль0..0
    Типstring
    Модификаторfalse
    Примитивное значениеЭтот примитивный элемент может присутствовать или отсутствовать, или быть замененным расширением
    Требуется поддержкаfalse
    Summarytrue
    Инвариантыele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    44. Endpoint.environmentType
    Определение

    The type of environment(s) exposed at this endpoint (dev, prod, test, etc.).

    КороткийThe type of environment(s) exposed at this endpoint
    Контроль0..0
    ПривязкаЕсли они не подходят, эти коды ДОЛЖНЫ быть взяты из EndpointEnvironment
    (extensible to http://hl7.org/fhir/ValueSet/endpoint-environment|5.0.0)
    ТипCodeableConcept
    Модификаторfalse
    Требуется поддержкаfalse
    Summarytrue
    Инвариантыele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    46. Endpoint.managingOrganization
    Определение

    The organization that manages this endpoint (even if technically another organization is hosting this in the cloud, it is the organization associated with the data).

    КороткийOrganization that manages this endpoint (might not be the organization that exposes the endpoint)
    Комментарии

    This property is not typically used when searching for Endpoint resources for usage. The typical usage is via the reference from an applicable Organization/Location/Practitioner resource, which is where the context is provided. Multiple Locations may reference a single endpoint, and don't have to be within the same organization resource, but most likely within the same organizational hierarchy.

    Контроль1..1
    ТипReference(Organization)
    Модификаторfalse
    Требуется поддержкаfalse
    Summarytrue
    Инвариантыele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    48. Endpoint.contact
    Определение

    Contact details for a human to contact about the endpoint. The primary use of this for system administrator troubleshooting.

    КороткийContact details for source (e.g. troubleshooting)
    Контроль0..0
    ТипContactPoint
    Модификаторfalse
    Требуется поддержкаfalse
    Summaryfalse
    Инвариантыele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    50. Endpoint.period
    Определение

    The interval during which the endpoint is expected to be operational.

    КороткийInterval the endpoint is expected to be operational
    Комментарии

    Temporary downtimes or other short-term changes in availability would not be represented in this property.

    Контроль0..0
    ТипPeriod
    Модификаторfalse
    Требуется поддержкаfalse
    Summarytrue
    Инвариантыele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    52. Endpoint.payload
    Определение

    The set of payloads that are provided/available at this endpoint.

    КороткийSet of payloads that are provided by this endpoint
    Комментарии

    Note that not all mimetypes or types will be listed under the one endpoint resource, there may be multiple instances that information for cases where other header data such as the endpoint address, active status/period etc. is different.

    Контроль0..0
    ТипBackboneElement
    Модификаторfalse
    Требуется поддержкаfalse
    Summaryfalse
    Инвариантыele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    59. Endpoint.address
    Определение

    The uri that describes the actual end-point to connect to.

    КороткийThe technical base address for connecting to this endpoint
    Комментарии

    For rest-hook, and websocket, the end-point must be an http: or https: URL; for email, a mailto: url, for sms, a tel: url, and for message the endpoint can be in any form of url the server understands (usually, http: or mllp:). The URI is allowed to be relative; in which case, it is relative to the server end-point (since there may be more than one, clients should avoid using relative URIs)

    This address will be to the service base, without any parameters, or sub-services or resources tacked on.

    E.g. for a WADO-RS endpoint, the url should be "https://pacs.hospital.org/wado-rs"

    and not "https://pacs.hospital.org/wado-rs/studies/1.2.250.1.59.40211.12345678.678910/series/1.2.250.1.59.40211.789001276.14556172.67789/instances/...".

    Контроль1..1
    Типurl
    Модификаторfalse
    Примитивное значениеЭтот примитивный элемент может присутствовать или отсутствовать, или быть замененным расширением
    Требуется поддержкаfalse
    Summarytrue
    Инвариантыele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    61. Endpoint.header
    Определение

    Additional headers / information to send as part of the notification.

    КороткийUsage depends on the channel type
    Комментарии

    Exactly what these mean depends on the channel type. The can convey additional information to the recipient and/or meet security requirements.

    Контроль0..0
    Типstring
    Модификаторfalse
    Примитивное значениеЭтот примитивный элемент может присутствовать или отсутствовать, или быть замененным расширением
    Требуется поддержкаfalse
    Summaryfalse
    Инвариантыele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))