Validated Healthcare Directory IG STU1 Draft for Comment
This page is part of the Validated Healthcare Directory FHIR IG (v0.1.0: STU 1 Draft) based on FHIR v3.2.0. . For a full list of available versions, see the Directory of published versions 
{
"resourceType" : "StructureDefinition",
"id" : "vhdir-endpoint",
"meta" : {
"lastUpdated" : "2017-12-08T19:51:07.842-05:00"
},
"text" : {
"status" : "generated",
"div" : "<div xmlns="http://www.w3.org/1999/xhtml"><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="http://hl7.org/fhir/STU3/formats.html#table" title="The logical name of the element">Name</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="http://hl7.org/fhir/STU3/formats.html#table" title="Information about the use of the element">Flags</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="http://hl7.org/fhir/STU3/formats.html#table" title="Minimum and Maximum # of times the the element can appear in the instance">Card.</a></th><th style="width: 100px" class="hierarchy"><a href="http://hl7.org/fhir/STU3/formats.html#table" title="Reference to the type of the 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="http://hl7.org/fhir/STU3/formats.html#table" title="Additional information about the element">Description & Constraints</a><span style="float: right"><a href="http://hl7.org/fhir/STU3/formats.html#table" title="Legend for this format"><img src="http://hl7.org/fhir/STU3/help16.png" 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_element.gif" alt="." style="background-color: white; background-color: inherit" title="Element" class="hierarchy"/> <a href="StructureDefinition-vhdir-endpoint-definitions.html#Endpoint" title="null">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.4">0</span><span style="opacity: 0.5">..</span><span style="opacity: 0.4">*</span></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"/></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_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: white; background-color: inherit" title="Element" class="hierarchy"/> <span style="text-decoration:line-through" title="null">language</span><a name="Endpoint.language"> </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="text-decoration:line-through"/><span style="text-decoration:line-through">0</span><span style="text-decoration:line-through">..</span><span style="text-decoration:line-through">0</span></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"/></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_bck11.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: white; background-color: inherit" title="Element" class="hierarchy"/> <a href="StructureDefinition-vhdir-endpoint-definitions.html#Endpoint.identifier" title="null">identifier</a><a name="Endpoint.identifier"> </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.4">0</span><span style="opacity: 0.5">..</span><span style="opacity: 0.4">*</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.4" href="http://hl7.org/fhir/STU3/datatypes.html#Identifier">Identifier</a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"/></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_bck100.png)" class="hierarchy"><img src="tbl_spacer.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_vline.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_vjoin_end.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="icon_extension_simple.png" alt="." style="background-color: white; background-color: inherit" title="Simple Extension" class="hierarchy"/> <a href="StructureDefinition-vhdir-endpoint-definitions.html#Endpoint.identifier.extension:status" title="Extension URL = http://hl7.org/fhir/ig/vhdir/StructureDefinition/identifier-status">identifier-status</a><a name="Endpoint.identifier.extension"> </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.4">0</span>..<span style="opacity: 0.4">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 href="http://hl7.org/fhir/STU3/datatypes.html#code">code</a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy">Status<br/><span style="font-weight:bold">URL: </span><a href="http://hl7.org/fhir/STU3/StructureDefinition-identifier-status.html">http://hl7.org/fhir/ig/vhdir/StructureDefinition/identifier-status</a></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_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: white; background-color: inherit" title="Element" class="hierarchy"/> <a href="StructureDefinition-vhdir-endpoint-definitions.html#Endpoint.managingOrganization" title="null">managingOrganization</a><a name="Endpoint.managingOrganization"> </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">1..1</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/references.html">Reference</a>(<a style="opacity: 0.4" href="http://hl7.org/fhir/STU3/organization.html">Organization</a>)</td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"/></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_bck11.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: white; background-color: inherit" title="Element" class="hierarchy"/> <a href="StructureDefinition-vhdir-endpoint-definitions.html#Endpoint.contact" title="null">contact</a><a name="Endpoint.contact"> </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.4">0</span>..<span style="opacity: 0.4">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.4" href="http://hl7.org/fhir/STU3/datatypes.html#ContactPoint">ContactPoint</a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"/></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_bck110.png)" class="hierarchy"><img src="tbl_spacer.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_vline.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_vjoin.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="icon_extension_complex.png" alt="." style="background-color: white; background-color: inherit" title="Complex Extension" class="hierarchy"/> <a href="StructureDefinition-vhdir-endpoint-definitions.html#Endpoint.contact.extension:availabletime" title="Extension URL = http://hl7.org/fhir/ig/vhdir/StructureDefinition/contactPoint-availableTime">contactPoint-availableTime</a><a name="Endpoint.contact.extension"> </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.4">0</span><span style="opacity: 0.5">..</span><span style="opacity: 0.4">*</span></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy">(Complex)</td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy">Available time<br/><span style="font-weight:bold">URL: </span><a href="http://hl7.org/fhir/STU3/StructureDefinition-contactPoint-availableTime.html">http://hl7.org/fhir/ig/vhdir/StructureDefinition/contactPoint-availableTime</a></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_bck100.png)" class="hierarchy"><img src="tbl_spacer.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_vline.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_vjoin_end.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="icon_extension_simple.png" alt="." style="background-color: white; background-color: inherit" title="Simple Extension" class="hierarchy"/> <a href="StructureDefinition-vhdir-endpoint-definitions.html#Endpoint.contact.extension:viaintermediary" title="Extension URL = http://hl7.org/fhir/ig/vhdir/StructureDefinition/contactPoint-viaIntermediary">contactPoint-viaIntermediary</a><a name="Endpoint.contact.extension"> </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.4">0</span>..<span style="opacity: 0.4">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 href="http://hl7.org/fhir/STU3/references.html">Reference</a>(<a href="StructureDefinition-vhdir-practitioner.html">vhdir-practitioner</a>), <a href="http://hl7.org/fhir/STU3/references.html">Reference</a>(<a href="StructureDefinition-vhdir-organization.html">vhdir-organization</a>), <a href="http://hl7.org/fhir/STU3/references.html">Reference</a>(<a href="StructureDefinition-vhdir-location.html">vhdir-location</a>)</td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy">viaIntermediary<br/><span style="font-weight:bold">URL: </span><a href="http://hl7.org/fhir/STU3/StructureDefinition-contactPoint-viaIntermediary.html">http://hl7.org/fhir/ig/vhdir/StructureDefinition/contactPoint-viaIntermediary</a></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_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: white; background-color: inherit" title="Element" class="hierarchy"/> <a href="StructureDefinition-vhdir-endpoint-definitions.html#Endpoint.period" title="null">period</a><a name="Endpoint.period"> </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">1..1</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.4" href="http://hl7.org/fhir/STU3/datatypes.html#Period">Period</a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"/></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_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_extension_complex.png" alt="." style="background-color: white; background-color: inherit" title="Complex Extension" class="hierarchy"/> <a href="StructureDefinition-vhdir-endpoint-definitions.html#Endpoint.extension:usecase" title="Extension URL = http://hl7.org/fhir/ig/vhdir/StructureDefinition/endpoint-useCase">endpoint-useCase</a><a name="Endpoint.extension"> </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.4">0</span><span style="opacity: 0.5">..</span><span style="opacity: 0.4">*</span></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy">(Complex)</td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy">Use case<br/><span style="font-weight:bold">URL: </span><a href="http://hl7.org/fhir/STU3/StructureDefinition-endpoint-useCase.html">http://hl7.org/fhir/ig/vhdir/StructureDefinition/endpoint-useCase</a></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_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_extension_simple.png" alt="." style="background-color: white; background-color: inherit" title="Simple Extension" class="hierarchy"/> <a href="StructureDefinition-vhdir-endpoint-definitions.html#Endpoint.extension:rank" title="Extension URL = http://hl7.org/fhir/ig/vhdir/StructureDefinition/endpoint-rank">endpoint-rank</a><a name="Endpoint.extension"> </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.4">0</span>..<span style="opacity: 0.4">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 href="http://hl7.org/fhir/STU3/datatypes.html#positiveInt">positiveInt</a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy">Rank<br/><span style="font-weight:bold">URL: </span><a href="http://hl7.org/fhir/STU3/StructureDefinition-endpoint-rank.html">http://hl7.org/fhir/ig/vhdir/StructureDefinition/endpoint-rank</a></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_extension_complex.png" alt="." style="background-color: white; background-color: inherit" title="Complex Extension" class="hierarchy"/> <a href="StructureDefinition-vhdir-endpoint-definitions.html#Endpoint.extension:digitalcertificate" title="Extension URL = http://hl7.org/fhir/ig/vhdir/StructureDefinition/digitalCertificate">digitalCertificate</a><a name="Endpoint.extension"> </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.4">0</span><span style="opacity: 0.5">..</span><span style="opacity: 0.4">*</span></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy">(Complex)</td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy">digitalCertificate<br/><span style="font-weight:bold">URL: </span><a href="http://hl7.org/fhir/STU3/StructureDefinition-digitalCertificate.html">http://hl7.org/fhir/ig/vhdir/StructureDefinition/digitalCertificate</a></td></tr>
<tr><td colspan="5" class="hierarchy"><br/><a href="http://hl7.org/fhir/STU3/formats.html#table" title="Legend for this format"><img src="http://hl7.org/fhir/STU3/help16.png" alt="doco" style="background-color: inherit"/> Documentation for this format</a></td></tr></table></div>"
},
"url" : "http://hl7.org/fhir/ig/vhdir/StructureDefinition/vhdir-endpoint",
"version" : "0.1.0",
"name" : "vhdir-endpoint",
"status" : "draft",
"date" : "2017-10-04T00:34:40.427+11:00",
"description" : "Defines the basic constraints and extensions on the Endpoint resource for use in a Validated Healthcare Directory",
"jurisdiction" : [
{
"coding" : [
{
"system" : "urn:iso:std:iso:3166",
"code" : "International"
}
]
}
],
"fhirVersion" : "3.2.0",
"mapping" : [
{
"identity" : "rim",
"uri" : "http://hl7.org/v3",
"name" : "RIM Mapping"
},
{
"identity" : "w5",
"uri" : "http://hl7.org/fhir/w5",
"name" : "W5 Mapping"
}
],
"kind" : "resource",
"abstract" : false,
"type" : "Endpoint",
"baseDefinition" : "http://hl7.org/fhir/StructureDefinition/Endpoint",
"derivation" : "constraint",
"snapshot" : {
"element" : [
{
"id" : "Endpoint",
"path" : "Endpoint",
"short" : "The technical details of an endpoint that can be used for electronic services",
"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.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Endpoint",
"min" : 0,
"max" : "*"
},
"constraint" : [
{
"key" : "dom-2",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression" : "contained.contained.empty()",
"xpath" : "not(parent::f:contained and f:contained)",
"source" : "DomainResource"
},
{
"key" : "dom-1",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL NOT contain any narrative",
"expression" : "contained.text.empty()",
"xpath" : "not(parent::f:contained and f:text)",
"source" : "DomainResource"
},
{
"key" : "dom-4",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression" : "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source" : "DomainResource"
},
{
"key" : "dom-3",
"severity" : "error",
"human" : "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",
"expression" : "contained.all(('#'+id in %resource.descendants().reference) or descendants().where(reference = '#').exists())",
"xpath" : "not(exists(for $contained in f:contained return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::reference[@value='#'])]))",
"source" : "DomainResource"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "Entity. Role, or Act"
},
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "w5",
"map" : "infrastructure.exchange"
}
]
},
{
"id" : "Endpoint.id",
"path" : "Endpoint.id",
"short" : "Logical id of this artifact",
"definition" : "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comment" : "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" : 0,
"max" : "1",
"base" : {
"path" : "Resource.id",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "id"
}
],
"isSummary" : true
},
{
"id" : "Endpoint.meta",
"path" : "Endpoint.meta",
"short" : "Metadata about the resource",
"definition" : "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.meta",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "Meta"
}
],
"isSummary" : true
},
{
"id" : "Endpoint.implicitRules",
"path" : "Endpoint.implicitRules",
"short" : "A set of rules under which this content was created",
"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.",
"comment" : "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" : 0,
"max" : "1",
"base" : {
"path" : "Resource.implicitRules",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "uri"
}
],
"isModifier" : true,
"isSummary" : true
},
{
"id" : "Endpoint.language",
"path" : "Endpoint.language",
"short" : "Language of the resource content",
"definition" : "The base language in which the resource is written.",
"comment" : "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" : 0,
"max" : "0",
"base" : {
"path" : "Resource.language",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"binding" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueReference" : {
"reference" : "http://hl7.org/fhir/ValueSet/all-languages"
}
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Language"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}
],
"strength" : "extensible",
"description" : "A human language.",
"valueSetReference" : {
"reference" : "http://hl7.org/fhir/ValueSet/languages"
}
}
},
{
"id" : "Endpoint.text",
"path" : "Endpoint.text",
"short" : "Text summary of the resource, for human interpretation",
"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.",
"comment" : "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" : [
"narrative",
"html",
"xhtml",
"display"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "DomainResource.text",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "Narrative"
}
],
"condition" : [
"dom-1"
],
"mapping" : [
{
"identity" : "rim",
"map" : "Act.text?"
}
]
},
{
"id" : "Endpoint.contained",
"path" : "Endpoint.contained",
"short" : "Contained, inline Resources",
"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.",
"comment" : "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" : [
"inline resources",
"anonymous resources",
"contained resources"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.contained",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Resource"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "N/A"
}
]
},
{
"id" : "Endpoint.extension",
"path" : "Endpoint.extension",
"slicing" : {
"discriminator" : [
{
"type" : "value",
"path" : "url"
}
],
"rules" : "open"
},
"short" : "Extension",
"definition" : "An Extension",
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.extension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension"
}
]
},
{
"id" : "Endpoint.extension:usecase",
"path" : "Endpoint.extension",
"sliceName" : "useCase",
"short" : "Extension",
"definition" : "An Extension",
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.extension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension",
"profile" : "http://hl7.org/fhir/ig/vhdir/StructureDefinition/endpoint-useCase"
}
]
},
{
"id" : "Endpoint.extension:rank",
"path" : "Endpoint.extension",
"sliceName" : "rank",
"short" : "Extension",
"definition" : "Order established by a Role, Organization... for Endpoints capable of transferring the same content",
"min" : 0,
"max" : "1",
"base" : {
"path" : "DomainResource.extension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension",
"profile" : "http://hl7.org/fhir/ig/vhdir/StructureDefinition/endpoint-rank"
}
]
},
{
"id" : "Endpoint.extension:digitalcertificate",
"path" : "Endpoint.extension",
"sliceName" : "digitalCertificate",
"short" : "Extension",
"definition" : "An Extension",
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.extension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension",
"profile" : "http://hl7.org/fhir/ig/vhdir/StructureDefinition/digitalCertificate"
}
]
},
{
"id" : "Endpoint.modifierExtension",
"path" : "Endpoint.modifierExtension",
"short" : "Extensions that cannot be ignored",
"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.",
"comment" : "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" : [
"extensions",
"user content"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension"
}
],
"isModifier" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "N/A"
}
]
},
{
"id" : "Endpoint.identifier",
"path" : "Endpoint.identifier",
"short" : "Identifies this endpoint across multiple systems",
"definition" : "Identifier for the organization that is used to identify the endpoint across multiple disparate systems.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Endpoint.identifier",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Identifier"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "w5",
"map" : "FiveWs.identifier"
},
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "w5",
"map" : "id"
}
]
},
{
"id" : "Endpoint.identifier.id",
"path" : "Endpoint.identifier.id",
"representation" : [
"xmlAttr"
],
"short" : "xml:id (or equivalent in JSON)",
"definition" : "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "Endpoint.identifier.extension",
"path" : "Endpoint.identifier.extension",
"slicing" : {
"discriminator" : [
{
"type" : "value",
"path" : "url"
}
],
"description" : "Extensions are always sliced by (at least) url",
"rules" : "open"
},
"short" : "Extension",
"definition" : "An Extension",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension"
}
]
},
{
"id" : "Endpoint.identifier.extension:status",
"path" : "Endpoint.identifier.extension",
"sliceName" : "status",
"short" : "Extension",
"definition" : "An Extension",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension",
"profile" : "http://hl7.org/fhir/ig/vhdir/StructureDefinition/identifier-status"
}
]
},
{
"id" : "Endpoint.identifier.extension:status.id",
"path" : "Endpoint.identifier.extension.id",
"representation" : [
"xmlAttr"
],
"short" : "xml:id (or equivalent in JSON)",
"definition" : "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "Endpoint.identifier.extension:status.extension",
"path" : "Endpoint.identifier.extension.extension",
"slicing" : {
"discriminator" : [
{
"type" : "value",
"path" : "url"
}
],
"description" : "Extensions are always sliced by (at least) url",
"rules" : "open"
},
"short" : "Additional Content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. 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" : "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" : [
"extensions",
"user content"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "Endpoint.identifier.extension:status.url",
"path" : "Endpoint.identifier.extension.url",
"representation" : [
"xmlAttr"
],
"short" : "identifies the meaning of the extension",
"definition" : "Source of the definition for the extension code - a logical name or a URL.",
"comment" : "The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Extension.url",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "uri"
}
],
"fixedUri" : "http://hl7.org/fhir/ig/vhdir/StructureDefinition/identifier-status",
"mapping" : [
{
"identity" : "rim",
"map" : "N/A"
}
]
},
{
"id" : "Endpoint.identifier.extension:status.valueCode:valuecode",
"path" : "Endpoint.identifier.extension.valueCode",
"sliceName" : "valueCode",
"label" : "status",
"short" : "Status",
"definition" : "Describes the status of an identifier",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Extension.value[x]",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "N/A"
}
]
},
{
"id" : "Endpoint.identifier.use",
"path" : "Endpoint.identifier.use",
"short" : "usual | official | temp | secondary | old (If known)",
"definition" : "The purpose of this identifier.",
"comment" : "This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.",
"requirements" : "Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Identifier.use",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"isModifier" : true,
"isSummary" : true,
"binding" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "IdentifierUse"
}
],
"strength" : "required",
"description" : "Identifies the purpose for this identifier, if known .",
"valueSetReference" : {
"reference" : "http://hl7.org/fhir/ValueSet/identifier-use"
}
},
"mapping" : [
{
"identity" : "v2",
"map" : "N/A"
},
{
"identity" : "rim",
"map" : "Role.code or implied by context"
}
]
},
{
"id" : "Endpoint.identifier.type",
"path" : "Endpoint.identifier.type",
"short" : "Description of identifier",
"definition" : "A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.",
"comment" : "This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage.
Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.",
"requirements" : "Allows users to make use of identifiers when the identifier system is not known.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Identifier.type",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "CodeableConcept"
}
],
"isSummary" : true,
"binding" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "IdentifierType"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}
],
"strength" : "extensible",
"description" : "A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.",
"valueSetReference" : {
"reference" : "http://hl7.org/fhir/ValueSet/identifier-type"
}
},
"mapping" : [
{
"identity" : "v2",
"map" : "CX.5"
},
{
"identity" : "rim",
"map" : "Role.code or implied by context"
}
]
},
{
"id" : "Endpoint.identifier.system",
"path" : "Endpoint.identifier.system",
"short" : "The namespace for the identifier value",
"definition" : "Establishes the namespace for the value - that is, a URL that describes a set values that are unique.",
"requirements" : "There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Identifier.system",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "uri"
}
],
"example" : [
{
"label" : "General",
"valueUri" : "http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "v2",
"map" : "CX.4 / EI-2-4"
},
{
"identity" : "rim",
"map" : "II.root or Role.id.root"
},
{
"identity" : "servd",
"map" : "./IdentifierType"
}
]
},
{
"id" : "Endpoint.identifier.value",
"path" : "Endpoint.identifier.value",
"short" : "The value that is unique",
"definition" : "The portion of the identifier typically relevant to the user and which is unique within the context of the system.",
"comment" : "If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the [Rendered Value extension](extension-rendered-value.html).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Identifier.value",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"example" : [
{
"label" : "General",
"valueString" : "123456"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "v2",
"map" : "CX.1 / EI.1"
},
{
"identity" : "rim",
"map" : "II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)"
},
{
"identity" : "servd",
"map" : "./Value"
}
]
},
{
"id" : "Endpoint.identifier.period",
"path" : "Endpoint.identifier.period",
"short" : "Time period when id is/was valid for use",
"definition" : "Time period during which identifier is/was valid for use.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Identifier.period",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "Period"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "v2",
"map" : "CX.7 + CX.8"
},
{
"identity" : "rim",
"map" : "Role.effectiveTime or implied by context"
},
{
"identity" : "servd",
"map" : "./StartDate and ./EndDate"
}
]
},
{
"id" : "Endpoint.identifier.assigner",
"path" : "Endpoint.identifier.assigner",
"short" : "Organization that issued id (may be just text)",
"definition" : "Organization that issued/manages the identifier.",
"comment" : "The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Identifier.assigner",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "Reference",
"targetProfile" : "http://hl7.org/fhir/StructureDefinition/Organization"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "v2",
"map" : "CX.4 / (CX.4,CX.9,CX.10)"
},
{
"identity" : "rim",
"map" : "II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper"
},
{
"identity" : "servd",
"map" : "./IdentifierIssuingAuthority"
}
]
},
{
"id" : "Endpoint.status",
"path" : "Endpoint.status",
"short" : "active | suspended | error | off | entered-in-error | test",
"definition" : "active | suspended | error | off | test.",
"comment" : "This element is labeled as a modifier because the status contains codes that mark the endpoint as not currently valid.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Endpoint.status",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"isModifier" : true,
"isSummary" : true,
"binding" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "EndpointStatus"
}
],
"strength" : "required",
"description" : "The status of the endpoint",
"valueSetReference" : {
"reference" : "http://hl7.org/fhir/ValueSet/endpoint-status"
}
},
"mapping" : [
{
"identity" : "w5",
"map" : "FiveWs.status"
},
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "w5",
"map" : "status"
}
]
},
{
"id" : "Endpoint.connectionType",
"path" : "Endpoint.connectionType",
"short" : "Protocol/Profile/Standard to be used with this endpoint connection",
"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).",
"comment" : "For additional connectivity details for the protocol, extensions will be used at this point, as in the XDS example.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Endpoint.connectionType",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "Coding"
}
],
"isSummary" : true,
"binding" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "endpoint-contype"
}
],
"strength" : "extensible",
"valueSetReference" : {
"reference" : "http://hl7.org/fhir/ValueSet/endpoint-connection-type"
}
},
"mapping" : [
{
"identity" : "w5",
"map" : "FiveWs.class"
},
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "w5",
"map" : "class"
}
]
},
{
"id" : "Endpoint.name",
"path" : "Endpoint.name",
"short" : "A name that this endpoint can be identified by",
"definition" : "A friendly name that this endpoint can be referred to with.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Endpoint.name",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "w5",
"map" : "FiveWs.what[x]"
},
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "w5",
"map" : "what"
}
]
},
{
"id" : "Endpoint.managingOrganization",
"path" : "Endpoint.managingOrganization",
"short" : "Organization that manages this endpoint (might not be the organization that exposes the endpoint)",
"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).",
"comment" : "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" : 1,
"max" : "1",
"base" : {
"path" : "Endpoint.managingOrganization",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "Reference",
"targetProfile" : "http://hl7.org/fhir/StructureDefinition/Organization"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "Endpoint.contact",
"path" : "Endpoint.contact",
"short" : "Contact details for source (e.g. troubleshooting)",
"definition" : "Contact details for a human to contact about the subscription. The primary use of this for system administrator troubleshooting.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Endpoint.contact",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "ContactPoint"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "Endpoint.contact.id",
"path" : "Endpoint.contact.id",
"representation" : [
"xmlAttr"
],
"short" : "xml:id (or equivalent in JSON)",
"definition" : "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "Endpoint.contact.extension",
"path" : "Endpoint.contact.extension",
"slicing" : {
"discriminator" : [
{
"type" : "value",
"path" : "url"
}
],
"description" : "Extensions are always sliced by (at least) url",
"rules" : "open"
},
"short" : "Extension",
"definition" : "An Extension",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension"
}
]
},
{
"id" : "Endpoint.contact.extension:availabletime",
"path" : "Endpoint.contact.extension",
"sliceName" : "availableTime",
"short" : "Extension",
"definition" : "An Extension",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension",
"profile" : "http://hl7.org/fhir/ig/vhdir/StructureDefinition/contactPoint-availableTime"
}
]
},
{
"id" : "Endpoint.contact.extension:availabletime.id",
"path" : "Endpoint.contact.extension.id",
"representation" : [
"xmlAttr"
],
"short" : "xml:id (or equivalent in JSON)",
"definition" : "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "Endpoint.contact.extension:availabletime.extension",
"path" : "Endpoint.contact.extension.extension",
"slicing" : {
"discriminator" : [
{
"type" : "value",
"path" : "url"
}
],
"description" : "Extensions are always sliced by (at least) url",
"rules" : "open"
},
"short" : "Extension",
"definition" : "An Extension",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension"
}
]
},
{
"id" : "Endpoint.contact.extension:availabletime.extension:daysofweek",
"path" : "Endpoint.contact.extension.extension",
"sliceName" : "daysOfWeek",
"label" : "daysOfWeek",
"short" : "Days of week",
"definition" : "Days of the week - mon|tue|wed|thu|fri|sat|sun",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension"
}
]
},
{
"id" : "Endpoint.contact.extension:availabletime.extension:daysofweek.id",
"path" : "Endpoint.contact.extension.extension.id",
"representation" : [
"xmlAttr"
],
"short" : "xml:id (or equivalent in JSON)",
"definition" : "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "Endpoint.contact.extension:availabletime.extension:daysofweek.extension",
"path" : "Endpoint.contact.extension.extension.extension",
"slicing" : {
"discriminator" : [
{
"type" : "value",
"path" : "url"
}
],
"description" : "Extensions are always sliced by (at least) url",
"rules" : "open"
},
"short" : "Additional Content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. 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" : "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" : [
"extensions",
"user content"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "Endpoint.contact.extension:availabletime.extension:daysofweek.url",
"path" : "Endpoint.contact.extension.extension.url",
"representation" : [
"xmlAttr"
],
"short" : "identifies the meaning of the extension",
"definition" : "Source of the definition for the extension code - a logical name or a URL.",
"comment" : "The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Extension.url",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "uri"
}
],
"fixedUri" : "daysOfWeek",
"mapping" : [
{
"identity" : "rim",
"map" : "N/A"
}
]
},
{
"id" : "Endpoint.contact.extension:availabletime.extension:daysofweek.valueCode:valuecode",
"path" : "Endpoint.contact.extension.extension.valueCode",
"sliceName" : "valueCode",
"label" : "daysOfWeek",
"short" : "Days of week",
"definition" : "Days of the week - mon|tue|wed|thu|fri|sat|sun",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Extension.value[x]",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "N/A"
}
]
},
{
"id" : "Endpoint.contact.extension:availabletime.extension:allday",
"path" : "Endpoint.contact.extension.extension",
"sliceName" : "allDay",
"label" : "allDay",
"short" : "All day",
"definition" : "Always available? e.g. 24 hour service",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension"
}
]
},
{
"id" : "Endpoint.contact.extension:availabletime.extension:allday.id",
"path" : "Endpoint.contact.extension.extension.id",
"representation" : [
"xmlAttr"
],
"short" : "xml:id (or equivalent in JSON)",
"definition" : "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "Endpoint.contact.extension:availabletime.extension:allday.extension",
"path" : "Endpoint.contact.extension.extension.extension",
"slicing" : {
"discriminator" : [
{
"type" : "value",
"path" : "url"
}
],
"description" : "Extensions are always sliced by (at least) url",
"rules" : "open"
},
"short" : "Additional Content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. 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" : "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" : [
"extensions",
"user content"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "Endpoint.contact.extension:availabletime.extension:allday.url",
"path" : "Endpoint.contact.extension.extension.url",
"representation" : [
"xmlAttr"
],
"short" : "identifies the meaning of the extension",
"definition" : "Source of the definition for the extension code - a logical name or a URL.",
"comment" : "The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Extension.url",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "uri"
}
],
"fixedUri" : "allDay",
"mapping" : [
{
"identity" : "rim",
"map" : "N/A"
}
]
},
{
"id" : "Endpoint.contact.extension:availabletime.extension:allday.valueBoolean:valueboolean",
"path" : "Endpoint.contact.extension.extension.valueBoolean",
"sliceName" : "valueBoolean",
"label" : "allDay",
"short" : "All day",
"definition" : "Always available? e.g. 24 hour service",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Extension.value[x]",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "boolean"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "N/A"
}
]
},
{
"id" : "Endpoint.contact.extension:availabletime.extension:availablestarttime",
"path" : "Endpoint.contact.extension.extension",
"sliceName" : "availableStartTime",
"label" : "availableStartTime",
"short" : "Available start time",
"definition" : "Opening time of day (ignored if allDay = true)",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension"
}
]
},
{
"id" : "Endpoint.contact.extension:availabletime.extension:availablestarttime.id",
"path" : "Endpoint.contact.extension.extension.id",
"representation" : [
"xmlAttr"
],
"short" : "xml:id (or equivalent in JSON)",
"definition" : "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "Endpoint.contact.extension:availabletime.extension:availablestarttime.extension",
"path" : "Endpoint.contact.extension.extension.extension",
"slicing" : {
"discriminator" : [
{
"type" : "value",
"path" : "url"
}
],
"description" : "Extensions are always sliced by (at least) url",
"rules" : "open"
},
"short" : "Additional Content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. 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" : "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" : [
"extensions",
"user content"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "Endpoint.contact.extension:availabletime.extension:availablestarttime.url",
"path" : "Endpoint.contact.extension.extension.url",
"representation" : [
"xmlAttr"
],
"short" : "identifies the meaning of the extension",
"definition" : "Source of the definition for the extension code - a logical name or a URL.",
"comment" : "The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Extension.url",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "uri"
}
],
"fixedUri" : "availableStartTime",
"mapping" : [
{
"identity" : "rim",
"map" : "N/A"
}
]
},
{
"id" : "Endpoint.contact.extension:availabletime.extension:availablestarttime.valueTime:valuetime",
"path" : "Endpoint.contact.extension.extension.valueTime",
"sliceName" : "valueTime",
"label" : "availableStartTime",
"short" : "Available start time",
"definition" : "Opening time of day (ignored if allDay = true)",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Extension.value[x]",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "time"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "N/A"
}
]
},
{
"id" : "Endpoint.contact.extension:availabletime.extension:availableendtime",
"path" : "Endpoint.contact.extension.extension",
"sliceName" : "availableEndTime",
"label" : "availableEndTime",
"short" : "Available end time",
"definition" : "Closing time of day (ignored if allDay = true)",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension"
}
]
},
{
"id" : "Endpoint.contact.extension:availabletime.extension:availableendtime.id",
"path" : "Endpoint.contact.extension.extension.id",
"representation" : [
"xmlAttr"
],
"short" : "xml:id (or equivalent in JSON)",
"definition" : "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "Endpoint.contact.extension:availabletime.extension:availableendtime.extension",
"path" : "Endpoint.contact.extension.extension.extension",
"slicing" : {
"discriminator" : [
{
"type" : "value",
"path" : "url"
}
],
"description" : "Extensions are always sliced by (at least) url",
"rules" : "open"
},
"short" : "Additional Content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. 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" : "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" : [
"extensions",
"user content"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "Endpoint.contact.extension:availabletime.extension:availableendtime.url",
"path" : "Endpoint.contact.extension.extension.url",
"representation" : [
"xmlAttr"
],
"short" : "identifies the meaning of the extension",
"definition" : "Source of the definition for the extension code - a logical name or a URL.",
"comment" : "The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Extension.url",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "uri"
}
],
"fixedUri" : "availableEndTime",
"mapping" : [
{
"identity" : "rim",
"map" : "N/A"
}
]
},
{
"id" : "Endpoint.contact.extension:availabletime.extension:availableendtime.valueTime:valuetime",
"path" : "Endpoint.contact.extension.extension.valueTime",
"sliceName" : "valueTime",
"label" : "availableEndTime",
"short" : "Available end time",
"definition" : "Closing time of day (ignored if allDay = true)",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Extension.value[x]",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "time"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "N/A"
}
]
},
{
"id" : "Endpoint.contact.extension:availabletime.url",
"path" : "Endpoint.contact.extension.url",
"representation" : [
"xmlAttr"
],
"short" : "identifies the meaning of the extension",
"definition" : "Source of the definition for the extension code - a logical name or a URL.",
"comment" : "The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Extension.url",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "uri"
}
],
"fixedUri" : "http://hl7.org/fhir/ig/vhdir/StructureDefinition/contactPoint-availableTime",
"mapping" : [
{
"identity" : "rim",
"map" : "N/A"
}
]
},
{
"id" : "Endpoint.contact.extension:availabletime.value[x]",
"path" : "Endpoint.contact.extension.value[x]",
"short" : "Value of extension",
"definition" : "Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).",
"min" : 0,
"max" : "0",
"base" : {
"path" : "Extension.value[x]",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "base64Binary"
},
{
"code" : "boolean"
},
{
"code" : "code"
},
{
"code" : "date"
},
{
"code" : "dateTime"
},
{
"code" : "decimal"
},
{
"code" : "id"
},
{
"code" : "instant"
},
{
"code" : "integer"
},
{
"code" : "markdown"
},
{
"code" : "oid"
},
{
"code" : "positiveInt"
},
{
"code" : "string"
},
{
"code" : "time"
},
{
"code" : "unsignedInt"
},
{
"code" : "uri"
},
{
"code" : "Address"
},
{
"code" : "Age"
},
{
"code" : "Annotation"
},
{
"code" : "Attachment"
},
{
"code" : "CodeableConcept"
},
{
"code" : "Coding"
},
{
"code" : "ContactPoint"
},
{
"code" : "Count"
},
{
"code" : "Distance"
},
{
"code" : "Duration"
},
{
"code" : "HumanName"
},
{
"code" : "Identifier"
},
{
"code" : "Money"
},
{
"code" : "Period"
},
{
"code" : "Quantity"
},
{
"code" : "Range"
},
{
"code" : "Ratio"
},
{
"code" : "Reference"
},
{
"code" : "SampledData"
},
{
"code" : "Signature"
},
{
"code" : "Timing"
},
{
"code" : "Dosage"
},
{
"code" : "ContactDetail"
},
{
"code" : "Contributor"
},
{
"code" : "DataRequirement"
},
{
"code" : "ParameterDefinition"
},
{
"code" : "RelatedArtifact"
},
{
"code" : "TriggerDefinition"
},
{
"code" : "UsageContext"
},
{
"code" : "Meta"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "N/A"
}
]
},
{
"id" : "Endpoint.contact.extension:viaintermediary",
"path" : "Endpoint.contact.extension",
"sliceName" : "viaIntermediary",
"short" : "Extension",
"definition" : "An Extension",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension",
"profile" : "http://hl7.org/fhir/ig/vhdir/StructureDefinition/contactPoint-viaIntermediary"
}
]
},
{
"id" : "Endpoint.contact.extension:viaintermediary.id",
"path" : "Endpoint.contact.extension.id",
"representation" : [
"xmlAttr"
],
"short" : "xml:id (or equivalent in JSON)",
"definition" : "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "Endpoint.contact.extension:viaintermediary.extension",
"path" : "Endpoint.contact.extension.extension",
"slicing" : {
"discriminator" : [
{
"type" : "value",
"path" : "url"
}
],
"description" : "Extensions are always sliced by (at least) url",
"rules" : "open"
},
"short" : "Additional Content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. 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" : "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" : [
"extensions",
"user content"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "Endpoint.contact.extension:viaintermediary.url",
"path" : "Endpoint.contact.extension.url",
"representation" : [
"xmlAttr"
],
"short" : "identifies the meaning of the extension",
"definition" : "Source of the definition for the extension code - a logical name or a URL.",
"comment" : "The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Extension.url",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "uri"
}
],
"fixedUri" : "http://hl7.org/fhir/ig/vhdir/StructureDefinition/contactPoint-viaIntermediary",
"mapping" : [
{
"identity" : "rim",
"map" : "N/A"
}
]
},
{
"id" : "Endpoint.contact.extension:viaintermediary.value[x]:valuereference",
"path" : "Endpoint.contact.extension.value[x]",
"sliceName" : "valueReference",
"label" : "viaIntermediary",
"short" : "Via intermediary",
"definition" : "Represents an external point of contact responsible for handling communications with this entity",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Extension.value[x]",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "Reference",
"targetProfile" : "http://hl7.org/fhir/ig/vhdir/StructureDefinition/vhdir-practitioner"
},
{
"code" : "Reference",
"targetProfile" : "http://hl7.org/fhir/ig/vhdir/StructureDefinition/vhdir-organization"
},
{
"code" : "Reference",
"targetProfile" : "http://hl7.org/fhir/ig/vhdir/StructureDefinition/vhdir-location"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "N/A"
}
]
},
{
"id" : "Endpoint.contact.system",
"path" : "Endpoint.contact.system",
"short" : "phone | fax | email | pager | url | sms | other",
"definition" : "Telecommunications form for contact point - what communications system is required to make use of the contact.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ContactPoint.system",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"condition" : [
"cpt-2"
],
"isSummary" : true,
"binding" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ContactPointSystem"
}
],
"strength" : "required",
"description" : "Telecommunications form for contact point",
"valueSetReference" : {
"reference" : "http://hl7.org/fhir/ValueSet/contact-point-system"
}
},
"mapping" : [
{
"identity" : "v2",
"map" : "XTN.3"
},
{
"identity" : "rim",
"map" : "./scheme"
},
{
"identity" : "servd",
"map" : "./ContactPointType"
}
]
},
{
"id" : "Endpoint.contact.value",
"path" : "Endpoint.contact.value",
"short" : "The actual contact point details",
"definition" : "The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).",
"comment" : "Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.",
"requirements" : "Need to support legacy numbers that are not in a tightly controlled format.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ContactPoint.value",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "v2",
"map" : "XTN.1 (or XTN.12)"
},
{
"identity" : "rim",
"map" : "./url"
},
{
"identity" : "servd",
"map" : "./Value"
}
]
},
{
"id" : "Endpoint.contact.use",
"path" : "Endpoint.contact.use",
"short" : "home | work | temp | old | mobile - purpose of this contact point",
"definition" : "Identifies the purpose for the contact point.",
"comment" : "This is labeled as "Is Modifier" because applications should not mistake a temporary or old contact etc.for a current/permanent one. Applications can assume that a contact is current unless it explicitly says that it is temporary or old.",
"requirements" : "Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ContactPoint.use",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"isModifier" : true,
"isSummary" : true,
"binding" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ContactPointUse"
}
],
"strength" : "required",
"description" : "Use of contact point",
"valueSetReference" : {
"reference" : "http://hl7.org/fhir/ValueSet/contact-point-use"
}
},
"mapping" : [
{
"identity" : "v2",
"map" : "XTN.2 - but often indicated by field"
},
{
"identity" : "rim",
"map" : "unique(./use)"
},
{
"identity" : "servd",
"map" : "./ContactPointPurpose"
}
]
},
{
"id" : "Endpoint.contact.rank",
"path" : "Endpoint.contact.rank",
"short" : "Specify preferred order of use (1 = highest)",
"definition" : "Specifies a preferred order in which to use a set of contacts. Contacts are ranked with lower values coming before higher values.",
"comment" : "Note that rank does not necessarily follow the order in which the contacts are represented in the instance.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ContactPoint.rank",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "positiveInt"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "v2",
"map" : "n/a"
},
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "Endpoint.contact.period",
"path" : "Endpoint.contact.period",
"short" : "Time period when the contact point was/is in use",
"definition" : "Time period when the contact point was/is in use.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ContactPoint.period",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "Period"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "v2",
"map" : "N/A"
},
{
"identity" : "rim",
"map" : "./usablePeriod[type="IVL<TS>"]"
},
{
"identity" : "servd",
"map" : "./StartDate and ./EndDate"
}
]
},
{
"id" : "Endpoint.period",
"path" : "Endpoint.period",
"short" : "Interval the endpoint is expected to be operational",
"definition" : "The interval during which the endpoint is expected to be operational.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Endpoint.period",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "Period"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "w5",
"map" : "FiveWs.done[x]"
},
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "w5",
"map" : "when.done"
}
]
},
{
"id" : "Endpoint.payloadType",
"path" : "Endpoint.payloadType",
"short" : "The type of content that may be used at this endpoint (e.g. XDS Discharge summaries)",
"definition" : "The payload type describes the acceptable content that can be communicated on the endpoint.",
"comment" : "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" : 1,
"max" : "*",
"base" : {
"path" : "Endpoint.payloadType",
"min" : 1,
"max" : "*"
},
"type" : [
{
"code" : "CodeableConcept"
}
],
"isSummary" : true,
"binding" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "PayloadType"
}
],
"strength" : "example",
"valueSetReference" : {
"reference" : "http://hl7.org/fhir/ValueSet/endpoint-payload-type"
}
},
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "Endpoint.payloadMimeType",
"path" : "Endpoint.payloadMimeType",
"short" : "Mimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this)",
"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).",
"comment" : "Sending the payload has obvious security consequences. The server is responsible for ensuring that the content is appropriately secured.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Endpoint.payloadMimeType",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "code"
}
],
"isSummary" : true,
"binding" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "MimeType"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}
],
"strength" : "required",
"description" : "The mime type of an attachment. Any valid mime type is allowed.",
"valueSetUri" : "http://www.rfc-editor.org/bcp/bcp13.txt"
},
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "Endpoint.address",
"path" : "Endpoint.address",
"short" : "The technical base address for connecting to this endpoint",
"definition" : "The uri that describes the actual end-point to connect to.",
"comment" : "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" : 1,
"max" : "1",
"base" : {
"path" : "Endpoint.address",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "uri"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "Endpoint.header",
"path" : "Endpoint.header",
"short" : "Usage depends on the channel type",
"definition" : "Additional headers / information to send as part of the notification.",
"comment" : "Exactly what these mean depend on the channel type. The can convey additional information to the recipient and/or meet security requirements.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Endpoint.header",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "string"
}
],
"isSummary" : false
}
]
},
"differential" : {
"element" : [
{
"id" : "Endpoint",
"path" : "Endpoint"
},
{
"id" : "Endpoint.language",
"path" : "Endpoint.language",
"max" : "0"
},
{
"id" : "Endpoint.extension",
"path" : "Endpoint.extension",
"slicing" : {
"discriminator" : [
{
"type" : "value",
"path" : "url"
}
],
"rules" : "open"
}
},
{
"id" : "Endpoint.extension:usecase",
"path" : "Endpoint.extension",
"sliceName" : "useCase",
"type" : [
{
"code" : "Extension",
"profile" : "http://hl7.org/fhir/ig/vhdir/StructureDefinition/endpoint-useCase"
}
]
},
{
"id" : "Endpoint.extension:rank",
"path" : "Endpoint.extension",
"sliceName" : "rank",
"definition" : "Order established by a Role, Organization... for Endpoints capable of transferring the same content",
"min" : 0,
"max" : "1",
"type" : [
{
"code" : "Extension",
"profile" : "http://hl7.org/fhir/ig/vhdir/StructureDefinition/endpoint-rank"
}
]
},
{
"id" : "Endpoint.extension:digitalcertificate",
"path" : "Endpoint.extension",
"sliceName" : "digitalCertificate",
"type" : [
{
"code" : "Extension",
"profile" : "http://hl7.org/fhir/ig/vhdir/StructureDefinition/digitalCertificate"
}
]
},
{
"id" : "Endpoint.identifier",
"path" : "Endpoint.identifier"
},
{
"id" : "Endpoint.identifier.extension",
"path" : "Endpoint.identifier.extension",
"slicing" : {
"discriminator" : [
{
"type" : "value",
"path" : "url"
}
],
"rules" : "open"
}
},
{
"id" : "Endpoint.identifier.extension:status",
"path" : "Endpoint.identifier.extension",
"sliceName" : "status",
"min" : 0,
"max" : "1",
"type" : [
{
"code" : "Extension",
"profile" : "http://hl7.org/fhir/ig/vhdir/StructureDefinition/identifier-status"
}
]
},
{
"id" : "Endpoint.managingOrganization",
"path" : "Endpoint.managingOrganization",
"min" : 1
},
{
"id" : "Endpoint.contact",
"path" : "Endpoint.contact",
"max" : "1"
},
{
"id" : "Endpoint.contact.extension",
"path" : "Endpoint.contact.extension",
"slicing" : {
"discriminator" : [
{
"type" : "value",
"path" : "url"
}
],
"rules" : "open"
}
},
{
"id" : "Endpoint.contact.extension:availabletime",
"path" : "Endpoint.contact.extension",
"sliceName" : "availableTime",
"type" : [
{
"code" : "Extension",
"profile" : "http://hl7.org/fhir/ig/vhdir/StructureDefinition/contactPoint-availableTime"
}
]
},
{
"id" : "Endpoint.contact.extension:viaintermediary",
"path" : "Endpoint.contact.extension",
"sliceName" : "viaIntermediary",
"min" : 0,
"max" : "1",
"type" : [
{
"code" : "Extension",
"profile" : "http://hl7.org/fhir/ig/vhdir/StructureDefinition/contactPoint-viaIntermediary"
}
]
},
{
"id" : "Endpoint.period",
"path" : "Endpoint.period",
"min" : 1
}
]
}
}
Validated Healthcare Directory Version: 0.1.0 ®© FHIR Version: 3.2.0 (IG Publisher v3.2.0-12882) generated on Wed, Dec 20, 2017 12:44+1100. |
