Ancestor: HL7Connect.Cda.ANY

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 usually defined based on ISO object identifiers.

An identifier allows someone to select one record, object or thing from a set of candidates. Usually an identifier alone without any context is not usable. Identifiers are distinguished from concept descriptors as concept descriptors never identify an individual thing, although there may sometimes be an individual record or object that represents the concept.

Information Processing Entities claiming direct or indirect conformance SHALL never assume that receiving applications can infer the identity of issuing authority or the type of the identifier from the identifier or components thereof

Properties

string root;
   A unique identifier that guarantees the global uniqueness of the instance identifier.

If root is populated, and there is no nullFlavor or extension, then the root is a globally unique identifier in it's own right. In the presence of a non-null extension, the root is the unique identifier for the "namespace" of the identifier in the extension. Note that this does NOT necessarily correlate with the organization that manages the issuing of the identifiers. A given organization may manage multiple identifier namespaces, and control over a given namespace may transfer from organization to organization over time while the root remains the same.

This field can be either a DCE UUID, an Object Identifier (OID), or a special identifier taken from lists that may be published by ISO or HL7.

Comparison of root values is always case sensitive. UUID's SHALL be represented in upper case, so UUID case should always be preserved.

The root SHALL not be used to carry semantic meaning - all it does is ensure global computational uniqueness

string extension;
   A character string as a unique identifier within the scope of the identifier root.

The root and extension scheme means that the concatenation of root and extension SHALL be a globally unique identifier for the item that this II value identifies.

Some identifier schemes define certain style options to their code values. For example, the U.S. Social Security Number (SSN) is normally written with dashes that group the digits into a pattern "123-12-1234". However, the dashes are not meaningful and a SSN can also be represented as "123121234" without the dashes. In the case where identifier schemes provide for multiple representations, HL7 or ISO may make a ruling about which is the preferred form and document that ruling where that respective external identifier scheme is recognized.

If no extension attribute is provided in a non-null II, then the root is the complete unique identifier. If the root is not a complete unique identifier, and the extension is not known, then the II SHALL have a nullFlavor even if the root is populated.

string identifierName;
   This is a human-readable name for the namespace represented in the root.

Note: It is a descriptive name for the actual namespace. e.g. "California, U.S. Driver's License Number, 1970-".

IdentifierName does NOT refer to the organization which issued the identifier (e.g. California Dept. of Motor Vehicles). It is intended for use as a human readable label when an identifier must be displayed to a human user where an OID would not be meaningful.

The Identifier Name has no computational value. IdentifierName can never modify the meaning of the root attribute. The purpose of the Identifer Name is to assist an unaided human interpreter of an II value to interpret the authority. Applications SHALL NOT attempt to perform any decision-making, matching, filtering or other processing based on the presence or value of this property. It is for display and development assistance only. All decision logic MUST be based solely on the root and extension properties. Information Processing Entities claiming direct or indirect conformance MAY choose not to implement identifierName but SHALL NOT reject instances because identifierName is present.

Note: In general, it should only be used when an extension is present, allowing for a display such as "California, U.S. Driver's License Number, 1970-: 123456789". There are absolutely no guidelines for the contents of this text other than it should be completely descriptive of the namespace. E.g. "Driver's License" or even "California Driver's License" would not be ideal. However, formatting, capitalization, whitepace, language, etc. are completely up to the sender.

bool displayable;
   If the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).

Information Processing Entities claiming direct or indirect conformance MAY choose not to implement displayable but SHALL NOT reject instances because displayable is present.

bool HasDisplayable;
   false if displayable is null, true if displayable is either true or false

Tv3IdentifierScope scope;
   The scope in which the identifier applies to the object with which it is associated.

If populated, the value of this attribute SHALL be taken from the HL7 IdentifierScope code system -- Possible scopes for an identifier

isNull

isBUSN : Business identifier : An identifier whose scope is defined by business practices associated with the object. In contrast to the other scope identifiers, the scope of the use of the id is not necessarily restricted to a single object, but may be reused for other objects closely associated with the object due to business practice

isOBJ : Object identifier : The identifier associated with a particular object. It remains consistent as the object undergoes state transitions

isVER : Version Identifier : An identifier that references a particular object as it existed at a given point in time.

The identifier SHALL change with each state transition on the object. I.e. The version identifier of an object prior to a 'suspend' state transition is distinct from the identifier of the object after the state transition. Each version identifier can be tied to exactly one ControlAct event which brought that version into being (though the control act may never be instantiated). NOTE: Applications that do not support versioning of objects must ignore and not persist these ids to avoid confusion resulting from leaving the same identifier on an object that undergoes changes

isVW : View specific identifier : An identifier for a particular snapshot of a version of the object.

This identifies a view of the business object at a particular point in time, and as such identifies a set of data items that can be digitally signed and/or attested. This is in contrast to the Version Identifier which identifies the object at a specific time, but not the amount of information being asserted about the object. This identifier would be changed when a transformation of the information is performed (eg to add code translations, to provide a simplified textual rendering, or to provide additional information about the object as it existed at the specific point in time)

Tv3IdentifierReliability reliability;
   The reliability with which this identifier is known. This attribute may be used to assist with identifier matching algorithms.

If populated, the value of this attribute SHALL be taken from the HL7 IdentifierReliability code system. -- Possible reliability markers for an identifier

irNull

irISS : Issued by system : The identifier was issued by the system responsible for constructing the instance

irVRF

irUNV : Unverified by system : The identifier was provided to the system that constructed the instance, but has not been verified. e.g. a Driver's licence entered manually into a system by a user


Methods


© Kestral Computing P/L 2000 - 2003. HL7Connect v2.00-063 generated on 30-Nov 2015.
Keywords: displayable, extension, HasDisplayable, identifierName, reliability, root, scope, II, HL7Connect.Cda.II