II
type: StructureDefinition
node role: treeRoot
id:
  v: II
text:
  status:
    v: generated
  div: 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.
extension:
  url:
    v: http://hl7.org/fhir/tools/StructureDefinition/logical-target
  value: boolean
    extension:
      url:
        v: http://hl7.org/fhir/StructureDefinition/data-absent-reason
      value: code
        v: not-applicable
extension:
  url:
    v: http://hl7.org/fhir/tools/StructureDefinition/xml-namespace
  value: uri
    v: urn:hl7-org:v3
extension:
  url:
    v: http://hl7.org/fhir/tools/StructureDefinition/logical-container
  value: uri
    v: http://hl7.org/cda/stds/core/StructureDefinition/ClinicalDocument
url:
  v: http://hl7.org/cda/stds/core/StructureDefinition/II
version:
  v: 1.0.1
name:
  v: II
title:
  v: II: InstanceIdentifier (V3 Data Type)
status:
  v: active
experimental:
  v: false
date:
  v: 2025-10-10T09:58:30+10:00
publisher:
  v: HL7
description:
  v: 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.
fhir version:
  v: 5.0.0
mapping:
  identity:
    v: rim
  uri:
    v: http://hl7.org/v3
  name:
    v: RIM Mapping
kind:
  v: logical
abstract:
  v: false
type:
  v: http://hl7.org/cda/stds/core/StructureDefinition/II
base definition:
  v: http://hl7.org/cda/stds/core/StructureDefinition/ANY
  link: http://hl7.org/cda/stds/core/StructureDefinition/ANY
derivation:
  v: specialization
snapshot:
  extension:
    url:
      v: http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version
    value: string
      v: 1.0.1
  element:
    id:
      v: II
    path:
      v: II
    short:
      v: Base for all types and resources
    definition:
      v: 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.
    min:
      v: 1
    max:
      v: *
    base:
      path:
        v: Base
      min:
        v: 0
      max:
        v: *
    constraint:
      key:
        v: II-1
      severity:
        v: error
      human:
        v: An II instance must have either a root or an nullFlavor.
      expression:
        v: root.exists() or nullFlavor.exists()
    is modifier:
      v: false
    mapping:
      identity:
        v: rim
      map:
        v: n/a
  element:
    id:
      v: II.nullFlavor
    path:
      v: II.nullFlavor
    representation:
      v: xmlAttr
    label:
      v: Exceptional Value Detail
    definition:
      v: If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
    min:
      v: 0
    max:
      v: 1
    base:
      path:
        v: ANY.nullFlavor
      min:
        v: 0
      max:
        v: 1
    type:
      code:
        v: code
      profile:
        v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
        link: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    binding:
      strength:
        v: required
      value set:
        v: http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
        link: http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
  element:
    id:
      v: II.assigningAuthorityName
    path:
      v: II.assigningAuthorityName
    representation:
      v: xmlAttr
    label:
      v: Assigning Authority Name
    definition:
      v: 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:
      v: 0
    max:
      v: 1
    base:
      path:
        v: II.assigningAuthorityName
      min:
        v: 0
      max:
        v: 1
    type:
      code:
        v: string
      profile:
        v: http://hl7.org/cda/stds/core/StructureDefinition/st-simple
        link: http://hl7.org/cda/stds/core/StructureDefinition/st-simple
  element:
    id:
      v: II.displayable
    path:
      v: II.displayable
    representation:
      v: xmlAttr
    label:
      v: Displayable
    definition:
      v: Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
    min:
      v: 0
    max:
      v: 1
    base:
      path:
        v: II.displayable
      min:
        v: 0
      max:
        v: 1
    type:
      code:
        v: boolean
      profile:
        v: http://hl7.org/cda/stds/core/StructureDefinition/bl-simple
        link: http://hl7.org/cda/stds/core/StructureDefinition/bl-simple
  element:
    id:
      v: II.root
    path:
      v: II.root

v: xmlAttr

v: Root

v: A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier.

v: 0

v: 1

path:
  v: II.root
min:
  v: 0
max:
  v: 1

code:
  v: string
profile:
  v: http://hl7.org/cda/stds/core/StructureDefinition/oid
  link: http://hl7.org/cda/stds/core/StructureDefinition/oid
profile:
  v: http://hl7.org/cda/stds/core/StructureDefinition/uuid
  link: http://hl7.org/cda/stds/core/StructureDefinition/uuid
profile:
  v: http://hl7.org/cda/stds/core/StructureDefinition/ruid
  link: http://hl7.org/cda/stds/core/StructureDefinition/ruid

id:
  v: II.extension
path:
  v: II.extension
representation:
  v: xmlAttr
label:
  v: Extension
definition:
  v: A character string as a unique identifier within the scope of the identifier root.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: II.extension
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/st-simple
    link: http://hl7.org/cda/stds/core/StructureDefinition/st-simple

element:
  id:
    v: II
  path:
    v: II
  definition:
    v: 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.
  min:
    v: 1
  max:
    v: *
  constraint:
    key:
      v: II-1
    severity:
      v: error
    human:
      v: An II instance must have either a root or an nullFlavor.
    expression:
      v: root.exists() or nullFlavor.exists()
element:
  id:
    v: II.assigningAuthorityName
  path:
    v: II.assigningAuthorityName
  representation:
    v: xmlAttr
  label:
    v: Assigning Authority Name
  definition:
    v: 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:
    v: 0
  max:
    v: 1
  type:
    code:
      v: string
    profile:
      v: http://hl7.org/cda/stds/core/StructureDefinition/st-simple
      link: http://hl7.org/cda/stds/core/StructureDefinition/st-simple
element:
  id:
    v: II.displayable
  path:
    v: II.displayable
  representation:
    v: xmlAttr
  label:
    v: Displayable
  definition:
    v: Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
  min:
    v: 0
  max:
    v: 1
  type:
    code:
      v: boolean
    profile:
      v: http://hl7.org/cda/stds/core/StructureDefinition/bl-simple
      link: http://hl7.org/cda/stds/core/StructureDefinition/bl-simple
element:
  id:
    v: II.root
  path:
    v: II.root
  representation:
    v: xmlAttr
  label:
    v: Root
  definition:
    v: A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier.
  min:
    v: 0
  max:
    v: 1
  type:
    code:
      v: string
    profile:
      v: http://hl7.org/cda/stds/core/StructureDefinition/oid
      link: http://hl7.org/cda/stds/core/StructureDefinition/oid
    profile:
      v: http://hl7.org/cda/stds/core/StructureDefinition/uuid
      link: http://hl7.org/cda/stds/core/StructureDefinition/uuid
    profile:
      v: http://hl7.org/cda/stds/core/StructureDefinition/ruid
      link: http://hl7.org/cda/stds/core/StructureDefinition/ruid
element:
  id:
    v: II.extension
  path:
    v: II.extension
  representation:
    v: xmlAttr
  label:
    v: Extension
  definition:
    v: A character string as a unique identifier within the scope of the identifier root.
  min:
    v: 0
  max:
    v: 1
  type:
    code:
      v: string
    profile:
      v: http://hl7.org/cda/stds/core/StructureDefinition/st-simple
      link: http://hl7.org/cda/stds/core/StructureDefinition/st-simple