DK EER Endpoint Register (EER)
0.8.0 - ci-build Denmark flag

DK EER Endpoint Register (EER), published by . This guide is not an authorized publication; it is the continuous build for version 0.8.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/medcomdk/dk-ehmi-eer/ and changes regularly. See the Directory of published versions

Resource Profile: EER Endpoint - General Endpoint

Official URL: http://medcomehmi.dk/ig/dk-ehmi-eer/StructureDefinition/eer.dk.endpoint Version: 0.8.0
Draft as of 2024-11-21 Computable Name: EerEndpoint

A profile on the mCSD Endpoint.

An Organization may be reachable through electronic Endpoint(s). An Endpoint may be a eDelivery receiver or a vans receiver (or in the future a FHIR server, an IHE web services actor, or some other mechanism).

Usage:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from MCSDEndpoint

NameFlagsCard.TypeDescription & Constraintsdoco
.. Endpoint MCSDEndpoint
... identifier S 1..1 Identifier Identifies this endpoint across multiple systems
.... type 0..1 CodeableConcept Description of identifier
Binding: http://medcomehmi.dk/ig/dk-ehmi-eer/CodeSystem/ehmi-auditevent-agent-who-identifier-types (required)
.... system 0..1 uri The namespace for the identifier value
Required Pattern: http://medcomehmi.dk/ig/dk-ehmi-eer/CodeSystem/ehmi-auditevent-agent-who-identifier-types
.... value S 1..1 string The value that is unique
... connectionType 1..1 Coding Protocol/Profile/Standard to be used with this endpoint connection
Binding: EER connection Types Valueset (required)
... period 1..1 Period Overall deployment lifetime for this endpoint.

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Endpoint.identifier.typerequiredhttp://medcomehmi.dk/ig/dk-ehmi-eer/CodeSystem/ehmi-auditevent-agent-who-identifier-types
http://medcomehmi.dk/ig/dk-ehmi-eer/CodeSystem/ehmi-auditevent-agent-who-identifier-types
Endpoint.connectionTyperequiredEerEndpointConnectionTypeVS (a valid code from EER Connection Types CS)
http://medcomehmi.dk/ig/dk-ehmi-eer/ValueSet/eer-endpoint-connection-type-valueset
from this IG
NameFlagsCard.TypeDescription & Constraintsdoco
.. Endpoint 0..* MCSDEndpoint The technical details of an endpoint that can be used for electronic services
... Slices for extension Content/Rules for all slices
.... purposeOfUse 0..* CodeableConcept Purpose of Use Extension
URL: https://profiles.ihe.net/ITI/mCSD/StructureDefinition/IHE.mCSD.PurposeOfUse
Binding: PurposeOfUse (preferred)
... identifier SΣ 1..1 Identifier Identifies this endpoint across multiple systems
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... type Σ 0..1 CodeableConcept Description of identifier
Binding: http://medcomehmi.dk/ig/dk-ehmi-eer/CodeSystem/ehmi-auditevent-agent-who-identifier-types (required)
.... system Σ 0..1 uri The namespace for the identifier value
Required Pattern: http://medcomehmi.dk/ig/dk-ehmi-eer/CodeSystem/ehmi-auditevent-agent-who-identifier-types
.... value SΣ 1..1 string The value that is unique
Example General: 123456
... status ?!SΣ 1..1 code represents the current status of this endpoint.
Binding: EndpointStatus (required): The status of the endpoint.

... managingOrganization Σ 1..1 Reference(mCSD Organization) Organization that manages this endpoint.
... period SΣ 1..1 Period Overall deployment lifetime for this endpoint.
... payloadType Σ 1..* CodeableConcept The type of content that may be used at this endpoint (e.g. XDS Discharge summaries)
Binding: EndpointPayloadType (example)
... address Σ 1..1 url The technical base address for connecting to this endpoint

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Endpoint.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Endpoint.identifier.typerequiredhttp://medcomehmi.dk/ig/dk-ehmi-eer/CodeSystem/ehmi-auditevent-agent-who-identifier-types
http://medcomehmi.dk/ig/dk-ehmi-eer/CodeSystem/ehmi-auditevent-agent-who-identifier-types
Endpoint.statusrequiredEndpointStatus
http://hl7.org/fhir/ValueSet/endpoint-status|4.0.1
from the FHIR Standard
Endpoint.connectionTyperequiredEerEndpointConnectionTypeVS (a valid code from EER Connection Types CS)
http://medcomehmi.dk/ig/dk-ehmi-eer/ValueSet/eer-endpoint-connection-type-valueset
from this IG
Endpoint.payloadTypeexampleEndpointPayloadType
http://hl7.org/fhir/ValueSet/endpoint-payload-type
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorEndpointIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorEndpointIf 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-4errorEndpointIf 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-5errorEndpointIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceEndpointA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. Endpoint 0..* MCSDEndpoint The technical details of an endpoint that can be used for electronic services
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguages Max Binding
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... purposeOfUse 0..* CodeableConcept Purpose of Use Extension
URL: https://profiles.ihe.net/ITI/mCSD/StructureDefinition/IHE.mCSD.PurposeOfUse
Binding: PurposeOfUse (preferred)
... identifier SΣ 1..1 Identifier Identifies this endpoint across multiple systems
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... type Σ 0..1 CodeableConcept Description of identifier
Binding: http://medcomehmi.dk/ig/dk-ehmi-eer/CodeSystem/ehmi-auditevent-agent-who-identifier-types (required)
.... system Σ 0..1 uri The namespace for the identifier value
Required Pattern: http://medcomehmi.dk/ig/dk-ehmi-eer/CodeSystem/ehmi-auditevent-agent-who-identifier-types
.... value SΣ 1..1 string The value that is unique
Example General: 123456
.... period Σ 0..1 Period Time period when id is/was valid for use
.... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... status ?!SΣ 1..1 code represents the current status of this endpoint.
Binding: EndpointStatus (required): The status of the endpoint.

... connectionType Σ 1..1 Coding Protocol/Profile/Standard to be used with this endpoint connection
Binding: EER connection Types Valueset (required)
... name Σ 0..1 string A name that this endpoint can be identified by
... managingOrganization Σ 1..1 Reference(mCSD Organization) Organization that manages this endpoint.
... contact 0..* ContactPoint Contact details for source (e.g. troubleshooting)
... period SΣ 1..1 Period Overall deployment lifetime for this endpoint.
... payloadType Σ 1..* CodeableConcept The type of content that may be used at this endpoint (e.g. XDS Discharge summaries)
Binding: EndpointPayloadType (example)
... payloadMimeType Σ 0..* code Mimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this)
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.


... address Σ 1..1 url The technical base address for connecting to this endpoint
... header 0..* string Usage depends on the channel type

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Endpoint.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Endpoint.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Endpoint.identifier.typerequiredhttp://medcomehmi.dk/ig/dk-ehmi-eer/CodeSystem/ehmi-auditevent-agent-who-identifier-types
http://medcomehmi.dk/ig/dk-ehmi-eer/CodeSystem/ehmi-auditevent-agent-who-identifier-types
Endpoint.statusrequiredEndpointStatus
http://hl7.org/fhir/ValueSet/endpoint-status|4.0.1
from the FHIR Standard
Endpoint.connectionTyperequiredEerEndpointConnectionTypeVS (a valid code from EER Connection Types CS)
http://medcomehmi.dk/ig/dk-ehmi-eer/ValueSet/eer-endpoint-connection-type-valueset
from this IG
Endpoint.payloadTypeexampleEndpointPayloadType
http://hl7.org/fhir/ValueSet/endpoint-payload-type
from the FHIR Standard
Endpoint.payloadMimeTyperequiredMime Types (a valid code from urn:ietf:bcp:13)
http://hl7.org/fhir/ValueSet/mimetypes|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorEndpointIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorEndpointIf 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-4errorEndpointIf 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-5errorEndpointIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceEndpointA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from MCSDEndpoint

Summary

Mandatory: 3 elements
Must-Support: 2 elements

Differential View

This structure is derived from MCSDEndpoint

NameFlagsCard.TypeDescription & Constraintsdoco
.. Endpoint MCSDEndpoint
... identifier S 1..1 Identifier Identifies this endpoint across multiple systems
.... type 0..1 CodeableConcept Description of identifier
Binding: http://medcomehmi.dk/ig/dk-ehmi-eer/CodeSystem/ehmi-auditevent-agent-who-identifier-types (required)
.... system 0..1 uri The namespace for the identifier value
Required Pattern: http://medcomehmi.dk/ig/dk-ehmi-eer/CodeSystem/ehmi-auditevent-agent-who-identifier-types
.... value S 1..1 string The value that is unique
... connectionType 1..1 Coding Protocol/Profile/Standard to be used with this endpoint connection
Binding: EER connection Types Valueset (required)
... period 1..1 Period Overall deployment lifetime for this endpoint.

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Endpoint.identifier.typerequiredhttp://medcomehmi.dk/ig/dk-ehmi-eer/CodeSystem/ehmi-auditevent-agent-who-identifier-types
http://medcomehmi.dk/ig/dk-ehmi-eer/CodeSystem/ehmi-auditevent-agent-who-identifier-types
Endpoint.connectionTyperequiredEerEndpointConnectionTypeVS (a valid code from EER Connection Types CS)
http://medcomehmi.dk/ig/dk-ehmi-eer/ValueSet/eer-endpoint-connection-type-valueset
from this IG

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Endpoint 0..* MCSDEndpoint The technical details of an endpoint that can be used for electronic services
... Slices for extension Content/Rules for all slices
.... purposeOfUse 0..* CodeableConcept Purpose of Use Extension
URL: https://profiles.ihe.net/ITI/mCSD/StructureDefinition/IHE.mCSD.PurposeOfUse
Binding: PurposeOfUse (preferred)
... identifier SΣ 1..1 Identifier Identifies this endpoint across multiple systems
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... type Σ 0..1 CodeableConcept Description of identifier
Binding: http://medcomehmi.dk/ig/dk-ehmi-eer/CodeSystem/ehmi-auditevent-agent-who-identifier-types (required)
.... system Σ 0..1 uri The namespace for the identifier value
Required Pattern: http://medcomehmi.dk/ig/dk-ehmi-eer/CodeSystem/ehmi-auditevent-agent-who-identifier-types
.... value SΣ 1..1 string The value that is unique
Example General: 123456
... status ?!SΣ 1..1 code represents the current status of this endpoint.
Binding: EndpointStatus (required): The status of the endpoint.

... managingOrganization Σ 1..1 Reference(mCSD Organization) Organization that manages this endpoint.
... period SΣ 1..1 Period Overall deployment lifetime for this endpoint.
... payloadType Σ 1..* CodeableConcept The type of content that may be used at this endpoint (e.g. XDS Discharge summaries)
Binding: EndpointPayloadType (example)
... address Σ 1..1 url The technical base address for connecting to this endpoint

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Endpoint.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Endpoint.identifier.typerequiredhttp://medcomehmi.dk/ig/dk-ehmi-eer/CodeSystem/ehmi-auditevent-agent-who-identifier-types
http://medcomehmi.dk/ig/dk-ehmi-eer/CodeSystem/ehmi-auditevent-agent-who-identifier-types
Endpoint.statusrequiredEndpointStatus
http://hl7.org/fhir/ValueSet/endpoint-status|4.0.1
from the FHIR Standard
Endpoint.connectionTyperequiredEerEndpointConnectionTypeVS (a valid code from EER Connection Types CS)
http://medcomehmi.dk/ig/dk-ehmi-eer/ValueSet/eer-endpoint-connection-type-valueset
from this IG
Endpoint.payloadTypeexampleEndpointPayloadType
http://hl7.org/fhir/ValueSet/endpoint-payload-type
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorEndpointIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorEndpointIf 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-4errorEndpointIf 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-5errorEndpointIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceEndpointA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Endpoint 0..* MCSDEndpoint The technical details of an endpoint that can be used for electronic services
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguages Max Binding
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... purposeOfUse 0..* CodeableConcept Purpose of Use Extension
URL: https://profiles.ihe.net/ITI/mCSD/StructureDefinition/IHE.mCSD.PurposeOfUse
Binding: PurposeOfUse (preferred)
... identifier SΣ 1..1 Identifier Identifies this endpoint across multiple systems
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... type Σ 0..1 CodeableConcept Description of identifier
Binding: http://medcomehmi.dk/ig/dk-ehmi-eer/CodeSystem/ehmi-auditevent-agent-who-identifier-types (required)
.... system Σ 0..1 uri The namespace for the identifier value
Required Pattern: http://medcomehmi.dk/ig/dk-ehmi-eer/CodeSystem/ehmi-auditevent-agent-who-identifier-types
.... value SΣ 1..1 string The value that is unique
Example General: 123456
.... period Σ 0..1 Period Time period when id is/was valid for use
.... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... status ?!SΣ 1..1 code represents the current status of this endpoint.
Binding: EndpointStatus (required): The status of the endpoint.

... connectionType Σ 1..1 Coding Protocol/Profile/Standard to be used with this endpoint connection
Binding: EER connection Types Valueset (required)
... name Σ 0..1 string A name that this endpoint can be identified by
... managingOrganization Σ 1..1 Reference(mCSD Organization) Organization that manages this endpoint.
... contact 0..* ContactPoint Contact details for source (e.g. troubleshooting)
... period SΣ 1..1 Period Overall deployment lifetime for this endpoint.
... payloadType Σ 1..* CodeableConcept The type of content that may be used at this endpoint (e.g. XDS Discharge summaries)
Binding: EndpointPayloadType (example)
... payloadMimeType Σ 0..* code Mimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this)
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.


... address Σ 1..1 url The technical base address for connecting to this endpoint
... header 0..* string Usage depends on the channel type

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Endpoint.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Endpoint.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Endpoint.identifier.typerequiredhttp://medcomehmi.dk/ig/dk-ehmi-eer/CodeSystem/ehmi-auditevent-agent-who-identifier-types
http://medcomehmi.dk/ig/dk-ehmi-eer/CodeSystem/ehmi-auditevent-agent-who-identifier-types
Endpoint.statusrequiredEndpointStatus
http://hl7.org/fhir/ValueSet/endpoint-status|4.0.1
from the FHIR Standard
Endpoint.connectionTyperequiredEerEndpointConnectionTypeVS (a valid code from EER Connection Types CS)
http://medcomehmi.dk/ig/dk-ehmi-eer/ValueSet/eer-endpoint-connection-type-valueset
from this IG
Endpoint.payloadTypeexampleEndpointPayloadType
http://hl7.org/fhir/ValueSet/endpoint-payload-type
from the FHIR Standard
Endpoint.payloadMimeTyperequiredMime Types (a valid code from urn:ietf:bcp:13)
http://hl7.org/fhir/ValueSet/mimetypes|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorEndpointIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorEndpointIf 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-4errorEndpointIf 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-5errorEndpointIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceEndpointA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from MCSDEndpoint

Summary

Mandatory: 3 elements
Must-Support: 2 elements

 

Other representations of profile: CSV, Excel, Schematron