RIVO-Noord Zorgviewer Implementation Guide
1.21.0 - CI build

RIVO-Noord Zorgviewer Implementation Guide, published by RIVO-NN HL7NL. This guide is not an authorized publication; it is the continuous build for version 1.21.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/RIVO-Noord/zorgviewer-ig/ and changes regularly. See the Directory of published versions

## Resource Profile: Endpoint

Official URL: http://fhir.hl7.nl/zorgviewer/StructureDefinition/Endpoint | Version: 1.21.0
Draft as of 2025-10-28 | Computable Name: Endpoint

The minimal Endpoint for the Zorgviewer

Usages:

- CapabilityStatements using this Profile: Adressering and Toestemming
- This Profile is not used by any profiles in this Implementation Guide

You can also check for usages in the FHIR IG Statistics

Changes since version 1.20.0:

- No changes

### Formal Views of Profile Content

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

- Key Elements Table
- Differential Table
- Snapshot Table
- Statistics/References
- All

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
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
connectionType | Σ | 1..1 | Coding | Protocol/Profile/Standard to be used with this endpoint connection Binding: Endpoint Connection Type (extensible)
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
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
Endpoint.status | Base | required | EndpointStatus | 📍3.0.2 | FHIR Std.
Endpoint.connectionType | Base | extensible | Endpoint Connection Type | 📍3.0.2 | FHIR Std.
Endpoint.payloadType | Base | example | Endpoint Payload Type | 📍3.0.2 | FHIR Std.

#### Constraints

Id | Grade | Path(s) | Description | Expression
dom-1 | error | Endpoint | If the resource is contained in another resource, it SHALL NOT contain any narrative | `contained.text.empty()`
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 | `contained.where(('#'+id in %resource.descendants().reference).not()).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()`

This structure is derived from Endpoint

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
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
Documentation for this format

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
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
language |  | 0..1 | code | Language of the resource content Binding: Common Languages (extensible): A human language.
Additional Bindings | Purpose
All Languages | Max Binding
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
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: (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
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
Endpoint.language | Base | extensible | Common Languages | 📍3.0.2 | FHIR Std.
Endpoint.status | Base | required | EndpointStatus | 📍3.0.2 | FHIR Std.
Endpoint.connectionType | Base | extensible | Endpoint Connection Type | 📍3.0.2 | FHIR Std.
Endpoint.payloadType | Base | example | Endpoint Payload Type | 📍3.0.2 | FHIR Std.
Endpoint.payloadMimeType | Base | required | ​ null (missing link) | 📦 | unknown?

#### Constraints

Id | Grade | Path(s) | Description | Expression
dom-1 | error | Endpoint | If the resource is contained in another resource, it SHALL NOT contain any narrative | `contained.text.empty()`
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 | `contained.where(('#'+id in %resource.descendants().reference).not()).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()`

This structure is derived from Endpoint

Summary

Must-Support: 2 elements

Key Elements View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
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
connectionType | Σ | 1..1 | Coding | Protocol/Profile/Standard to be used with this endpoint connection Binding: Endpoint Connection Type (extensible)
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
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
Endpoint.status | Base | required | EndpointStatus | 📍3.0.2 | FHIR Std.
Endpoint.connectionType | Base | extensible | Endpoint Connection Type | 📍3.0.2 | FHIR Std.
Endpoint.payloadType | Base | example | Endpoint Payload Type | 📍3.0.2 | FHIR Std.

#### Constraints

Id | Grade | Path(s) | Description | Expression
dom-1 | error | Endpoint | If the resource is contained in another resource, it SHALL NOT contain any narrative | `contained.text.empty()`
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 | `contained.where(('#'+id in %resource.descendants().reference).not()).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()`

Differential View

This structure is derived from Endpoint

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
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
Documentation for this format

Snapshot View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
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
language |  | 0..1 | code | Language of the resource content Binding: Common Languages (extensible): A human language.
Additional Bindings | Purpose
All Languages | Max Binding
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
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: (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
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
Endpoint.language | Base | extensible | Common Languages | 📍3.0.2 | FHIR Std.
Endpoint.status | Base | required | EndpointStatus | 📍3.0.2 | FHIR Std.
Endpoint.connectionType | Base | extensible | Endpoint Connection Type | 📍3.0.2 | FHIR Std.
Endpoint.payloadType | Base | example | Endpoint Payload Type | 📍3.0.2 | FHIR Std.
Endpoint.payloadMimeType | Base | required | ​ null (missing link) | 📦 | unknown?

#### Constraints

Id | Grade | Path(s) | Description | Expression
dom-1 | error | Endpoint | If the resource is contained in another resource, it SHALL NOT contain any narrative | `contained.text.empty()`
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 | `contained.where(('#'+id in %resource.descendants().reference).not()).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()`

This structure is derived from Endpoint

Summary

Must-Support: 2 elements

Other representations of profile: CSV, Excel, Schematron