STU 3 Candidate

This page is part of the FHIR Specification (v1.4.0: STU 3 Ballot 3). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

Ccda/II.xml

Raw XML (canonical form)

Logical Model V3 Data type II (InstanceIdentifier)

<StructureDefinition xmlns="http://hl7.org/fhir">
  <id value="II"/>
  <extension url="http://www.healthintersections.com.au/fhir/StructureDefinition/extension-namespace">
    <valueUri value="urn:hl7-org:v3"/>
  </extension>
  <url value="http://hl7.org/fhir/StructureDefinition/II"/>
  <name value="V3 Data type II (InstanceIdentifier)"/>
  <display value="V3 Data type II (InstanceIdentifier)"/>
  <status value="active"/>
  <experimental value="false"/>
  <publisher value="HL7"/>
  <description value="An 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."/>
  <kind value="logical"/>
  <abstract value="false"/>
  <baseDefinition value="http://hl7.org/fhir/StructureDefinition/ANY"/>
  <snapshot>
    <element>
      <path value="II"/>
      <min value="1"/>
      <max value="*"/>
      <type>
        <code value="Element"/>
      </type>
    </element>
    <element>
      <path value="II.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"/>
      <type>
        <code value="code"/>
      </type>
      <binding>
        <strength value="required"/>
        <valueSetReference>
          <reference value="http://hl7.org/fhir/ValueSet/v3-NullFlavor"/>
        </valueSetReference>
      </binding>
    </element>
    <element>
      <path value="II.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"/>
      </type>
    </element>
    <element>
      <path value="II.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"/>
      </type>
    </element>
    <element>
      <path value="II.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"/>
      <type>
        <code value="string"/>
      </type>
    </element>
    <element>
      <path value="II.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"/>
      </type>
    </element>
  </snapshot>
  <differential>
    <element>
      <path value="II"/>
      <min value="1"/>
      <max value="*"/>
      <type>
        <code value="Element"/>
      </type>
    </element>
    <element>
      <path value="II.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"/>
      </type>
    </element>
    <element>
      <path value="II.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"/>
      </type>
    </element>
    <element>
      <path value="II.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"/>
      <type>
        <code value="string"/>
      </type>
    </element>
    <element>
      <path value="II.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"/>
      </type>
    </element>
  </differential>
</StructureDefinition>

Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.