Relatedperson.profile.xml

Profile for relatedperson

Raw XML

<Profile xmlns="http://hl7.org/fhir">
  <text>
    <status value="generated"/><div xmlns="http://www.w3.org/1999/xhtml"><pre>
&lt;<a class="dict" href="relatedperson-definitions.html#RelatedPerson" title="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."><b>RelatedPerson</b></a> xmlns=&quot;http://hl7.org/fhir&quot;&gt; <span style="float: right"><a href="formats.html" title="Documentation for this format"><img alt="doco" src="help.png"/></a></span>
 &lt;!-- from <a href="resources.html">Resource</a>: <a href="extensibility.html">extension</a>, <a href="extensibility.html#modifierExtension">modifierExtension</a>, language, <a href="narrative.html#Narrative">text</a>, and <a href="references.html#contained">contained</a> --&gt;
 &lt;<a class="dict" href="relatedperson-definitions.html#RelatedPerson.identifier" title="Identifier for a person within a particular scope."><b>identifier</b></a>&gt;<span style="color: Gray">&lt;!--</span> <span style="color: brown"><b>0..*</b></span> <span style="color: darkgreen"><a href="datatypes.html#Identifier">Identifier</a></span> <span style="color: navy">A Human identifier for this person<span style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --&gt;</span>&lt;/identifier&gt;
 &lt;<a class="dict" href="relatedperson-definitions.html#RelatedPerson.patient" title="The patient this person is related to."><b>patient</b></a>&gt;<span style="color: Gray">&lt;!--</span> <span style="color: brown"><b>1..1</b></span> <span style="color: darkgreen"><a href="references.html#Resource">Resource</a>(<a href="patient.html#Patient">Patient</a>)</span> <span style="color: navy">The patient this person is related to<span style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --&gt;</span>&lt;/patient&gt;
 &lt;<a class="dict" href="relatedperson-definitions.html#RelatedPerson.relationship" title="The nature of the relationship between a patient and the related person."><b>relationship</b></a>&gt;<span style="color: Gray">&lt;!--</span> <span style="color: brown"><b>0..1</b></span> <span style="color: darkgreen"><a href="datatypes.html#CodeableConcept">CodeableConcept</a></span> <span style="color: navy"><a href="valueset-relatedperson-relationshiptype.html" style="color: navy">The nature of the relationship<span style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></a></span><span style="color: Gray"> --&gt;</span>&lt;/relationship&gt;
 &lt;<a class="dict" href="relatedperson-definitions.html#RelatedPerson.name" title="A name associated with the person."><b>name</b></a>&gt;<span style="color: Gray">&lt;!--</span> <span style="color: brown"><b>0..1</b></span> <span style="color: darkgreen"><a href="datatypes.html#HumanName">HumanName</a></span> <span style="color: navy">A name associated with the person<span style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --&gt;</span>&lt;/name&gt;
 &lt;<a class="dict" href="relatedperson-definitions.html#RelatedPerson.telecom" title="A contact detail for the person, e.g. a telephone number or an email address."><b>telecom</b></a>&gt;<span style="color: Gray">&lt;!--</span> <span style="color: brown"><b>0..*</b></span> <span style="color: darkgreen"><a href="datatypes.html#Contact">Contact</a></span> <span style="color: navy">A contact detail for the person<span style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --&gt;</span>&lt;/telecom&gt;
 &lt;<a class="dict" href="relatedperson-definitions.html#RelatedPerson.gender" title="Administrative Gender - the gender that the person is considered to have for administration
         and record keeping purposes."><b>gender</b></a>&gt;<span style="color: Gray">&lt;!--</span> <span style="color: brown"><b>0..1</b></span> <span style="color: darkgreen"><a href="datatypes.html#CodeableConcept">CodeableConcept</a></span> <span style="color: navy"><a href="valueset-administrative-gender.html" style="color: navy">Gender for administrative purposes<span style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></a></span><span style="color: Gray"> --&gt;</span>&lt;/gender&gt;
 &lt;<a class="dict" href="relatedperson-definitions.html#RelatedPerson.address" title="Address where the related person can be contacted or visited."><b>address</b></a>&gt;<span style="color: Gray">&lt;!--</span> <span style="color: brown"><b>0..1</b></span> <span style="color: darkgreen"><a href="datatypes.html#Address">Address</a></span> <span style="color: navy">Address where the related person can be contacted or visited<span style="color: Navy" title="This element is included in a summary view (See Search/Query)"> §</span></span><span style="color: Gray"> --&gt;</span>&lt;/address&gt;
 &lt;<a class="dict" href="relatedperson-definitions.html#RelatedPerson.photo" title="Image of the person."><b>photo</b></a>&gt;<span style="color: Gray">&lt;!--</span> <span style="color: brown"><b>0..*</b></span> <span style="color: darkgreen"><a href="datatypes.html#Attachment">Attachment</a></span> <span style="color: navy">Image of the person</span><span style="color: Gray"> --&gt;</span>&lt;/photo&gt;
&lt;/RelatedPerson&gt;
</pre></div>
  </text>
  <name value="relatedperson"/>
  <publisher value="FHIR Project"/>
  <description value="Basic Profile. 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."/>
  <status value="draft"/>
  <date value="2014-09-30"/>
  <requirements value="Scope and Usage RelatedPersons typically have a personal or non-healthcare-specific professional
   relationship to the patient. A RelatedPerson resource is primarily used for attribution
   of information, since RelatedPersons are often a source of information about the patient.
   For keeping information about persons for contact purposes for a patient, use a Patient's
   Contact element instead.   Example RelatedPersons are:   * A patient's wife or husband
   * A patient's relatives or friends * A neighbor bringing a patient to the hospital * The
   owner or trainer of a horse * A patient's attorney or guardian"/>
  <mapping>
    <identity value="rim"/>
    <uri value="http://hl7.org/v3"/>
    <name value="RIM"/>
  </mapping>
  <mapping>
    <identity value="v2"/>
    <uri value="http://hl7.org/v2"/>
    <name value="HL7 v2"/>
  </mapping>
  <structure>
    <type value="RelatedPerson"/>
    <publish value="true"/>
    <element>
      <path value="RelatedPerson"/>
      <definition>
        <short value="An person that is related to a patient, but who is not a direct target of care"/>
        <formal 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="1"/>
        <max value="1"/>
        <type>
          <code value="Resource"/>
        </type>
        <isModifier value="false"/>
        <mapping>
          <identity value="rim"/>
          <map value="role"/>
        </mapping>
      </definition>
    </element>
    <element>
      <path value="RelatedPerson.extension"/>
      <definition>
        <short value="Additional Content defined by implementations"/>
        <formal 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 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."/>
        <comments 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 simplicity
         for everyone."/>
        <synonym value="extensions"/>
        <synonym value="user content"/>
        <min value="0"/>
        <max value="*"/>
        <type>
          <code value="Extension"/>
        </type>
        <isModifier value="false"/>
      </definition>
    </element>
    <element>
      <path value="RelatedPerson.modifierExtension"/>
      <definition>
        <short value="Extensions that cannot be ignored"/>
        <formal 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 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."/>
        <comments 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 simplicity
         for everyone."/>
        <synonym value="extensions"/>
        <synonym value="user content"/>
        <min value="0"/>
        <max value="*"/>
        <type>
          <code value="Extension"/>
        </type>
        <isModifier value="false"/>
      </definition>
    </element>
    <element>
      <path value="RelatedPerson.text"/>
      <definition>
        <short value="Text summary of the resource, for human interpretation"/>
        <formal 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 &quot;clinically
         safe&quot; for a human to just read the narrative. Resource definitions may define what
         content should be represented in the narrative to ensure clinical safety."/>
        <comments value="Contained resources do not have narrative. Resources that are not contained SHOULD have
         a narrative."/>
        <synonym value="narrative"/>
        <synonym value="html"/>
        <synonym value="xhtml"/>
        <synonym value="display"/>
        <min value="0"/>
        <max value="1"/>
        <type>
          <code value="Narrative"/>
        </type>
        <isModifier value="false"/>
      </definition>
    </element>
    <element>
      <path value="RelatedPerson.contained"/>
      <definition>
        <short value="Contained, inline Resources"/>
        <formal 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."/>
        <comments 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."/>
        <synonym value="inline resources"/>
        <synonym value="anonymous resources"/>
        <synonym value="contained resources"/>
        <min value="0"/>
        <max value="*"/>
        <type>
          <code value="Resource"/>
        </type>
        <isModifier value="false"/>
      </definition>
    </element>
    <element>
      <path value="RelatedPerson.identifier"/>
      <definition>
        <short value="A Human identifier for this person"/>
        <formal value="Identifier for a person within a particular scope."/>
        <min value="0"/>
        <max value="*"/>
        <type>
          <code value="Identifier"/>
        </type>
        <isModifier value="false"/>
        <mapping>
          <identity value="rim"/>
          <map value="id"/>
        </mapping>
        <mapping>
          <identity value="v2"/>
          <map value="NK1-33"/>
        </mapping>
      </definition>
    </element>
    <element>
      <path value="RelatedPerson.patient"/>
      <definition>
        <short value="The patient this person is related to"/>
        <formal value="The patient this person is related to."/>
        <min value="1"/>
        <max value="1"/>
        <type>
          <code value="ResourceReference"/>
          <profile value="http://hl7.org/fhir/profiles/Patient"/>
        </type>
        <isModifier value="false"/>
        <mapping>
          <identity value="rim"/>
          <map value="scoper[classCode=PSN|ANM and determinerCode='INSTANCE']/playedRole[classCode='PAT']/id"/>
        </mapping>
        <mapping>
          <identity value="v2"/>
          <map value="PID-3"/>
        </mapping>
      </definition>
    </element>
    <element>
      <path value="RelatedPerson.relationship"/>
      <definition>
        <short value="The nature of the relationship"/>
        <formal value="The nature of the relationship between a patient and the related person."/>
        <min value="0"/>
        <max value="1"/>
        <type>
          <code value="CodeableConcept"/>
        </type>
        <isModifier value="false"/>
        <binding>
          <name value="PatientRelationshipType"/>
          <isExtensible value="true"/>
          <conformance value="preferred"/>
          <referenceResource>
            <reference value="http://hl7.org/fhir/vs/relatedperson-relationshiptype"/>
          </referenceResource>
        </binding>
        <mapping>
          <identity value="rim"/>
          <map value="code"/>
        </mapping>
        <mapping>
          <identity value="v2"/>
          <map value="NK1-3"/>
        </mapping>
      </definition>
    </element>
    <element>
      <path value="RelatedPerson.name"/>
      <definition>
        <short value="A name associated with the person"/>
        <formal value="A name associated with the person."/>
        <min value="0"/>
        <max value="1"/>
        <type>
          <code value="HumanName"/>
        </type>
        <isModifier value="false"/>
        <mapping>
          <identity value="rim"/>
          <map value="name"/>
        </mapping>
        <mapping>
          <identity value="v2"/>
          <map value="NK1-2"/>
        </mapping>
      </definition>
    </element>
    <element>
      <path value="RelatedPerson.telecom"/>
      <definition>
        <short value="A contact detail for the person"/>
        <formal value="A contact detail for the person, e.g. a telephone number or an email address."/>
        <comments 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."/>
        <min value="0"/>
        <max value="*"/>
        <type>
          <code value="Contact"/>
        </type>
        <isModifier value="false"/>
        <mapping>
          <identity value="rim"/>
          <map value="telecom"/>
        </mapping>
        <mapping>
          <identity value="v2"/>
          <map value="NK1-5 / NK1-6 / NK1-40"/>
        </mapping>
      </definition>
    </element>
    <element>
      <path value="RelatedPerson.gender"/>
      <definition>
        <short value="Gender for administrative purposes"/>
        <formal value="Administrative Gender - the gender that the person is considered to have for administration
         and record keeping purposes."/>
        <min value="0"/>
        <max value="1"/>
        <type>
          <code value="CodeableConcept"/>
        </type>
        <isModifier value="false"/>
        <binding>
          <name value="AdministrativeGender"/>
          <isExtensible value="true"/>
          <conformance value="preferred"/>
          <referenceResource>
            <reference value="http://hl7.org/fhir/vs/administrative-gender"/>
          </referenceResource>
        </binding>
        <mapping>
          <identity value="rim"/>
          <map value="administrativeGender"/>
        </mapping>
        <mapping>
          <identity value="v2"/>
          <map value="NK1-15"/>
        </mapping>
      </definition>
    </element>
    <element>
      <path value="RelatedPerson.address"/>
      <definition>
        <short value="Address where the related person can be contacted or visited"/>
        <formal value="Address where the related person can be contacted or visited."/>
        <min value="0"/>
        <max value="1"/>
        <type>
          <code value="Address"/>
        </type>
        <isModifier value="false"/>
        <mapping>
          <identity value="rim"/>
          <map value="addr"/>
        </mapping>
        <mapping>
          <identity value="v2"/>
          <map value="NK1-4"/>
        </mapping>
      </definition>
    </element>
    <element>
      <path value="RelatedPerson.photo"/>
      <definition>
        <short value="Image of the person"/>
        <formal value="Image of the person."/>
        <min value="0"/>
        <max value="*"/>
        <type>
          <code value="Attachment"/>
        </type>
        <isModifier value="false"/>
        <mapping>
          <identity value="rim"/>
          <map value="player[classCode='PSN' and determinerCode='INSTANCE']/desc"/>
        </mapping>
        <mapping>
          <identity value="v2"/>
          <map value="OBX-5 - needs a profile"/>
        </mapping>
      </definition>
    </element>
    <searchParam>
      <name value="_id"/>
      <type value="token"/>
      <documentation value="The logical resource id associated with the resource (must be supported by all servers)"/>
    </searchParam>
    <searchParam>
      <name value="_language"/>
      <type value="token"/>
      <documentation value="The language of the resource"/>
    </searchParam>
    <searchParam>
      <name value="address"/>
      <type value="string"/>
      <documentation value="An address in any kind of address/part"/>
      <xpath value="f:RelatedPerson/f:address"/>
    </searchParam>
    <searchParam>
      <name value="gender"/>
      <type value="token"/>
      <documentation value="Gender of the person"/>
      <xpath value="f:RelatedPerson/f:gender"/>
    </searchParam>
    <searchParam>
      <name value="identifier"/>
      <type value="token"/>
      <documentation value="A patient Identifier"/>
      <xpath value="f:RelatedPerson/f:identifier"/>
    </searchParam>
    <searchParam>
      <name value="name"/>
      <type value="string"/>
      <documentation value="A portion of name in any name part"/>
      <xpath value="f:RelatedPerson/f:name"/>
    </searchParam>
    <searchParam>
      <name value="patient"/>
      <type value="reference"/>
      <documentation value="The patient this person is related to"/>
      <xpath value="f:RelatedPerson/f:patient"/>
    </searchParam>
    <searchParam>
      <name value="phonetic"/>
      <type value="string"/>
      <documentation value="A portion of name using some kind of phonetic matching algorithm"/>
    </searchParam>
    <searchParam>
      <name value="telecom"/>
      <type value="string"/>
      <documentation value="The value in any kind of contact"/>
      <xpath value="f:RelatedPerson/f:telecom"/>
    </searchParam>
  </structure>
</Profile>