RIVO-Noord Zorgviewer Implementation Guide
0.26.0 - sprint33 Netherlands flag

RIVO-Noord Zorgviewer Implementation Guide - Local Development build (v0.26.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: Endpoint

Official URL: http://hl7.nl/fhir/zorgviewer/StructureDefinition/Endpoint Version: 0.26.0
Draft as of 2024-06-07 Computable Name: Endpoint

The minimal Endpoint for the Zorgviewer

Usage:

  • This Resource Profile is not used by any profiles in this Implementation Guide

Formal Views of Profile Content

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

This structure is derived from Endpoint

NameFlagsCard.TypeDescription & Constraintsdoco
.. Endpoint 0..* Endpoint The technical details of an endpoint that can be used for electronic services
... managingOrganization S 0..1 Reference(Organization) Organization that manages this endpoint (may not be the organization that exposes the endpoint)
... address S 1..1 uri The technical base address for connecting to this endpoint

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Endpoint 0..* Endpoint The technical details of an endpoint that can be used for electronic services
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... status ?!Σ 1..1 code active | suspended | error | off | entered-in-error | test
Binding: EndpointStatus (required): The status of the endpoint

... managingOrganization SΣ 0..1 Reference(Organization) Organization that manages this endpoint (may not be the organization that exposes the endpoint)
... payloadType Σ 1..* CodeableConcept The type of content that may be used at this endpoint (e.g. XDS Discharge summaries)
Binding: Endpoint Payload Type (example)
... address SΣ 1..1 uri The technical base address for connecting to this endpoint

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Endpoint.statusrequiredEndpointStatus
http://hl7.org/fhir/ValueSet/endpoint-status
from the FHIR Standard
Endpoint.connectionTypeextensibleEndpoint Connection Type
http://hl7.org/fhir/ValueSet/endpoint-connection-type
from the FHIR Standard
Endpoint.payloadTypeexampleEndpoint Payload Type
http://hl7.org/fhir/ValueSet/endpoint-payload-type
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-1errorEndpointIf the resource is contained in another resource, it SHALL NOT contain any narrative
: contained.text.empty()
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
: contained.where(('#'+id in %resource.descendants().reference).not()).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()
NameFlagsCard.TypeDescription & Constraintsdoco
.. 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 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
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional Content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier Identifies this endpoint across multiple systems
... 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: Endpoint Connection Type (extensible)
... name Σ 0..1 string A name that this endpoint can be identified by
... managingOrganization SΣ 0..1 Reference(Organization) Organization that manages this endpoint (may not be the organization that exposes the endpoint)
... contact 0..* ContactPoint Contact details for source (e.g. troubleshooting)
... period Σ 0..1 Period Interval the endpoint is expected to be operational
... payloadType Σ 1..* CodeableConcept The type of content that may be used at this endpoint (e.g. XDS Discharge summaries)
Binding: Endpoint Payload Type (example)
... payloadMimeType Σ 0..* code Mimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this)
Binding: mimetypes (required): The mime type of an attachment. Any valid mime type is allowed.


... address SΣ 1..1 uri 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.languageextensibleCommon Languages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Endpoint.statusrequiredEndpointStatus
http://hl7.org/fhir/ValueSet/endpoint-status
from the FHIR Standard
Endpoint.connectionTypeextensibleEndpoint Connection Type
http://hl7.org/fhir/ValueSet/endpoint-connection-type
from the FHIR Standard
Endpoint.payloadTypeexampleEndpoint Payload Type
http://hl7.org/fhir/ValueSet/endpoint-payload-type
from the FHIR Standard
Endpoint.payloadMimeTyperequiredhttp://hl7.org/fhir/ValueSet/mimetypes
http://hl7.org/fhir/ValueSet/mimetypes

Constraints

IdGradePath(s)DetailsRequirements
dom-1errorEndpointIf the resource is contained in another resource, it SHALL NOT contain any narrative
: contained.text.empty()
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
: contained.where(('#'+id in %resource.descendants().reference).not()).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()

This structure is derived from Endpoint

Summary

Must-Support: 2 elements

Differential View

This structure is derived from Endpoint

NameFlagsCard.TypeDescription & Constraintsdoco
.. Endpoint 0..* Endpoint The technical details of an endpoint that can be used for electronic services
... managingOrganization S 0..1 Reference(Organization) Organization that manages this endpoint (may not be the organization that exposes the endpoint)
... address S 1..1 uri The technical base address for connecting to this endpoint

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Endpoint 0..* Endpoint The technical details of an endpoint that can be used for electronic services
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... status ?!Σ 1..1 code active | suspended | error | off | entered-in-error | test
Binding: EndpointStatus (required): The status of the endpoint

... managingOrganization SΣ 0..1 Reference(Organization) Organization that manages this endpoint (may not be the organization that exposes the endpoint)
... payloadType Σ 1..* CodeableConcept The type of content that may be used at this endpoint (e.g. XDS Discharge summaries)
Binding: Endpoint Payload Type (example)
... address SΣ 1..1 uri The technical base address for connecting to this endpoint

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Endpoint.statusrequiredEndpointStatus
http://hl7.org/fhir/ValueSet/endpoint-status
from the FHIR Standard
Endpoint.connectionTypeextensibleEndpoint Connection Type
http://hl7.org/fhir/ValueSet/endpoint-connection-type
from the FHIR Standard
Endpoint.payloadTypeexampleEndpoint Payload Type
http://hl7.org/fhir/ValueSet/endpoint-payload-type
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-1errorEndpointIf the resource is contained in another resource, it SHALL NOT contain any narrative
: contained.text.empty()
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
: contained.where(('#'+id in %resource.descendants().reference).not()).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()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. 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 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
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional Content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier Identifies this endpoint across multiple systems
... 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: Endpoint Connection Type (extensible)
... name Σ 0..1 string A name that this endpoint can be identified by
... managingOrganization SΣ 0..1 Reference(Organization) Organization that manages this endpoint (may not be the organization that exposes the endpoint)
... contact 0..* ContactPoint Contact details for source (e.g. troubleshooting)
... period Σ 0..1 Period Interval the endpoint is expected to be operational
... payloadType Σ 1..* CodeableConcept The type of content that may be used at this endpoint (e.g. XDS Discharge summaries)
Binding: Endpoint Payload Type (example)
... payloadMimeType Σ 0..* code Mimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this)
Binding: mimetypes (required): The mime type of an attachment. Any valid mime type is allowed.


... address SΣ 1..1 uri 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.languageextensibleCommon Languages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Endpoint.statusrequiredEndpointStatus
http://hl7.org/fhir/ValueSet/endpoint-status
from the FHIR Standard
Endpoint.connectionTypeextensibleEndpoint Connection Type
http://hl7.org/fhir/ValueSet/endpoint-connection-type
from the FHIR Standard
Endpoint.payloadTypeexampleEndpoint Payload Type
http://hl7.org/fhir/ValueSet/endpoint-payload-type
from the FHIR Standard
Endpoint.payloadMimeTyperequiredhttp://hl7.org/fhir/ValueSet/mimetypes
http://hl7.org/fhir/ValueSet/mimetypes

Constraints

IdGradePath(s)DetailsRequirements
dom-1errorEndpointIf the resource is contained in another resource, it SHALL NOT contain any narrative
: contained.text.empty()
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
: contained.where(('#'+id in %resource.descendants().reference).not()).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()

This structure is derived from Endpoint

Summary

Must-Support: 2 elements

 

Other representations of profile: CSV, Excel, Schematron