Clinical Document Architecture V2.0.1
2.1.0 - CI Build

Clinical Document Architecture V2.0.1, published by Health Level 7. This is not an authorized publication; it is the continuous build for version 2.1.0). This version is based on the current content of https://github.com/HL7/cda-core-2.0/ and changes regularly. See the Directory of published versions

Logical Model: CDAR2.RelatedEntity - XML Profile

XML representation of the RelatedEntity logical model.

Raw xml | Download



<StructureDefinition xmlns="http://hl7.org/fhir">
  <id value="RelatedEntity"/>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml">
      <p>The RelatedEntity role is used to represent an informant without a role.id (e.g. a parent or guy on the street).</p>
    </div>
  </text>
  <extension
             url="http://hl7.org/fhir/StructureDefinition/elementdefinition-namespace">
    <valueUri value="urn:hl7-org:v3"/>
  </extension>
  <url value="http://hl7.org/fhir/cda/StructureDefinition/RelatedEntity"/>
  <version value="2.1.0"/>
  <name value="CDAR2.RelatedEntity"/>
  <title value="RelatedEntity (CDA Class)"/>
  <status value="active"/>
  <experimental value="false"/>
  <date value="2021-04-15T20:51:17+00:00"/>
  <publisher value="Health Level 7"/>
  <description
               value="The RelatedEntity role is used to represent an informant without a role.id (e.g. a parent or guy on the street)."/>
  <fhirVersion value="4.0.1"/>
  <kind value="logical"/>
  <abstract value="false"/>
  <type value="RelatedEntity"/>
  <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Base"/>
  <derivation value="specialization"/>
  <snapshot>
    <element id="RelatedEntity">
      <path value="RelatedEntity"/>
      <min value="1"/>
      <max value="1"/>
      <base>
        <path value="Base"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <isModifier value="false"/>
    </element>
    <element id="RelatedEntity.classCode">
      <path value="RelatedEntity.classCode"/>
      <representation value="xmlAttr"/>
      <min value="1"/>
      <max value="1"/>
      <base>
        <path value="RelatedEntity.classCode"/>
        <min value="1"/>
        <max value="1"/>
      </base>
      <type>
        <code value="code"/>
      </type>
      <binding>
        <strength value="required"/>
        <valueSet
                  value="http://terminology.hl7.org/ValueSet/v3-RoleClassMutualRelationship"/>
      </binding>
    </element>
    <element id="RelatedEntity.templateId">
      <path value="RelatedEntity.templateId"/>
      <definition
                  value="When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question"/>
      <min value="0"/>
      <max value="*"/>
      <base>
        <path value="RelatedEntity.templateId"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <type>
        <code value="http://hl7.org/fhir/cda/StructureDefinition/II"/>
      </type>
    </element>
    <element id="RelatedEntity.code">
      <path value="RelatedEntity.code"/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="RelatedEntity.code"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="http://hl7.org/fhir/cda/StructureDefinition/CE"/>
      </type>
      <binding>
        <strength value="extensible"/>
        <valueSet
                  value="http://terminology.hl7.org/ValueSet/v3-PersonalRelationshipRoleType"/>
      </binding>
    </element>
    <element id="RelatedEntity.addr">
      <path value="RelatedEntity.addr"/>
      <min value="0"/>
      <max value="*"/>
      <base>
        <path value="RelatedEntity.addr"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <type>
        <code value="http://hl7.org/fhir/cda/StructureDefinition/AD"/>
      </type>
    </element>
    <element id="RelatedEntity.telecom">
      <path value="RelatedEntity.telecom"/>
      <min value="0"/>
      <max value="*"/>
      <base>
        <path value="RelatedEntity.telecom"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <type>
        <code value="http://hl7.org/fhir/cda/StructureDefinition/TEL"/>
      </type>
    </element>
    <element id="RelatedEntity.effectiveTime">
      <path value="RelatedEntity.effectiveTime"/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="RelatedEntity.effectiveTime"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="http://hl7.org/fhir/cda/StructureDefinition/IVL-TS"/>
      </type>
    </element>
    <element id="RelatedEntity.relatedPerson">
      <path value="RelatedEntity.relatedPerson"/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="RelatedEntity.relatedPerson"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="http://hl7.org/fhir/cda/StructureDefinition/Person"/>
      </type>
    </element>
  </snapshot>
  <differential>
    <element id="RelatedEntity">
      <path value="RelatedEntity"/>
      <min value="1"/>
      <max value="1"/>
    </element>
    <element id="RelatedEntity.classCode">
      <path value="RelatedEntity.classCode"/>
      <representation value="xmlAttr"/>
      <min value="1"/>
      <max value="1"/>
      <type>
        <code value="code"/>
      </type>
      <binding>
        <strength value="required"/>
        <valueSet
                  value="http://terminology.hl7.org/ValueSet/v3-RoleClassMutualRelationship"/>
      </binding>
    </element>
    <element id="RelatedEntity.templateId">
      <path value="RelatedEntity.templateId"/>
      <definition
                  value="When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question"/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="http://hl7.org/fhir/cda/StructureDefinition/II"/>
      </type>
    </element>
    <element id="RelatedEntity.code">
      <path value="RelatedEntity.code"/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="http://hl7.org/fhir/cda/StructureDefinition/CE"/>
      </type>
      <binding>
        <strength value="extensible"/>
        <valueSet
                  value="http://terminology.hl7.org/ValueSet/v3-PersonalRelationshipRoleType"/>
      </binding>
    </element>
    <element id="RelatedEntity.addr">
      <path value="RelatedEntity.addr"/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="http://hl7.org/fhir/cda/StructureDefinition/AD"/>
      </type>
    </element>
    <element id="RelatedEntity.telecom">
      <path value="RelatedEntity.telecom"/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="http://hl7.org/fhir/cda/StructureDefinition/TEL"/>
      </type>
    </element>
    <element id="RelatedEntity.effectiveTime">
      <path value="RelatedEntity.effectiveTime"/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="http://hl7.org/fhir/cda/StructureDefinition/IVL-TS"/>
      </type>
    </element>
    <element id="RelatedEntity.relatedPerson">
      <path value="RelatedEntity.relatedPerson"/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="http://hl7.org/fhir/cda/StructureDefinition/Person"/>
      </type>
    </element>
  </differential>
</StructureDefinition>