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.

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

active | suspended | error | off.

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

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

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

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

The type of channel to send notifications on.

The http verb to be used when calling this endpoint.

This is the HTTP method that must be used when using the connection.

The interval during which the managing organization assumes the defined responsibility.

The uri that describes the actual end-point to send messages to.

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

The mime type to send the payload in - either application/fhir+xml, or application/fhir+json. If the mime type is blank, then there is no payload in the notification, just a notification.

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

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

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

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

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

The public part of the 'keys' allocated to an Organization by an accredited body to support secure exchange of data over the internet. To be provided by the Organization, where available.