RIVO-Noord Zorgviewer Implementation Guide
1.7.0 - CI build
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 |
XML representation of the Endpoint resource profile.
<StructureDefinition xmlns="http://hl7.org/fhir">
<id value="Endpoint"/>
<text>
<status value="extensions"/>
<div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Gegenereerde narrative: StructureDefinition Endpoint</b></p><a name="Endpoint"> </a><a name="hcEndpoint"> </a><a name="Endpoint-nl-NL"> </a><table border="0" cellpadding="0" cellspacing="0" style="border: 0px #F0F0F0 solid; font-size: 11px; font-family: verdana; vertical-align: top;"><tr style="border: 1px #F0F0F0 solid; font-size: 11px; font-family: verdana; vertical-align: top"><th style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" title="De logische naam van het element">Naam</a></th><th style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" title="Informatie over het gebruik van het element">Markeringen</a></th><th style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" title="Minimum en maximum # keren dat het element kan voorkomen in de instance">Kard.</a></th><th style="width: 100px" class="hierarchy"><a href="https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" title="Referentie naar het type van het element">Type</a></th><th style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" title="Additionele informatie over het element">Omschrijving & constraints</a><span style="float: right"><a href="https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" title="Legend for this format"><img src="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAABmJLR0QA/wD/AP+gvaeTAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB3RJTUUH3goXBCwdPqAP0wAAAldJREFUOMuNk0tIlFEYhp9z/vE2jHkhxXA0zJCMitrUQlq4lnSltEqCFhFG2MJFhIvIFpkEWaTQqjaWZRkp0g26URZkTpbaaOJkDqk10szoODP//7XIMUe0elcfnPd9zsfLOYplGrpRwZaqTtw3K7PtGem7Q6FoidbGgqHVy/HRb669R+56zx7eRV1L31JGxYbBtjKK93cxeqfyQHbehkZbUkK20goELEuIzEd+dHS+qz/Y8PTSif0FnGkbiwcAjHaU1+QWOptFiyCLp/LnKptpqIuXHx6rbR26kJcBX3yLgBfnd7CxwJmflpP2wUg0HIAoUUpZBmKzELGWcN8nAr6Gpu7tLU/CkwAaoKTWRSQyt89Q8w6J+oVQkKnBoblH7V0PPvUOvDYXfopE/SJmALsxnVm6LbkotrUtNowMeIrVrBcBpaMmdS0j9df7abpSuy7HWehwJdt1lhVwi/J58U5beXGAF6c3UXLycw1wdFklArBn87xdh0ZsZtArghBdAA3+OEDVubG4UEzP6x1FOWneHh2VDAHBAt80IbdXDcesNoCvs3E5AFyNSU5nbrDPZpcUEQQTFZiEVx+51fxMhhyJEAgvlriadIJZZksRuwBYMOPBbO3hePVVqgEJhFeUuFLhIPkRP6BQLIBrmMenujm/3g4zc398awIe90Zb5A1vREALqneMcYgP/xVQWlG+Ncu5vgwwlaUNx+3799rfe96u9K0JSDXcOzOTJg4B6IgmXfsygc7/Bvg9g9E58/cDVmGIBOP/zT8Bz1zqWqpbXIsd0O9hajXfL6u4BaOS6SeWAAAAAElFTkSuQmCC" alt="doco" style="background-color: inherit"/></a></span></th></tr><tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white"><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck1.png)" class="hierarchy"><img src="tbl_spacer.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="icon_resource.png" alt="." style="background-color: white; background-color: inherit" title="Resource" class="hierarchy"/> <a href="StructureDefinition-Endpoint-definitions.html#Endpoint">Endpoint</a><a name="Endpoint"> </a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"/><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="opacity: 0.5">0</span><span style="opacity: 0.5">..</span><span style="opacity: 0.5">*</span></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="http://hl7.org/fhir/STU3/endpoint.html">Endpoint</a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="opacity: 0.5">The technical details of an endpoint that can be used for electronic services</span></td></tr>
<tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: #F7F7F7"><td style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck10.png)" class="hierarchy"><img src="tbl_spacer.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_vjoin.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="icon_element.gif" alt="." style="background-color: #F7F7F7; background-color: inherit" title="Element" class="hierarchy"/> <a href="StructureDefinition-Endpoint-definitions.html#Endpoint.managingOrganization">managingOrganization</a><a name="Endpoint.managingOrganization"> </a></td><td style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="padding-left: 3px; padding-right: 3px; color: white; background-color: red" title="Dit element moet worden ondersteund">S</span></td><td style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="opacity: 0.5">0</span><span style="opacity: 0.5">..</span><span style="opacity: 0.5">1</span></td><td style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="http://hl7.org/fhir/STU3/references.html">Reference</a>(<a style="opacity: 0.5" href="http://hl7.org/fhir/STU3/organization.html">Organization</a>)</td><td style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="opacity: 0.5">Organization that manages this endpoint (may not be the organization that exposes the endpoint)</span></td></tr>
<tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white"><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck00.png)" class="hierarchy"><img src="tbl_spacer.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_vjoin_end.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="icon_element.gif" alt="." style="background-color: white; background-color: inherit" title="Element" class="hierarchy"/> <a href="StructureDefinition-Endpoint-definitions.html#Endpoint.address">address</a><a name="Endpoint.address"> </a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="padding-left: 3px; padding-right: 3px; color: white; background-color: red" title="Dit element moet worden ondersteund">S</span></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="opacity: 0.5">1</span><span style="opacity: 0.5">..</span><span style="opacity: 0.5">1</span></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a style="opacity: 0.5" href="http://hl7.org/fhir/STU3/datatypes.html#uri">uri</a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="opacity: 0.5">The technical base address for connecting to this endpoint</span></td></tr>
<tr><td colspan="5" class="hierarchy"><br/><a href="https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" title="Legenda voor dit formaat"><img src="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAABmJLR0QA/wD/AP+gvaeTAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB3RJTUUH3goXBCwdPqAP0wAAAldJREFUOMuNk0tIlFEYhp9z/vE2jHkhxXA0zJCMitrUQlq4lnSltEqCFhFG2MJFhIvIFpkEWaTQqjaWZRkp0g26URZkTpbaaOJkDqk10szoODP//7XIMUe0elcfnPd9zsfLOYplGrpRwZaqTtw3K7PtGem7Q6FoidbGgqHVy/HRb669R+56zx7eRV1L31JGxYbBtjKK93cxeqfyQHbehkZbUkK20goELEuIzEd+dHS+qz/Y8PTSif0FnGkbiwcAjHaU1+QWOptFiyCLp/LnKptpqIuXHx6rbR26kJcBX3yLgBfnd7CxwJmflpP2wUg0HIAoUUpZBmKzELGWcN8nAr6Gpu7tLU/CkwAaoKTWRSQyt89Q8w6J+oVQkKnBoblH7V0PPvUOvDYXfopE/SJmALsxnVm6LbkotrUtNowMeIrVrBcBpaMmdS0j9df7abpSuy7HWehwJdt1lhVwi/J58U5beXGAF6c3UXLycw1wdFklArBn87xdh0ZsZtArghBdAA3+OEDVubG4UEzP6x1FOWneHh2VDAHBAt80IbdXDcesNoCvs3E5AFyNSU5nbrDPZpcUEQQTFZiEVx+51fxMhhyJEAgvlriadIJZZksRuwBYMOPBbO3hePVVqgEJhFeUuFLhIPkRP6BQLIBrmMenujm/3g4zc398awIe90Zb5A1vREALqneMcYgP/xVQWlG+Ncu5vgwwlaUNx+3799rfe96u9K0JSDXcOzOTJg4B6IgmXfsygc7/Bvg9g9E58/cDVmGIBOP/zT8Bz1zqWqpbXIsd0O9hajXfL6u4BaOS6SeWAAAAAElFTkSuQmCC" alt="doco" style="background-color: inherit"/> Documentatie voor dit formaat</a></td></tr></table></div>
</text>
<url value="http://hl7.nl/fhir/zorgviewer/StructureDefinition/Endpoint"/>
<version value="1.7.0"/>
<name value="Endpoint"/>
<title value="Endpoint"/>
<status value="active"/>
<date value="2024-11-06T21:21:19+00:00"/>
<publisher value="RIVO-NN HL7NL"/>
<contact>
<name value="RIVO-NN"/>
<telecom>
<system value="url"/>
<value value="https://rivo-noord.nl"/>
</telecom>
</contact>
<contact>
<name value="HL7NL"/>
<telecom>
<system value="url"/>
<value value="https://hl7.nl"/>
</telecom>
</contact>
<description value="The minimal Endpoint for the Zorgviewer"/>
<jurisdiction>
<coding>
<system value="urn:iso:std:iso:3166"/>
<code value="NL"/>
</coding>
</jurisdiction>
<fhirVersion value="3.0.2"/>
<mapping>
<identity value="rim"/>
<uri value="http://hl7.org/v3"/>
<name value="RIM Mapping"/>
</mapping>
<mapping>
<identity value="w5"/>
<uri value="http://hl7.org/fhir/w5"/>
<name value="W5 Mapping"/>
</mapping>
<kind value="resource"/>
<abstract value="false"/>
<type value="Endpoint"/>
<baseDefinition value="http://hl7.org/fhir/StructureDefinition/Endpoint"/>
<derivation value="constraint"/>
<snapshot>
<element id="Endpoint">
<path value="Endpoint"/>
<short
value="The technical details of an endpoint that can be used for electronic services"/>
<definition
value="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."/>
<min value="0"/>
<max value="*"/>
<base>
<path value="Endpoint"/>
<min value="0"/>
<max value="*"/>
</base>
<constraint>
<key value="dom-2"/>
<severity value="error"/>
<human
value="If the resource is contained in another resource, it SHALL NOT contain nested Resources"/>
<expression value="contained.contained.empty()"/>
<xpath value="not(parent::f:contained and f:contained)"/>
<source
value="http://hl7.org/fhir/StructureDefinition/DomainResource"/>
</constraint>
<constraint>
<key value="dom-1"/>
<severity value="error"/>
<human
value="If the resource is contained in another resource, it SHALL NOT contain any narrative"/>
<expression value="contained.text.empty()"/>
<xpath value="not(parent::f:contained and f:text)"/>
<source
value="http://hl7.org/fhir/StructureDefinition/DomainResource"/>
</constraint>
<constraint>
<key value="dom-4"/>
<severity value="error"/>
<human
value="If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated"/>
<expression
value="contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()"/>
<xpath
value="not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))"/>
<source
value="http://hl7.org/fhir/StructureDefinition/DomainResource"/>
</constraint>
<constraint>
<key value="dom-3"/>
<severity value="error"/>
<human
value="If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource"/>
<expression
value="contained.where(('#'+id in %resource.descendants().reference).not()).empty()"/>
<xpath
value="not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))"/>
<source
value="http://hl7.org/fhir/StructureDefinition/DomainResource"/>
</constraint>
<mapping>
<identity value="rim"/>
<map value="Entity. Role, or Act"/>
</mapping>
<mapping>
<identity value="rim"/>
<map value="n/a"/>
</mapping>
<mapping>
<identity value="w5"/>
<map value="infrastructure.exchange"/>
</mapping>
</element>
<element id="Endpoint.id">
<path value="Endpoint.id"/>
<short value="Logical id of this artifact"/>
<definition
value="The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes."/>
<comment
value="The only time that a resource does not have an id is when it is being submitted to the server using a create operation."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="Resource.id"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="id"/>
</type>
<isSummary value="true"/>
</element>
<element id="Endpoint.meta">
<path value="Endpoint.meta"/>
<short value="Metadata about the resource"/>
<definition
value="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."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="Resource.meta"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="Meta"/>
</type>
<isSummary value="true"/>
</element>
<element id="Endpoint.implicitRules">
<path value="Endpoint.implicitRules"/>
<short value="A set of rules under which this content was created"/>
<definition
value="A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content."/>
<comment
value="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."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="Resource.implicitRules"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="uri"/>
</type>
<isModifier value="true"/>
<isSummary value="true"/>
</element>
<element id="Endpoint.language">
<path value="Endpoint.language"/>
<short value="Language of the resource content"/>
<definition
value="The base language in which the resource is written."/>
<comment
value="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)."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="Resource.language"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="code"/>
</type>
<binding>
<extension
url="http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet">
<valueReference>🔗
<reference value="http://hl7.org/fhir/ValueSet/all-languages"/>
</valueReference>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
<valueString value="Language"/>
</extension>
<strength value="extensible"/>
<description value="A human language."/>
<valueSetReference>🔗
<reference value="http://hl7.org/fhir/ValueSet/languages"/>
</valueSetReference>
</binding>
</element>
<element id="Endpoint.text">
<path value="Endpoint.text"/>
<short value="Text summary of the resource, for human interpretation"/>
<definition
value="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."/>
<comment
value="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."/>
<alias value="narrative"/>
<alias value="html"/>
<alias value="xhtml"/>
<alias value="display"/>
<min value="0"/>
<max value="1"/>
<base>
<path value="DomainResource.text"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="Narrative"/>
</type>
<condition value="dom-1"/>
<mapping>
<identity value="rim"/>
<map value="Act.text?"/>
</mapping>
</element>
<element id="Endpoint.contained">
<path value="Endpoint.contained"/>
<short value="Contained, inline Resources"/>
<definition
value="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."/>
<comment
value="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."/>
<alias value="inline resources"/>
<alias value="anonymous resources"/>
<alias value="contained resources"/>
<min value="0"/>
<max value="*"/>
<base>
<path value="DomainResource.contained"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code value="Resource"/>
</type>
<mapping>
<identity value="rim"/>
<map value="N/A"/>
</mapping>
</element>
<element id="Endpoint.extension">
<path value="Endpoint.extension"/>
<short value="Additional Content defined by implementations"/>
<definition
value="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."/>
<comment
value="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."/>
<alias value="extensions"/>
<alias value="user content"/>
<min value="0"/>
<max value="*"/>
<base>
<path value="DomainResource.extension"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code value="Extension"/>
</type>
<mapping>
<identity value="rim"/>
<map value="N/A"/>
</mapping>
</element>
<element id="Endpoint.modifierExtension">
<path value="Endpoint.modifierExtension"/>
<short value="Extensions that cannot be ignored"/>
<definition
value="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."/>
<comment
value="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."/>
<alias value="extensions"/>
<alias value="user content"/>
<min value="0"/>
<max value="*"/>
<base>
<path value="DomainResource.modifierExtension"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code value="Extension"/>
</type>
<isModifier value="true"/>
<mapping>
<identity value="rim"/>
<map value="N/A"/>
</mapping>
</element>
<element id="Endpoint.identifier">
<path value="Endpoint.identifier"/>
<short value="Identifies this endpoint across multiple systems"/>
<definition
value="Identifier for the organization that is used to identify the endpoint across multiple disparate systems."/>
<min value="0"/>
<max value="*"/>
<base>
<path value="Endpoint.identifier"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code value="Identifier"/>
</type>
<isSummary value="true"/>
<mapping>
<identity value="rim"/>
<map value="n/a"/>
</mapping>
<mapping>
<identity value="w5"/>
<map value="id"/>
</mapping>
</element>
<element id="Endpoint.status">
<path value="Endpoint.status"/>
<short
value="active | suspended | error | off | entered-in-error | test"/>
<definition value="active | suspended | error | off | test."/>
<comment
value="This element is labeled as a modifier because the status contains codes that mark the endpoint as not currently valid."/>
<min value="1"/>
<max value="1"/>
<base>
<path value="Endpoint.status"/>
<min value="1"/>
<max value="1"/>
</base>
<type>
<code value="code"/>
</type>
<isModifier value="true"/>
<isSummary value="true"/>
<binding>
<extension
url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
<valueString value="EndpointStatus"/>
</extension>
<strength value="required"/>
<description value="The status of the endpoint"/>
<valueSetReference>🔗
<reference value="http://hl7.org/fhir/ValueSet/endpoint-status"/>
</valueSetReference>
</binding>
<mapping>
<identity value="rim"/>
<map value="n/a"/>
</mapping>
<mapping>
<identity value="w5"/>
<map value="status"/>
</mapping>
</element>
<element id="Endpoint.connectionType">
<path value="Endpoint.connectionType"/>
<short
value="Protocol/Profile/Standard to be used with this endpoint connection"/>
<definition
value="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)."/>
<comment
value="For additional connectivity details for the protocol, extensions will be used at this point, as in the XDS example."/>
<min value="1"/>
<max value="1"/>
<base>
<path value="Endpoint.connectionType"/>
<min value="1"/>
<max value="1"/>
</base>
<type>
<code value="Coding"/>
</type>
<isSummary value="true"/>
<binding>
<extension
url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
<valueString value="endpoint-contype"/>
</extension>
<strength value="extensible"/>
<valueSetReference>🔗
<reference
value="http://hl7.org/fhir/ValueSet/endpoint-connection-type"/>
</valueSetReference>
</binding>
<mapping>
<identity value="rim"/>
<map value="n/a"/>
</mapping>
<mapping>
<identity value="w5"/>
<map value="class"/>
</mapping>
</element>
<element id="Endpoint.name">
<path value="Endpoint.name"/>
<short value="A name that this endpoint can be identified by"/>
<definition
value="A friendly name that this endpoint can be referred to with."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="Endpoint.name"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="string"/>
</type>
<isSummary value="true"/>
<mapping>
<identity value="rim"/>
<map value="n/a"/>
</mapping>
<mapping>
<identity value="w5"/>
<map value="what"/>
</mapping>
</element>
<element id="Endpoint.managingOrganization">
<path value="Endpoint.managingOrganization"/>
<short
value="Organization that manages this endpoint (may not be the organization that exposes the endpoint)"/>
<definition
value="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)."/>
<comment
value="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."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="Endpoint.managingOrganization"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="Reference"/>
<targetProfile
value="http://hl7.org/fhir/StructureDefinition/Organization"/>
</type>
<mustSupport value="true"/>
<isSummary value="true"/>
<mapping>
<identity value="rim"/>
<map value="n/a"/>
</mapping>
</element>
<element id="Endpoint.contact">
<path value="Endpoint.contact"/>
<short value="Contact details for source (e.g. troubleshooting)"/>
<definition
value="Contact details for a human to contact about the subscription. The primary use of this for system administrator troubleshooting."/>
<min value="0"/>
<max value="*"/>
<base>
<path value="Endpoint.contact"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code value="ContactPoint"/>
</type>
<mapping>
<identity value="rim"/>
<map value="n/a"/>
</mapping>
</element>
<element id="Endpoint.period">
<path value="Endpoint.period"/>
<short value="Interval the endpoint is expected to be operational"/>
<definition
value="The interval during which the endpoint is expected to be operational."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="Endpoint.period"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="Period"/>
</type>
<isSummary value="true"/>
<mapping>
<identity value="rim"/>
<map value="n/a"/>
</mapping>
<mapping>
<identity value="w5"/>
<map value="when.done"/>
</mapping>
</element>
<element id="Endpoint.payloadType">
<path value="Endpoint.payloadType"/>
<short
value="The type of content that may be used at this endpoint (e.g. XDS Discharge summaries)"/>
<definition
value="The payload type describes the acceptable content that can be communicated on the endpoint."/>
<comment
value="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."/>
<min value="1"/>
<max value="*"/>
<base>
<path value="Endpoint.payloadType"/>
<min value="1"/>
<max value="*"/>
</base>
<type>
<code value="CodeableConcept"/>
</type>
<isSummary value="true"/>
<binding>
<extension
url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
<valueString value="PayloadType"/>
</extension>
<strength value="example"/>
<valueSetReference>🔗
<reference
value="http://hl7.org/fhir/ValueSet/endpoint-payload-type"/>
</valueSetReference>
</binding>
<mapping>
<identity value="rim"/>
<map value="n/a"/>
</mapping>
</element>
<element id="Endpoint.payloadMimeType">
<path value="Endpoint.payloadMimeType"/>
<short
value="Mimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this)"/>
<definition
value="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)."/>
<comment
value="Sending the payload has obvious security consequences. The server is responsible for ensuring that the content is appropriately secured."/>
<min value="0"/>
<max value="*"/>
<base>
<path value="Endpoint.payloadMimeType"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code value="code"/>
</type>
<isSummary value="true"/>
<binding>
<extension
url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
<valueString value="MimeType"/>
</extension>
<strength value="required"/>
<description
value="The mime type of an attachment. Any valid mime type is allowed."/>
<valueSetUri value="http://www.rfc-editor.org/bcp/bcp13.txt"/>
</binding>
<mapping>
<identity value="rim"/>
<map value="n/a"/>
</mapping>
</element>
<element id="Endpoint.address">
<path value="Endpoint.address"/>
<short
value="The technical base address for connecting to this endpoint"/>
<definition
value="The uri that describes the actual end-point to connect to."/>
<comment
value="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/..."."/>
<min value="1"/>
<max value="1"/>
<base>
<path value="Endpoint.address"/>
<min value="1"/>
<max value="1"/>
</base>
<type>
<code value="uri"/>
</type>
<mustSupport value="true"/>
<isSummary value="true"/>
<mapping>
<identity value="rim"/>
<map value="n/a"/>
</mapping>
</element>
<element id="Endpoint.header">
<path value="Endpoint.header"/>
<short value="Usage depends on the channel type"/>
<definition
value="Additional headers / information to send as part of the notification."/>
<comment
value="Exactly what these mean depend on the channel type. The can convey additional information to the recipient and/or meet security requirements."/>
<min value="0"/>
<max value="*"/>
<base>
<path value="Endpoint.header"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code value="string"/>
</type>
<isSummary value="false"/>
</element>
</snapshot>
<differential>
<element id="Endpoint">
<path value="Endpoint"/>
</element>
<element id="Endpoint.managingOrganization">
<path value="Endpoint.managingOrganization"/>
<mustSupport value="true"/>
</element>
<element id="Endpoint.address">
<path value="Endpoint.address"/>
<mustSupport value="true"/>
</element>
</differential>
</StructureDefinition>