FHIR CI-Build

This is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions icon

Patient Administration icon Work GroupMaturity Level: 2 Trial UseSecurity Category: Business Compartments: No defined compartments

Detailed Descriptions for the elements in the Endpoint resource.

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, a REST endpoint for another FHIR server, or a s/Mime email address. This may include any security context information.

Short DisplayThe technical details of an endpoint that can be used for electronic services
Cardinality0..*
TypeDomainResource
Summaryfalse
Endpoint.identifier
Element IdEndpoint.identifier
Definition

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

Short DisplayIdentifies this endpoint across multiple systems
NoteThis is a business identifier, not a resource identifier (see discussion)
Cardinality0..*
TypeIdentifier
Summarytrue
Endpoint.status
Element IdEndpoint.status
Definition

The endpoint status represents whether the endpoint can currently be used for connections or why it can't be used.

Short Displayactive | suspended | error | off | entered-in-error
Cardinality1..1
Terminology BindingEndpoint Status (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. Temporary downtimes or other unexpected short-term changes in availability would not be represented in this property.

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

Short DisplayProtocol/Profile/Standard to be used with this endpoint connection
Cardinality1..*
Terminology BindingEndpoint Connection Type (Example)
TypeCodeableConcept
Summarytrue
Comments

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.

Endpoint.name
Element IdEndpoint.name
Definition

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

Short DisplayA name that this endpoint can be identified by
Cardinality0..1
Typestring
Summarytrue
Endpoint.description
Element IdEndpoint.description
Definition

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

Short DisplayAdditional details about the endpoint that could be displayed as further information to identify the description beyond its name
Cardinality0..1
Typestring
Summarytrue
Endpoint.environmentType
Element IdEndpoint.environmentType
Definition

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

Short DisplayThe type of environment(s) exposed at this endpoint
Cardinality0..*
Terminology BindingEndpoint Environment (Extensible)
TypeCodeableConcept
Summarytrue
Endpoint.managingOrganization
Element IdEndpoint.managingOrganization
Definition

The organization that provides technical management services for this endpoint. This would be the organization that acts as the public help desk for when the endpoint is not functioning. It does NOT necessarily represent the organization who is the steward of data being provided/accepted by the endpoint.

Short DisplayOrganization that manages this endpoint (might not be the organization that exposes the endpoint)
Cardinality0..1
TypeReference(Organization)
Summarytrue
Comments

This property would NOT be used if the organization is only providing technical infrastructure. For example, it would NOT refer to the cloud hosting provider if that provider were not providing helpdesk support for the endpoint.

This property would NOT be used to represent the entity that is the steward of the data exposed by the endpoint. This should be represented via Organization.endpoint. PractitionerRole.endpoint, Location.endpoint, or the other directory resources that may refer to endpoints.

This property is not typically used when searching for Endpoint resources for the purpose of retrieving or sending clinical or administrative data. However you may use this property to find endpoints for other technical administrative reasons such as if an organization that is managing endpoints is going out of business, you may need to update to the new managing organization.

Endpoint.contact
Element IdEndpoint.contact
Definition

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

Short DisplayContact details for source (e.g. troubleshooting)
Cardinality0..*
TypeContactPoint
Summaryfalse
Endpoint.period
Element IdEndpoint.period
Definition

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

Short DisplayInterval the endpoint is expected to be operational
Cardinality0..1
TypePeriod
Summarytrue
Comments

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

Endpoint.availability
Element IdEndpoint.availability
Definition

The times the endpoint is expected to be available, including transient downtimes and any exceptions.

Short DisplayTimes the endpoint is expected to be available (including exceptions)
Cardinality0..1
TypeAvailability
Summaryfalse
Comments

Endpoint.availability is meant to represent specific availability, including temporary downtimes or other short term changes in availability. Conversely, Endpoint.period is meant to represent the general planned period of time when the Endpoint may be used, for example when an endpoint is being commissioned or decommissioned. For example, if an Endpoint is only available during business hours (9-5), the lack of availability during the night would not be reflected in Endpoint.period,but would be reflected in Endpoint.availability.

Endpoint.payload
Element IdEndpoint.payload
Definition

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

Short DisplaySet of payloads that are provided by this endpoint
Cardinality0..*
Summaryfalse
Comments

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.

Endpoint.payload.type
Element IdEndpoint.payload.type
Definition

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

Short DisplayThe type of content that may be used at this endpoint (e.g. XDS Discharge summaries)
Cardinality0..*
Terminology BindingEndpoint Payload Type (Example)
TypeCodeableConcept
Summarytrue
Comments

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

Endpoint.payload.mimeType
Element IdEndpoint.payload.mimeType
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).

Short DisplayMimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this)
Cardinality0..*
Terminology BindingMime Types (Required)
Typecode
Summarytrue
Comments

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

Endpoint.payload.profileCanonical
Element IdEndpoint.payload.profileCanonical
Definition

The FHIR profile that is expected at this endpoint. It describes the resources that are handled, or even simply which resource types -e.g. Vital Sign Observations or QuestionnaireResponse. The profileUri may be used when a FHIR Structure Definition is not available/appropriate.

Short DisplayThe profile that is expected at this endpoint
Cardinality0..*
Typecanonical
Summaryfalse
Endpoint.payload.profileUri
Element IdEndpoint.payload.profileUri
Definition

The profile (as a uri) that is expected at this endpoint when not represented using a FHIR profile.

e.g. CDA Template ID expressed as an OID (in the Uri).

Short DisplayThe non-fhir based profile that is expected at this endpoint
Cardinality0..*
Typeuri
Summaryfalse
Endpoint.address
Element IdEndpoint.address
Definition

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

Short DisplayThe technical base address for connecting to this endpoint
Cardinality1..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 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 IdEndpoint.header
Definition

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

Short DisplayUsage depends on the channel type
Cardinality0..*
Typestring
Summaryfalse
Comments

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