This page is part of the FHIR Specification (v5.0.0: R5 - STU). This is the current published version. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3
Patient Administration Work Group | Maturity Level: 2 | Trial Use | Security Category: Business | Compartments: No 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, a REST endpoint for another FHIR server, or a s/Mime email address. This may include any security context information. |
Short Display | The technical details of an endpoint that can be used for electronic services |
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. |
Short Display | Identifies this endpoint across multiple 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 | The endpoint status represents the general expected availability of an endpoint. |
Short Display | active | suspended | error | off | entered-in-error | test |
Cardinality | 1..1 |
Terminology Binding | Endpoint Status (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. Temporary downtimes or other unexpected short-term changes in availability would not be represented in this property. |
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). |
Short Display | Protocol/Profile/Standard to be used with this endpoint connection |
Cardinality | 1..* |
Terminology Binding | Endpoint Connection Type (Example) |
Type | CodeableConcept |
Summary | true |
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 Id | Endpoint.name |
Definition | A friendly name that this endpoint can be referred to with. |
Short Display | A name that this endpoint can be identified by |
Cardinality | 0..1 |
Type | string |
Summary | true |
Endpoint.description | |
Element Id | Endpoint.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 Display | Additional details about the endpoint that could be displayed as further information to identify the description beyond its name |
Cardinality | 0..1 |
Type | string |
Summary | true |
Endpoint.environmentType | |
Element Id | Endpoint.environmentType |
Definition | The type of environment(s) exposed at this endpoint (dev, prod, test, etc.). |
Short Display | The type of environment(s) exposed at this endpoint |
Cardinality | 0..* |
Terminology Binding | Endpoint Environment (Extensible) |
Type | CodeableConcept |
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). |
Short Display | Organization that manages this endpoint (might not be the organization that exposes the endpoint) |
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 endpoint. The primary use of this for system administrator troubleshooting. |
Short Display | Contact details for source (e.g. 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. |
Short Display | Interval the endpoint is expected to be operational |
Cardinality | 0..1 |
Type | Period |
Summary | true |
Comments | Temporary downtimes or other short-term changes in availability would not be represented in this property. |
Endpoint.payload | |
Element Id | Endpoint.payload |
Definition | The set of payloads that are provided/available at this endpoint. |
Short Display | Set of payloads that are provided by this endpoint |
Cardinality | 0..* |
Summary | false |
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 Id | Endpoint.payload.type |
Definition | The payload type describes the acceptable content that can be communicated on the endpoint. |
Short Display | The type of content that may be used at this endpoint (e.g. XDS Discharge summaries) |
Cardinality | 0..* |
Terminology Binding | Endpoint Payload Type (Example) |
Type | CodeableConcept |
Summary | true |
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 Id | Endpoint.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 Display | Mimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this) |
Cardinality | 0..* |
Terminology Binding | Mime Types (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. |
Short Display | The technical base address for connecting to this endpoint |
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. |
Short Display | Usage depends on the channel type |
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. |