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
Official URL: http://dsf.dev/fhir/StructureDefinition/endpoint | Version: 2.0.0 | |||
Active as of 2025-05-26 | Computable Name: DSF Endpoint |
An Endpoint in the DSF context with restrictions to enforce DSF specific details.
Usages:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
0..* | Endpoint | The technical details of an endpoint that can be used for electronic services | |
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
0..* | string | Optional Extensions Element URL: http://dsf.dev/fhir/StructureDefinition/extension-certificate-thumbprint | |
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() |
Σ | 1..* | Identifier | Identifies this endpoint across multiple systems Slice: Unordered, Open by value:system, value:value |
![]() ![]() ![]() ![]() |
Σ | 1..1 | Identifier | Identifies this endpoint across multiple systems |
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: http://dsf.dev/sid/endpoint-identifier |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | string | The value that is unique Example General: 123456 |
![]() ![]() ![]() |
?!Σ | 1..1 | code | active | suspended | error | off | entered-in-error | test Binding: EndpointStatus (required): The status of the endpoint. |
![]() ![]() ![]() |
Σ | 1..1 | Coding | Protocol/Profile/Standard to be used with this endpoint connection Binding: EndpointConnectionType (extensible) |
![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/endpoint-connection-type |
![]() ![]() ![]() ![]() |
Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: hl7-fhir-rest |
![]() ![]() ![]() |
Σ | 1..1 | Reference(DSF Organization(2.0.0)) | Organization that manages this endpoint (might not be the organization that exposes the endpoint) |
![]() ![]() ![]() ![]() |
ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL |
![]() ![]() ![]() |
Σ | 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) |
![]() ![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | The type of content that may be used at this endpoint (e.g. XDS Discharge summaries) Binding: EndpointPayloadType (example) |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/resource-types |
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: Task |
![]() ![]() ![]() |
Σ | 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. |
![]() ![]() ![]() ![]() |
Σ | 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 |
![]() ![]() ![]() ![]() |
Σ | 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 |
![]() ![]() ![]() |
Σ | 1..1 | url | The technical base address for connecting to this endpoint |
![]() |
Path | Conformance | ValueSet / Code | URI |
Endpoint.identifier:dsfIdentifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard | |
Endpoint.status | required | EndpointStatushttp://hl7.org/fhir/ValueSet/endpoint-status|4.0.1 From the FHIR Standard | |
Endpoint.connectionType | extensible | Fixed Value: hl7-fhir-resthttp://hl7.org/fhir/ValueSet/endpoint-connection-type From the FHIR Standard | |
Endpoint.payloadType | example | EndpointPayloadTypehttp://hl7.org/fhir/ValueSet/endpoint-payload-type From the FHIR Standard | |
Endpoint.payloadType:slicePayloadType | example | EndpointPayloadTypehttp://hl7.org/fhir/ValueSet/endpoint-payload-type From the FHIR Standard | |
Endpoint.payloadMimeType | required | Mime Types(a valid code from urn:ietf:bcp:13 )http://hl7.org/fhir/ValueSet/mimetypes|4.0.1 From the FHIR Standard | |
Endpoint.payloadMimeType:fhirXml | required | Fixed Value: application/fhir+xmlhttp://hl7.org/fhir/ValueSet/mimetypes|4.0.1 From the FHIR Standard | |
Endpoint.payloadMimeType:fhirJson | required | Fixed Value: application/fhir+jsonhttp://hl7.org/fhir/ValueSet/mimetypes|4.0.1 From the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
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
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
0..* | Endpoint | The technical details of an endpoint that can be used for electronic services | |
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
0..* | string | Optional Extensions Element URL: http://dsf.dev/fhir/StructureDefinition/extension-certificate-thumbprint | |
![]() ![]() ![]() |
1..* | Identifier | Identifies this endpoint across multiple systems Slice: Unordered, Open by value:system, value:value | |
![]() ![]() ![]() ![]() |
1..1 | Identifier | Identifies this endpoint across multiple systems | |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | The namespace for the identifier value Fixed Value: http://dsf.dev/sid/endpoint-identifier | |
![]() ![]() ![]() ![]() ![]() |
1..1 | string | The value that is unique | |
![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/endpoint-connection-type | |
![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: hl7-fhir-rest | |
![]() ![]() ![]() |
1..1 | Reference(DSF Organization(2.0.0)) | Organization that manages this endpoint (might not be the organization that exposes the endpoint) | |
![]() ![]() ![]() ![]() |
1..1 | string | Literal reference, Relative, internal or absolute URL | |
![]() ![]() ![]() |
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 | |
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | The type of content that may be used at this endpoint (e.g. XDS Discharge summaries) | |
![]() ![]() ![]() ![]() ![]() |
1..1 | Coding | Code defined by a terminology system | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/resource-types | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: Task | |
![]() ![]() ![]() |
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 | |
![]() ![]() ![]() ![]() |
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 | |
![]() ![]() ![]() ![]() |
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 | |
![]() |
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
0..* | Endpoint | The technical details of an endpoint that can be used for electronic services | |||||
![]() ![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
0..* | string | Optional Extensions Element URL: http://dsf.dev/fhir/StructureDefinition/extension-certificate-thumbprint | |||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
Σ | 1..* | Identifier | Identifies this endpoint across multiple systems Slice: Unordered, Open by value:system, value:value | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | Identifier | Identifies this endpoint across multiple systems | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 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. | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: http://dsf.dev/sid/endpoint-identifier | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | string | The value that is unique Example General: 123456 | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() ![]() |
?!Σ | 1..1 | code | active | suspended | error | off | entered-in-error | test Binding: EndpointStatus (required): The status of the endpoint. | ||||
![]() ![]() ![]() |
Σ | 1..1 | Coding | Protocol/Profile/Standard to be used with this endpoint connection Binding: EndpointConnectionType (extensible) | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/endpoint-connection-type | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: hl7-fhir-rest | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | A name that this endpoint can be identified by | ||||
![]() ![]() ![]() |
Σ | 1..1 | Reference(DSF Organization(2.0.0)) | Organization that manages this endpoint (might not be the organization that exposes the endpoint) | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() ![]() |
Σ | 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). | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Text alternative for the resource | ||||
![]() ![]() ![]() |
0..* | ContactPoint | Contact details for source (e.g. troubleshooting) | |||||
![]() ![]() ![]() |
Σ | 0..1 | Period | Interval the endpoint is expected to be operational | ||||
![]() ![]() ![]() |
Σ | 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) | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | The type of content that may be used at this endpoint (e.g. XDS Discharge summaries) Binding: EndpointPayloadType (example) | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/resource-types | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: Task | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() ![]() |
Σ | 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. | ||||
![]() ![]() ![]() ![]() |
Σ | 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 | ||||
![]() ![]() ![]() ![]() |
Σ | 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 | ||||
![]() ![]() ![]() |
Σ | 1..1 | url | The technical base address for connecting to this endpoint | ||||
![]() ![]() ![]() |
0..* | string | Usage depends on the channel type | |||||
![]() |
Path | Conformance | ValueSet / Code | URI | |||
Endpoint.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages From the FHIR Standard
| ||||
Endpoint.identifier:dsfIdentifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard | ||||
Endpoint.identifier:dsfIdentifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type From the FHIR Standard | ||||
Endpoint.status | required | EndpointStatushttp://hl7.org/fhir/ValueSet/endpoint-status|4.0.1 From the FHIR Standard | ||||
Endpoint.connectionType | extensible | Fixed Value: hl7-fhir-resthttp://hl7.org/fhir/ValueSet/endpoint-connection-type From the FHIR Standard | ||||
Endpoint.managingOrganization.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types From the FHIR Standard | ||||
Endpoint.payloadType | example | EndpointPayloadTypehttp://hl7.org/fhir/ValueSet/endpoint-payload-type From the FHIR Standard | ||||
Endpoint.payloadType:slicePayloadType | example | EndpointPayloadTypehttp://hl7.org/fhir/ValueSet/endpoint-payload-type From the FHIR Standard | ||||
Endpoint.payloadMimeType | required | Mime Types(a valid code from urn:ietf:bcp:13 )http://hl7.org/fhir/ValueSet/mimetypes|4.0.1 From the FHIR Standard | ||||
Endpoint.payloadMimeType:fhirXml | required | Fixed Value: application/fhir+xmlhttp://hl7.org/fhir/ValueSet/mimetypes|4.0.1 From the FHIR Standard | ||||
Endpoint.payloadMimeType:fhirJson | required | Fixed Value: application/fhir+jsonhttp://hl7.org/fhir/ValueSet/mimetypes|4.0.1 From the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
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:
Key Elements View
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
0..* | Endpoint | The technical details of an endpoint that can be used for electronic services | |
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
0..* | string | Optional Extensions Element URL: http://dsf.dev/fhir/StructureDefinition/extension-certificate-thumbprint | |
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() |
Σ | 1..* | Identifier | Identifies this endpoint across multiple systems Slice: Unordered, Open by value:system, value:value |
![]() ![]() ![]() ![]() |
Σ | 1..1 | Identifier | Identifies this endpoint across multiple systems |
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: http://dsf.dev/sid/endpoint-identifier |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | string | The value that is unique Example General: 123456 |
![]() ![]() ![]() |
?!Σ | 1..1 | code | active | suspended | error | off | entered-in-error | test Binding: EndpointStatus (required): The status of the endpoint. |
![]() ![]() ![]() |
Σ | 1..1 | Coding | Protocol/Profile/Standard to be used with this endpoint connection Binding: EndpointConnectionType (extensible) |
![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/endpoint-connection-type |
![]() ![]() ![]() ![]() |
Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: hl7-fhir-rest |
![]() ![]() ![]() |
Σ | 1..1 | Reference(DSF Organization(2.0.0)) | Organization that manages this endpoint (might not be the organization that exposes the endpoint) |
![]() ![]() ![]() ![]() |
ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL |
![]() ![]() ![]() |
Σ | 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) |
![]() ![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | The type of content that may be used at this endpoint (e.g. XDS Discharge summaries) Binding: EndpointPayloadType (example) |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/resource-types |
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: Task |
![]() ![]() ![]() |
Σ | 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. |
![]() ![]() ![]() ![]() |
Σ | 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 |
![]() ![]() ![]() ![]() |
Σ | 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 |
![]() ![]() ![]() |
Σ | 1..1 | url | The technical base address for connecting to this endpoint |
![]() |
Path | Conformance | ValueSet / Code | URI |
Endpoint.identifier:dsfIdentifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard | |
Endpoint.status | required | EndpointStatushttp://hl7.org/fhir/ValueSet/endpoint-status|4.0.1 From the FHIR Standard | |
Endpoint.connectionType | extensible | Fixed Value: hl7-fhir-resthttp://hl7.org/fhir/ValueSet/endpoint-connection-type From the FHIR Standard | |
Endpoint.payloadType | example | EndpointPayloadTypehttp://hl7.org/fhir/ValueSet/endpoint-payload-type From the FHIR Standard | |
Endpoint.payloadType:slicePayloadType | example | EndpointPayloadTypehttp://hl7.org/fhir/ValueSet/endpoint-payload-type From the FHIR Standard | |
Endpoint.payloadMimeType | required | Mime Types(a valid code from urn:ietf:bcp:13 )http://hl7.org/fhir/ValueSet/mimetypes|4.0.1 From the FHIR Standard | |
Endpoint.payloadMimeType:fhirXml | required | Fixed Value: application/fhir+xmlhttp://hl7.org/fhir/ValueSet/mimetypes|4.0.1 From the FHIR Standard | |
Endpoint.payloadMimeType:fhirJson | required | Fixed Value: application/fhir+jsonhttp://hl7.org/fhir/ValueSet/mimetypes|4.0.1 From the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
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
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
0..* | Endpoint | The technical details of an endpoint that can be used for electronic services | |
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
0..* | string | Optional Extensions Element URL: http://dsf.dev/fhir/StructureDefinition/extension-certificate-thumbprint | |
![]() ![]() ![]() |
1..* | Identifier | Identifies this endpoint across multiple systems Slice: Unordered, Open by value:system, value:value | |
![]() ![]() ![]() ![]() |
1..1 | Identifier | Identifies this endpoint across multiple systems | |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | The namespace for the identifier value Fixed Value: http://dsf.dev/sid/endpoint-identifier | |
![]() ![]() ![]() ![]() ![]() |
1..1 | string | The value that is unique | |
![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/endpoint-connection-type | |
![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: hl7-fhir-rest | |
![]() ![]() ![]() |
1..1 | Reference(DSF Organization(2.0.0)) | Organization that manages this endpoint (might not be the organization that exposes the endpoint) | |
![]() ![]() ![]() ![]() |
1..1 | string | Literal reference, Relative, internal or absolute URL | |
![]() ![]() ![]() |
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 | |
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | The type of content that may be used at this endpoint (e.g. XDS Discharge summaries) | |
![]() ![]() ![]() ![]() ![]() |
1..1 | Coding | Code defined by a terminology system | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/resource-types | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: Task | |
![]() ![]() ![]() |
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 | |
![]() ![]() ![]() ![]() |
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 | |
![]() ![]() ![]() ![]() |
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 | |
![]() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
0..* | Endpoint | The technical details of an endpoint that can be used for electronic services | |||||
![]() ![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
0..* | string | Optional Extensions Element URL: http://dsf.dev/fhir/StructureDefinition/extension-certificate-thumbprint | |||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
Σ | 1..* | Identifier | Identifies this endpoint across multiple systems Slice: Unordered, Open by value:system, value:value | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | Identifier | Identifies this endpoint across multiple systems | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 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. | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: http://dsf.dev/sid/endpoint-identifier | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | string | The value that is unique Example General: 123456 | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() ![]() |
?!Σ | 1..1 | code | active | suspended | error | off | entered-in-error | test Binding: EndpointStatus (required): The status of the endpoint. | ||||
![]() ![]() ![]() |
Σ | 1..1 | Coding | Protocol/Profile/Standard to be used with this endpoint connection Binding: EndpointConnectionType (extensible) | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/endpoint-connection-type | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: hl7-fhir-rest | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | A name that this endpoint can be identified by | ||||
![]() ![]() ![]() |
Σ | 1..1 | Reference(DSF Organization(2.0.0)) | Organization that manages this endpoint (might not be the organization that exposes the endpoint) | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() ![]() |
Σ | 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). | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Text alternative for the resource | ||||
![]() ![]() ![]() |
0..* | ContactPoint | Contact details for source (e.g. troubleshooting) | |||||
![]() ![]() ![]() |
Σ | 0..1 | Period | Interval the endpoint is expected to be operational | ||||
![]() ![]() ![]() |
Σ | 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) | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | The type of content that may be used at this endpoint (e.g. XDS Discharge summaries) Binding: EndpointPayloadType (example) | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/resource-types | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: Task | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() ![]() |
Σ | 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. | ||||
![]() ![]() ![]() ![]() |
Σ | 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 | ||||
![]() ![]() ![]() ![]() |
Σ | 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 | ||||
![]() ![]() ![]() |
Σ | 1..1 | url | The technical base address for connecting to this endpoint | ||||
![]() ![]() ![]() |
0..* | string | Usage depends on the channel type | |||||
![]() |
Path | Conformance | ValueSet / Code | URI | |||
Endpoint.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages From the FHIR Standard
| ||||
Endpoint.identifier:dsfIdentifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard | ||||
Endpoint.identifier:dsfIdentifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type From the FHIR Standard | ||||
Endpoint.status | required | EndpointStatushttp://hl7.org/fhir/ValueSet/endpoint-status|4.0.1 From the FHIR Standard | ||||
Endpoint.connectionType | extensible | Fixed Value: hl7-fhir-resthttp://hl7.org/fhir/ValueSet/endpoint-connection-type From the FHIR Standard | ||||
Endpoint.managingOrganization.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types From the FHIR Standard | ||||
Endpoint.payloadType | example | EndpointPayloadTypehttp://hl7.org/fhir/ValueSet/endpoint-payload-type From the FHIR Standard | ||||
Endpoint.payloadType:slicePayloadType | example | EndpointPayloadTypehttp://hl7.org/fhir/ValueSet/endpoint-payload-type From the FHIR Standard | ||||
Endpoint.payloadMimeType | required | Mime Types(a valid code from urn:ietf:bcp:13 )http://hl7.org/fhir/ValueSet/mimetypes|4.0.1 From the FHIR Standard | ||||
Endpoint.payloadMimeType:fhirXml | required | Fixed Value: application/fhir+xmlhttp://hl7.org/fhir/ValueSet/mimetypes|4.0.1 From the FHIR Standard | ||||
Endpoint.payloadMimeType:fhirJson | required | Fixed Value: application/fhir+jsonhttp://hl7.org/fhir/ValueSet/mimetypes|4.0.1 From the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
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:
Other representations of profile: CSV, Excel, Schematron