RIVO-Noord Zorgviewer Implementation Guide
1.7.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.7.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
Active as of 2024-11-06 |
Definitions for the Endpoint resource profile.
Guidance on how to interpret the contents of this table can be found here
0. Endpoint | |
2. Endpoint.managingOrganization | |
Must Support | true |
4. Endpoint.address | |
Must Support | true |
Guidance on how to interpret the contents of this table can be found here
0. Endpoint | |
Definition | The technical details of an endpoint that can be used for electronic services, such as for web services providing XDS.b or a REST endpoint for another FHIR server. This may include any security context information. |
Short | The technical details of an endpoint that can be used for electronic services |
Control | 0..* |
Invariants | dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty() )dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative ( contained.text.empty() )dom-4: 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-3: 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-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty()) dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative (contained.text.empty()) dom-4: 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-3: 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()) |
2. Endpoint.implicitRules | |
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. |
Short | A set of rules under which this content was created |
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation. |
Control | 0..1 |
Type | uri |
Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
4. Endpoint.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. |
Short | Extensions that cannot be ignored |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..* |
Type | Extension |
Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR |
Alternate Names | extensions, user content |
6. Endpoint.status | |
Definition | active | suspended | error | off | test. |
Short | active | suspended | error | off | entered-in-error | test |
Comments | This element is labeled as a modifier because the status contains codes that mark the endpoint as not currently valid. |
Control | 1..1 |
Binding | The codes SHALL be taken from EndpointStatushttp://hl7.org/fhir/ValueSet/endpoint-status (required to http://hl7.org/fhir/ValueSet/endpoint-status )The status of the endpoint |
Type | code |
Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
8. Endpoint.connectionType | |
Definition | A coded value that represents the technical details of the usage of this endpoint, such as what WSDLs should be used in what way. (e.g. XDS.b/DICOM/cds-hook). |
Short | Protocol/Profile/Standard to be used with this endpoint connection |
Comments | For additional connectivity details for the protocol, extensions will be used at this point, as in the XDS example. |
Control | 1..1 |
Binding | Unless not suitable, these codes SHALL be taken from Endpoint Connection Typehttp://hl7.org/fhir/ValueSet/endpoint-connection-type (extensible to http://hl7.org/fhir/ValueSet/endpoint-connection-type ) |
Type | Coding |
Summary | true |
10. Endpoint.managingOrganization | |
Definition | The organization that manages this endpoint (even if technically another organisation is hosting this in the cloud, it is the organisation associated with the data). |
Short | Organization that manages this endpoint (may not be the organization that exposes the endpoint) |
Comments | This property is not typically used when searching for Endpoint resources for usage. The typical usage is via the reference from an aplicable Organization/Location/Practitioner resource, which is where the context is provided. Multiple Locations may reference a single endpoint, and don't have to be within the same organization resource, but most likely within the same organizational hierarchy. |
Control | 0..1 |
Type | Reference(Organization) |
Must Support | true |
Summary | true |
12. Endpoint.payloadType | |
Definition | The payload type describes the acceptable content that can be communicated on the endpoint. |
Short | The type of content that may be used at this endpoint (e.g. XDS Discharge summaries) |
Comments | The payloadFormat describes the serialization format of the data, where the payloadType indicates the specific document/schema that is being transferred; e.g. DischargeSummary or CarePlan. |
Control | 1..* |
Binding | For example codes, see Endpoint Payload Typehttp://hl7.org/fhir/ValueSet/endpoint-payload-type (example to http://hl7.org/fhir/ValueSet/endpoint-payload-type ) |
Type | CodeableConcept |
Summary | true |
14. Endpoint.address | |
Definition | The uri that describes the actual end-point to connect to. |
Short | The technical base address for connecting to this endpoint |
Comments | For rest-hook, and websocket, the end-point must be an http: or https: URL; for email, a mailto: url, for sms, a tel: url, and for message the endpoint can be in any form of url the server understands (usually, http: or mllp:). The URI is allowed to be relative; in which case, it is relative to the server end-point (since their may be more than one, clients should avoid using relative URIs) This address will be to the service base, without any parameters, or sub-services or resources tacked on. E.g. for a WADO-RS endpoint, the url should be "https://pacs.hospital.org/wado-rs" and not "https://pacs.hospital.org/wado-rs/studies/1.2.250.1.59.40211.12345678.678910/series/1.2.250.1.59.40211.789001276.14556172.67789/instances/...". |
Control | 1..1 |
Type | uri |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Summary | true |
Guidance on how to interpret the contents of this table can be found here
0. Endpoint | |||||
Definition | The technical details of an endpoint that can be used for electronic services, such as for web services providing XDS.b or a REST endpoint for another FHIR server. This may include any security context information. | ||||
Short | The technical details of an endpoint that can be used for electronic services | ||||
Control | 0..* | ||||
Invariants | dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty() )dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative ( contained.text.empty() )dom-4: 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-3: 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() ) | ||||
2. Endpoint.id | |||||
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | ||||
Short | Logical id of this artifact | ||||
Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation. | ||||
Control | 0..1 | ||||
Type | id | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
4. Endpoint.meta | |||||
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource. | ||||
Short | Metadata about the resource | ||||
Control | 0..1 | ||||
Type | Meta | ||||
Summary | true | ||||
6. Endpoint.implicitRules | |||||
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. | ||||
Short | A set of rules under which this content was created | ||||
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation. | ||||
Control | 0..1 | ||||
Type | uri | ||||
Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
8. Endpoint.language | |||||
Definition | The base language in which the resource is written. | ||||
Short | Language of the resource content | ||||
Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). | ||||
Control | 0..1 | ||||
Binding | Unless not suitable, these codes SHALL be taken from Common Languages (extensible to http://hl7.org/fhir/ValueSet/languages )A human language.
| ||||
Type | code | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
10. Endpoint.text | |||||
Definition | A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. | ||||
Short | Text summary of the resource, for human interpretation | ||||
Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded in formation is added later. | ||||
Control | 0..1 This element is affected by the following invariants: dom-1 | ||||
Type | Narrative | ||||
Alternate Names | narrative, html, xhtml, display | ||||
12. Endpoint.contained | |||||
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. | ||||
Short | Contained, inline Resources | ||||
Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. | ||||
Control | 0..* | ||||
Type | Resource | ||||
Alternate Names | inline resources, anonymous resources, contained resources | ||||
14. Endpoint.extension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
Short | Additional Content defined by implementations | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Alternate Names | extensions, user content | ||||
16. Endpoint.modifierExtension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. | ||||
Short | Extensions that cannot be ignored | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR | ||||
Alternate Names | extensions, user content | ||||
18. Endpoint.identifier | |||||
Definition | Identifier for the organization that is used to identify the endpoint across multiple disparate systems. | ||||
Short | Identifies this endpoint across multiple systems | ||||
Note | This is a business identifier, not a resource identifier (see discussion) | ||||
Control | 0..* | ||||
Type | Identifier | ||||
Summary | true | ||||
20. Endpoint.status | |||||
Definition | active | suspended | error | off | test. | ||||
Short | active | suspended | error | off | entered-in-error | test | ||||
Comments | This element is labeled as a modifier because the status contains codes that mark the endpoint as not currently valid. | ||||
Control | 1..1 | ||||
Binding | The codes SHALL be taken from EndpointStatus (required to http://hl7.org/fhir/ValueSet/endpoint-status )The status of the endpoint | ||||
Type | code | ||||
Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
22. Endpoint.connectionType | |||||
Definition | A coded value that represents the technical details of the usage of this endpoint, such as what WSDLs should be used in what way. (e.g. XDS.b/DICOM/cds-hook). | ||||
Short | Protocol/Profile/Standard to be used with this endpoint connection | ||||
Comments | For additional connectivity details for the protocol, extensions will be used at this point, as in the XDS example. | ||||
Control | 1..1 | ||||
Binding | Unless not suitable, these codes SHALL be taken from Endpoint Connection Type (extensible to http://hl7.org/fhir/ValueSet/endpoint-connection-type ) | ||||
Type | Coding | ||||
Summary | true | ||||
24. Endpoint.name | |||||
Definition | A friendly name that this endpoint can be referred to with. | ||||
Short | A name that this endpoint can be identified by | ||||
Control | 0..1 | ||||
Type | string | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
26. Endpoint.managingOrganization | |||||
Definition | The organization that manages this endpoint (even if technically another organisation is hosting this in the cloud, it is the organisation associated with the data). | ||||
Short | Organization that manages this endpoint (may not be the organization that exposes the endpoint) | ||||
Comments | This property is not typically used when searching for Endpoint resources for usage. The typical usage is via the reference from an aplicable Organization/Location/Practitioner resource, which is where the context is provided. Multiple Locations may reference a single endpoint, and don't have to be within the same organization resource, but most likely within the same organizational hierarchy. | ||||
Control | 0..1 | ||||
Type | Reference(Organization) | ||||
Must Support | true | ||||
Summary | true | ||||
28. Endpoint.contact | |||||
Definition | Contact details for a human to contact about the subscription. The primary use of this for system administrator troubleshooting. | ||||
Short | Contact details for source (e.g. troubleshooting) | ||||
Control | 0..* | ||||
Type | ContactPoint | ||||
30. Endpoint.period | |||||
Definition | The interval during which the endpoint is expected to be operational. | ||||
Short | Interval the endpoint is expected to be operational | ||||
Control | 0..1 | ||||
Type | Period | ||||
Summary | true | ||||
32. Endpoint.payloadType | |||||
Definition | The payload type describes the acceptable content that can be communicated on the endpoint. | ||||
Short | The type of content that may be used at this endpoint (e.g. XDS Discharge summaries) | ||||
Comments | The payloadFormat describes the serialization format of the data, where the payloadType indicates the specific document/schema that is being transferred; e.g. DischargeSummary or CarePlan. | ||||
Control | 1..* | ||||
Binding | For example codes, see Endpoint Payload Type (example to http://hl7.org/fhir/ValueSet/endpoint-payload-type ) | ||||
Type | CodeableConcept | ||||
Summary | true | ||||
34. Endpoint.payloadMimeType | |||||
Definition | The mime type to send the payload in - e.g. application/fhir+xml, application/fhir+json. If the mime type is not specified, then the sender could send any content (including no content depending on the connectionType). | ||||
Short | Mimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this) | ||||
Comments | Sending the payload has obvious security consequences. The server is responsible for ensuring that the content is appropriately secured. | ||||
Control | 0..* | ||||
Binding | The codes SHALL be taken from mimetypes (required to http://hl7.org/fhir/ValueSet/mimetypes )The mime type of an attachment. Any valid mime type is allowed. | ||||
Type | code | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
36. Endpoint.address | |||||
Definition | The uri that describes the actual end-point to connect to. | ||||
Short | The technical base address for connecting to this endpoint | ||||
Comments | For rest-hook, and websocket, the end-point must be an http: or https: URL; for email, a mailto: url, for sms, a tel: url, and for message the endpoint can be in any form of url the server understands (usually, http: or mllp:). The URI is allowed to be relative; in which case, it is relative to the server end-point (since their may be more than one, clients should avoid using relative URIs) This address will be to the service base, without any parameters, or sub-services or resources tacked on. E.g. for a WADO-RS endpoint, the url should be "https://pacs.hospital.org/wado-rs" and not "https://pacs.hospital.org/wado-rs/studies/1.2.250.1.59.40211.12345678.678910/series/1.2.250.1.59.40211.789001276.14556172.67789/instances/...". | ||||
Control | 1..1 | ||||
Type | uri | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Must Support | true | ||||
Summary | true | ||||
38. Endpoint.header | |||||
Definition | Additional headers / information to send as part of the notification. | ||||
Short | Usage depends on the channel type | ||||
Comments | Exactly what these mean depend on the channel type. The can convey additional information to the recipient and/or meet security requirements. | ||||
Control | 0..* | ||||
Type | string | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false |