This page is part of the CDA: Clinical Document Architecture (v2.1.0-draft1: CDA 2.1 Draft) based on FHIR v5.0.0. . For a full list of available versions, see the Directory of published versions

• Content
• Detailed Descriptions
• Mappings
• XML
• JSON
• TTL

Logical Model: CDAR2.PatientRole - XML Profile

XML representation of the PatientRole logical model.

Raw xml | Download

<StructureDefinition xmlns="http://hl7.org/fhir">
  <id value="PatientRole"/>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml">
      <p>A recordTarget is represented as a relationship between a person and an organization, where the person is in a patient role (PatientRole class). The entity playing the role is a patient (Patient class). The entity scoping the role is an organization (Organization class). A patient is uniquely identified via the PatientRole.id attribute.</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/PatientRole"/>
  <version value="2.1.0-draft1"/>
  <name value="CDAR2.PatientRole"/>
  <title value="PatientRole (CDA Class)"/>
  <status value="active"/>
  <experimental value="false"/>
  <date value="2023-01-16T16:39:50+11:00"/>
  <publisher value="Health Level 7"/>
  <contact>
    <name value="HL7 International - Cross-Group Projects"/>
    <telecom>
      <system value="url"/>
      <value value="http://www.hl7.org/Special/committees/cgp"/>
    </telecom>
    <telecom>
      <system value="email"/>
      <value value="cgp@lists.HL7.org"/>
    </telecom>
  </contact>
  <description
               value="A recordTarget is represented as a relationship between a person and an organization, where the person is in a patient role (PatientRole class). The entity playing the role is a patient (Patient class). The entity scoping the role is an organization (Organization class). A patient is uniquely identified via the PatientRole.id attribute."/>
  <fhirVersion value="5.0.0-snapshot3"/>
  <mapping>
    <identity value="rim"/>
    <uri value="http://hl7.org/v3"/>
    <name value="RIM Mapping"/>
  </mapping>
  <kind value="logical"/>
  <abstract value="false"/>
  <type value="PatientRole"/>
  <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Base"/>
  <derivation value="specialization"/>
  <snapshot>
    <element id="PatientRole">
      <path value="PatientRole"/>
      <short value="Base for all types and resources"/>
      <definition
                  value="Base definition for all types defined in FHIR type system."/>
      <min value="1"/>
      <max value="1"/>
      <base>
        <path value="Base"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <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() &gt; id.count())"/>
        <source value="http://hl7.org/fhir/StructureDefinition/Element"/>
      </constraint>
      <isModifier value="false"/>
      <mapping>
        <identity value="rim"/>
        <map value="n/a"/>
      </mapping>
    </element>
    <element id="PatientRole.classCode">
      <path value="PatientRole.classCode"/>
      <representation value="xmlAttr"/>
      <min value="1"/>
      <max value="1"/>
      <base>
        <path value="PatientRole.classCode"/>
        <min value="1"/>
        <max value="1"/>
      </base>
      <type>
        <code value="code"/>
      </type>
      <defaultValueCode value="PAT"/>
      <fixedCode value="PAT"/>
      <binding>
        <strength value="required"/>
        <valueSet
                  value="http://terminology.hl7.org/ValueSet/v3-RoleClassRelationshipFormal"/>
      </binding>
    </element>
    <element id="PatientRole.templateId">
      <path value="PatientRole.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="PatientRole.templateId"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <type>
        <code value="http://hl7.org/fhir/cda/StructureDefinition/II"/>
      </type>
    </element>
    <element id="PatientRole.id">
      <path value="PatientRole.id"/>
      <min value="1"/>
      <max value="*"/>
      <base>
        <path value="PatientRole.id"/>
        <min value="1"/>
        <max value="*"/>
      </base>
      <type>
        <code value="http://hl7.org/fhir/cda/StructureDefinition/II"/>
      </type>
    </element>
    <element id="PatientRole.sdtcIdentifiedBy">
      <extension
                 url="http://hl7.org/fhir/StructureDefinition/elementdefinition-namespace">
        <valueUri value="urn:hl7-org:sdtc"/>
      </extension>
      <extension
                 url="http://hl7.org/fhir/StructureDefinition/elementdefinition-xml-name">
        <valueString value="identifiedBy"/>
      </extension>
      <path value="PatientRole.sdtcIdentifiedBy"/>
      <min value="0"/>
      <max value="*"/>
      <base>
        <path value="PatientRole.sdtcIdentifiedBy"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <type>
        <code
              value="http://hl7.org/fhir/cda/StructureDefinition/IdentifiedBy"/>
      </type>
    </element>
    <element id="PatientRole.addr">
      <path value="PatientRole.addr"/>
      <min value="0"/>
      <max value="*"/>
      <base>
        <path value="PatientRole.addr"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <type>
        <code value="http://hl7.org/fhir/cda/StructureDefinition/AD"/>
      </type>
    </element>
    <element id="PatientRole.telecom">
      <path value="PatientRole.telecom"/>
      <min value="0"/>
      <max value="*"/>
      <base>
        <path value="PatientRole.telecom"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <type>
        <code value="http://hl7.org/fhir/cda/StructureDefinition/TEL"/>
      </type>
    </element>
    <element id="PatientRole.patient">
      <path value="PatientRole.patient"/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="PatientRole.patient"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="http://hl7.org/fhir/cda/StructureDefinition/Patient"/>
      </type>
    </element>
    <element id="PatientRole.providerOrganization">
      <path value="PatientRole.providerOrganization"/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="PatientRole.providerOrganization"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code
              value="http://hl7.org/fhir/cda/StructureDefinition/Organization"/>
      </type>
    </element>
  </snapshot>
  <differential>
    <element id="PatientRole">
      <path value="PatientRole"/>
      <min value="1"/>
      <max value="1"/>
    </element>
    <element id="PatientRole.classCode">
      <path value="PatientRole.classCode"/>
      <representation value="xmlAttr"/>
      <min value="1"/>
      <max value="1"/>
      <type>
        <code value="code"/>
      </type>
      <defaultValueCode value="PAT"/>
      <fixedCode value="PAT"/>
      <binding>
        <strength value="required"/>
        <valueSet
                  value="http://terminology.hl7.org/ValueSet/v3-RoleClassRelationshipFormal"/>
      </binding>
    </element>
    <element id="PatientRole.templateId">
      <path value="PatientRole.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="PatientRole.id">
      <path value="PatientRole.id"/>
      <min value="1"/>
      <max value="*"/>
      <type>
        <code value="http://hl7.org/fhir/cda/StructureDefinition/II"/>
      </type>
    </element>
    <element id="PatientRole.sdtcIdentifiedBy">
      <extension
                 url="http://hl7.org/fhir/StructureDefinition/elementdefinition-namespace">
        <valueUri value="urn:hl7-org:sdtc"/>
      </extension>
      <extension
                 url="http://hl7.org/fhir/StructureDefinition/elementdefinition-xml-name">
        <valueString value="identifiedBy"/>
      </extension>
      <path value="PatientRole.sdtcIdentifiedBy"/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code
              value="http://hl7.org/fhir/cda/StructureDefinition/IdentifiedBy"/>
      </type>
    </element>
    <element id="PatientRole.addr">
      <path value="PatientRole.addr"/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="http://hl7.org/fhir/cda/StructureDefinition/AD"/>
      </type>
    </element>
    <element id="PatientRole.telecom">
      <path value="PatientRole.telecom"/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="http://hl7.org/fhir/cda/StructureDefinition/TEL"/>
      </type>
    </element>
    <element id="PatientRole.patient">
      <path value="PatientRole.patient"/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="http://hl7.org/fhir/cda/StructureDefinition/Patient"/>
      </type>
    </element>
    <element id="PatientRole.providerOrganization">
      <path value="PatientRole.providerOrganization"/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code
              value="http://hl7.org/fhir/cda/StructureDefinition/Organization"/>
      </type>
    </element>
  </differential>
</StructureDefinition>