Wales FHIR Implementation Guide

Important: All content in this FHIR Implementation Guide is under development

DataStandardsWales-Endpoint

The Endpoint resource contains information about a physical place where services are provided and resources and participants may be stored, found, contained, or accommodated. Typical examples include buildings, wards, corridors, rooms or beds, but may also include mobile clinics, a vehicle or lift, or a patient's home.

The DataStandardsWales-Endpoint profile is derived from the HL7 R4 Endpoint Standard. It defines additional rules for use within health and care organisations in Wales.

Formal Views of Profile Content

Snapshot View
Differential View
Hybrid View
Examples

Endpoint	I		Endpoint	There are no (further) constraints on this element Element Id Endpoint Short description The technical details of an endpoint that can be used for electronic services 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. Data Type Endpoint Constraints dom-2:If the resource is contained in another resource, it SHALL NOT contain nested Resources `contained.contained.empty()` dom-4:If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated `contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()` dom-3:If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource `contained.where((('#'+id in (%resource.descendants().reference \| %resource.descendants().as(canonical) \| %resource.descendants().as(uri) \| %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()` dom-6:A resource should have narrative for robust management text.`div`.exists() dom-5:If a resource is contained in another resource, it SHALL NOT have a security label `contained.meta.security.empty()` Mappings rim:Entity. Role, or Act rim:n/a
identifier	Σ	0..*	Identifier	There are no (further) constraints on this element Element Id Endpoint.identifier Short description Identifies this endpoint across multiple systems Definition Identifier for the organization that is used to identify the endpoint across multiple disparate systems. Data Type Identifier Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CX / EI (occasionally, more often EI maps to a resource id or a URL) rim:II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT] servd:Identifier w5:FiveWs.identifier
status	Σ ?!	1..1	codeBinding	There are no (further) constraints on this element Element Id Endpoint.status Short description active \| suspended \| error \| off \| entered-in-error \| test Definition active \| suspended \| error \| off \| test. Comments This element is labeled as a modifier because the status contains codes that mark the endpoint as not currently valid. Data Type code Binding The status of the endpoint. EndpointStatus (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a w5:FiveWs.status
connectionType	Σ	1..1	CodingBinding	There are no (further) constraints on this element Element Id Endpoint.connectionType Short description Protocol/Profile/Standard to be used with this endpoint connection 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). Comments For additional connectivity details for the protocol, extensions will be used at this point, as in the XDS example. Data Type Coding Binding EndpointConnectionType (extensible) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CE/CNE/CWE subset one of the sets of component 1-3 or 4-6 rim:CV orim:fhir:Coding rdfs:subClassOf dt:CDCoding w5:FiveWs.class
name	Σ	0..1	string	There are no (further) constraints on this element Element Id Endpoint.name Short description A name that this endpoint can be identified by Definition A friendly name that this endpoint can be referred to with. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a w5:FiveWs.what[x]
managingOrganization	Σ I	0..1	Reference(Data Standards Wales Organization Profile)	Element Id Endpoint.managingOrganization Short description Organization that manages this endpoint (might not be the organization that exposes the endpoint) 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). 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. Data Type Reference(Data Standards Wales Organization Profile) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ref-1:SHALL have a contained resource if a local reference is provided `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))` Mappings rim:n/a rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
contact	I	0..*	ContactPoint	There are no (further) constraints on this element Element Id Endpoint.contact Short description Contact details for source (e.g. troubleshooting) Definition Contact details for a human to contact about the subscription. The primary use of this for system administrator troubleshooting. Data Type ContactPoint Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` cpt-2:A system is required if a value is provided. `value.empty() or system.exists()` Mappings rim:n/a v2:XTN rim:TEL servd:ContactPoint
period	Σ I	0..1	Period	There are no (further) constraints on this element Element Id Endpoint.period Short description Interval the endpoint is expected to be operational Definition The interval during which the endpoint is expected to be operational. Comments A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. Data Type Period Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` per-1:If present, start SHALL have a lower value than end `start.hasValue().not() or end.hasValue().not() or (start <= end)` Mappings rim:n/a v2:DR rim:IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"] w5:FiveWs.done[x]
payloadType	Σ	1..*	CodeableConcept	There are no (further) constraints on this element Element Id Endpoint.payloadType Short description The type of content that may be used at this endpoint (e.g. XDS Discharge summaries) Definition The payload type describes the acceptable content that can be communicated on the endpoint. 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. Data Type CodeableConcept Binding EndpointPayloadType (example) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CE/CNE/CWE rim:CD orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
payloadMimeType	Σ	0..*	codeBinding	There are no (further) constraints on this element Element Id Endpoint.payloadMimeType Short description Mimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this) 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). Comments Sending the payload has obvious security consequences. The server is responsible for ensuring that the content is appropriately secured. Data Type code Binding The mime type of an attachment. Any valid mime type is allowed. Mime Types (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
address	Σ	1..1	url	There are no (further) constraints on this element Element Id Endpoint.address Short description The technical base address for connecting to this endpoint Definition The uri that describes the actual end-point to connect to. 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/...". Data Type url Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
header		0..*	string	There are no (further) constraints on this element Element Id Endpoint.header Short description Usage depends on the channel type Definition Additional headers / information to send as part of the notification. Comments Exactly what these mean depends on the channel type. The can convey additional information to the recipient and/or meet security requirements. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a

Endpoint	I		Endpoint	There are no (further) constraints on this element Element Id Endpoint Short description The technical details of an endpoint that can be used for electronic services 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. Data Type Endpoint Constraints dom-2:If the resource is contained in another resource, it SHALL NOT contain nested Resources `contained.contained.empty()` dom-4:If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated `contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()` dom-3:If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource `contained.where((('#'+id in (%resource.descendants().reference \| %resource.descendants().as(canonical) \| %resource.descendants().as(uri) \| %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()` dom-6:A resource should have narrative for robust management text.`div`.exists() dom-5:If a resource is contained in another resource, it SHALL NOT have a security label `contained.meta.security.empty()` Mappings rim:Entity. Role, or Act rim:n/a
identifier	Σ	0..*	Identifier	There are no (further) constraints on this element Element Id Endpoint.identifier Short description Identifies this endpoint across multiple systems Definition Identifier for the organization that is used to identify the endpoint across multiple disparate systems. Data Type Identifier Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CX / EI (occasionally, more often EI maps to a resource id or a URL) rim:II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT] servd:Identifier w5:FiveWs.identifier
status	Σ ?!	1..1	codeBinding	There are no (further) constraints on this element Element Id Endpoint.status Short description active \| suspended \| error \| off \| entered-in-error \| test Definition active \| suspended \| error \| off \| test. Comments This element is labeled as a modifier because the status contains codes that mark the endpoint as not currently valid. Data Type code Binding The status of the endpoint. EndpointStatus (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a w5:FiveWs.status
connectionType	Σ	1..1	CodingBinding	There are no (further) constraints on this element Element Id Endpoint.connectionType Short description Protocol/Profile/Standard to be used with this endpoint connection 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). Comments For additional connectivity details for the protocol, extensions will be used at this point, as in the XDS example. Data Type Coding Binding EndpointConnectionType (extensible) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CE/CNE/CWE subset one of the sets of component 1-3 or 4-6 rim:CV orim:fhir:Coding rdfs:subClassOf dt:CDCoding w5:FiveWs.class
name	Σ	0..1	string	There are no (further) constraints on this element Element Id Endpoint.name Short description A name that this endpoint can be identified by Definition A friendly name that this endpoint can be referred to with. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a w5:FiveWs.what[x]
managingOrganization	Σ I	0..1	Reference(Data Standards Wales Organization Profile)	Element Id Endpoint.managingOrganization Short description Organization that manages this endpoint (might not be the organization that exposes the endpoint) 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). 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. Data Type Reference(Data Standards Wales Organization Profile) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ref-1:SHALL have a contained resource if a local reference is provided `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))` Mappings rim:n/a rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
contact	I	0..*	ContactPoint	There are no (further) constraints on this element Element Id Endpoint.contact Short description Contact details for source (e.g. troubleshooting) Definition Contact details for a human to contact about the subscription. The primary use of this for system administrator troubleshooting. Data Type ContactPoint Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` cpt-2:A system is required if a value is provided. `value.empty() or system.exists()` Mappings rim:n/a v2:XTN rim:TEL servd:ContactPoint
period	Σ I	0..1	Period	There are no (further) constraints on this element Element Id Endpoint.period Short description Interval the endpoint is expected to be operational Definition The interval during which the endpoint is expected to be operational. Comments A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. Data Type Period Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` per-1:If present, start SHALL have a lower value than end `start.hasValue().not() or end.hasValue().not() or (start <= end)` Mappings rim:n/a v2:DR rim:IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"] w5:FiveWs.done[x]
payloadType	Σ	1..*	CodeableConcept	There are no (further) constraints on this element Element Id Endpoint.payloadType Short description The type of content that may be used at this endpoint (e.g. XDS Discharge summaries) Definition The payload type describes the acceptable content that can be communicated on the endpoint. 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. Data Type CodeableConcept Binding EndpointPayloadType (example) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CE/CNE/CWE rim:CD orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
payloadMimeType	Σ	0..*	codeBinding	There are no (further) constraints on this element Element Id Endpoint.payloadMimeType Short description Mimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this) 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). Comments Sending the payload has obvious security consequences. The server is responsible for ensuring that the content is appropriately secured. Data Type code Binding The mime type of an attachment. Any valid mime type is allowed. Mime Types (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
address	Σ	1..1	url	There are no (further) constraints on this element Element Id Endpoint.address Short description The technical base address for connecting to this endpoint Definition The uri that describes the actual end-point to connect to. 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/...". Data Type url Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
header		0..*	string	There are no (further) constraints on this element Element Id Endpoint.header Short description Usage depends on the channel type Definition Additional headers / information to send as part of the notification. Comments Exactly what these mean depends on the channel type. The can convey additional information to the recipient and/or meet security requirements. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a

Endpoint	I		Endpoint	There are no (further) constraints on this element Element Id Endpoint Short description The technical details of an endpoint that can be used for electronic services 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. Data Type Endpoint Constraints dom-2:If the resource is contained in another resource, it SHALL NOT contain nested Resources `contained.contained.empty()` dom-4:If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated `contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()` dom-3:If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource `contained.where((('#'+id in (%resource.descendants().reference \| %resource.descendants().as(canonical) \| %resource.descendants().as(uri) \| %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()` dom-6:A resource should have narrative for robust management text.`div`.exists() dom-5:If a resource is contained in another resource, it SHALL NOT have a security label `contained.meta.security.empty()` Mappings rim:Entity. Role, or Act rim:n/a
identifier	Σ	0..*	Identifier	There are no (further) constraints on this element Element Id Endpoint.identifier Short description Identifies this endpoint across multiple systems Definition Identifier for the organization that is used to identify the endpoint across multiple disparate systems. Data Type Identifier Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CX / EI (occasionally, more often EI maps to a resource id or a URL) rim:II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT] servd:Identifier w5:FiveWs.identifier
status	Σ ?!	1..1	codeBinding	There are no (further) constraints on this element Element Id Endpoint.status Short description active \| suspended \| error \| off \| entered-in-error \| test Definition active \| suspended \| error \| off \| test. Comments This element is labeled as a modifier because the status contains codes that mark the endpoint as not currently valid. Data Type code Binding The status of the endpoint. EndpointStatus (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a w5:FiveWs.status
connectionType	Σ	1..1	CodingBinding	There are no (further) constraints on this element Element Id Endpoint.connectionType Short description Protocol/Profile/Standard to be used with this endpoint connection 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). Comments For additional connectivity details for the protocol, extensions will be used at this point, as in the XDS example. Data Type Coding Binding EndpointConnectionType (extensible) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CE/CNE/CWE subset one of the sets of component 1-3 or 4-6 rim:CV orim:fhir:Coding rdfs:subClassOf dt:CDCoding w5:FiveWs.class
name	Σ	0..1	string	There are no (further) constraints on this element Element Id Endpoint.name Short description A name that this endpoint can be identified by Definition A friendly name that this endpoint can be referred to with. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a w5:FiveWs.what[x]
managingOrganization	Σ I	0..1	Reference(Data Standards Wales Organization Profile)	Element Id Endpoint.managingOrganization Short description Organization that manages this endpoint (might not be the organization that exposes the endpoint) 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). 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. Data Type Reference(Data Standards Wales Organization Profile) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ref-1:SHALL have a contained resource if a local reference is provided `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))` Mappings rim:n/a rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
contact	I	0..*	ContactPoint	There are no (further) constraints on this element Element Id Endpoint.contact Short description Contact details for source (e.g. troubleshooting) Definition Contact details for a human to contact about the subscription. The primary use of this for system administrator troubleshooting. Data Type ContactPoint Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` cpt-2:A system is required if a value is provided. `value.empty() or system.exists()` Mappings rim:n/a v2:XTN rim:TEL servd:ContactPoint
period	Σ I	0..1	Period	There are no (further) constraints on this element Element Id Endpoint.period Short description Interval the endpoint is expected to be operational Definition The interval during which the endpoint is expected to be operational. Comments A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. Data Type Period Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` per-1:If present, start SHALL have a lower value than end `start.hasValue().not() or end.hasValue().not() or (start <= end)` Mappings rim:n/a v2:DR rim:IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"] w5:FiveWs.done[x]
payloadType	Σ	1..*	CodeableConcept	There are no (further) constraints on this element Element Id Endpoint.payloadType Short description The type of content that may be used at this endpoint (e.g. XDS Discharge summaries) Definition The payload type describes the acceptable content that can be communicated on the endpoint. 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. Data Type CodeableConcept Binding EndpointPayloadType (example) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CE/CNE/CWE rim:CD orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
payloadMimeType	Σ	0..*	codeBinding	There are no (further) constraints on this element Element Id Endpoint.payloadMimeType Short description Mimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this) 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). Comments Sending the payload has obvious security consequences. The server is responsible for ensuring that the content is appropriately secured. Data Type code Binding The mime type of an attachment. Any valid mime type is allowed. Mime Types (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
address	Σ	1..1	url	There are no (further) constraints on this element Element Id Endpoint.address Short description The technical base address for connecting to this endpoint Definition The uri that describes the actual end-point to connect to. 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/...". Data Type url Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
header		0..*	string	There are no (further) constraints on this element Element Id Endpoint.header Short description Usage depends on the channel type Definition Additional headers / information to send as part of the notification. Comments Exactly what these mean depends on the channel type. The can convey additional information to the recipient and/or meet security requirements. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a

Example Endpoint - DICOM Endpoint

Example Endpoint

The following Endpoint example resources are provided within this guide:

Example Endpoint - DICOM Endpoint