CARIN Consumer Directed Payer Data Exchange (CARIN IG for Blue Button®)
2.1.0-snapshot1 - STU 2.1 prepublication draft
CARIN Consumer Directed Payer Data Exchange (CARIN IG for Blue Button®)
2.1.0-snapshot1 - STU 2.1 prepublication draft
CARIN Consumer Directed Payer Data Exchange (CARIN IG for Blue Button®), published by HL7 International / Financial Management. This guide is not an authorized publication; it is the continuous build for version 2.1.0-snapshot1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/carin-bb/ and changes regularly. See the Directory of published versions
| Page standards status: Trial-use |
XML representation of the C4BB-RelatedPerson resource profile.
<StructureDefinition xmlns="http://hl7.org/fhir">
<id value="C4BB-RelatedPerson"/>
<text>
<status value="extensions"/>
<div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: StructureDefinition C4BB-RelatedPerson</b></p><a name="C4BB-RelatedPerson"> </a><a name="hcC4BB-RelatedPerson"> </a><a name="C4BB-RelatedPerson-en-US"> </a><table border="0" cellpadding="0" cellspacing="0" style="border: 0px #F0F0F0 solid; font-size: 11px; font-family: verdana; vertical-align: top;"><tr style="border: 1px #F0F0F0 solid; font-size: 11px; font-family: verdana; vertical-align: top"><th style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" title="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="https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" 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="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 style="width: 100px" class="hierarchy"><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 style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" title="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 src="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAABmJLR0QA/wD/AP+gvaeTAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB3RJTUUH3goXBCwdPqAP0wAAAldJREFUOMuNk0tIlFEYhp9z/vE2jHkhxXA0zJCMitrUQlq4lnSltEqCFhFG2MJFhIvIFpkEWaTQqjaWZRkp0g26URZkTpbaaOJkDqk10szoODP//7XIMUe0elcfnPd9zsfLOYplGrpRwZaqTtw3K7PtGem7Q6FoidbGgqHVy/HRb669R+56zx7eRV1L31JGxYbBtjKK93cxeqfyQHbehkZbUkK20goELEuIzEd+dHS+qz/Y8PTSif0FnGkbiwcAjHaU1+QWOptFiyCLp/LnKptpqIuXHx6rbR26kJcBX3yLgBfnd7CxwJmflpP2wUg0HIAoUUpZBmKzELGWcN8nAr6Gpu7tLU/CkwAaoKTWRSQyt89Q8w6J+oVQkKnBoblH7V0PPvUOvDYXfopE/SJmALsxnVm6LbkotrUtNowMeIrVrBcBpaMmdS0j9df7abpSuy7HWehwJdt1lhVwi/J58U5beXGAF6c3UXLycw1wdFklArBn87xdh0ZsZtArghBdAA3+OEDVubG4UEzP6x1FOWneHh2VDAHBAt80IbdXDcesNoCvs3E5AFyNSU5nbrDPZpcUEQQTFZiEVx+51fxMhhyJEAgvlriadIJZZksRuwBYMOPBbO3hePVVqgEJhFeUuFLhIPkRP6BQLIBrmMenujm/3g4zc398awIe90Zb5A1vREALqneMcYgP/xVQWlG+Ncu5vgwwlaUNx+3799rfe96u9K0JSDXcOzOTJg4B6IgmXfsygc7/Bvg9g9E58/cDVmGIBOP/zT8Bz1zqWqpbXIsd0O9hajXfL6u4BaOS6SeWAAAAAElFTkSuQmCC" alt="doco" style="background-color: inherit"/></a></span></th></tr><tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white"><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck1.png)" class="hierarchy"><img src="tbl_spacer.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="icon_resource.png" alt="." style="background-color: white; background-color: inherit" title="Resource" class="hierarchy"/> <a href="StructureDefinition-C4BB-RelatedPerson-definitions.html#RelatedPerson">RelatedPerson</a><a name="RelatedPerson"> </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"/><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/us/core/STU6.1/StructureDefinition-us-core-relatedperson.html">USCoreRelatedPersonProfile</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: #F7F7F7"><td style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_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: #F7F7F7; background-color: inherit" title="Element" class="hierarchy"/> <a href="StructureDefinition-C4BB-RelatedPerson-definitions.html#RelatedPerson.meta">meta</a><a name="RelatedPerson.meta"> </a></td><td style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="padding-left: 3px; padding-right: 3px; color: white; background-color: red" title="This element must be supported">S</span></td><td style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy">1..<span style="opacity: 0.5">1</span></td><td style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a style="opacity: 0.5" href="http://hl7.org/fhir/R4/datatypes.html#Meta">Meta</a></td><td style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="opacity: 0.5">Metadata about the resource</span></td></tr>
<tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white"><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_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_element.gif" alt="." style="background-color: white; background-color: inherit" title="Element" class="hierarchy"/> <a href="StructureDefinition-C4BB-RelatedPerson-definitions.html#RelatedPerson.meta.lastUpdated">lastUpdated</a><a name="RelatedPerson.meta.lastUpdated"> </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..<span style="opacity: 0.5">1</span></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a style="opacity: 0.5" href="http://hl7.org/fhir/R4/datatypes.html#instant">instant</a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="opacity: 0.5">When the resource version last changed</span></td></tr>
<tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: #F7F7F7"><td style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_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_element.gif" alt="." style="background-color: #F7F7F7; background-color: inherit" title="Element" class="hierarchy"/> <a href="StructureDefinition-C4BB-RelatedPerson-definitions.html#RelatedPerson.meta.profile">profile</a><a name="RelatedPerson.meta.profile"> </a></td><td style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"/><td style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy">1..<span style="opacity: 0.5">*</span></td><td style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="http://hl7.org/fhir/R4/references.html">canonical</a>(<a style="opacity: 0.5" href="http://hl7.org/fhir/R4/structuredefinition.html">StructureDefinition</a>)</td><td style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="opacity: 0.5">Profiles this resource claims to conform to</span></td></tr>
<tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white"><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck00.png)" class="hierarchy"><img src="tbl_spacer.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_vjoin_end.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="icon_reference.png" alt="." style="background-color: white; background-color: inherit" title="Reference to another Resource" class="hierarchy"/> <a href="StructureDefinition-C4BB-RelatedPerson-definitions.html#RelatedPerson.patient">patient</a><a name="RelatedPerson.patient"> </a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"/><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="opacity: 0.5">1</span><span style="opacity: 0.5">..</span><span style="opacity: 0.5">1</span></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="http://hl7.org/fhir/R4/references.html">Reference</a>(<a href="StructureDefinition-C4BB-Patient.html">C4BB Patient</a>)</td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="opacity: 0.5">(USCDI) The patient this person is related to</span></td></tr>
<tr><td colspan="5" class="hierarchy"><br/><a href="https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" title="Legend for this format"><img src="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAABmJLR0QA/wD/AP+gvaeTAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB3RJTUUH3goXBCwdPqAP0wAAAldJREFUOMuNk0tIlFEYhp9z/vE2jHkhxXA0zJCMitrUQlq4lnSltEqCFhFG2MJFhIvIFpkEWaTQqjaWZRkp0g26URZkTpbaaOJkDqk10szoODP//7XIMUe0elcfnPd9zsfLOYplGrpRwZaqTtw3K7PtGem7Q6FoidbGgqHVy/HRb669R+56zx7eRV1L31JGxYbBtjKK93cxeqfyQHbehkZbUkK20goELEuIzEd+dHS+qz/Y8PTSif0FnGkbiwcAjHaU1+QWOptFiyCLp/LnKptpqIuXHx6rbR26kJcBX3yLgBfnd7CxwJmflpP2wUg0HIAoUUpZBmKzELGWcN8nAr6Gpu7tLU/CkwAaoKTWRSQyt89Q8w6J+oVQkKnBoblH7V0PPvUOvDYXfopE/SJmALsxnVm6LbkotrUtNowMeIrVrBcBpaMmdS0j9df7abpSuy7HWehwJdt1lhVwi/J58U5beXGAF6c3UXLycw1wdFklArBn87xdh0ZsZtArghBdAA3+OEDVubG4UEzP6x1FOWneHh2VDAHBAt80IbdXDcesNoCvs3E5AFyNSU5nbrDPZpcUEQQTFZiEVx+51fxMhhyJEAgvlriadIJZZksRuwBYMOPBbO3hePVVqgEJhFeUuFLhIPkRP6BQLIBrmMenujm/3g4zc398awIe90Zb5A1vREALqneMcYgP/xVQWlG+Ncu5vgwwlaUNx+3799rfe96u9K0JSDXcOzOTJg4B6IgmXfsygc7/Bvg9g9E58/cDVmGIBOP/zT8Bz1zqWqpbXIsd0O9hajXfL6u4BaOS6SeWAAAAAElFTkSuQmCC" alt="doco" style="background-color: inherit"/> Documentation for this format</a></td></tr></table></div>
</text>
<extension
url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg">
<valueCode value="fm"/>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status">
<valueCode value="trial-use">
<extension
url="http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom">
<valueCanonical
value="http://hl7.org/fhir/us/carin-bb/ImplementationGuide/hl7.fhir.us.carin-bb"/>
</extension>
</valueCode>
</extension>
<url
value="http://hl7.org/fhir/us/carin-bb/StructureDefinition/C4BB-RelatedPerson"/>
<version value="2.1.0-snapshot1"/>
<name value="C4BBRelatedPerson"/>
<title value="C4BB RelatedPerson"/>
<status value="active"/>
<date value="2024-08-09T18:19:59+00:00"/>
<publisher value="HL7 International / Financial Management"/>
<contact>
<name value="HL7 International / Financial Management"/>
<telecom>
<system value="url"/>
<value value="http://www.hl7.org/Special/committees/fm"/>
</telecom>
<telecom>
<system value="email"/>
<value value="fm@lists.HL7.org"/>
</telecom>
</contact>
<description
value="This profile is used to convey basic demographic information about a person related to the claim."/>
<jurisdiction>
<coding>
<system value="urn:iso:std:iso:3166"/>
<code value="US"/>
</coding>
</jurisdiction>
<fhirVersion value="4.0.1"/>
<mapping>
<identity value="rim"/>
<uri value="http://hl7.org/v3"/>
<name value="RIM Mapping"/>
</mapping>
<mapping>
<identity value="w5"/>
<uri value="http://hl7.org/fhir/fivews"/>
<name value="FiveWs Pattern Mapping"/>
</mapping>
<mapping>
<identity value="v2"/>
<uri value="http://hl7.org/v2"/>
<name value="HL7 v2 Mapping"/>
</mapping>
<kind value="resource"/>
<abstract value="false"/>
<type value="RelatedPerson"/>
<baseDefinition
value="http://hl7.org/fhir/us/core/StructureDefinition/us-core-relatedperson"/>
<derivation value="constraint"/>
<snapshot>
<element id="RelatedPerson">
<path value="RelatedPerson"/>
<short
value="A person that is related to a patient, but who is not a direct target of care"/>
<definition value="\-"/>
<comment value="\-"/>
<min value="0"/>
<max value="*"/>
<base>
<path value="RelatedPerson"/>
<min value="0"/>
<max value="*"/>
</base>
<constraint>
<key value="dom-2"/>
<severity value="error"/>
<human
value="If the resource is contained in another resource, it SHALL NOT contain nested Resources"/>
<expression value="contained.contained.empty()"/>
<xpath value="not(parent::f:contained and f:contained)"/>
<source
value="http://hl7.org/fhir/StructureDefinition/DomainResource"/>
</constraint>
<constraint>
<key value="dom-3"/>
<severity value="error"/>
<human
value="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
value="contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()"/>
<xpath
value="not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))"/>
<source
value="http://hl7.org/fhir/StructureDefinition/DomainResource"/>
</constraint>
<constraint>
<key value="dom-4"/>
<severity value="error"/>
<human
value="If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated"/>
<expression
value="contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()"/>
<xpath
value="not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))"/>
<source
value="http://hl7.org/fhir/StructureDefinition/DomainResource"/>
</constraint>
<constraint>
<key value="dom-5"/>
<severity value="error"/>
<human
value="If a resource is contained in another resource, it SHALL NOT have a security label"/>
<expression value="contained.meta.security.empty()"/>
<xpath value="not(exists(f:contained/*/f:meta/f:security))"/>
<source
value="http://hl7.org/fhir/StructureDefinition/DomainResource"/>
</constraint>
<constraint>
<extension
url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice">
<valueBoolean value="true"/>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation">
<valueMarkdown
value="When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."/>
</extension>
<key value="dom-6"/>
<severity value="warning"/>
<human
value="A resource should have narrative for robust management"/>
<expression value="text.`div`.exists()"/>
<xpath value="exists(f:text/h:div)"/>
<source
value="http://hl7.org/fhir/StructureDefinition/DomainResource"/>
</constraint>
<constraint>
<key value="us-core-14"/>
<severity value="error"/>
<human
value="Either a name or a relationship SHALL be provided (or both)"/>
<expression value="name.exists() or relationship.exists()"/>
<source
value="http://hl7.org/fhir/us/core/StructureDefinition/us-core-relatedperson"/>
</constraint>
<isModifier value="false"/>
<isSummary value="false"/>
<mapping>
<identity value="rim"/>
<map value="Entity. Role, or Act"/>
</mapping>
<mapping>
<identity value="rim"/>
<map value="role"/>
</mapping>
</element>
<element id="RelatedPerson.id">
<path value="RelatedPerson.id"/>
<short value="Logical id of this artifact"/>
<definition
value="The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes."/>
<comment
value="The only time that a resource does not have an id is when it is being submitted to the server using a create operation."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="Resource.id"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<extension
url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type">
<valueUrl value="id"/>
</extension>
<code value="http://hl7.org/fhirpath/System.String"/>
</type>
<isModifier value="false"/>
<isSummary value="true"/>
</element>
<element id="RelatedPerson.meta">
<path value="RelatedPerson.meta"/>
<short value="Metadata about the resource"/>
<definition
value="The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource."/>
<min value="1"/>
<max value="1"/>
<base>
<path value="Resource.meta"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="Meta"/>
</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())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<mustSupport value="true"/>
<isModifier value="false"/>
<isSummary value="true"/>
</element>
<element id="RelatedPerson.meta.id">
<path value="RelatedPerson.meta.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>
<type>
<extension
url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type">
<valueUrl value="string"/>
</extension>
<code value="http://hl7.org/fhirpath/System.String"/>
</type>
<isModifier value="false"/>
<isSummary value="false"/>
<mapping>
<identity value="rim"/>
<map value="n/a"/>
</mapping>
</element>
<element id="RelatedPerson.meta.extension">
<path value="RelatedPerson.meta.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 manageable, 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())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<constraint>
<key value="ext-1"/>
<severity value="error"/>
<human value="Must have either extensions or value[x], not both"/>
<expression value="extension.exists() != value.exists()"/>
<xpath
value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])"/>
<source value="http://hl7.org/fhir/StructureDefinition/Extension"/>
</constraint>
<isModifier value="false"/>
<isSummary value="false"/>
<mapping>
<identity value="rim"/>
<map value="n/a"/>
</mapping>
</element>
<element id="RelatedPerson.meta.versionId">
<path value="RelatedPerson.meta.versionId"/>
<short value="Version specific identifier"/>
<definition
value="The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted."/>
<comment
value="The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="Meta.versionId"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="id"/>
</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())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<isModifier value="false"/>
<isSummary value="true"/>
</element>
<element id="RelatedPerson.meta.lastUpdated">
<path value="RelatedPerson.meta.lastUpdated"/>
<short value="When the resource version last changed"/>
<definition
value="When the resource last changed - e.g. when the version changed."/>
<comment
value="This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a [read](http://hl7.org/fhir/R4/http.html#read) interaction."/>
<min value="1"/>
<max value="1"/>
<base>
<path value="Meta.lastUpdated"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="instant"/>
</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())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<mustSupport value="true"/>
<isModifier value="false"/>
<isSummary value="true"/>
</element>
<element id="RelatedPerson.meta.source">
<path value="RelatedPerson.meta.source"/>
<short value="Identifies where the resource comes from"/>
<definition
value="A uri that identifies the source system of the resource. This provides a minimal amount of [Provenance](provenance.html#) information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc."/>
<comment
value="In the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used.
This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="Meta.source"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="uri"/>
</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())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<isModifier value="false"/>
<isSummary value="true"/>
</element>
<element id="RelatedPerson.meta.profile">
<path value="RelatedPerson.meta.profile"/>
<short value="Profiles this resource claims to conform to"/>
<definition
value="A list of profiles (references to [StructureDefinition](structuredefinition.html#) resources) that this resource claims to conform to. The URL is a reference to [StructureDefinition.url](structuredefinition-definitions.html#StructureDefinition.url)."/>
<comment
value="It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set."/>
<min value="1"/>
<max value="*"/>
<base>
<path value="Meta.profile"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code value="canonical"/>
<targetProfile
value="http://hl7.org/fhir/StructureDefinition/StructureDefinition"/>
</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())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<isModifier value="false"/>
<isSummary value="true"/>
</element>
<element id="RelatedPerson.meta.security">
<path value="RelatedPerson.meta.security"/>
<short value="Security Labels applied to this resource"/>
<definition
value="Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure."/>
<comment
value="The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored."/>
<min value="0"/>
<max value="*"/>
<base>
<path value="Meta.security"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code value="Coding"/>
</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())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<isModifier value="false"/>
<isSummary value="true"/>
<binding>
<extension
url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
<valueString value="SecurityLabels"/>
</extension>
<strength value="extensible"/>
<description
value="Security Labels from the Healthcare Privacy and Security Classification System."/>
<valueSet value="http://hl7.org/fhir/ValueSet/security-labels"/>
</binding>
</element>
<element id="RelatedPerson.meta.tag">
<path value="RelatedPerson.meta.tag"/>
<short value="Tags applied to this resource"/>
<definition
value="Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource."/>
<comment
value="The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored."/>
<min value="0"/>
<max value="*"/>
<base>
<path value="Meta.tag"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code value="Coding"/>
</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())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<isModifier value="false"/>
<isSummary value="true"/>
<binding>
<extension
url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
<valueString value="Tags"/>
</extension>
<strength value="example"/>
<description
value="Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"."/>
<valueSet value="http://hl7.org/fhir/ValueSet/common-tags"/>
</binding>
</element>
<element id="RelatedPerson.implicitRules">
<path value="RelatedPerson.implicitRules"/>
<short value="A set of rules under which this content was created"/>
<definition
value="A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc."/>
<comment
value="Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="Resource.implicitRules"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="uri"/>
</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())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<isModifier value="true"/>
<isModifierReason
value="This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation"/>
<isSummary value="true"/>
</element>
<element id="RelatedPerson.language">
<path value="RelatedPerson.language"/>
<short value="Language of the resource content"/>
<definition
value="The base language in which the resource is written."/>
<comment
value="Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute)."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="Resource.language"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="code"/>
</type>
<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())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<isModifier value="false"/>
<isSummary value="false"/>
<binding>
<extension
url="http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet">
<valueCanonical value="http://hl7.org/fhir/ValueSet/all-languages"/>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
<valueString value="Language"/>
</extension>
<strength value="preferred"/>
<description value="A human language."/>
<valueSet value="http://hl7.org/fhir/ValueSet/languages"/>
</binding>
</element>
<element id="RelatedPerson.text">
<path value="RelatedPerson.text"/>
<short value="Text summary of the resource, for human interpretation"/>
<definition
value="A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety."/>
<comment
value="Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later."/>
<alias value="narrative"/>
<alias value="html"/>
<alias value="xhtml"/>
<alias value="display"/>
<min value="0"/>
<max value="1"/>
<base>
<path value="DomainResource.text"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="Narrative"/>
</type>
<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())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<isModifier value="false"/>
<isSummary value="false"/>
<mapping>
<identity value="rim"/>
<map value="Act.text?"/>
</mapping>
</element>
<element id="RelatedPerson.contained">
<path value="RelatedPerson.contained"/>
<short value="Contained, inline Resources"/>
<definition
value="These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope."/>
<comment
value="This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels."/>
<alias value="inline resources"/>
<alias value="anonymous resources"/>
<alias value="contained resources"/>
<min value="0"/>
<max value="*"/>
<base>
<path value="DomainResource.contained"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code value="Resource"/>
</type>
<isModifier value="false"/>
<isSummary value="false"/>
<mapping>
<identity value="rim"/>
<map value="N/A"/>
</mapping>
</element>
<element id="RelatedPerson.extension">
<path value="RelatedPerson.extension"/>
<short value="Additional content defined by implementations"/>
<definition
value="May be used to represent additional information that is not part of the basic definition of the resource. 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 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="DomainResource.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())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<constraint>
<key value="ext-1"/>
<severity value="error"/>
<human value="Must have either extensions or value[x], not both"/>
<expression value="extension.exists() != value.exists()"/>
<xpath
value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])"/>
<source value="http://hl7.org/fhir/StructureDefinition/Extension"/>
</constraint>
<isModifier value="false"/>
<isSummary value="false"/>
<mapping>
<identity value="rim"/>
<map value="N/A"/>
</mapping>
</element>
<element id="RelatedPerson.modifierExtension">
<path value="RelatedPerson.modifierExtension"/>
<short value="Extensions that cannot be ignored"/>
<definition
value="May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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.
Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself)."/>
<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."/>
<requirements
value="Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R4/extensibility.html#modifierExtension)."/>
<alias value="extensions"/>
<alias value="user content"/>
<min value="0"/>
<max value="*"/>
<base>
<path value="DomainResource.modifierExtension"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code value="Extension"/>
</type>
<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())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<constraint>
<key value="ext-1"/>
<severity value="error"/>
<human value="Must have either extensions or value[x], not both"/>
<expression value="extension.exists() != value.exists()"/>
<xpath
value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])"/>
<source value="http://hl7.org/fhir/StructureDefinition/Extension"/>
</constraint>
<isModifier value="true"/>
<isModifierReason
value="Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them"/>
<isSummary value="false"/>
<mapping>
<identity value="rim"/>
<map value="N/A"/>
</mapping>
</element>
<element id="RelatedPerson.identifier">
<path value="RelatedPerson.identifier"/>
<short value="A human identifier for this person"/>
<definition value="Identifier for a person within a particular scope."/>
<requirements
value="People are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the patient. Examples are national person identifier and local identifier."/>
<min value="0"/>
<max value="*"/>
<base>
<path value="RelatedPerson.identifier"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code value="Identifier"/>
</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())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<isModifier value="false"/>
<isSummary value="true"/>
<mapping>
<identity value="w5"/>
<map value="FiveWs.identifier"/>
</mapping>
<mapping>
<identity value="v2"/>
<map value="NK1-33"/>
</mapping>
<mapping>
<identity value="rim"/>
<map value=".id"/>
</mapping>
</element>
<element id="RelatedPerson.active">
<extension
url="http://hl7.org/fhir/us/core/StructureDefinition/uscdi-requirement">
<valueBoolean value="true"/>
</extension>
<path value="RelatedPerson.active"/>
<short
value="(USCDI) Whether this related person's record is in active use"/>
<definition
value="Whether this related person record is in active use."/>
<comment
value="This element is labeled as a modifier because it may be used to mark that the resource was created in error."/>
<requirements
value="Need to be able to mark a related person record as not to be used, such as if it was created in error."/>
<min value="1"/>
<max value="1"/>
<base>
<path value="RelatedPerson.active"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="boolean"/>
</type>
<meaningWhenMissing
value="This resource is generally assumed to be active if no value is provided for the active element"/>
<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())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<mustSupport value="true"/>
<isModifier value="true"/>
<isModifierReason
value="This element is labelled as a modifier because it is a status element that can indicate that a record should not be treated as valid"/>
<isSummary value="true"/>
<mapping>
<identity value="w5"/>
<map value="FiveWs.status"/>
</mapping>
<mapping>
<identity value="rim"/>
<map value=".statusCode"/>
</mapping>
</element>
<element id="RelatedPerson.patient">
<extension
url="http://hl7.org/fhir/us/core/StructureDefinition/uscdi-requirement">
<valueBoolean value="true"/>
</extension>
<path value="RelatedPerson.patient"/>
<short value="(USCDI) The patient this person is related to"/>
<definition value="The patient this person is related to."/>
<requirements
value="We need to know which patient this RelatedPerson is related to."/>
<min value="1"/>
<max value="1"/>
<base>
<path value="RelatedPerson.patient"/>
<min value="1"/>
<max value="1"/>
</base>
<type>
<code value="Reference"/>
<targetProfile
value="http://hl7.org/fhir/us/carin-bb/StructureDefinition/C4BB-Patient"/>
</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())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<mustSupport value="true"/>
<isModifier value="false"/>
<isSummary value="true"/>
<mapping>
<identity value="v2"/>
<map value="PID-3"/>
</mapping>
<mapping>
<identity value="rim"/>
<map
value="scoper[classCode=PSN|ANM and determinerCode='INSTANCE']/playedRole[classCode='PAT']/id"/>
</mapping>
</element>
<element id="RelatedPerson.relationship">
<extension
url="http://hl7.org/fhir/us/core/StructureDefinition/uscdi-requirement">
<valueBoolean value="true"/>
</extension>
<path value="RelatedPerson.relationship"/>
<short value="(USCDI) The nature of the relationship"/>
<definition
value="The nature of the relationship between a patient and the related person."/>
<requirements
value="We need to know the relationship with the patient since it influences the interpretation of the information attributed to this person."/>
<min value="0"/>
<max value="*"/>
<base>
<path value="RelatedPerson.relationship"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code value="CodeableConcept"/>
</type>
<condition value="us-core-14"/>
<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())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<mustSupport value="true"/>
<isModifier value="false"/>
<isSummary value="true"/>
<binding>
<extension
url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
<valueString value="PatientRelationshipType"/>
</extension>
<strength value="preferred"/>
<description
value="The nature of the relationship between a patient and the related person."/>
<valueSet
value="http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype"/>
</binding>
<mapping>
<identity value="w5"/>
<map value="FiveWs.class"/>
</mapping>
<mapping>
<identity value="v2"/>
<map value="NK1-3"/>
</mapping>
<mapping>
<identity value="rim"/>
<map value="code"/>
</mapping>
</element>
<element id="RelatedPerson.name">
<extension
url="http://hl7.org/fhir/us/core/StructureDefinition/uscdi-requirement">
<valueBoolean value="true"/>
</extension>
<path value="RelatedPerson.name"/>
<short value="(USCDI) A name associated with the person"/>
<definition value="A name associated with the person."/>
<requirements
value="Related persons need to be identified by name, but it is uncommon to need details about multiple other names for that person."/>
<min value="0"/>
<max value="*"/>
<base>
<path value="RelatedPerson.name"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code value="HumanName"/>
</type>
<condition value="us-core-14"/>
<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())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<mustSupport value="true"/>
<isModifier value="false"/>
<isSummary value="true"/>
<mapping>
<identity value="v2"/>
<map value="NK1-2"/>
</mapping>
<mapping>
<identity value="rim"/>
<map value="name"/>
</mapping>
</element>
<element id="RelatedPerson.telecom">
<extension
url="http://hl7.org/fhir/us/core/StructureDefinition/uscdi-requirement">
<valueBoolean value="true"/>
</extension>
<path value="RelatedPerson.telecom"/>
<short value="(USCDI) A contact detail for the person"/>
<definition
value="A contact detail for the person, e.g. a telephone number or an email address."/>
<comment
value="Person may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently, and also to help with identification."/>
<requirements
value="People have (primary) ways to contact them in some way such as phone, email."/>
<min value="0"/>
<max value="*"/>
<base>
<path value="RelatedPerson.telecom"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code value="ContactPoint"/>
</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())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<mustSupport value="true"/>
<isModifier value="false"/>
<isSummary value="true"/>
<mapping>
<identity value="v2"/>
<map value="NK1-5 / NK1-6 / NK1-40"/>
</mapping>
<mapping>
<identity value="rim"/>
<map value="telecom"/>
</mapping>
</element>
<element id="RelatedPerson.gender">
<path value="RelatedPerson.gender"/>
<short value="male | female | other | unknown"/>
<definition
value="Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes."/>
<requirements
value="Needed for identification of the person, in combination with (at least) name and birth date."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="RelatedPerson.gender"/>
<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())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<isModifier value="false"/>
<isSummary value="true"/>
<binding>
<extension
url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
<valueString value="AdministrativeGender"/>
</extension>
<strength value="required"/>
<description
value="The gender of a person used for administrative purposes."/>
<valueSet
value="http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1"/>
</binding>
<mapping>
<identity value="v2"/>
<map value="NK1-15"/>
</mapping>
<mapping>
<identity value="rim"/>
<map value="administrativeGender"/>
</mapping>
</element>
<element id="RelatedPerson.birthDate">
<path value="RelatedPerson.birthDate"/>
<short value="The date on which the related person was born"/>
<definition value="The date on which the related person was born."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="RelatedPerson.birthDate"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="date"/>
</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())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<isModifier value="false"/>
<isSummary value="true"/>
<mapping>
<identity value="rim"/>
<map value="player.birthTime"/>
</mapping>
</element>
<element id="RelatedPerson.address">
<extension
url="http://hl7.org/fhir/us/core/StructureDefinition/uscdi-requirement">
<valueBoolean value="true"/>
</extension>
<path value="RelatedPerson.address"/>
<short
value="(USCDI) Address where the related person can be contacted or visited"/>
<definition
value="Address where the related person can be contacted or visited."/>
<requirements
value="Need to keep track where the related person can be contacted per postal mail or visited."/>
<min value="0"/>
<max value="*"/>
<base>
<path value="RelatedPerson.address"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code value="Address"/>
</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())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<mustSupport value="true"/>
<isModifier value="false"/>
<isSummary value="true"/>
<mapping>
<identity value="v2"/>
<map value="NK1-4"/>
</mapping>
<mapping>
<identity value="rim"/>
<map value="addr"/>
</mapping>
</element>
<element id="RelatedPerson.photo">
<path value="RelatedPerson.photo"/>
<short value="Image of the person"/>
<definition value="Image of the person."/>
<requirements
value="Many EHR systems have the capability to capture an image of persons. Fits with newer social media usage too."/>
<min value="0"/>
<max value="*"/>
<base>
<path value="RelatedPerson.photo"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code value="Attachment"/>
</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())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<isModifier value="false"/>
<isSummary value="false"/>
<mapping>
<identity value="v2"/>
<map value="OBX-5 - needs a profile"/>
</mapping>
<mapping>
<identity value="rim"/>
<map
value="player[classCode='PSN' and determinerCode='INSTANCE']/desc"/>
</mapping>
</element>
<element id="RelatedPerson.period">
<path value="RelatedPerson.period"/>
<short
value="Period of time that this relationship is considered valid"/>
<definition
value="The period of time during which this relationship is or was active. If there are no dates defined, then the interval is unknown."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="RelatedPerson.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())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<isModifier value="false"/>
<isSummary value="false"/>
<mapping>
<identity value="w5"/>
<map value="FiveWs.done[x]"/>
</mapping>
<mapping>
<identity value="rim"/>
<map value=".effectiveTime"/>
</mapping>
</element>
<element id="RelatedPerson.communication">
<path value="RelatedPerson.communication"/>
<short
value="A language which may be used to communicate with about the patient's health"/>
<definition
value="A language which may be used to communicate with about the patient's health."/>
<comment
value="If no language is specified, this *implies* that the default local language is spoken. If you need to convey proficiency for multiple modes, then you need multiple RelatedPerson.Communication associations. If the RelatedPerson does not speak the default local language, then the Interpreter Required Standard can be used to explicitly declare that an interpreter is required."/>
<requirements
value="If a related person does not speak the local language, interpreters may be required, so languages spoken and proficiency is an important things to keep track of both for patient and other persons of interest."/>
<min value="0"/>
<max value="*"/>
<base>
<path value="RelatedPerson.communication"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code value="BackboneElement"/>
</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())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<isModifier value="false"/>
<isSummary value="false"/>
<mapping>
<identity value="rim"/>
<map value="LanguageCommunication"/>
</mapping>
</element>
<element id="RelatedPerson.communication.id">
<path value="RelatedPerson.communication.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>
<type>
<extension
url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type">
<valueUrl value="string"/>
</extension>
<code value="http://hl7.org/fhirpath/System.String"/>
</type>
<isModifier value="false"/>
<isSummary value="false"/>
<mapping>
<identity value="rim"/>
<map value="n/a"/>
</mapping>
</element>
<element id="RelatedPerson.communication.extension">
<path value="RelatedPerson.communication.extension"/>
<short value="Additional content defined by implementations"/>
<definition
value="May be used to represent additional information that is not part of the basic definition of the element. 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 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())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<constraint>
<key value="ext-1"/>
<severity value="error"/>
<human value="Must have either extensions or value[x], not both"/>
<expression value="extension.exists() != value.exists()"/>
<xpath
value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])"/>
<source value="http://hl7.org/fhir/StructureDefinition/Extension"/>
</constraint>
<isModifier value="false"/>
<isSummary value="false"/>
<mapping>
<identity value="rim"/>
<map value="n/a"/>
</mapping>
</element>
<element id="RelatedPerson.communication.modifierExtension">
<path value="RelatedPerson.communication.modifierExtension"/>
<short value="Extensions that cannot be ignored even if unrecognized"/>
<definition
value="May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 can 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.
Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself)."/>
<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."/>
<requirements
value="Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R4/extensibility.html#modifierExtension)."/>
<alias value="extensions"/>
<alias value="user content"/>
<alias value="modifiers"/>
<min value="0"/>
<max value="*"/>
<base>
<path value="BackboneElement.modifierExtension"/>
<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())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<constraint>
<key value="ext-1"/>
<severity value="error"/>
<human value="Must have either extensions or value[x], not both"/>
<expression value="extension.exists() != value.exists()"/>
<xpath
value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])"/>
<source value="http://hl7.org/fhir/StructureDefinition/Extension"/>
</constraint>
<isModifier value="true"/>
<isModifierReason
value="Modifier extensions are expected to modify the meaning or interpretation of the element that contains them"/>
<isSummary value="true"/>
<mapping>
<identity value="rim"/>
<map value="N/A"/>
</mapping>
</element>
<element id="RelatedPerson.communication.language">
<path value="RelatedPerson.communication.language"/>
<short
value="The language which can be used to communicate with the patient about his or her health"/>
<definition
value="The ISO-639-1 alpha 2 code in lower case for the language, optionally followed by a hyphen and the ISO-3166-1 alpha 2 code for the region in upper case; e.g. "en" for English, or "en-US" for American English versus "en-EN" for England English."/>
<comment
value="The structure aa-BB with this exact casing is one the most widely used notations for locale. However not all systems actually code this but instead have it as free text. Hence CodeableConcept instead of code as the data type."/>
<requirements
value="Most systems in multilingual countries will want to convey language. Not all systems actually need the regional dialect."/>
<min value="1"/>
<max value="1"/>
<base>
<path value="RelatedPerson.communication.language"/>
<min value="1"/>
<max value="1"/>
</base>
<type>
<code value="CodeableConcept"/>
</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())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<isModifier value="false"/>
<isSummary value="false"/>
<binding>
<extension
url="http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet">
<valueCanonical value="http://hl7.org/fhir/ValueSet/all-languages"/>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
<valueString value="Language"/>
</extension>
<strength value="preferred"/>
<description value="A human language."/>
<valueSet value="http://hl7.org/fhir/ValueSet/languages"/>
</binding>
<mapping>
<identity value="rim"/>
<map
value="player[classCode=PSN|ANM and determinerCode=INSTANCE]/languageCommunication/code"/>
</mapping>
</element>
<element id="RelatedPerson.communication.preferred">
<path value="RelatedPerson.communication.preferred"/>
<short value="Language preference indicator"/>
<definition
value="Indicates whether or not the patient prefers this language (over other languages he masters up a certain level)."/>
<comment
value="This language is specifically identified for communicating healthcare information."/>
<requirements
value="People that master multiple languages up to certain level may prefer one or more, i.e. feel more confident in communicating in a particular language making other languages sort of a fall back method."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="RelatedPerson.communication.preferred"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="boolean"/>
</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())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<isModifier value="false"/>
<isSummary value="false"/>
<mapping>
<identity value="rim"/>
<map value="preferenceInd"/>
</mapping>
</element>
</snapshot>
<differential>
<element id="RelatedPerson.meta">
<path value="RelatedPerson.meta"/>
<min value="1"/>
<mustSupport value="true"/>
</element>
<element id="RelatedPerson.meta.lastUpdated">
<path value="RelatedPerson.meta.lastUpdated"/>
<min value="1"/>
<mustSupport value="true"/>
</element>
<element id="RelatedPerson.meta.profile">
<path value="RelatedPerson.meta.profile"/>
<min value="1"/>
</element>
<element id="RelatedPerson.patient">
<path value="RelatedPerson.patient"/>
<type>
<code value="Reference"/>
<targetProfile
value="http://hl7.org/fhir/us/carin-bb/StructureDefinition/C4BB-Patient"/>
</type>
</element>
</differential>
</StructureDefinition>
IG © 2024+ HL7 International / Financial Management. Package hl7.fhir.us.carin-bb#2.1.0-snapshot1 based on FHIR 4.0.1. Generated 2024-08-09
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change