Clinical Document Architecture with Australian Schema
1.0.0 - current Australia flag

Clinical Document Architecture with Australian Schema - Local Development build (v1.0.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Logical Model: id - XML Profile

Active as of 2024-08-29

XML representation of the id logical model.

Raw xml | Download



<StructureDefinition xmlns="http://hl7.org/fhir">
  <id value="id"/>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml">
      <p>An Australian identifier that uniquely identifies a thing or object. Examples are object identifier for HL7 RIM objects, medical record number, order id, service catalog item id, Vehicle Identification Number (VIN), etc. Instance identifiers are defined based on ISO object identifiers.</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/StructureDefinition/elementdefinition-namespace">
    <valueUri value="urn:hl7-org:v3"/>
  </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="infrastructureRoot"/>
  </extension>
  <extension
             url="http://hl7.org/fhir/tools/StructureDefinition/type-profile-style">
    <valueUri value="cda"/>
  </extension>
  <extension
             url="http://hl7.org/fhir/tools/StructureDefinition/logical-container">
    <valueUri
              value="http://hl7.org/cda/stds/core/StructureDefinition/ClinicalDocument"/>
  </extension>
  <url value="http://ns.electronichealth.net.au/cda/StructureDefinition/id"/>
  <version value="1.0.0"/>
  <name value="id"/>
  <title value="ADHA Extension id"/>
  <status value="active"/>
  <experimental value="false"/>
  <date value="2024-08-29T09:46:41+10:00"/>
  <publisher value="Australian Digital Health Agency"/>
  <contact>
    <name value="Australian Digital Health Agency"/>
    <telecom>
      <system value="email"/>
      <value value="mailto:[email protected]"/>
    </telecom>
  </contact>
  <description
               value="Australian Digital Health Agency CDA extension for an Australian identifier that uniquely identifies a thing or object. Examples are object identifier for HL7 RIM objects, medical record number, order id, service catalog item id, Vehicle Identification Number (VIN), etc. Instance identifiers are defined based on ISO object identifiers."/>
  <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://ns.electronichealth.net.au/cda/StructureDefinition/id"/>
  <baseDefinition
                  value="http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot"/>
  <derivation value="specialization"/>
  <snapshot>
    <element id="id">
      <path value="id"/>
      <short value="ADHA CDA extension to represent the identifier"/>
      <definition
                  value="Australian Digital Health Agency CDA extension for identifier."/>
      <min value="1"/>
      <max value="*"/>
      <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="id.nullFlavor">
      <path value="id.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="id.realmCode">
      <path value="id.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="id.typeId">
      <path value="id.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="id.typeId.nullFlavor">
      <path value="id.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="id.typeId.assigningAuthorityName">
      <path value="id.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="id.typeId.displayable">
      <path value="id.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="id.typeId.root">
      <path value="id.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="id.typeId.extension">
      <path value="id.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="id.templateId">
      <path value="id.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="id.assigningAuthorityName">
      <path value="id.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 id 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="id.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="id.displayable">
      <path value="id.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="id.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="id.root">
      <path value="id.root"/>
      <representation value="xmlAttr"/>
      <label value="Root"/>
      <definition
                  value="A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier."/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="id.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>
    </element>
    <element id="id.extension">
      <path value="id.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="0"/>
      <max value="1"/>
      <base>
        <path value="id.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>
  </snapshot>
  <differential>
    <element id="id">
      <path value="id"/>
      <short value="ADHA CDA extension to represent the identifier"/>
      <definition
                  value="Australian Digital Health Agency CDA extension for identifier."/>
      <min value="1"/>
      <max value="*"/>
    </element>
    <element id="id.assigningAuthorityName">
      <path value="id.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 id 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"/>
      <type>
        <code value="string"/>
        <profile
                 value="http://hl7.org/cda/stds/core/StructureDefinition/st-simple"/>
      </type>
    </element>
    <element id="id.displayable">
      <path value="id.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"/>
      <type>
        <code value="boolean"/>
        <profile
                 value="http://hl7.org/cda/stds/core/StructureDefinition/bl-simple"/>
      </type>
    </element>
    <element id="id.root">
      <path value="id.root"/>
      <representation value="xmlAttr"/>
      <label value="Root"/>
      <definition
                  value="A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier."/>
      <min value="0"/>
      <max value="1"/>
      <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>
    </element>
    <element id="id.extension">
      <path value="id.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="0"/>
      <max value="1"/>
      <type>
        <code value="string"/>
        <profile
                 value="http://hl7.org/cda/stds/core/StructureDefinition/st-simple"/>
      </type>
    </element>
  </differential>
</StructureDefinition>