3.31.9 StructureDefinition: Shared Health ContactPoint - XML Profile
XML representation of the dtprofile-contactpoint Profile.
Narrative view of the profile
<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="dtprofile-contactpoint"/> <text> <status value="generated"/> <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/2016may/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/2016may/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/2016may/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/2016may/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/2016may/formats.html#table" title="Additional information about the element">Description & Constraints</a><span style="float: right"><a href="http://hl7.org/fhir/2016may/formats.html#table" title="Legend for this format"><img src="http://hl7.org/fhir/2016may/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="dtprofile-contactpoint-definitions.html#ContactPoint" title="null">ContactPoint</a><a name="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"><span style="padding-left: 3px; padding-right: 3px; color: white; background-color: red" title="This element must be supported">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.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_bck12.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="dtprofile-contactpoint-definitions.html#ContactPoint.extension" title="null">extension</a><a name="ContactPoint.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"><span style="padding-left: 3px; padding-right: 3px; color: white; background-color: red" title="This element must be supported">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.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/2016may/extensibility.html">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"><span style="font-weight:bold">Slice: </span>Unordered, Open by value:url</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_bck14.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="dtprofile-contactpoint-definitions.html#ContactPoint.extension:confidential" title="Extension URL = http://sharedhealth.exchange/fhir/StructureDefinition/ext-contactpoint-confidential">ext-contactpoint-confidential</a><a name="ContactPoint.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"><span style="padding-left: 3px; padding-right: 3px; color: white; background-color: red" title="This element must be supported">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.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/2016may/datatypes.html#boolean">boolean</a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy">Contact Point is Confidential<br/><span style="font-weight:bold">URL: </span><a href="http://hl7.org/fhir/2016may/extension-ext-contactpoint-confidential.html">http://sharedhealth.exchange/fhir/StructureDefinition/ext-contactpoint-confidential</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="dtprofile-contactpoint-definitions.html#ContactPoint.system" title="null">system</a><a name="ContactPoint.system"> </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="This element must be supported">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">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/2016may/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">phone | fax | email<br/><span style="font-weight:bold">Binding: </span><a href="https://tgateway.infoway-inforoute.ca/vs/sharedcontactpointsystem">SharedContactPointSystem</a> (<a href="http://hl7.org/fhir/2016may/terminologies.html#required" title="To be conformant, the concept in this element SHALL be from the specified value set.">required</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="dtprofile-contactpoint-definitions.html#ContactPoint.value" title="null">value</a><a name="ContactPoint.value"> </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="This element must be supported">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">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/2016may/datatypes.html#string">string</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_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="dtprofile-contactpoint-definitions.html#ContactPoint.use" title="null">use</a><a name="ContactPoint.use"> </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: black; background-color: white" title="This element is a modifier element">?!</span><span style="padding-left: 3px; padding-right: 3px; color: white; background-color: red" title="This element must be supported">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">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/2016may/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">home | mobile | work<br/><span style="font-weight:bold">Binding: </span><a href="https://tgateway.infoway-inforoute.ca/vs/sharedcontactpointuse">SharedContactPointUse</a> (<a href="http://hl7.org/fhir/2016may/terminologies.html#required" title="To be conformant, the concept in this element SHALL be from the specified value set.">required</a>)</td></tr> <tr><td colspan="5" class="hierarchy"><br/><a href="http://hl7.org/fhir/2016may/formats.html#table" title="Legend for this format"><img src="http://hl7.org/fhir/2016may/help16.png" alt="doco" style="background-color: inherit"/> Documentation for this format</a></td></tr></table></div> </text> <url value="http://sharedhealth.exchange/fhir/StructureDefinition/dtprofile-contactpoint"/> <version value="2.0 Revision F"/> <name value="Shared Health ContactPoint"/> <status value="draft"/> <date value="2015-09-22T06:02:49-04:00"/> <description value="Constraints on the ContactPoint data type"/> <fhirVersion value="1.4.0"/> <mapping> <identity value="v2"/> <uri value="http://hl7.org/v2"/> <name value="HL7 v2"/> </mapping> <mapping> <identity value="rim"/> <uri value="http://hl7.org/v3"/> <name value="RIM"/> </mapping> <mapping> <identity value="servd"/> <uri value="http://www.omg.org/spec/ServD/1.0/"/> <name value="ServD"/> </mapping> <kind value="datatype"/> <abstract value="false"/> <baseType value="ContactPoint"/> <baseDefinition value="http://hl7.org/fhir/StructureDefinition/ContactPoint"/> <derivation value="constraint"/> <snapshot> <element id="ContactPoint"> <path value="ContactPoint"/> <short value="Details of a Technology mediated contact point (phone, fax, email, etc.)"/> <definition value="Details for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc."/> <min value="0"/> <max value="*"/> <base> <path value="ContactPoint"/> <min value="0"/> <max value="*"/> </base> <maxLength value="0"/> <constraint> <key value="cpt-2"/> <severity value="error"/> <human value="A system is required if a value is provided."/> <expression value="value.empty() or system.exists()"/> <xpath value="not(exists(f:value)) or exists(f:system)"/> </constraint> <mustSupport value="true"/> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="v2"/> <map value="XTN"/> </mapping> <mapping> <identity value="rim"/> <map value="TEL"/> </mapping> <mapping> <identity value="servd"/> <map value="ContactPoint"/> </mapping> </element> <element id="ContactPoint.id"> <path value="ContactPoint.id"/> <representation value="xmlAttr"/> <short value="xml:id (or equivalent in JSON)"/> <definition value="unique id for the element within a resource (for internal references)."/> <min value="0"/> <max value="1"/> <base> <path value="Element.id"/> <min value="0"/> <max value="*"/> </base> <type> <code value="id"/> </type> <maxLength value="0"/> <mustSupport value="false"/> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element id="ContactPoint.extension"> <path value="ContactPoint.extension"/> <slicing> <discriminator value="url"/> <rules value="open"/> </slicing> <short value="Extension"/> <definition value="An Extension"/> <min value="0"/> <max value="*"/> <base> <path value="Element.extension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> </type> <maxLength value="0"/> <mustSupport value="true"/> <isModifier value="false"/> <isSummary value="false"/> </element> <element id="ContactPoint.extension:confidential"> <path value="ContactPoint.extension"/> <name value="confidential"/> <short value="Contact Point is Confidential"/> <definition value="If true, indicates that the contact point is considered to be confidential and should be disclosed only in limited circumstances"/> <comments value="Conformance Rule: If the phone number is not to be published, set value to 'true'."/> <min value="0"/> <max value="1"/> <base> <path value="Element.extension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> <profile value="http://sharedhealth.exchange/fhir/StructureDefinition/ext-contactpoint-confidential"/> </type> <maxLength value="0"/> <mustSupport value="true"/> <isModifier value="false"/> <isSummary value="false"/> </element> <element id="ContactPoint.system"> <path value="ContactPoint.system"/> <short value="phone | fax | email"/> <definition value="Telecommunications form for contact point - what communications system is required to make use of the contact."/> <min value="1"/> <max value="1"/> <base> <path value="ContactPoint.system"/> <min value="0"/> <max value="1"/> </base> <type> <code value="code"/> </type> <maxLength value="0"/> <condition value="cpt-2"/> <mustSupport value="true"/> <isModifier value="false"/> <isSummary value="true"/> <binding> <strength value="required"/> <valueSetReference> <reference value="https://fhir.infoway-inforoute.ca/ValueSet/sharedcontactpointsystem|20170626"/> </valueSetReference> </binding> <mapping> <identity value="v2"/> <map value="XTN.3"/> </mapping> <mapping> <identity value="rim"/> <map value="./scheme"/> </mapping> <mapping> <identity value="servd"/> <map value="./ContactPointType"/> </mapping> </element> <element id="ContactPoint.value"> <path value="ContactPoint.value"/> <short value="The actual contact point details"/> <definition value="The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address)."/> <comments value="Conformance Rule: Format as (123) 456-7890."/> <requirements value="Need to support legacy numbers that are not in a tightly controlled format."/> <min value="1"/> <max value="1"/> <base> <path value="ContactPoint.value"/> <min value="0"/> <max value="1"/> </base> <type> <code value="string"/> </type> <maxLength value="0"/> <mustSupport value="true"/> <isModifier value="false"/> <isSummary value="true"/> <mapping> <identity value="v2"/> <map value="XTN.1 (or XTN.12)"/> </mapping> <mapping> <identity value="rim"/> <map value="./url"/> </mapping> <mapping> <identity value="servd"/> <map value="./Value"/> </mapping> </element> <element id="ContactPoint.use"> <path value="ContactPoint.use"/> <short value="home | mobile | work"/> <definition value="Identifies the purpose for the contact point."/> <comments value="Binding value set defined. (home, mobile, work)"/> <requirements value="Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose."/> <min value="1"/> <max value="1"/> <base> <path value="ContactPoint.use"/> <min value="0"/> <max value="1"/> </base> <type> <code value="code"/> </type> <maxLength value="0"/> <mustSupport value="true"/> <isModifier value="true"/> <isSummary value="true"/> <binding> <strength value="required"/> <valueSetReference> <reference value="https://fhir.infoway-inforoute.ca/ValueSet/sharedcontactpointuse|20170626"/> </valueSetReference> </binding> <mapping> <identity value="v2"/> <map value="XTN.2 - but often indicated by field"/> </mapping> <mapping> <identity value="rim"/> <map value="unique(./use)"/> </mapping> <mapping> <identity value="servd"/> <map value="./ContactPointPurpose"/> </mapping> </element> <element id="ContactPoint.rank"> <path value="ContactPoint.rank"/> <short value="Specify preferred order of use (1 = highest)"/> <definition value="Specifies a preferred order in which to use a set of contacts. Contacts are ranked with lower values coming before higher values."/> <comments value="Note that rank does not necessarily follow the order in which the contacts are represented in the instance."/> <min value="0"/> <max value="1"/> <base> <path value="ContactPoint.rank"/> <min value="0"/> <max value="1"/> </base> <type> <code value="positiveInt"/> </type> <maxLength value="0"/> <mustSupport value="false"/> <isModifier value="false"/> <isSummary value="true"/> <mapping> <identity value="v2"/> <map value="n/a"/> </mapping> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element id="ContactPoint.period"> <path value="ContactPoint.period"/> <short value="Time period when the contact point was/is in use"/> <definition value="Time period when the contact point was/is in use."/> <min value="0"/> <max value="1"/> <base> <path value="ContactPoint.period"/> <min value="0"/> <max value="1"/> </base> <type> <code value="Period"/> </type> <maxLength value="0"/> <mustSupport value="false"/> <isModifier value="false"/> <isSummary value="true"/> <mapping> <identity value="v2"/> <map value="N/A"/> </mapping> <mapping> <identity value="rim"/> <map value="./useablePeriod[type="IVL<TS>"]"/> </mapping> <mapping> <identity value="servd"/> <map value="./StartDate and ./EndDate"/> </mapping> </element> </snapshot> <differential> <element id="ContactPoint"> <path value="ContactPoint"/> <mustSupport value="true"/> </element> <element id="ContactPoint.extension"> <path value="ContactPoint.extension"/> <slicing> <discriminator value="url"/> <rules value="open"/> </slicing> <mustSupport value="true"/> </element> <element id="ContactPoint.extension:confidential"> <path value="ContactPoint.extension"/> <name value="confidential"/> <max value="1"/> <type> <code value="Extension"/> <profile value="http://sharedhealth.exchange/fhir/StructureDefinition/ext-contactpoint-confidential"/> </type> <mustSupport value="true"/> </element> <element id="ContactPoint.system"> <path value="ContactPoint.system"/> <short value="phone | fax | email"/> <min value="1"/> <mustSupport value="true"/> <binding> <strength value="required"/> <valueSetReference> <reference value="https://fhir.infoway-inforoute.ca/ValueSet/sharedcontactpointsystem|20170626"/> </valueSetReference> </binding> </element> <element id="ContactPoint.value"> <path value="ContactPoint.value"/> <comments value="Conformance Rule: Format as (123) 456-7890."/> <min value="1"/> <mustSupport value="true"/> </element> <element id="ContactPoint.use"> <path value="ContactPoint.use"/> <short value="home | mobile | work"/> <comments value="Binding value set defined. (home, mobile, work)"/> <min value="1"/> <mustSupport value="true"/> <isModifier value="true"/> <binding> <strength value="required"/> <valueSetReference> <reference value="https://fhir.infoway-inforoute.ca/ValueSet/sharedcontactpointuse|20170626"/> </valueSetReference> </binding> </element> </differential> </StructureDefinition>