Current Build

Переводит команда Health Samurai . Приглашаем поучаствовать в русификации стандарта FHIR: GitHub , Email.

Patient Administration Work GroupMaturity Level: 2 Trial Use Compartments: Not linked to any defined compartments

Подробное описание элементов ресурса Endpoint.

Endpoint
Element IdEndpoint
Definition

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

Control0..*
TypeDomainResource
Endpoint.identifier
Element IdEndpoint.identifier
Definition

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

NoteThis is a business identifer, not a resource identifier (see discussion)
Control0..*
TypeIdentifier
Summarytrue
Endpoint.status
Element IdEndpoint.status
Definition

active | suspended | error | off | test.

Control1..1
Terminology BindingEndpointStatus (Required)
Typecode
Is Modifiertrue (Reason: 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)
Summarytrue
Comments

This element is labeled as a modifier because the status contains codes that mark the endpoint as not currently valid.

Endpoint.connectionType
Element IdEndpoint.connectionType
Definition

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).

Control1..1
Terminology BindingEndpoint Connection Type (Extensible)
TypeCoding
Summarytrue
Comments

For additional connectivity details for the protocol, extensions will be used at this point, as in the XDS example.

Endpoint.name
Element IdEndpoint.name
Definition

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

Control0..1
Typestring
Summarytrue
Endpoint.managingOrganization
Element IdEndpoint.managingOrganization
Definition

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).

Control0..1
TypeReference(Organization)
Summarytrue
Comments

This property is not typically used when searching for Endpoint resources for usage. The typical usage is via the reference from an aplicable 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.

Endpoint.contact
Element IdEndpoint.contact
Definition

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

Control0..*
TypeContactPoint
Endpoint.period
Element IdEndpoint.period
Definition

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

Control0..1
TypePeriod
Summarytrue
Endpoint.payloadType
Element IdEndpoint.payloadType
Definition

The payload type describes the acceptable content that can be communicated on the endpoint.

Control1..*
Terminology BindingEndpoint Payload Type (Example)
TypeCodeableConcept
Summarytrue
Comments

The payloadFormat describes the serialization format of the data, where the payloadType indicates the specific document/schema that is being transferred; e.g. DischargeSummary or CarePlan.

Endpoint.payloadMimeType
Element IdEndpoint.payloadMimeType
Definition

The mime type to send the payload in - e.g. application/fhir+xml, application/fhir+json. If the mime type is not specified, then the sender could send any content (including no content depending on the connectionType).

Control0..*
Terminology BindingMimeType (Required)
Typecode
Summarytrue
Comments

Sending the payload has obvious security consequences. The server is responsible for ensuring that the content is appropriately secured.

Endpoint.address
Element IdEndpoint.address
Definition

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

Control1..1
Typeurl
Summarytrue
Comments

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 their 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/...".

Endpoint.header
Element IdEndpoint.header
Definition

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

Control0..*
Typestring
Summaryfalse
Comments

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