xdw v3 oasis

Element : II (XML Type: II )


Summary

Package : v3

XML Type : II

Comments : 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.


Generalization

Parent : ANY


Attributes
Name Type cardinality Comment
assigningAuthorityName
Attribute : assigningAuthorityName
java.lang.String 0...1 A human readable name or mnemonic for the assigning authority. This name may be provided solely for the convenience of unaided humans interpreting an II value and can have no computational meaning. Note: no automated processing must depend on the assigning authority name to be present in any form.
displayable
Attribute : displayable
boolean 0...1 Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
extension
Attribute : extension
java.lang.String 0...1 A character string as a unique identifier within the scope of the identifier root.
root
Attribute : root
java.lang.String 0...1 A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier.

Constraints

II

  • self.root <> self.extension

Schema declaration
<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="II">
      
<xs:annotation>
         
<xs:documentation>
            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.
         
</xs:documentation>
         
<xs:appinfo>
            
<sch:pattern xmlns:sch="http://www.ascc.net/xml/schematron" name="validate II">
               
<sch:rule abstract="true" id="rule-II">
                  
<sch:report test="(@root or @nullFlavor) and not(@root and @nullFlavor)">
                     A root component is required or else the II value is NULL.
                  
</sch:report>
               
</sch:rule>
            
</sch:pattern>
         
</xs:appinfo>
      
</xs:annotation>
      
<xs:complexContent>
         
<xs:extension base="ANY">
            
<xs:attribute name="root" type="uid" use="optional">
               
<xs:annotation>
                  
<xs:documentation>
                     A unique identifier that guarantees the global uniqueness
                     of the instance identifier. The root alone may be the
                     entire instance identifier.
                  
</xs:documentation>
               
</xs:annotation>
            
</xs:attribute>
            
<xs:attribute name="extension" type="st" use="optional">
               
<xs:annotation>
                  
<xs:documentation>
                     A character string as a unique identifier within the
                     scope of the identifier root.
                  
</xs:documentation>
               
</xs:annotation>
            
</xs:attribute>
            
<xs:attribute name="assigningAuthorityName" type="st" use="optional">
               
<xs:annotation>
                  
<xs:documentation>
                     A human readable name or mnemonic for the assigning
                     authority. This name may be provided solely for the
                     convenience of unaided humans interpreting an II value
                     and can have no computational meaning. Note: no
                     automated processing must depend on the assigning
                     authority name to be present in any form.
                  
</xs:documentation>
               
</xs:annotation>
            
</xs:attribute>
            
<xs:attribute name="displayable" type="bl" use="optional">
               
<xs:annotation>
                  
<xs:documentation>
                     Specifies if the identifier is intended for human
                     display and data entry (displayable = true) as
                     opposed to pure machine interoperation (displayable
                     = false).
                  
</xs:documentation>
               
</xs:annotation>
            
</xs:attribute>
         
</xs:extension>
      
</xs:complexContent>
   
</xs:complexType>