Release 4 5 Snapshot #1

This page is part of the FHIR Specification (v4.0.1: R4 - Mixed Normative and STU ) in it's permanent home (it will always be available at this URL). (v5.0.0-snapshot1: R5 Snapshot #1). The current version which supercedes this version is 5.0.0 . For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3

8.9.7 8.9.8 Resource Endpoint - Detailed Descriptions

Patient Administration Work Group Maturity Level : 2   Trial Use Security Category : Business Compartments : Not linked to any defined compartments

Detailed Descriptions for the elements in the Endpoint resource.

Endpoint
Element Id Endpoint
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.

Cardinality 0..*
Type DomainResource
Summary false
Endpoint.identifier
Element Id Endpoint.identifier
Definition

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

Note This is a business identifier, not a resource identifier (see discussion )
Cardinality 0..*
Type Identifier
Summary true
Endpoint.status
Element Id Endpoint.status
Definition

active | suspended | error | off | test.

Cardinality 1..1
Terminology Binding EndpointStatus ( Required )
Type code
Is Modifier true (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)
Summary true
Comments

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

Endpoint.connectionType
Element Id Endpoint.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).

Cardinality 1..1
Terminology Binding Endpoint Connection Type ( Extensible )
Type Coding
Summary true
Comments

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

Endpoint.name
Element Id Endpoint.name
Definition

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

Cardinality 0..1
Type string
Summary true
Endpoint.managingOrganization
Element Id Endpoint.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).

Cardinality 0..1
Type Reference ( Organization )
Summary true
Comments

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.

Endpoint.contact
Element Id Endpoint.contact
Definition

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

Cardinality 0..*
Type ContactPoint
Summary false
Endpoint.period
Element Id Endpoint.period
Definition

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

Cardinality 0..1
Type Period
Summary true
Endpoint.payloadType
Element Id Endpoint.payloadType
Definition

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

Cardinality 1..*
Terminology Binding Endpoint Payload Type ( Example )
Type CodeableConcept
Summary true
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 Id Endpoint.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).

Cardinality 0..*
Terminology Binding MimeType ( Required )
Type code
Summary true
Comments

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

Endpoint.address
Element Id Endpoint.address
Definition

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

Cardinality 1..1
Type url
Summary true
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 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/...".

Endpoint.header
Element Id Endpoint.header
Definition

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

Cardinality 0..*
Type string
Summary false
Comments

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