EHDS Logical Information Models
0.1.0 - ci-build

EHDS Logical Information Models, published by Xt-EHR. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/Xt-EHR/xt-ehr-common/tree/main and changes regularly. See the Directory of published versions

Logical Model: EHDSEndpoint - Detailed Descriptions

Draft as of 2025-06-13

Definitions for the EHDSEndpoint logical model.

Guidance on how to interpret the contents of this table can be foundhere

0. EHDSEndpoint
Definition

C.33 - EHDS refined base model for Endpoint


Base definition for all types defined in FHIR type system.

ShortEndpoint modelBase for all types and resources
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. EHDSEndpoint.identifier
Definition

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

ShortC.33.1 - Identifier
NoteThis is a business identifier, not a resource identifier (see discussion)
Control1..*
TypeIdentifier
4. EHDSEndpoint.status
Definition

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

ShortC.33.2 - Status
Control1..1
Binding

hl7:EndpointStatus

TypeCodeableConcept
6. EHDSEndpoint.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).

ShortC.33.3 - Connection type
Control1..*
Binding

hl7:endpoint-connection-type

TypeCodeableConcept
8. EHDSEndpoint.name
Definition

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

ShortC.33.4 - Name
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
10. EHDSEndpoint.managingOrganization
Definition

The organization that provides technical management services for this endpoint.

ShortC.33.5 - Managing organization
Control0..1
Typehttps://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSOrganization
12. EHDSEndpoint.payload
Definition

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

ShortC.33.6 - Payload
Control0..*
TypeBase
14. EHDSEndpoint.payload.type
Definition

The type of content that may be used at this endpoint (e.g. XDS Discharge summaries).

ShortC.33.6.1 - Type
Control0..*
Binding

hl7:endpoint-payload-type

TypeCodeableConcept
16. EHDSEndpoint.payload.mimeType
Definition

The mime type to send the payload in - e.g. application/fhir+xml, application/fhir+json.

ShortC.33.6.2 - Mime type
Control0..*
Binding

BCP-13

TypeCodeableConcept
18. EHDSEndpoint.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.

ShortC.33.6.3 - Profile Canonical
Control0..*
Typeuri
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
20. EHDSEndpoint.payload.profileUri
Definition

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

ShortC.33.6.4 - Profile uri
Control0..*
Typeuri
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
22. EHDSEndpoint.address
Definition

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

ShortC.33.7 - Address
Control1..1
Typeuri
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
24. EHDSEndpoint.header
Definition

Additional headers / information to send as part of the notification. Usage depends on the channel type.

ShortC.33.8 - Header
Control0..*
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension

Guidance on how to interpret the contents of this table can be foundhere

0. EHDSEndpoint
Definition

C.33 - EHDS refined base model for Endpoint

ShortEndpoint model
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. EHDSEndpoint.identifier
Definition

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

ShortC.33.1 - Identifier
NoteThis is a business identifier, not a resource identifier (see discussion)
Control1..*
TypeIdentifier
4. EHDSEndpoint.status
Definition

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

ShortC.33.2 - Status
Control1..1
Binding

hl7:EndpointStatus

TypeCodeableConcept
6. EHDSEndpoint.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).

ShortC.33.3 - Connection type
Control1..*
Binding

hl7:endpoint-connection-type

TypeCodeableConcept
8. EHDSEndpoint.name
Definition

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

ShortC.33.4 - Name
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
10. EHDSEndpoint.managingOrganization
Definition

The organization that provides technical management services for this endpoint.

ShortC.33.5 - Managing organization
Control0..1
Typehttps://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSOrganization
12. EHDSEndpoint.payload
Definition

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

ShortC.33.6 - Payload
Control0..*
TypeBase
14. EHDSEndpoint.payload.type
Definition

The type of content that may be used at this endpoint (e.g. XDS Discharge summaries).

ShortC.33.6.1 - Type
Control0..*
Binding

hl7:endpoint-payload-type

TypeCodeableConcept
16. EHDSEndpoint.payload.mimeType
Definition

The mime type to send the payload in - e.g. application/fhir+xml, application/fhir+json.

ShortC.33.6.2 - Mime type
Control0..*
Binding

BCP-13

TypeCodeableConcept
18. EHDSEndpoint.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.

ShortC.33.6.3 - Profile Canonical
Control0..*
Typeuri
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
20. EHDSEndpoint.payload.profileUri
Definition

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

ShortC.33.6.4 - Profile uri
Control0..*
Typeuri
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
22. EHDSEndpoint.address
Definition

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

ShortC.33.7 - Address
Control1..1
Typeuri
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
24. EHDSEndpoint.header
Definition

Additional headers / information to send as part of the notification. Usage depends on the channel type.

ShortC.33.8 - Header
Control0..*
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension

Guidance on how to interpret the contents of this table can be foundhere

0. EHDSEndpoint
Definition

C.33 - EHDS refined base model for Endpoint

ShortEndpoint model
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. EHDSEndpoint.identifier
Definition

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

ShortC.33.1 - Identifier
NoteThis is a business identifier, not a resource identifier (see discussion)
Control1..*
TypeIdentifier
4. EHDSEndpoint.status
Definition

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

ShortC.33.2 - Status
Control1..1
Binding

hl7:EndpointStatus

TypeCodeableConcept
6. EHDSEndpoint.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).

ShortC.33.3 - Connection type
Control1..*
Binding

hl7:endpoint-connection-type

TypeCodeableConcept
8. EHDSEndpoint.name
Definition

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

ShortC.33.4 - Name
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
10. EHDSEndpoint.managingOrganization
Definition

The organization that provides technical management services for this endpoint.

ShortC.33.5 - Managing organization
Control0..1
Typehttps://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSOrganization
12. EHDSEndpoint.payload
Definition

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

ShortC.33.6 - Payload
Control0..*
TypeBase
14. EHDSEndpoint.payload.type
Definition

The type of content that may be used at this endpoint (e.g. XDS Discharge summaries).

ShortC.33.6.1 - Type
Control0..*
Binding

hl7:endpoint-payload-type

TypeCodeableConcept
16. EHDSEndpoint.payload.mimeType
Definition

The mime type to send the payload in - e.g. application/fhir+xml, application/fhir+json.

ShortC.33.6.2 - Mime type
Control0..*
Binding

BCP-13

TypeCodeableConcept
18. EHDSEndpoint.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.

ShortC.33.6.3 - Profile Canonical
Control0..*
Typeuri
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
20. EHDSEndpoint.payload.profileUri
Definition

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

ShortC.33.6.4 - Profile uri
Control0..*
Typeuri
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
22. EHDSEndpoint.address
Definition

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

ShortC.33.7 - Address
Control1..1
Typeuri
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
24. EHDSEndpoint.header
Definition

Additional headers / information to send as part of the notification. Usage depends on the channel type.

ShortC.33.8 - Header
Control0..*
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension