Interweave Implementation Guide
0.1.0 - ci-build
Interweave Implementation Guide - Local Development build (v0.1.0). See the Directory of published versions
| Draft as of 2019-03-01 |
XML representation of the CareConnect-RelatedPerson-1 resource profile.
<StructureDefinition xmlns="http://hl7.org/fhir">
<id value="CareConnect-RelatedPerson-1"/>
<text>
<status value="extensions"/>
<div xmlns="http://www.w3.org/1999/xhtml"><table border="0" cellpadding="0" cellspacing="0" style="border: 0px #F0F0F0 solid; font-size: 11px; font-family: verdana; vertical-align: top;"><tr style="border: 1px #F0F0F0 solid; font-size: 11px; font-family: verdana; vertical-align: top"><th style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="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 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-CareConnect-RelatedPerson-1-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"><span style="opacity: 0.5">0</span><span style="opacity: 0.5">..</span><span style="opacity: 0.5">*</span></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="http://hl7.org/fhir/STU3/relatedperson.html">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"><span style="opacity: 0.5">An person that is related to a patient, but who is not a direct target of care</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_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-CareConnect-RelatedPerson-1-definitions.html#RelatedPerson.identifier">identifier</a><a name="RelatedPerson.identifier"> </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"/><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"/></tr>
<tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white"><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck100.png)" class="hierarchy"><img src="tbl_spacer.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_vline.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_vjoin_end.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="icon_reference.png" alt="." style="background-color: white; background-color: inherit" title="Reference to another Resource" class="hierarchy"/> <a href="StructureDefinition-CareConnect-RelatedPerson-1-definitions.html#RelatedPerson.identifier.assigner">assigner</a><a name="RelatedPerson.identifier.assigner"> </a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"/><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="opacity: 0.5">0</span><span style="opacity: 0.5">..</span><span style="opacity: 0.5">1</span></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="http://hl7.org/fhir/STU3/references.html">Reference</a>(<a href="StructureDefinition-CareConnect-Organization-1.html">CareConnect-Organization-1</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">Organization that issued id (may be just text)</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_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: #F7F7F7; background-color: inherit" title="Reference to another Resource" class="hierarchy"/> <a href="StructureDefinition-CareConnect-RelatedPerson-1-definitions.html#RelatedPerson.patient">patient</a><a name="RelatedPerson.patient"> </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"><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: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="http://hl7.org/fhir/STU3/references.html">Reference</a>(<a href="StructureDefinition-CareConnect-Patient-1.html">CareConnectPatient1</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">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>
<url
value="https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-RelatedPerson-1"/>
<version value="0.1.0"/>
<name value="CareConnect-RelatedPerson-1"/>
<status value="draft"/>
<date value="2019-03-01T13:53:50.534+00:00"/>
<publisher value="Interweave Publisher"/>
<contact>
<name value="Interweave Publisher"/>
<telecom>
<system value="url"/>
<value value="https://fhir.yhcr.nhs.uk/yhcr-publisher"/>
</telecom>
</contact>
<description
value="Information about a person that is involved in the care for a patient, but who is not the target of healthcare, nor has a formal responsibility in the care process."/>
<purpose
value="[NOT CURATED BY INTEROPEN see: http://www.interopen.org/careconnect-curation-methodology/] Initial development for the Digital Maternity programme"/>
<copyright
value="Copyright © 2016 HL7 UK Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. HL7® FHIR® standard Copyright © 2011+ HL7 The HL7® FHIR® standard is used under the FHIR license. You may obtain a copy of the FHIR license at https://www.hl7.org/fhir/license.html"/>
<fhirVersion value="3.0.2"/>
<mapping>
<identity value="rim"/>
<uri value="http://hl7.org/v3"/>
<name value="RIM Mapping"/>
</mapping>
<mapping>
<identity value="w5"/>
<uri value="http://hl7.org/fhir/w5"/>
<name value="W5 Mapping"/>
</mapping>
<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/StructureDefinition/RelatedPerson"/>
<derivation value="constraint"/>
<snapshot>
<element id="RelatedPerson">
<path value="RelatedPerson"/>
<short
value="An person that is related to a patient, but who is not a direct target of care"/>
<definition
value="Information about a person that is involved in the care for a patient, but who is not the target of healthcare, nor has a formal responsibility in the care process."/>
<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-1"/>
<severity value="error"/>
<human
value="If the resource is contained in another resource, it SHALL NOT contain any narrative"/>
<expression value="contained.text.empty()"/>
<xpath value="not(parent::f:contained and f:text)"/>
<source
value="http://hl7.org/fhir/StructureDefinition/DomainResource"/>
</constraint>
<constraint>
<key value="dom-4"/>
<severity value="error"/>
<human
value="If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated"/>
<expression
value="contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()"/>
<xpath
value="not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))"/>
<source
value="http://hl7.org/fhir/StructureDefinition/DomainResource"/>
</constraint>
<constraint>
<key value="dom-3"/>
<severity value="error"/>
<human
value="If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource"/>
<expression
value="contained.where(('#'+id in %resource.descendants().reference).not()).empty()"/>
<xpath
value="not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))"/>
<source
value="http://hl7.org/fhir/StructureDefinition/DomainResource"/>
</constraint>
<mapping>
<identity value="rim"/>
<map value="Entity. Role, or Act"/>
</mapping>
<mapping>
<identity value="rim"/>
<map value="role"/>
</mapping>
<mapping>
<identity value="w5"/>
<map value="administrative.individual"/>
</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>
<code value="id"/>
</type>
<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 may not always be associated with version changes to the resource."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="Resource.meta"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="Meta"/>
</type>
<isSummary value="true"/>
</element>
<element id="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."/>
<comment
value="Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element.
This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="Resource.implicitRules"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="uri"/>
</type>
<isModifier value="true"/>
<isSummary value="true"/>
</element>
<element id="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>
<binding>
<extension
url="http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet">
<valueReference>
<reference value="http://hl7.org/fhir/ValueSet/all-languages"/>
</valueReference>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
<valueString value="Language"/>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding">
<valueBoolean value="true"/>
</extension>
<strength value="extensible"/>
<description value="A human language."/>
<valueSetReference>
<reference value="http://hl7.org/fhir/ValueSet/languages"/>
</valueSetReference>
</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 may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety."/>
<comment
value="Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded in formation is added later."/>
<alias value="narrative"/>
<alias value="html"/>
<alias value="xhtml"/>
<alias value="display"/>
<min value="0"/>
<max value="1"/>
<base>
<path value="DomainResource.text"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="Narrative"/>
</type>
<condition value="dom-1"/>
<mapping>
<identity value="rim"/>
<map value="Act.text?"/>
</mapping>
</element>
<element id="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."/>
<alias value="inline resources"/>
<alias value="anonymous resources"/>
<alias value="contained resources"/>
<min value="0"/>
<max value="*"/>
<base>
<path value="DomainResource.contained"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code value="Resource"/>
</type>
<mapping>
<identity value="rim"/>
<map value="N/A"/>
</mapping>
</element>
<element id="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. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension."/>
<comment
value="There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone."/>
<alias value="extensions"/>
<alias value="user content"/>
<min value="0"/>
<max value="*"/>
<base>
<path value="DomainResource.extension"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code value="Extension"/>
</type>
<mapping>
<identity value="rim"/>
<map value="N/A"/>
</mapping>
</element>
<element id="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. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions."/>
<comment
value="There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone."/>
<alias value="extensions"/>
<alias value="user content"/>
<min value="0"/>
<max value="*"/>
<base>
<path value="DomainResource.modifierExtension"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code value="Extension"/>
</type>
<isModifier value="true"/>
<mapping>
<identity value="rim"/>
<map value="N/A"/>
</mapping>
</element>
<element id="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>
<isSummary value="true"/>
<mapping>
<identity value="v2"/>
<map value="NK1-33"/>
</mapping>
<mapping>
<identity value="rim"/>
<map value=".id"/>
</mapping>
<mapping>
<identity value="w5"/>
<map value="id"/>
</mapping>
</element>
<element id="RelatedPerson.identifier.id">
<path value="RelatedPerson.identifier.id"/>
<representation value="xmlAttr"/>
<short value="xml:id (or equivalent in JSON)"/>
<definition
value="unique id for the element within a resource (for internal references). 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>
<code value="string"/>
</type>
<mapping>
<identity value="rim"/>
<map value="n/a"/>
</mapping>
</element>
<element id="RelatedPerson.identifier.extension">
<path value="RelatedPerson.identifier.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. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension."/>
<comment
value="There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone."/>
<alias value="extensions"/>
<alias value="user content"/>
<min value="0"/>
<max value="*"/>
<base>
<path value="Element.extension"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code value="Extension"/>
</type>
<mapping>
<identity value="rim"/>
<map value="n/a"/>
</mapping>
</element>
<element id="RelatedPerson.identifier.use">
<path value="RelatedPerson.identifier.use"/>
<short value="usual | official | temp | secondary (If known)"/>
<definition value="The purpose of this identifier."/>
<comment
value="This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary."/>
<requirements
value="Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="Identifier.use"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="code"/>
</type>
<isModifier value="true"/>
<isSummary value="true"/>
<binding>
<extension
url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
<valueString value="IdentifierUse"/>
</extension>
<strength value="required"/>
<description
value="Identifies the purpose for this identifier, if known ."/>
<valueSetReference>
<reference value="http://hl7.org/fhir/ValueSet/identifier-use"/>
</valueSetReference>
</binding>
<mapping>
<identity value="v2"/>
<map value="N/A"/>
</mapping>
<mapping>
<identity value="rim"/>
<map value="Role.code or implied by context"/>
</mapping>
</element>
<element id="RelatedPerson.identifier.type">
<path value="RelatedPerson.identifier.type"/>
<short value="Description of identifier"/>
<definition
value="A coded type for the identifier that can be used to determine which identifier to use for a specific purpose."/>
<comment
value="This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage.
Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type."/>
<requirements
value="Allows users to make use of identifiers when the identifier system is not known."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="Identifier.type"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="CodeableConcept"/>
</type>
<isSummary value="true"/>
<binding>
<extension
url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
<valueString value="IdentifierType"/>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding">
<valueBoolean value="true"/>
</extension>
<strength value="extensible"/>
<description
value="A coded type for an identifier that can be used to determine which identifier to use for a specific purpose."/>
<valueSetReference>
<reference value="http://hl7.org/fhir/ValueSet/identifier-type"/>
</valueSetReference>
</binding>
<mapping>
<identity value="v2"/>
<map value="CX.5"/>
</mapping>
<mapping>
<identity value="rim"/>
<map value="Role.code or implied by context"/>
</mapping>
</element>
<element id="RelatedPerson.identifier.system">
<path value="RelatedPerson.identifier.system"/>
<short value="The namespace for the identifier value"/>
<definition
value="Establishes the namespace for the value - that is, a URL that describes a set values that are unique."/>
<requirements
value="There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="Identifier.system"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="uri"/>
</type>
<example>
<label value="General"/>
<valueUri value="http://www.acme.com/identifiers/patient"/>
</example>
<isSummary value="true"/>
<mapping>
<identity value="v2"/>
<map value="CX.4 / EI-2-4"/>
</mapping>
<mapping>
<identity value="rim"/>
<map value="II.root or Role.id.root"/>
</mapping>
<mapping>
<identity value="servd"/>
<map value="./IdentifierType"/>
</mapping>
</element>
<element id="RelatedPerson.identifier.value">
<path value="RelatedPerson.identifier.value"/>
<short value="The value that is unique"/>
<definition
value="The portion of the identifier typically relevant to the user and which is unique within the context of the system."/>
<comment
value="If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the [Rendered Value extension](http://hl7.org/fhir/STU3/extension-rendered-value.html)."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="Identifier.value"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="string"/>
</type>
<example>
<label value="General"/>
<valueString value="123456"/>
</example>
<isSummary value="true"/>
<mapping>
<identity value="v2"/>
<map value="CX.1 / EI.1"/>
</mapping>
<mapping>
<identity value="rim"/>
<map
value="II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)"/>
</mapping>
<mapping>
<identity value="servd"/>
<map value="./Value"/>
</mapping>
</element>
<element id="RelatedPerson.identifier.period">
<path value="RelatedPerson.identifier.period"/>
<short value="Time period when id is/was valid for use"/>
<definition
value="Time period during which identifier is/was valid for use."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="Identifier.period"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="Period"/>
</type>
<isSummary value="true"/>
<mapping>
<identity value="v2"/>
<map value="CX.7 + CX.8"/>
</mapping>
<mapping>
<identity value="rim"/>
<map value="Role.effectiveTime or implied by context"/>
</mapping>
<mapping>
<identity value="servd"/>
<map value="./StartDate and ./EndDate"/>
</mapping>
</element>
<element id="RelatedPerson.identifier.assigner">
<path value="RelatedPerson.identifier.assigner"/>
<short value="Organization that issued id (may be just text)"/>
<definition value="Organization that issued/manages the identifier."/>
<comment
value="The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="Identifier.assigner"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="Reference"/>
<targetProfile
value="https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Organization-1"/>
</type>
<isSummary value="true"/>
<mapping>
<identity value="v2"/>
<map value="CX.4 / (CX.4,CX.9,CX.10)"/>
</mapping>
<mapping>
<identity value="rim"/>
<map
value="II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper"/>
</mapping>
<mapping>
<identity value="servd"/>
<map value="./IdentifierIssuingAuthority"/>
</mapping>
</element>
<element id="RelatedPerson.active">
<path value="RelatedPerson.active"/>
<short value="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="0"/>
<max value="1"/>
<base>
<path value="RelatedPerson.active"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="boolean"/>
</type>
<defaultValueBoolean value="true"/>
<isModifier value="true"/>
<isSummary value="true"/>
<mapping>
<identity value="rim"/>
<map value=".statusCode"/>
</mapping>
<mapping>
<identity value="w5"/>
<map value="status"/>
</mapping>
</element>
<element id="RelatedPerson.patient">
<path value="RelatedPerson.patient"/>
<short value="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="https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Patient-1"/>
</type>
<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">
<path value="RelatedPerson.relationship"/>
<short value="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="1"/>
<base>
<path value="RelatedPerson.relationship"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="CodeableConcept"/>
</type>
<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"/>
<valueSetReference>
<reference
value="http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype"/>
</valueSetReference>
</binding>
<mapping>
<identity value="v2"/>
<map value="NK1-3"/>
</mapping>
<mapping>
<identity value="rim"/>
<map value="code"/>
</mapping>
<mapping>
<identity value="w5"/>
<map value="class"/>
</mapping>
</element>
<element id="RelatedPerson.name">
<path value="RelatedPerson.name"/>
<short value="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>
<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">
<path value="RelatedPerson.telecom"/>
<short value="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>
<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>
<isSummary value="true"/>
<binding>
<extension
url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
<valueString value="AdministrativeGender"/>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding">
<valueBoolean value="true"/>
</extension>
<strength value="required"/>
<description
value="The gender of a person used for administrative purposes."/>
<valueSetReference>
<reference
value="http://hl7.org/fhir/ValueSet/administrative-gender"/>
</valueSetReference>
</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>
<isSummary value="true"/>
<mapping>
<identity value="rim"/>
<map value="player.birthTime"/>
</mapping>
</element>
<element id="RelatedPerson.address">
<path value="RelatedPerson.address"/>
<short
value="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>
<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>
<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 that this relationship is considered to be valid. 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>
<mapping>
<identity value="rim"/>
<map value=".effectiveTime"/>
</mapping>
<mapping>
<identity value="w5"/>
<map value="when.done"/>
</mapping>
</element>
</snapshot>
<differential>
<element id="RelatedPerson">
<path value="RelatedPerson"/>
</element>
<element id="RelatedPerson.identifier.assigner">
<path value="RelatedPerson.identifier.assigner"/>
<type>
<code value="Reference"/>
<targetProfile
value="https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Organization-1"/>
</type>
</element>
<element id="RelatedPerson.patient">
<path value="RelatedPerson.patient"/>
<type>
<code value="Reference"/>
<targetProfile
value="https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Patient-1"/>
</type>
</element>
</differential>
</StructureDefinition>
IG © 2021+ Interweave Publisher. Package fhir.interweave#0.1.0 based on FHIR 3.0.2. Generated 2024-03-08
Links: Table of Contents |
QA Report