Data Sharing Framework (DSF) Implementation Guide
2.0.0 - ci-build

Data Sharing Framework (DSF) Implementation Guide - Local Development build (v2.0.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: Endpoint

Official URL: http://dsf.dev/fhir/StructureDefinition/endpoint Version: 2.0.0
Active as of 2025-11-26 Computable Name: Endpoint

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Endpoint 0..* Endpoint The technical details of an endpoint that can be used for electronic services
... meta Σ 0..1 Meta(2.0.0) Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:certificateThumbprint 0..* string Optional Extensions Element
URL: http://dsf.dev/fhir/StructureDefinition/extension-certificate-thumbprint
... Slices for identifier Σ 1..* Identifier Identifies this endpoint across multiple systems
Slice: Unordered, Open by value:system, value:value
.... identifier:dsfIdentifier Σ 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 .
..... system Σ 1..1 uri The namespace for the identifier value
Fixed Value: http://dsf.dev/sid/endpoint-identifier
..... value Σ 1..1 string The value that is unique
Example General: 123456
... status ?!Σ 1..1 code active | suspended | error | off | entered-in-error | test
Binding: EndpointStatus (required): The status of the endpoint.
... connectionType Σ 1..1 Coding Protocol/Profile/Standard to be used with this endpoint connection
Binding: EndpointConnectionType (extensible)
.... system Σ 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/endpoint-connection-type
.... code Σ 1..1 code Symbol in syntax defined by the system
Fixed Value: hl7-fhir-rest
... managingOrganization Σ 1..1 Reference(Organization(2.0.0)) Organization that manages this endpoint (might not be the organization that exposes the endpoint)
.... reference ΣC 1..1 string Literal reference, Relative, internal or absolute URL
... Slices for payloadType Σ 1..* CodeableConcept The type of content that may be used at this endpoint (e.g. XDS Discharge summaries)
Slice: Unordered, Open by value:coding.system, value:coding.code
Binding: EndpointPayloadType (example)
.... payloadType:slicePayloadType Σ 1..1 CodeableConcept The type of content that may be used at this endpoint (e.g. XDS Discharge summaries)
Binding: EndpointPayloadType (example)
..... coding Σ 1..1 Coding Code defined by a terminology system
...... system Σ 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/resource-types
...... code Σ 1..1 code Symbol in syntax defined by the system
Fixed Value: Task
... Slices for payloadMimeType Σ 2..2 code Mimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this)
Slice: Unordered, Open by value:value
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.
.... payloadMimeType:fhirXml Σ 1..1 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.

Fixed Value: application/fhir+xml
.... payloadMimeType:fhirJson Σ 1..1 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.

Fixed Value: application/fhir+json
... address Σ 1..1 url The technical base address for connecting to this endpoint

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Endpoint.identifier:dsfIdentifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Endpoint.status Base required EndpointStatus 📍4.0.1 FHIR Std.
Endpoint.connectionType Base extensible Endpoint Connection Type 📍4.0.1 FHIR Std.
Endpoint.payloadType Base example Endpoint Payload Type 📍4.0.1 FHIR Std.
Endpoint.payloadType:slicePayloadType Base example Endpoint Payload Type 📍4.0.1 FHIR Std.
Endpoint.payloadMimeType Base required MimeType 📍4.0.1 FHIR Std.
Endpoint.payloadMimeType:fhirXml Base required MimeType 📍4.0.1 FHIR Std.
Endpoint.payloadMimeType:fhirJson Base required MimeType 📍4.0.1 FHIR Std.

Constraints

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

This structure is derived from Endpoint

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Endpoint 0..* Endpoint The technical details of an endpoint that can be used for electronic services
... meta 0..1 Meta(2.0.0) Metadata about the resource
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:certificateThumbprint 0..* string Optional Extensions Element
URL: http://dsf.dev/fhir/StructureDefinition/extension-certificate-thumbprint
... Slices for identifier 1..* Identifier Identifies this endpoint across multiple systems
Slice: Unordered, Open by value:system, value:value
.... identifier:dsfIdentifier 1..1 Identifier Identifies this endpoint across multiple systems
..... system 1..1 uri The namespace for the identifier value
Fixed Value: http://dsf.dev/sid/endpoint-identifier
..... value 1..1 string The value that is unique
.... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/endpoint-connection-type
.... code 1..1 code Symbol in syntax defined by the system
Fixed Value: hl7-fhir-rest
... managingOrganization 1..1 Reference(Organization(2.0.0)) Organization that manages this endpoint (might not be the organization that exposes the endpoint)
.... reference 1..1 string Literal reference, Relative, internal or absolute URL
... Slices for payloadType 1..* CodeableConcept The type of content that may be used at this endpoint (e.g. XDS Discharge summaries)
Slice: Unordered, Open by value:coding.system, value:coding.code
.... payloadType:slicePayloadType 1..1 CodeableConcept The type of content that may be used at this endpoint (e.g. XDS Discharge summaries)
..... coding 1..1 Coding Code defined by a terminology system
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/resource-types
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: Task
... Slices for payloadMimeType 2..2 code Mimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this)
Slice: Unordered, Open by value:value
.... payloadMimeType:fhirXml 1..1 code Mimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this)
Fixed Value: application/fhir+xml
.... payloadMimeType:fhirJson 1..1 code Mimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this)
Fixed Value: application/fhir+json

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Endpoint 0..* Endpoint 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(2.0.0) Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:certificateThumbprint 0..* string Optional Extensions Element
URL: http://dsf.dev/fhir/StructureDefinition/extension-certificate-thumbprint
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier Σ 1..* Identifier Identifies this endpoint across multiple systems
Slice: Unordered, Open by value:system, value:value
.... identifier:dsfIdentifier Σ 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: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
..... system Σ 1..1 uri The namespace for the identifier value
Fixed Value: http://dsf.dev/sid/endpoint-identifier
..... value Σ 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 ?!Σ 1..1 code active | suspended | error | off | entered-in-error | test
Binding: EndpointStatus (required): The status of the endpoint.
... connectionType Σ 1..1 Coding Protocol/Profile/Standard to be used with this endpoint connection
Binding: EndpointConnectionType (extensible)
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... system Σ 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/endpoint-connection-type
.... version Σ 0..1 string Version of the system - if relevant
.... code Σ 1..1 code Symbol in syntax defined by the system
Fixed Value: hl7-fhir-rest
.... display Σ 0..1 string Representation defined by the system
.... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
... name Σ 0..1 string A name that this endpoint can be identified by
... managingOrganization Σ 1..1 Reference(Organization(2.0.0)) Organization that manages this endpoint (might not be the organization that exposes the endpoint)
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC 1..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... contact 0..* ContactPoint Contact details for source (e.g. troubleshooting)
... period Σ 0..1 Period Interval the endpoint is expected to be operational
... Slices for payloadType Σ 1..* CodeableConcept The type of content that may be used at this endpoint (e.g. XDS Discharge summaries)
Slice: Unordered, Open by value:coding.system, value:coding.code
Binding: EndpointPayloadType (example)
.... payloadType:slicePayloadType Σ 1..1 CodeableConcept The type of content that may be used at this endpoint (e.g. XDS Discharge summaries)
Binding: EndpointPayloadType (example)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ 1..1 Coding Code defined by a terminology system
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/resource-types
...... version Σ 0..1 string Version of the system - if relevant
...... code Σ 1..1 code Symbol in syntax defined by the system
Fixed Value: Task
...... display Σ 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... text Σ 0..1 string Plain text representation of the concept
... Slices for payloadMimeType Σ 2..2 code Mimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this)
Slice: Unordered, Open by value:value
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.
.... payloadMimeType:fhirXml Σ 1..1 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.

Fixed Value: application/fhir+xml
.... payloadMimeType:fhirJson Σ 1..1 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.

Fixed Value: application/fhir+json
... 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

Path Status Usage ValueSet Version Source
Endpoint.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Endpoint.identifier:dsfIdentifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Endpoint.identifier:dsfIdentifier.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Endpoint.status Base required EndpointStatus 📍4.0.1 FHIR Std.
Endpoint.connectionType Base extensible Endpoint Connection Type 📍4.0.1 FHIR Std.
Endpoint.managingOrganization.​type Base extensible ResourceType 📍4.0.1 FHIR Std.
Endpoint.payloadType Base example Endpoint Payload Type 📍4.0.1 FHIR Std.
Endpoint.payloadType:slicePayloadType Base example Endpoint Payload Type 📍4.0.1 FHIR Std.
Endpoint.payloadMimeType Base required MimeType 📍4.0.1 FHIR Std.
Endpoint.payloadMimeType:fhirXml Base required MimeType 📍4.0.1 FHIR Std.
Endpoint.payloadMimeType:fhirJson Base required MimeType 📍4.0.1 FHIR Std.

Constraints

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

This structure is derived from Endpoint

Summary

Mandatory: 14 elements
Fixed: 7 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 2 is sliced based on the values of Endpoint.identifier
  • The element 2 is sliced based on the values of Endpoint.payloadType
  • The element 1 is sliced based on the value of Endpoint.payloadMimeType

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Endpoint 0..* Endpoint The technical details of an endpoint that can be used for electronic services
... meta Σ 0..1 Meta(2.0.0) Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:certificateThumbprint 0..* string Optional Extensions Element
URL: http://dsf.dev/fhir/StructureDefinition/extension-certificate-thumbprint
... Slices for identifier Σ 1..* Identifier Identifies this endpoint across multiple systems
Slice: Unordered, Open by value:system, value:value
.... identifier:dsfIdentifier Σ 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 .
..... system Σ 1..1 uri The namespace for the identifier value
Fixed Value: http://dsf.dev/sid/endpoint-identifier
..... value Σ 1..1 string The value that is unique
Example General: 123456
... status ?!Σ 1..1 code active | suspended | error | off | entered-in-error | test
Binding: EndpointStatus (required): The status of the endpoint.
... connectionType Σ 1..1 Coding Protocol/Profile/Standard to be used with this endpoint connection
Binding: EndpointConnectionType (extensible)
.... system Σ 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/endpoint-connection-type
.... code Σ 1..1 code Symbol in syntax defined by the system
Fixed Value: hl7-fhir-rest
... managingOrganization Σ 1..1 Reference(Organization(2.0.0)) Organization that manages this endpoint (might not be the organization that exposes the endpoint)
.... reference ΣC 1..1 string Literal reference, Relative, internal or absolute URL
... Slices for payloadType Σ 1..* CodeableConcept The type of content that may be used at this endpoint (e.g. XDS Discharge summaries)
Slice: Unordered, Open by value:coding.system, value:coding.code
Binding: EndpointPayloadType (example)
.... payloadType:slicePayloadType Σ 1..1 CodeableConcept The type of content that may be used at this endpoint (e.g. XDS Discharge summaries)
Binding: EndpointPayloadType (example)
..... coding Σ 1..1 Coding Code defined by a terminology system
...... system Σ 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/resource-types
...... code Σ 1..1 code Symbol in syntax defined by the system
Fixed Value: Task
... Slices for payloadMimeType Σ 2..2 code Mimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this)
Slice: Unordered, Open by value:value
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.
.... payloadMimeType:fhirXml Σ 1..1 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.

Fixed Value: application/fhir+xml
.... payloadMimeType:fhirJson Σ 1..1 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.

Fixed Value: application/fhir+json
... address Σ 1..1 url The technical base address for connecting to this endpoint

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Endpoint.identifier:dsfIdentifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Endpoint.status Base required EndpointStatus 📍4.0.1 FHIR Std.
Endpoint.connectionType Base extensible Endpoint Connection Type 📍4.0.1 FHIR Std.
Endpoint.payloadType Base example Endpoint Payload Type 📍4.0.1 FHIR Std.
Endpoint.payloadType:slicePayloadType Base example Endpoint Payload Type 📍4.0.1 FHIR Std.
Endpoint.payloadMimeType Base required MimeType 📍4.0.1 FHIR Std.
Endpoint.payloadMimeType:fhirXml Base required MimeType 📍4.0.1 FHIR Std.
Endpoint.payloadMimeType:fhirJson Base required MimeType 📍4.0.1 FHIR Std.

Constraints

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

Differential View

This structure is derived from Endpoint

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Endpoint 0..* Endpoint The technical details of an endpoint that can be used for electronic services
... meta 0..1 Meta(2.0.0) Metadata about the resource
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:certificateThumbprint 0..* string Optional Extensions Element
URL: http://dsf.dev/fhir/StructureDefinition/extension-certificate-thumbprint
... Slices for identifier 1..* Identifier Identifies this endpoint across multiple systems
Slice: Unordered, Open by value:system, value:value
.... identifier:dsfIdentifier 1..1 Identifier Identifies this endpoint across multiple systems
..... system 1..1 uri The namespace for the identifier value
Fixed Value: http://dsf.dev/sid/endpoint-identifier
..... value 1..1 string The value that is unique
.... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/endpoint-connection-type
.... code 1..1 code Symbol in syntax defined by the system
Fixed Value: hl7-fhir-rest
... managingOrganization 1..1 Reference(Organization(2.0.0)) Organization that manages this endpoint (might not be the organization that exposes the endpoint)
.... reference 1..1 string Literal reference, Relative, internal or absolute URL
... Slices for payloadType 1..* CodeableConcept The type of content that may be used at this endpoint (e.g. XDS Discharge summaries)
Slice: Unordered, Open by value:coding.system, value:coding.code
.... payloadType:slicePayloadType 1..1 CodeableConcept The type of content that may be used at this endpoint (e.g. XDS Discharge summaries)
..... coding 1..1 Coding Code defined by a terminology system
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/resource-types
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: Task
... Slices for payloadMimeType 2..2 code Mimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this)
Slice: Unordered, Open by value:value
.... payloadMimeType:fhirXml 1..1 code Mimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this)
Fixed Value: application/fhir+xml
.... payloadMimeType:fhirJson 1..1 code Mimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this)
Fixed Value: application/fhir+json

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Endpoint 0..* Endpoint 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(2.0.0) Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:certificateThumbprint 0..* string Optional Extensions Element
URL: http://dsf.dev/fhir/StructureDefinition/extension-certificate-thumbprint
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier Σ 1..* Identifier Identifies this endpoint across multiple systems
Slice: Unordered, Open by value:system, value:value
.... identifier:dsfIdentifier Σ 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: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
..... system Σ 1..1 uri The namespace for the identifier value
Fixed Value: http://dsf.dev/sid/endpoint-identifier
..... value Σ 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 ?!Σ 1..1 code active | suspended | error | off | entered-in-error | test
Binding: EndpointStatus (required): The status of the endpoint.
... connectionType Σ 1..1 Coding Protocol/Profile/Standard to be used with this endpoint connection
Binding: EndpointConnectionType (extensible)
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... system Σ 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/endpoint-connection-type
.... version Σ 0..1 string Version of the system - if relevant
.... code Σ 1..1 code Symbol in syntax defined by the system
Fixed Value: hl7-fhir-rest
.... display Σ 0..1 string Representation defined by the system
.... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
... name Σ 0..1 string A name that this endpoint can be identified by
... managingOrganization Σ 1..1 Reference(Organization(2.0.0)) Organization that manages this endpoint (might not be the organization that exposes the endpoint)
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC 1..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... contact 0..* ContactPoint Contact details for source (e.g. troubleshooting)
... period Σ 0..1 Period Interval the endpoint is expected to be operational
... Slices for payloadType Σ 1..* CodeableConcept The type of content that may be used at this endpoint (e.g. XDS Discharge summaries)
Slice: Unordered, Open by value:coding.system, value:coding.code
Binding: EndpointPayloadType (example)
.... payloadType:slicePayloadType Σ 1..1 CodeableConcept The type of content that may be used at this endpoint (e.g. XDS Discharge summaries)
Binding: EndpointPayloadType (example)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ 1..1 Coding Code defined by a terminology system
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/resource-types
...... version Σ 0..1 string Version of the system - if relevant
...... code Σ 1..1 code Symbol in syntax defined by the system
Fixed Value: Task
...... display Σ 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... text Σ 0..1 string Plain text representation of the concept
... Slices for payloadMimeType Σ 2..2 code Mimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this)
Slice: Unordered, Open by value:value
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.
.... payloadMimeType:fhirXml Σ 1..1 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.

Fixed Value: application/fhir+xml
.... payloadMimeType:fhirJson Σ 1..1 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.

Fixed Value: application/fhir+json
... 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

Path Status Usage ValueSet Version Source
Endpoint.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Endpoint.identifier:dsfIdentifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Endpoint.identifier:dsfIdentifier.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Endpoint.status Base required EndpointStatus 📍4.0.1 FHIR Std.
Endpoint.connectionType Base extensible Endpoint Connection Type 📍4.0.1 FHIR Std.
Endpoint.managingOrganization.​type Base extensible ResourceType 📍4.0.1 FHIR Std.
Endpoint.payloadType Base example Endpoint Payload Type 📍4.0.1 FHIR Std.
Endpoint.payloadType:slicePayloadType Base example Endpoint Payload Type 📍4.0.1 FHIR Std.
Endpoint.payloadMimeType Base required MimeType 📍4.0.1 FHIR Std.
Endpoint.payloadMimeType:fhirXml Base required MimeType 📍4.0.1 FHIR Std.
Endpoint.payloadMimeType:fhirJson Base required MimeType 📍4.0.1 FHIR Std.

Constraints

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

This structure is derived from Endpoint

Summary

Mandatory: 14 elements
Fixed: 7 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 2 is sliced based on the values of Endpoint.identifier
  • The element 2 is sliced based on the values of Endpoint.payloadType
  • The element 1 is sliced based on the value of Endpoint.payloadMimeType

 

Other representations of profile: CSV, Excel, Schematron