Clinical Document Architecture
2.0.0-sd-202406-matchbox-patch - release

Clinical Document Architecture - Local Development build (v2.0.0-sd-202406-matchbox-patch) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Logical Model: Entity - XML Profile

Active as of 2024-06-19

XML representation of the Entity logical model.

Raw xml | Download



<StructureDefinition xmlns="http://hl7.org/fhir">
  <id value="Entity"/>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml">
      <p>A physical thing, group of physical things or an organization capable of participating in Acts while in a role.</p>
      <p>An entity is a physical object that has, had or will have existence. The only exception to this is Organization, which while not having a physical presence, fulfills the other characteristics of an Entity. Entity stipulates the thing itself, not the Roles it may play: the Role of Patient, e.g., is played by the Person Entity.</p>
      <p>Living subjects (including human beings), organizations, materials, places and their specializations.</p>
    </div>
  </text>
  <extension
             url="http://hl7.org/fhir/tools/StructureDefinition/logical-target">
    <valueBoolean>
      <extension
                 url="http://hl7.org/fhir/StructureDefinition/data-absent-reason">
        <valueCode value="not-applicable"/>
      </extension>
    </valueBoolean>
  </extension>
  <extension
             url="http://hl7.org/fhir/tools/StructureDefinition/xml-namespace">
    <valueUri value="urn:hl7-org:v3"/>
  </extension>
  <extension url="http://hl7.org/fhir/tools/StructureDefinition/xml-name">
    <valueString value="entity"/>
  </extension>
  <extension
             url="http://hl7.org/fhir/tools/StructureDefinition/logical-container">
    <valueUri
              value="http://hl7.org/cda/stds/core/StructureDefinition/ClinicalDocument"/>
  </extension>
  <extension
             url="http://hl7.org/fhir/tools/StructureDefinition/type-profile-style">
    <valueUri value="cda"/>
  </extension>
  <url value="http://hl7.org/cda/stds/core/StructureDefinition/Entity"/>
  <version value="2.0.0-sd-202406-matchbox-patch"/>
  <name value="Entity"/>
  <title value="Entity (CDA Class)"/>
  <status value="active"/>
  <experimental value="false"/>
  <date value="2024-06-19T17:47:42+02:00"/>
  <publisher value="Health Level 7"/>
  <contact>
    <name value="HL7 International - Structured Documents"/>
    <telecom>
      <system value="url"/>
      <value value="http://www.hl7.org/Special/committees/structure"/>
    </telecom>
    <telecom>
      <system value="email"/>
      <value value="structdog@lists.HL7.org"/>
    </telecom>
  </contact>
  <description
               value="A physical thing, group of physical things or an organization capable of participating in Acts while in a role.

An entity is a physical object that has, had or will have existence. The only exception to this is Organization, which while not having a physical presence, fulfills the other characteristics of an Entity. Entity stipulates the thing itself, not the Roles it may play: the Role of Patient, e.g., is played by the Person Entity.

Living subjects (including human beings), organizations, materials, places and their specializations."/>
  <fhirVersion value="5.0.0"/>
  <mapping>
    <identity value="rim"/>
    <uri value="http://hl7.org/v3"/>
    <name value="RIM Mapping"/>
  </mapping>
  <kind value="logical"/>
  <abstract value="false"/>
  <type value="http://hl7.org/cda/stds/core/StructureDefinition/Entity"/>
  <baseDefinition
                  value="http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot"/>
  <derivation value="specialization"/>
  <snapshot>
    <element id="Entity">
      <path value="Entity"/>
      <short value="Base for all types and resources"/>
      <definition
                  value="Defines the basic properties of every data value. This is an abstract type, meaning that no value can be just a data value without belonging to any concrete type. Every concrete type is a specialization of this general abstract DataValue type."/>
      <min value="1"/>
      <max value="1"/>
      <base>
        <path value="Base"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <isModifier value="false"/>
      <mapping>
        <identity value="rim"/>
        <map value="n/a"/>
      </mapping>
    </element>
    <element id="Entity.nullFlavor">
      <path value="Entity.nullFlavor"/>
      <representation value="xmlAttr"/>
      <label value="Exceptional Value Detail"/>
      <definition
                  value="If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing."/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="ANY.nullFlavor"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="code"/>
        <profile
                 value="http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"/>
      </type>
      <binding>
        <strength value="required"/>
        <valueSet
                  value="http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"/>
      </binding>
    </element>
    <element id="Entity.realmCode">
      <path value="Entity.realmCode"/>
      <definition
                  value="When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question"/>
      <min value="0"/>
      <max value="*"/>
      <base>
        <path value="InfrastructureRoot.realmCode"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <type>
        <code value="http://hl7.org/cda/stds/core/StructureDefinition/CS"/>
      </type>
    </element>
    <element id="Entity.typeId">
      <path value="Entity.typeId"/>
      <definition
                  value="When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question."/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="InfrastructureRoot.typeId"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="http://hl7.org/cda/stds/core/StructureDefinition/II"/>
      </type>
    </element>
    <element id="Entity.typeId.nullFlavor">
      <path value="Entity.typeId.nullFlavor"/>
      <representation value="xmlAttr"/>
      <label value="Exceptional Value Detail"/>
      <definition
                  value="If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing."/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="ANY.nullFlavor"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="code"/>
        <profile
                 value="http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"/>
      </type>
      <binding>
        <strength value="required"/>
        <valueSet
                  value="http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"/>
      </binding>
    </element>
    <element id="Entity.typeId.assigningAuthorityName">
      <path value="Entity.typeId.assigningAuthorityName"/>
      <representation value="xmlAttr"/>
      <label value="Assigning Authority Name"/>
      <definition
                  value="A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form."/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="II.assigningAuthorityName"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="string"/>
        <profile
                 value="http://hl7.org/cda/stds/core/StructureDefinition/st-simple"/>
      </type>
    </element>
    <element id="Entity.typeId.displayable">
      <path value="Entity.typeId.displayable"/>
      <representation value="xmlAttr"/>
      <label value="Displayable"/>
      <definition
                  value="Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false)."/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="II.displayable"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="boolean"/>
        <profile
                 value="http://hl7.org/cda/stds/core/StructureDefinition/bl-simple"/>
      </type>
    </element>
    <element id="Entity.typeId.root">
      <path value="Entity.typeId.root"/>
      <representation value="xmlAttr"/>
      <label value="Root"/>
      <definition value="Identifies the type as an HL7 Registered model"/>
      <min value="1"/>
      <max value="1"/>
      <base>
        <path value="II.root"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="string"/>
        <profile
                 value="http://hl7.org/cda/stds/core/StructureDefinition/oid"/>
        <profile
                 value="http://hl7.org/cda/stds/core/StructureDefinition/uuid"/>
        <profile
                 value="http://hl7.org/cda/stds/core/StructureDefinition/ruid"/>
      </type>
      <fixedString value="2.16.840.1.113883.1.3"/>
    </element>
    <element id="Entity.typeId.extension">
      <path value="Entity.typeId.extension"/>
      <representation value="xmlAttr"/>
      <label value="Extension"/>
      <definition
                  value="A character string as a unique identifier within the scope of the identifier root."/>
      <min value="1"/>
      <max value="1"/>
      <base>
        <path value="II.extension"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="string"/>
        <profile
                 value="http://hl7.org/cda/stds/core/StructureDefinition/st-simple"/>
      </type>
    </element>
    <element id="Entity.templateId">
      <path value="Entity.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="InfrastructureRoot.templateId"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <type>
        <code value="http://hl7.org/cda/stds/core/StructureDefinition/II"/>
      </type>
    </element>
    <element id="Entity.classCode">
      <path value="Entity.classCode"/>
      <representation value="xmlAttr"/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="Entity.classCode"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="code"/>
        <profile
                 value="http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"/>
      </type>
      <defaultValueCode value="ENT"/>
      <binding>
        <strength value="required"/>
        <valueSet
                  value="http://terminology.hl7.org/ValueSet/v3-EntityClassRoot"/>
      </binding>
    </element>
    <element id="Entity.determinerCode">
      <path value="Entity.determinerCode"/>
      <representation value="xmlAttr"/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="Entity.determinerCode"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="code"/>
        <profile
                 value="http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"/>
      </type>
      <fixedCode value="INSTANCE"/>
      <binding>
        <strength value="required"/>
        <valueSet
                  value="http://terminology.hl7.org/ValueSet/v3-EntityDeterminer"/>
      </binding>
    </element>
    <element id="Entity.id">
      <path value="Entity.id"/>
      <min value="0"/>
      <max value="*"/>
      <base>
        <path value="Entity.id"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <type>
        <code value="http://hl7.org/cda/stds/core/StructureDefinition/II"/>
      </type>
    </element>
    <element id="Entity.code">
      <path value="Entity.code"/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="Entity.code"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="http://hl7.org/cda/stds/core/StructureDefinition/CE"/>
      </type>
      <binding>
        <strength value="example"/>
        <valueSet
                  value="http://hl7.org/cda/stds/core/ValueSet/CDAEntityCode"/>
      </binding>
    </element>
    <element id="Entity.desc">
      <path value="Entity.desc"/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="Entity.desc"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="http://hl7.org/cda/stds/core/StructureDefinition/ED"/>
      </type>
    </element>
  </snapshot>
  <differential>
    <element id="Entity">
      <path value="Entity"/>
      <min value="1"/>
      <max value="1"/>
    </element>
    <element id="Entity.classCode">
      <path value="Entity.classCode"/>
      <representation value="xmlAttr"/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="code"/>
        <profile
                 value="http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"/>
      </type>
      <defaultValueCode value="ENT"/>
      <binding>
        <strength value="required"/>
        <valueSet
                  value="http://terminology.hl7.org/ValueSet/v3-EntityClassRoot"/>
      </binding>
    </element>
    <element id="Entity.determinerCode">
      <path value="Entity.determinerCode"/>
      <representation value="xmlAttr"/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="code"/>
        <profile
                 value="http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"/>
      </type>
      <fixedCode value="INSTANCE"/>
      <binding>
        <strength value="required"/>
        <valueSet
                  value="http://terminology.hl7.org/ValueSet/v3-EntityDeterminer"/>
      </binding>
    </element>
    <element id="Entity.id">
      <path value="Entity.id"/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="http://hl7.org/cda/stds/core/StructureDefinition/II"/>
      </type>
    </element>
    <element id="Entity.code">
      <path value="Entity.code"/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="http://hl7.org/cda/stds/core/StructureDefinition/CE"/>
      </type>
      <binding>
        <strength value="example"/>
        <valueSet
                  value="http://hl7.org/cda/stds/core/ValueSet/CDAEntityCode"/>
      </binding>
    </element>
    <element id="Entity.desc">
      <path value="Entity.desc"/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="http://hl7.org/cda/stds/core/StructureDefinition/ED"/>
      </type>
    </element>
  </differential>
</StructureDefinition>