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.Patient - XML Profile

XML representation of the Patient logical model.

Raw xml | Download



<StructureDefinition xmlns="http://hl7.org/fhir">
  <id value="Patient"/>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml">
      <p>A LivingSubject as a recipient of health care services from a healthcare provider.</p>
      <p>The patient is the player; the provider is the scoper.</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/Patient"/>
  <version value="2.1.0"/>
  <name value="CDAR2.Patient"/>
  <title value="Patient (CDA Class)"/>
  <status value="active"/>
  <experimental value="false"/>
  <date value="2021-03-11T17:00:55+00:00"/>
  <publisher value="Health Level 7"/>
  <description
               value="A LivingSubject as a recipient of health care services from a healthcare provider.
The patient is the player; the provider is the scoper."/>
  <fhirVersion value="4.0.1"/>
  <kind value="logical"/>
  <abstract value="false"/>
  <type value="Patient"/>
  <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Base"/>
  <derivation value="specialization"/>
  <snapshot>
    <element id="Patient">
      <path value="Patient"/>
      <min value="1"/>
      <max value="1"/>
      <base>
        <path value="Base"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <isModifier value="false"/>
    </element>
    <element id="Patient.classCode">
      <path value="Patient.classCode"/>
      <representation value="xmlAttr"/>
      <min value="1"/>
      <max value="1"/>
      <base>
        <path value="Patient.classCode"/>
        <min value="1"/>
        <max value="1"/>
      </base>
      <type>
        <code value="code"/>
      </type>
      <defaultValueCode value="PSN"/>
      <fixedCode value="PSN"/>
      <binding>
        <strength value="required"/>
        <valueSet
                  value="http://terminology.hl7.org/ValueSet/v3-EntityClassLivingSubject"/>
      </binding>
    </element>
    <element id="Patient.determinerCode">
      <path value="Patient.determinerCode"/>
      <representation value="xmlAttr"/>
      <min value="1"/>
      <max value="1"/>
      <base>
        <path value="Patient.determinerCode"/>
        <min value="1"/>
        <max value="1"/>
      </base>
      <type>
        <code value="code"/>
      </type>
      <defaultValueCode value="INSTANCE"/>
      <fixedCode value="INSTANCE"/>
      <binding>
        <strength value="required"/>
        <valueSet
                  value="http://terminology.hl7.org/ValueSet/v3-EntityDeterminer"/>
      </binding>
    </element>
    <element id="Patient.templateId">
      <path value="Patient.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="Patient.templateId"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <type>
        <code value="http://hl7.org/fhir/cda/StructureDefinition/II"/>
      </type>
    </element>
    <element id="Patient.id">
      <path value="Patient.id"/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="Patient.id"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="http://hl7.org/fhir/cda/StructureDefinition/II"/>
      </type>
    </element>
    <element id="Patient.name">
      <path value="Patient.name"/>
      <min value="0"/>
      <max value="*"/>
      <base>
        <path value="Patient.name"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <type>
        <code value="http://hl7.org/fhir/cda/StructureDefinition/EN"/>
      </type>
    </element>
    <element id="Patient.desc">
      <extension
                 url="http://hl7.org/fhir/StructureDefinition/elementdefinition-namespace">
        <valueUri value="urn:hl7-org:sdtc"/>
      </extension>
      <path value="Patient.desc"/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="Patient.desc"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="http://hl7.org/fhir/cda/StructureDefinition/ED"/>
      </type>
    </element>
    <element id="Patient.administrativeGenderCode">
      <path value="Patient.administrativeGenderCode"/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="Patient.administrativeGenderCode"/>
        <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-AdministrativeGender"/>
      </binding>
    </element>
    <element id="Patient.birthTime">
      <path value="Patient.birthTime"/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="Patient.birthTime"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="http://hl7.org/fhir/cda/StructureDefinition/TS"/>
      </type>
    </element>
    <element id="Patient.deceasedInd">
      <extension
                 url="http://hl7.org/fhir/StructureDefinition/elementdefinition-namespace">
        <valueUri value="urn:hl7-org:sdtc"/>
      </extension>
      <path value="Patient.deceasedInd"/>
      <short value="sdtc:deceasedInd"/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="Patient.deceasedInd"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="http://hl7.org/fhir/cda/StructureDefinition/BL"/>
      </type>
    </element>
    <element id="Patient.deceasedTime">
      <extension
                 url="http://hl7.org/fhir/StructureDefinition/elementdefinition-namespace">
        <valueUri value="urn:hl7-org:sdtc"/>
      </extension>
      <path value="Patient.deceasedTime"/>
      <short value="sdtc:deceasedTimed"/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="Patient.deceasedTime"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="http://hl7.org/fhir/cda/StructureDefinition/TS"/>
      </type>
    </element>
    <element id="Patient.multipleBirthInd">
      <extension
                 url="http://hl7.org/fhir/StructureDefinition/elementdefinition-namespace">
        <valueUri value="urn:hl7-org:sdtc"/>
      </extension>
      <path value="Patient.multipleBirthInd"/>
      <short value="sdtc:multipleBirthInd"/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="Patient.multipleBirthInd"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="http://hl7.org/fhir/cda/StructureDefinition/BL"/>
      </type>
    </element>
    <element id="Patient.multipleBirthOrderNumber">
      <extension
                 url="http://hl7.org/fhir/StructureDefinition/elementdefinition-namespace">
        <valueUri value="urn:hl7-org:sdtc"/>
      </extension>
      <path value="Patient.multipleBirthOrderNumber"/>
      <short value="sdtc:multipleBirthOrderNumber"/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="Patient.multipleBirthOrderNumber"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="http://hl7.org/fhir/cda/StructureDefinition/INT-POS"/>
      </type>
    </element>
    <element id="Patient.maritalStatusCode">
      <path value="Patient.maritalStatusCode"/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="Patient.maritalStatusCode"/>
        <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-MaritalStatus"/>
      </binding>
    </element>
    <element id="Patient.religiousAffiliationCode">
      <path value="Patient.religiousAffiliationCode"/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="Patient.religiousAffiliationCode"/>
        <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-ReligiousAffiliation"/>
      </binding>
    </element>
    <element id="Patient.raceCode">
      <path value="Patient.raceCode"/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="Patient.raceCode"/>
        <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-Race"/>
      </binding>
    </element>
    <element id="Patient.sdtcRaceCode">
      <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="raceCode"/>
      </extension>
      <path value="Patient.sdtcRaceCode"/>
      <short value="sdtcRaceCode"/>
      <min value="0"/>
      <max value="*"/>
      <base>
        <path value="Patient.sdtcRaceCode"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <type>
        <code value="http://hl7.org/fhir/cda/StructureDefinition/CE"/>
      </type>
      <binding>
        <strength value="extensible"/>
        <valueSet value="http://terminology.hl7.org/ValueSet/v3-Race"/>
      </binding>
    </element>
    <element id="Patient.ethnicGroupCode">
      <path value="Patient.ethnicGroupCode"/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="Patient.ethnicGroupCode"/>
        <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-Ethnicity"/>
      </binding>
    </element>
    <element id="Patient.ethnicGroupCode">
      <extension
                 url="http://hl7.org/fhir/StructureDefinition/elementdefinition-namespace">
        <valueUri value="urn:hl7-org:sdtc"/>
      </extension>
      <path value="Patient.ethnicGroupCode"/>
      <short value="sdtc:ethnicGroupCode"/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="Patient.ethnicGroupCode"/>
        <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-Ethnicity"/>
      </binding>
    </element>
    <element id="Patient.guardian">
      <path value="Patient.guardian"/>
      <min value="0"/>
      <max value="*"/>
      <base>
        <path value="Patient.guardian"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <type>
        <code value="http://hl7.org/fhir/cda/StructureDefinition/Guardian"/>
      </type>
    </element>
    <element id="Patient.birthplace">
      <path value="Patient.birthplace"/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="Patient.birthplace"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="http://hl7.org/fhir/cda/StructureDefinition/Birthplace"/>
      </type>
    </element>
    <element id="Patient.languageCommunication">
      <path value="Patient.languageCommunication"/>
      <min value="0"/>
      <max value="*"/>
      <base>
        <path value="Patient.languageCommunication"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <type>
        <code
              value="http://hl7.org/fhir/cda/StructureDefinition/LanguageCommunication"/>
      </type>
    </element>
  </snapshot>
  <differential>
    <element id="Patient">
      <path value="Patient"/>
      <min value="1"/>
      <max value="1"/>
    </element>
    <element id="Patient.classCode">
      <path value="Patient.classCode"/>
      <representation value="xmlAttr"/>
      <min value="1"/>
      <max value="1"/>
      <type>
        <code value="code"/>
      </type>
      <defaultValueCode value="PSN"/>
      <fixedCode value="PSN"/>
      <binding>
        <strength value="required"/>
        <valueSet
                  value="http://terminology.hl7.org/ValueSet/v3-EntityClassLivingSubject"/>
      </binding>
    </element>
    <element id="Patient.determinerCode">
      <path value="Patient.determinerCode"/>
      <representation value="xmlAttr"/>
      <min value="1"/>
      <max value="1"/>
      <type>
        <code value="code"/>
      </type>
      <defaultValueCode value="INSTANCE"/>
      <fixedCode value="INSTANCE"/>
      <binding>
        <strength value="required"/>
        <valueSet
                  value="http://terminology.hl7.org/ValueSet/v3-EntityDeterminer"/>
      </binding>
    </element>
    <element id="Patient.templateId">
      <path value="Patient.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="Patient.id">
      <path value="Patient.id"/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="http://hl7.org/fhir/cda/StructureDefinition/II"/>
      </type>
    </element>
    <element id="Patient.name">
      <path value="Patient.name"/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="http://hl7.org/fhir/cda/StructureDefinition/EN"/>
      </type>
    </element>
    <element id="Patient.desc">
      <extension
                 url="http://hl7.org/fhir/StructureDefinition/elementdefinition-namespace">
        <valueUri value="urn:hl7-org:sdtc"/>
      </extension>
      <path value="Patient.desc"/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="http://hl7.org/fhir/cda/StructureDefinition/ED"/>
      </type>
    </element>
    <element id="Patient.administrativeGenderCode">
      <path value="Patient.administrativeGenderCode"/>
      <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-AdministrativeGender"/>
      </binding>
    </element>
    <element id="Patient.birthTime">
      <path value="Patient.birthTime"/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="http://hl7.org/fhir/cda/StructureDefinition/TS"/>
      </type>
    </element>
    <element id="Patient.deceasedInd">
      <extension
                 url="http://hl7.org/fhir/StructureDefinition/elementdefinition-namespace">
        <valueUri value="urn:hl7-org:sdtc"/>
      </extension>
      <path value="Patient.deceasedInd"/>
      <short value="sdtc:deceasedInd"/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="http://hl7.org/fhir/cda/StructureDefinition/BL"/>
      </type>
    </element>
    <element id="Patient.deceasedTime">
      <extension
                 url="http://hl7.org/fhir/StructureDefinition/elementdefinition-namespace">
        <valueUri value="urn:hl7-org:sdtc"/>
      </extension>
      <path value="Patient.deceasedTime"/>
      <short value="sdtc:deceasedTimed"/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="http://hl7.org/fhir/cda/StructureDefinition/TS"/>
      </type>
    </element>
    <element id="Patient.multipleBirthInd">
      <extension
                 url="http://hl7.org/fhir/StructureDefinition/elementdefinition-namespace">
        <valueUri value="urn:hl7-org:sdtc"/>
      </extension>
      <path value="Patient.multipleBirthInd"/>
      <short value="sdtc:multipleBirthInd"/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="http://hl7.org/fhir/cda/StructureDefinition/BL"/>
      </type>
    </element>
    <element id="Patient.multipleBirthOrderNumber">
      <extension
                 url="http://hl7.org/fhir/StructureDefinition/elementdefinition-namespace">
        <valueUri value="urn:hl7-org:sdtc"/>
      </extension>
      <path value="Patient.multipleBirthOrderNumber"/>
      <short value="sdtc:multipleBirthOrderNumber"/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="http://hl7.org/fhir/cda/StructureDefinition/INT-POS"/>
      </type>
    </element>
    <element id="Patient.maritalStatusCode">
      <path value="Patient.maritalStatusCode"/>
      <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-MaritalStatus"/>
      </binding>
    </element>
    <element id="Patient.religiousAffiliationCode">
      <path value="Patient.religiousAffiliationCode"/>
      <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-ReligiousAffiliation"/>
      </binding>
    </element>
    <element id="Patient.raceCode">
      <path value="Patient.raceCode"/>
      <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-Race"/>
      </binding>
    </element>
    <element id="Patient.sdtcRaceCode">
      <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="raceCode"/>
      </extension>
      <path value="Patient.sdtcRaceCode"/>
      <short value="sdtcRaceCode"/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="http://hl7.org/fhir/cda/StructureDefinition/CE"/>
      </type>
      <binding>
        <strength value="extensible"/>
        <valueSet value="http://terminology.hl7.org/ValueSet/v3-Race"/>
      </binding>
    </element>
    <element id="Patient.ethnicGroupCode">
      <path value="Patient.ethnicGroupCode"/>
      <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-Ethnicity"/>
      </binding>
    </element>
    <element id="Patient.ethnicGroupCode">
      <extension
                 url="http://hl7.org/fhir/StructureDefinition/elementdefinition-namespace">
        <valueUri value="urn:hl7-org:sdtc"/>
      </extension>
      <path value="Patient.ethnicGroupCode"/>
      <short value="sdtc:ethnicGroupCode"/>
      <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-Ethnicity"/>
      </binding>
    </element>
    <element id="Patient.guardian">
      <path value="Patient.guardian"/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="http://hl7.org/fhir/cda/StructureDefinition/Guardian"/>
      </type>
    </element>
    <element id="Patient.birthplace">
      <path value="Patient.birthplace"/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="http://hl7.org/fhir/cda/StructureDefinition/Birthplace"/>
      </type>
    </element>
    <element id="Patient.languageCommunication">
      <path value="Patient.languageCommunication"/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code
              value="http://hl7.org/fhir/cda/StructureDefinition/LanguageCommunication"/>
      </type>
    </element>
  </differential>
</StructureDefinition>