FHIR CI-Build
FoundationThis is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions
| Modeling and Methodology Work Group | Maturity Level: N/A | Standards Status: Informative |
Raw XML (canonical form + also see XML Format Specification)
StructureDefinition for ContactPoint
<?xml version="1.0" encoding="UTF-8"?> <StructureDefinition xmlns="http://hl7.org/fhir"> <id value="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 class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px"> <a href="https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" title="The logical name of the element">Name</a> </th> <th class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px"> <a href="https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" title="Information about the use of the element">Flags</a> </th> <th class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px"> <a href="https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" title="Minimum and Maximum # of times the element can appear in the instance">Card.</a> </th> <th class="hierarchy" style="width: 100px"> <a href="https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" title="Reference to the type of the element">Type</a> </th> <th class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px"> <a href="https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" title="Additional information about the element">Description & Constraints</a> <span style="float: right"> <a href="https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" title="Legend for this format"> <img alt="doco" src="data:(snipped in html view)" style="background-color: inherit"/> </a> </span> </th> </tr> <tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white"> <td class="hierarchy" 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(data:image/png;bas e64,iVBORw0KGgoAAAANSUhEUgAAAyAAAAACCAYAAACg/LjIAAAAJUlEQVR4Xu3IIQEAAAgDsHd9/w4EQIOamFnaBgAA4M MKAACAKwNp30CqZFfFmwAAAABJRU5ErkJggg==)"> <img alt="." class="hierarchy" src="data:(snipped in html view)" style="background-color: inherit"/> <img alt="." class="hierarchy" src="data:(snipped in html view)" style="background-color: white; background-color: inherit" title="Element"/> <a href="datatypes-definitions.html#ContactPoint" title="ContactPoint : Details for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc.">ContactPoint</a> </td> <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px"> <a href="versions.html#std-process" style="padding-left: 3px; padding-right: 3px; border: 1px grey solid; font-weight: bold; color: black; background-color: #e6ffe6" title="Standards Status = Normative">N</a> </td> <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px"/> <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px"> <a href="types.html#Element">Element</a> </td> <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px">Details of a Technology mediated contact point (phone, fax, email, etc.) <br/> <span style="font-style: italic" title="cpt-2">+ Rule: A system is required if a value is provided.</span> <br/> <br/> Elements defined in Ancestors: <a href="types.html#Element" title="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.">id</a> , <a href="types.html#Element" title="May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.">extension</a> </td> </tr> <tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: #F7F7F7"> <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAyAAAAACCAYAAACg/LjIAAAALUlEQVR4Xu3IoREAIAw EwfT6/ddA0GBAxO3NrLlKUj9263wAAAAvrgEAADClAVWFQIBRHMicAAAAAElFTkSuQmCC)"> <img alt="." class="hierarchy" src="data:(snipped in html view)" style="background-color: inherit"/> <img alt="." class="hierarchy" src="data:(snipped in html view)" style="background-color: inherit"/> <img alt="." class="hierarchy" src="data:(snipped in html view)" style="background-color: #F7F7F7; background-color: inherit" title="Primitive Data Type"/> <a href="datatypes-definitions.html#ContactPoint.system" title="ContactPoint.system : Telecommunications form for contact point - what communications system is required to make use of the contact.">system</a> </td> <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px"> <a href="conformance-rules.html#constraints" style="padding-left: 3px; padding-right: 3px; border: 1px maroon solid; font-weight: bold; color: #301212; background-color: #fdf4f4;" title="This element has or is affected by some invariants">C</a> </td> <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px">0..1</td> <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px"> <a href="datatypes.html#code">code</a> </td> <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px">phone | fax | email | pager | url | sms | other <br/> Binding: <a href="valueset-contact-point-system.html" title="Telecommunications form for contact point.">ContactPointSystem</a> ( <a href="terminologies.html#required" title="To be conformant, the concept in this element SHALL be from the specified value set.">Required</a> ) <br/> </td> </tr> <tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white"> <td class="hierarchy" 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(data:image/png;bas e64,iVBORw0KGgoAAAANSUhEUgAAAyAAAAACCAYAAACg/LjIAAAALUlEQVR4Xu3IoREAIAwEwfT6/ddA0GBAxO3NrLlKUj 9263wAAAAvrgEAADClAVWFQIBRHMicAAAAAElFTkSuQmCC)"> <img alt="." class="hierarchy" src="data:(snipped in html view)" style="background-color: inherit"/> <img alt="." class="hierarchy" src="data:(snipped in html view)" style="background-color: inherit"/> <img alt="." class="hierarchy" src="data:(snipped in html view)" style="background-color: white; background-color: inherit" title="Primitive Data Type"/> <a href="datatypes-definitions.html#ContactPoint.value" title="ContactPoint.value : The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).">value</a> </td> <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px"> <a href="conformance-rules.html#constraints" style="padding-left: 3px; padding-right: 3px; border: 1px maroon solid; font-weight: bold; color: #301212; background-color: #fdf4f4;" title="This element has or is affected by some invariants">C</a> </td> <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px">0..1</td> <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px"> <a href="datatypes.html#string">string</a> </td> <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px">The actual contact point details <br/> </td> </tr> <tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: #F7F7F7"> <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAyAAAAACCAYAAACg/LjIAAAALUlEQVR4Xu3IoREAIAw EwfT6/ddA0GBAxO3NrLlKUj9263wAAAAvrgEAADClAVWFQIBRHMicAAAAAElFTkSuQmCC)"> <img alt="." class="hierarchy" src="data:(snipped in html view)" style="background-color: inherit"/> <img alt="." class="hierarchy" src="data:(snipped in html view)" style="background-color: inherit"/> <img alt="." class="hierarchy" src="data:(snipped in html view)" style="background-color: #F7F7F7; background-color: inherit" title="Primitive Data Type"/> <a href="datatypes-definitions.html#ContactPoint.use" title="ContactPoint.use : Identifies the purpose for the contact point.">use</a> </td> <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px"> <a href="conformance-rules.html#isModifier" style="padding-left: 3px; padding-right: 3px; color: black; null" title="This element is a modifier element">?!</a> </td> <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px">0..1</td> <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px"> <a href="datatypes.html#code">code</a> </td> <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px">home | work | temp | old | mobile - purpose of this contact point <br/> Binding: <a href="valueset-contact-point-use.html" title="Use of contact point.">ContactPointUse</a> ( <a href="terminologies.html#required" title="To be conformant, the concept in this element SHALL be from the specified value set.">Required</a> ) <br/> </td> </tr> <tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white"> <td class="hierarchy" 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(data:image/png;bas e64,iVBORw0KGgoAAAANSUhEUgAAAyAAAAACCAYAAACg/LjIAAAALUlEQVR4Xu3IoREAIAwEwfT6/ddA0GBAxO3NrLlKUj 9263wAAAAvrgEAADClAVWFQIBRHMicAAAAAElFTkSuQmCC)"> <img alt="." class="hierarchy" src="data:(snipped in html view)" style="background-color: inherit"/> <img alt="." class="hierarchy" src="data:(snipped in html view)" style="background-color: inherit"/> <img alt="." class="hierarchy" src="data:(snipped in html view)" style="background-color: white; background-color: inherit" title="Primitive Data Type"/> <a href="datatypes-definitions.html#ContactPoint.rank" title="ContactPoint.rank : Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values.">rank</a> </td> <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px"/> <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px">0..1</td> <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px"> <a href="datatypes.html#positiveInt">positiveInt</a> </td> <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px">Specify preferred order of use (1 = highest) <br/> </td> </tr> <tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: #F7F7F7"> <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAyAAAAACCAYAAACg/LjIAAAAJUlEQVR4Xu3IIQEAAAg DsHd9/w4EQIOamFnaBgAA4MMKAACAKwNp30CqZFfFmwAAAABJRU5ErkJggg==)"> <img alt="." class="hierarchy" src="data:(snipped in html view)" style="background-color: inherit"/> <img alt="." class="hierarchy" src="data:(snipped in html view)" style="background-color: inherit"/> <img alt="." class="hierarchy" src="data:(snipped in html view)" style="background-color: #F7F7F7; background-color: inherit" title="Data Type"/> <a href="datatypes-definitions.html#ContactPoint.period" title="ContactPoint.period : Time period when the contact point was/is in use.">period</a> </td> <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px"/> <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px">0..1</td> <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px"> <a href="datatypes.html#Period">Period</a> </td> <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px">Time period when the contact point was/is in use <br/> </td> </tr> <tr> <td class="hierarchy" colspan="5"> <br/> <a href="https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" title="Legend for this format"> <img alt="doco" src="data:(snipped in html view)" style="background-color: inherit"/> Documentation for this format </a> </td> </tr> </table> </div> </text> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status"> <valueCode value="normative"/> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version"> <valueCode value="4.0.0"/> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg"> <valueCode value="fhir"/> </extension> <url value="http://hl7.org/fhir/StructureDefinition/ContactPoint"/> <version value="6.0.0-ballot2"/> <name value="ContactPoint"/> <status value="active"/> <experimental value="false"/> <date value="2024-12-12T18:56:29+00:00"/> <publisher value="HL7 International / FHIR Infrastructure"/> <contact> <telecom> <system value="url"/> <value value="http://hl7.org/fhir"/> </telecom> </contact> <contact> <telecom> <system value="url"/> <value value="http://www.hl7.org/Special/committees/fiwg"/> </telecom> </contact> <description value="ContactPoint Type: Details for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc."/> <jurisdiction> <coding> <system value="http://unstats.un.org/unsd/methods/m49/m49.htm"/> <code value="001"/> <display value="World"/> </coding> </jurisdiction> <purpose value="Need to track phone, fax, mobile, sms numbers, email addresses, twitter tags, etc."/> <fhirVersion value="6.0.0-ballot2"/> <mapping> <identity value="v2"/> <uri value="http://hl7.org/v2"/> <name value="HL7 V2 Mapping"/> </mapping> <mapping> <identity value="rim"/> <uri value="http://hl7.org/v3"/> <name value="RIM Mapping"/> </mapping> <mapping> <identity value="servd"/> <uri value="http://www.omg.org/spec/ServD/1.0/"/> <name value="ServD"/> </mapping> <kind value="complex-type"/> <abstract value="false"/> <type value="ContactPoint"/> <baseDefinition value="http://hl7.org/fhir/StructureDefinition/DataType"/> <derivation value="specialization"/> <snapshot> <element id="ContactPoint"> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status"> <valueCode value="normative"/> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version"> <valueCode value="4.0.0"/> </extension> <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> <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()"/> <source value="http://hl7.org/fhir/StructureDefinition/ContactPoint"/> </constraint> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="n/a,TEL"/> </mapping> <mapping> <identity value="v2"/> <map value="XTN"/> </mapping> <mapping> <identity value="servd"/> <map value="ContactPoint"/> </mapping> </element> <element id="ContactPoint.id"> <path value="ContactPoint.id"/> <representation value="xmlAttr"/> <short value="Unique id for inter-element referencing"/> <definition value="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces."/> <min value="0"/> <max value="1"/> <base> <path value="Element.id"/> <min value="0"/> <max value="1"/> </base> <!-- Note: special primitive values have a FHIRPath system type. e.g. this is compiler magic (j) --> <type> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type"> <valueUrl value="id"/> </extension> <code value="http://hl7.org/fhirpath/System.String"/> </type> <condition value="ele-1"/> <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> <type value="value"/> <path value="url"/> </discriminator> <description value="Extensions are always sliced by (at least) url"/> <rules value="open"/> </slicing> <short value="Additional content defined by implementations"/> <definition value="May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension."/> <comment value="There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone."/> <alias value="extensions"/> <alias value="user content"/> <min value="0"/> <max value="*"/> <base> <path value="Element.extension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> </type> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element id="ContactPoint.system"> <path value="ContactPoint.system"/> <short value="phone | fax | email | pager | url | sms | other"/> <definition value="Telecommunications form for contact point - what communications system is required to make use of the contact."/> <min value="0"/> <max value="1"/> <base> <path value="ContactPoint.system"/> <min value="0"/> <max value="1"/> </base> <type> <code value="code"/> </type> <condition value="cpt-2"/> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <isModifier value="false"/> <isSummary value="false"/> <binding> <extension url="http://hl7.org/fhir/tools/StructureDefinition/binding-definition"> <valueMarkdown value="Telecommunications form for contact point."/> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="ContactPointSystem"/> </extension> <strength value="required"/> <description value="Telecommunications form for contact point."/> <valueSet value="http://hl7.org/fhir/ValueSet/contact-point-system|6.0.0-ballot2"/> </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)."/> <comment value="Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value."/> <requirements value="Need to support legacy numbers that are not in a tightly controlled format."/> <min value="0"/> <max value="1"/> <base> <path value="ContactPoint.value"/> <min value="0"/> <max value="1"/> </base> <type> <code value="string"/> </type> <condition value="cpt-2"/> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <isModifier value="false"/> <isSummary value="false"/> <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 | work | temp | old | mobile - purpose of this contact point"/> <definition value="Identifies the purpose for the contact point."/> <comment value="Applications can assume that a contact is current unless it explicitly says that it is temporary or old."/> <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="0"/> <max value="1"/> <base> <path value="ContactPoint.use"/> <min value="0"/> <max value="1"/> </base> <type> <code value="code"/> </type> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <isModifier value="true"/> <isModifierReason value="This is labeled as "Is Modifier" because applications should not mistake a temporary or old contact etc.for a current/permanent one"/> <isSummary value="false"/> <binding> <extension url="http://hl7.org/fhir/tools/StructureDefinition/binding-definition"> <valueMarkdown value="Use of contact point."/> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="ContactPointUse"/> </extension> <strength value="required"/> <description value="Use of contact point."/> <valueSet value="http://hl7.org/fhir/ValueSet/contact-point-use|6.0.0-ballot2"/> </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. ContactPoints with lower rank values are more preferred than those with higher rank values."/> <comment value="Note that rank does not necessarily follow the order in which the contacts are represented in the instance. Ranks need not be unique. E.g. it's possible to have multiple contacts with rank=1. If the ranks have different systems or uses, this would be interpreted to mean "X is my most preferred phone number, Y is my most preferred email address" or "X is my preferred home email and Y is my preferred work email". If the system and use for equally-ranked contacts are the same, then the level of preference is equivalent for both repetitions. Ranks need not be sequential and not all repetitions must have a rank. For example, it's possible to have 4 contacts with ranks of 2, 5 and two with no rank specified. That would be interpreted to mean the first is preferred over the second and no preference stated for the remaining contacts."/> <min value="0"/> <max value="1"/> <base> <path value="ContactPoint.rank"/> <min value="0"/> <max value="1"/> </base> <type> <code value="positiveInt"/> </type> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <isModifier value="false"/> <isSummary value="false"/> <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> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="v2"/> <map value="N/A"/> </mapping> <mapping> <identity value="rim"/> <map value="./usablePeriod[type="IVL<TS>"]"/> </mapping> <mapping> <identity value="servd"/> <map value="./StartDate and ./EndDate"/> </mapping> </element> </snapshot> <differential> <element id="ContactPoint"> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status"> <valueCode value="normative"/> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version"> <valueCode value="4.0.0"/> </extension> <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="*"/> <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()"/> <source value="http://hl7.org/fhir/StructureDefinition/ContactPoint"/> </constraint> <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.system"> <path value="ContactPoint.system"/> <short value="phone | fax | email | pager | url | sms | other"/> <definition value="Telecommunications form for contact point - what communications system is required to make use of the contact."/> <min value="0"/> <max value="1"/> <type> <code value="code"/> </type> <condition value="cpt-2"/> <binding> <extension url="http://hl7.org/fhir/tools/StructureDefinition/binding-definition"> <valueMarkdown value="Telecommunications form for contact point."/> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="ContactPointSystem"/> </extension> <strength value="required"/> <description value="Telecommunications form for contact point."/> <valueSet value="http://hl7.org/fhir/ValueSet/contact-point-system|6.0.0-ballot2"/> </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)."/> <comment value="Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value."/> <requirements value="Need to support legacy numbers that are not in a tightly controlled format."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <condition value="cpt-2"/> <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 | work | temp | old | mobile - purpose of this contact point"/> <definition value="Identifies the purpose for the contact point."/> <comment value="Applications can assume that a contact is current unless it explicitly says that it is temporary or old."/> <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="0"/> <max value="1"/> <type> <code value="code"/> </type> <isModifier value="true"/> <isModifierReason value="This is labeled as "Is Modifier" because applications should not mistake a temporary or old contact etc.for a current/permanent one"/> <binding> <extension url="http://hl7.org/fhir/tools/StructureDefinition/binding-definition"> <valueMarkdown value="Use of contact point."/> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="ContactPointUse"/> </extension> <strength value="required"/> <description value="Use of contact point."/> <valueSet value="http://hl7.org/fhir/ValueSet/contact-point-use|6.0.0-ballot2"/> </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. ContactPoints with lower rank values are more preferred than those with higher rank values."/> <comment value="Note that rank does not necessarily follow the order in which the contacts are represented in the instance. Ranks need not be unique. E.g. it's possible to have multiple contacts with rank=1. If the ranks have different systems or uses, this would be interpreted to mean "X is my most preferred phone number, Y is my most preferred email address" or "X is my preferred home email and Y is my preferred work email". If the system and use for equally-ranked contacts are the same, then the level of preference is equivalent for both repetitions. Ranks need not be sequential and not all repetitions must have a rank. For example, it's possible to have 4 contacts with ranks of 2, 5 and two with no rank specified. That would be interpreted to mean the first is preferred over the second and no preference stated for the remaining contacts."/> <min value="0"/> <max value="1"/> <type> <code value="positiveInt"/> </type> <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"/> <type> <code value="Period"/> </type> <mapping> <identity value="v2"/> <map value="N/A"/> </mapping> <mapping> <identity value="rim"/> <map value="./usablePeriod[type="IVL<TS>"]"/> </mapping> <mapping> <identity value="servd"/> <map value="./StartDate and ./EndDate"/> </mapping> </element> </differential> </StructureDefinition>
Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.
FHIR ®© HL7.org 2011+. FHIR R6 hl7.fhir.core#6.0.0-ballot2 generated on Thu, Dec 12, 2024 19:28+0000.
Links: Search |
Version History |
Contents |
Glossary |
QA |
Compare to R5 |
|
Propose a change