Clinical Document Architecture with Australian Schema, published by Australian Digital Health Agency. This guide is not an authorized publication; it is the continuous build for version 1.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/AuDigitalHealth/cda-au-schema/ and changes regularly. See the Directory of published versions

Logical Model: au-Entry - XML Profile

Active as of 2024-12-18

XML representation of the au-Entry logical model.

Raw xml | Download


<StructureDefinition xmlns="http://hl7.org/fhir">
  <id value="au-Entry"/>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml">
      <p>CDA entries represent the structured computer-processable components within a document section. Each section can contain zero to many entries.</p>
      <p>Clinical documents contain a wide breadth of content, requiring much of the RIM to enable a full and complete encoding. The current set of CDA entries have been developed in response to identified requirements and scenarios that are in CDA's scope. Rather than creating specific entries for each scenario, similar requirements are merged to create broader entries, which can then be constrained within a particular realm or implementation. This approach is consistent with the approach taken by CEN, DICOM, and OpenEHR.</p>
      <p>The model for CDA entries is derived from the shared HL7 Clinical Statement model, which is a collaborative project between several committees striving to provide a consistent representation of clinical observations and acts across various V3 specifications.</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="entry"/>
  </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://ns.electronichealth.net.au/cda/StructureDefinition/au-Entry"/>
  <version value="1.0.0"/>
  <name value="au-Entry"/>
  <title value="ADHA Entry (CDA Class)"/>
  <status value="active"/>
  <experimental value="false"/>
  <date value="2024-12-18T05:40:48+00:00"/>
  <publisher value="Australian Digital Health Agency"/>
  <contact>
    <name value="Australian Digital Health Agency"/>
    <telecom>
      <system value="email"/>
      <value value="mailto:help@digitalhealth.gov.au"/>
    </telecom>
  </contact>
  <description
               value="**Australian adaptation of the [HL7 International CDA Entry class](     https://hl7.org/cda/stds/core/2.0.0-sd/StructureDefinition-Entry.html)**.     

This is a generated StructureDefinition that describes CDA - that is, CDA as it actually is for R2. The intent of this StructureDefinition is to enable CDA to be a FHIR resource. That enables the FHIR infrastructure - API, conformance, query - to be used directly against CDA"/>
  <jurisdiction>
    <coding>
      <system value="urn:iso:std:iso:3166"/>
      <code value="AU"/>
    </coding>
  </jurisdiction>
  <copyright
             value="Copyright © 2024 Australian Digital Health Agency - All rights reserved. This content is licensed under a Creative Commons Attribution 4.0 International License. See [https://creativecommons.org/licenses/by/4.0/](https://creativecommons.org/licenses/by/4.0/)."/>
  <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/Entry"/>
  <baseDefinition
                  value="http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot"/>
  <derivation value="specialization"/>
  <snapshot>
    <element id="Entry">
      <path value="Entry"/>
      <short
             value="Australian adaptation of the HL7 International CDA Entry class"/>
      <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="*"/>
      <base>
        <path value="Base"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <constraint>
        <key value="entry-only-one"/>
        <severity value="error"/>
        <human
               value="SHALL have no more than one of act, encounter, observation, observationMedia, organizer, procedure, regionOfInterest, substanceAdministration, or supply."/>
        <expression
                    value="(act | encounter | observation | observationMedia | organizer | procedure | regionOfInterest | substanceAdministration | supply).count() = 1"/>
      </constraint>
      <isModifier value="false"/>
      <mapping>
        <identity value="rim"/>
        <map value="n/a"/>
      </mapping>
    </element>
    <element id="Entry.nullFlavor">
      <path value="Entry.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="Entry.realmCode">
      <path value="Entry.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="Entry.typeId">
      <path value="Entry.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>
      <constraint>
        <key value="II-1"/>
        <severity value="error"/>
        <human
               value="An II instance must have either a root or an nullFlavor."/>
        <expression value="root.exists() or nullFlavor.exists()"/>
        <source
                value="http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot"/>
      </constraint>
    </element>
    <element id="Entry.typeId.nullFlavor">
      <path value="Entry.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="Entry.typeId.assigningAuthorityName">
      <path value="Entry.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="Entry.typeId.displayable">
      <path value="Entry.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="Entry.typeId.root">
      <path value="Entry.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="Entry.typeId.extension">
      <path value="Entry.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="Entry.templateId">
      <path value="Entry.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="Entry.typeCode">
      <path value="Entry.typeCode"/>
      <representation value="xmlAttr"/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="Entry.typeCode"/>
        <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="COMP"/>
      <binding>
        <strength value="required"/>
        <valueSet
                  value="http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntry"/>
      </binding>
    </element>
    <element id="Entry.contextConductionInd">
      <path value="Entry.contextConductionInd"/>
      <representation value="xmlAttr"/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="Entry.contextConductionInd"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="boolean"/>
        <profile
                 value="http://hl7.org/cda/stds/core/StructureDefinition/bl-simple"/>
      </type>
      <fixedBoolean value="true"/>
    </element>
    <element id="Entry.act">
      <path value="Entry.act"/>
      <short value="Australian-adapted Act class"/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="Entry.act"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code
              value="http://ns.electronichealth.net.au/cda/StructureDefinition/au-Act"/>
        <profile
                 value="http://ns.electronichealth.net.au/cda/StructureDefinition/au-Act"/>
      </type>
    </element>
    <element id="Entry.encounter">
      <path value="Entry.encounter"/>
      <short value="Australian-adapted Encounter class"/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="Entry.encounter"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code
              value="http://ns.electronichealth.net.au/cda/StructureDefinition/au-Encounter"/>
        <profile
                 value="http://ns.electronichealth.net.au/cda/StructureDefinition/au-Encounter"/>
      </type>
    </element>
    <element id="Entry.observation">
      <path value="Entry.observation"/>
      <short value="Australian-adapted Observation class"/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="Entry.observation"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code
              value="http://ns.electronichealth.net.au/cda/StructureDefinition/au-Observation"/>
        <profile
                 value="http://ns.electronichealth.net.au/cda/StructureDefinition/au-Observation"/>
      </type>
    </element>
    <element id="Entry.observationMedia">
      <path value="Entry.observationMedia"/>
      <short value="Australian-adapted ObservationMedia class"/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="Entry.observationMedia"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code
              value="http://ns.electronichealth.net.au/cda/StructureDefinition/au-ObservationMedia"/>
        <profile
                 value="http://ns.electronichealth.net.au/cda/StructureDefinition/au-ObservationMedia"/>
      </type>
    </element>
    <element id="Entry.organizer">
      <path value="Entry.organizer"/>
      <short value="Australian-adapted Organizer class"/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="Entry.organizer"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code
              value="http://ns.electronichealth.net.au/cda/StructureDefinition/au-Organizer"/>
        <profile
                 value="http://ns.electronichealth.net.au/cda/StructureDefinition/au-Organizer"/>
      </type>
    </element>
    <element id="Entry.procedure">
      <path value="Entry.procedure"/>
      <short value="Australian-adapted Procedure class"/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="Entry.procedure"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code
              value="http://ns.electronichealth.net.au/cda/StructureDefinition/au-Procedure"/>
        <profile
                 value="http://ns.electronichealth.net.au/cda/StructureDefinition/au-Procedure"/>
      </type>
    </element>
    <element id="Entry.regionOfInterest">
      <path value="Entry.regionOfInterest"/>
      <short value="Australian-adapted RegionOfInterest class"/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="Entry.regionOfInterest"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code
              value="http://ns.electronichealth.net.au/cda/StructureDefinition/au-RegionOfInterest"/>
        <profile
                 value="http://ns.electronichealth.net.au/cda/StructureDefinition/au-RegionOfInterest"/>
      </type>
    </element>
    <element id="Entry.substanceAdministration">
      <path value="Entry.substanceAdministration"/>
      <short value="Australian-adapted SubstanceAdministration class"/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="Entry.substanceAdministration"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code
              value="http://ns.electronichealth.net.au/cda/StructureDefinition/au-SubstanceAdministration"/>
        <profile
                 value="http://ns.electronichealth.net.au/cda/StructureDefinition/au-SubstanceAdministration"/>
      </type>
    </element>
    <element id="Entry.supply">
      <path value="Entry.supply"/>
      <short value="Australian-adapted Supply class"/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="Entry.supply"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code
              value="http://ns.electronichealth.net.au/cda/StructureDefinition/au-Supply"/>
        <profile
                 value="http://ns.electronichealth.net.au/cda/StructureDefinition/au-Supply"/>
      </type>
    </element>
    <element id="Entry.controlAct">
      <extension
                 url="http://hl7.org/fhir/tools/StructureDefinition/xml-namespace">
        <valueUri
                  value="http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0"/>
      </extension>
      <path value="Entry.controlAct"/>
      <short value="ADHA CDA extension to represent control act"/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="Entry.controlAct"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code
              value="http://ns.electronichealth.net.au/cda/StructureDefinition/controlAct"/>
        <profile
                 value="http://ns.electronichealth.net.au/cda/StructureDefinition/controlAct"/>
      </type>
    </element>
  </snapshot>
  <differential>
    <element id="Entry">
      <path value="Entry"/>
      <short
             value="Australian adaptation of the HL7 International CDA Entry class"/>
      <min value="1"/>
      <max value="*"/>
      <constraint>
        <key value="entry-only-one"/>
        <severity value="error"/>
        <human
               value="SHALL have no more than one of act, encounter, observation, observationMedia, organizer, procedure, regionOfInterest, substanceAdministration, or supply."/>
        <expression
                    value="(act | encounter | observation | observationMedia | organizer | procedure | regionOfInterest | substanceAdministration | supply).count() = 1"/>
      </constraint>
    </element>
    <element id="Entry.typeCode">
      <path value="Entry.typeCode"/>
      <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="COMP"/>
      <binding>
        <strength value="required"/>
        <valueSet
                  value="http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntry"/>
      </binding>
    </element>
    <element id="Entry.contextConductionInd">
      <path value="Entry.contextConductionInd"/>
      <representation value="xmlAttr"/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="boolean"/>
        <profile
                 value="http://hl7.org/cda/stds/core/StructureDefinition/bl-simple"/>
      </type>
      <fixedBoolean value="true"/>
    </element>
    <element id="Entry.act">
      <path value="Entry.act"/>
      <short value="Australian-adapted Act class"/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code
              value="http://ns.electronichealth.net.au/cda/StructureDefinition/au-Act"/>
        <profile
                 value="http://ns.electronichealth.net.au/cda/StructureDefinition/au-Act"/>
      </type>
    </element>
    <element id="Entry.encounter">
      <path value="Entry.encounter"/>
      <short value="Australian-adapted Encounter class"/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code
              value="http://ns.electronichealth.net.au/cda/StructureDefinition/au-Encounter"/>
        <profile
                 value="http://ns.electronichealth.net.au/cda/StructureDefinition/au-Encounter"/>
      </type>
    </element>
    <element id="Entry.observation">
      <path value="Entry.observation"/>
      <short value="Australian-adapted Observation class"/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code
              value="http://ns.electronichealth.net.au/cda/StructureDefinition/au-Observation"/>
        <profile
                 value="http://ns.electronichealth.net.au/cda/StructureDefinition/au-Observation"/>
      </type>
    </element>
    <element id="Entry.observationMedia">
      <path value="Entry.observationMedia"/>
      <short value="Australian-adapted ObservationMedia class"/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code
              value="http://ns.electronichealth.net.au/cda/StructureDefinition/au-ObservationMedia"/>
        <profile
                 value="http://ns.electronichealth.net.au/cda/StructureDefinition/au-ObservationMedia"/>
      </type>
    </element>
    <element id="Entry.organizer">
      <path value="Entry.organizer"/>
      <short value="Australian-adapted Organizer class"/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code
              value="http://ns.electronichealth.net.au/cda/StructureDefinition/au-Organizer"/>
        <profile
                 value="http://ns.electronichealth.net.au/cda/StructureDefinition/au-Organizer"/>
      </type>
    </element>
    <element id="Entry.procedure">
      <path value="Entry.procedure"/>
      <short value="Australian-adapted Procedure class"/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code
              value="http://ns.electronichealth.net.au/cda/StructureDefinition/au-Procedure"/>
        <profile
                 value="http://ns.electronichealth.net.au/cda/StructureDefinition/au-Procedure"/>
      </type>
    </element>
    <element id="Entry.regionOfInterest">
      <path value="Entry.regionOfInterest"/>
      <short value="Australian-adapted RegionOfInterest class"/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code
              value="http://ns.electronichealth.net.au/cda/StructureDefinition/au-RegionOfInterest"/>
        <profile
                 value="http://ns.electronichealth.net.au/cda/StructureDefinition/au-RegionOfInterest"/>
      </type>
    </element>
    <element id="Entry.substanceAdministration">
      <path value="Entry.substanceAdministration"/>
      <short value="Australian-adapted SubstanceAdministration class"/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code
              value="http://ns.electronichealth.net.au/cda/StructureDefinition/au-SubstanceAdministration"/>
        <profile
                 value="http://ns.electronichealth.net.au/cda/StructureDefinition/au-SubstanceAdministration"/>
      </type>
    </element>
    <element id="Entry.supply">
      <path value="Entry.supply"/>
      <short value="Australian-adapted Supply class"/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code
              value="http://ns.electronichealth.net.au/cda/StructureDefinition/au-Supply"/>
        <profile
                 value="http://ns.electronichealth.net.au/cda/StructureDefinition/au-Supply"/>
      </type>
    </element>
    <element id="Entry.controlAct">
      <extension
                 url="http://hl7.org/fhir/tools/StructureDefinition/xml-namespace">
        <valueUri
                  value="http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0"/>
      </extension>
      <path value="Entry.controlAct"/>
      <short value="ADHA CDA extension to represent control act"/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code
              value="http://ns.electronichealth.net.au/cda/StructureDefinition/controlAct"/>
        <profile
                 value="http://ns.electronichealth.net.au/cda/StructureDefinition/controlAct"/>
      </type>
    </element>
  </differential>
</StructureDefinition>