FHIR © HL7.org  |  Server Home  |  XIG Home  |  Server Source  |  FHIR  

FHIR IG Statistics: StructureDefinition/II

Packageau.digitalhealth.cda.schema
TypeStructureDefinition
IdII
FHIR VersionR5
Sourcehttp://ns.electronichealth.net.au/cda/https://build.fhir.org/ig/AuDigitalHealth/cda-au-schema/StructureDefinition-II.html
URLhttp://hl7.org/cda/stds/core/StructureDefinition/II
Version1.0.0
Statusactive
Date2025-07-21T22:05:27+00:00
NameII
TitleII: InstanceIdentifier (V3 Data Type)
Realmau
Authoritynational
DescriptionAn 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.
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
Kindlogical

Resources that use this resource

StructureDefinition
ActAct (CDA Class)
AlternateIdentificationAlternateIdentification (CDA Class)
AssignedAuthorAssignedAuthor (CDA Class)
AssignedEntityAssignedEntity (CDA Class)
AssociatedEntityAssociatedEntity (CDA Class)
ClinicalDocumentClinicalDocument (CDA Class)
ConsentConsent (CDA Class)
CriterionCriterion (CDA Class)
CustodianOrganizationCustodianOrganization (CDA Class)
EncompassingEncounterEncompassingEncounter (CDA Class)
EncounterEncounter (CDA Class)
EntityEntity (CDA Class)
ExternalActExternalAct (CDA Class)
ExternalDocumentExternalDocument (CDA Class)
ExternalObservationExternalObservation (CDA Class)
ExternalProcedureExternalProcedure (CDA Class)
GuardianGuardian (CDA Class)
HealthCareFacilityHealthCareFacility (CDA Class)
InFulfillmentOf1InFulfillmentOf1 (CDA Class)
InfrastructureRootInfrastructureRoot (Base Type for all CDA Classes)
IntendedRecipientIntendedRecipient (CDA Class)
ManufacturedProductManufacturedProduct (CDA Class)
ObservationObservation (CDA Class)
ObservationMediaObservationMedia (CDA Class)
ObservationRangeObservationRange (CDA Class)
OrderOrder (CDA Class)
OrganizationOrganization (CDA Class)
OrganizationPartOfOrganizationPartOf (CDA Class)
OrganizerOrganizer (CDA Class)
ParentDocumentParentDocument (CDA Class)
ParticipantRoleParticipantRole (CDA Class)
PatientPatient (CDA Class)
PatientRolePatientRole (CDA Class)
PolicyOrAccountAgency extension PolicyOrAccount
PreconditionBasePreconditionBase (CDA Class)
ProcedureProcedure (CDA Class)
RegionOfInterestRegionOfInterest (CDA Class)
RelatedSubjectRelatedSubject (CDA Class)
SectionSection (CDA Class)
ServiceEventServiceEvent (CDA Class)
SpecimenRoleSpecimenRole (CDA Class)
SubjectPersonSubjectPerson (CDA Class)
SubstanceAdministrationSubstanceAdministration (CDA Class)
SupplySupply (CDA Class)
asIngredientADHA extension asIngredient
asPersonalRelationshipADHA extension asPersonalRelationship
au-ActADHA Act (CDA Class)
au-AssignedAuthorADHA AssignedAuthor (CDA Class)
au-AssignedEntityADHA AssignedEntity (CDA Class)
au-AssociatedEntityADHA AssociatedEntity (CDA Class)
au-ClinicalDocumentADHA ClinicalDocument (CDA Class)
au-CustodianOrganizationADHA CustodianOrganization (CDA Class)
au-EncompassingEncounterADHA EncompassingEncounter (CDA Class)
au-EncounterADHA Encounter (CDA Class)
au-EntityADHA Entity (CDA Class)
au-ExternalActADHA ExternalAct (CDA Class)
au-ExternalDocumentADHA ExternalDocument (CDA Class)
au-HealthCareFacilityADHA HealthCareFacility (CDA Class)
au-IntendedRecipientADHA IntendedRecipient (CDA Class)
au-ManufacturedProductADHA ManufacturedProduct (CDA Class)
au-ObservationADHA Observation (CDA Class)
au-ObservationMediaADHA ObservationMedia (CDA Class)
au-ObservationRangeADHA ObservationRange (CDA Class)
au-OrderADHA Order (CDA Class)
au-OrganizationADHA Organization (CDA Class)
au-OrganizationPartOfADHA OrganizationPartOf (CDA Class)
au-OrganizerADHA Organizer (CDA Class)
au-ParentDocumentADHA ParentDocument (CDA Class)
au-PatientADHA Patient (CDA Class)
au-PatientRoleADHA PatientRole (CDA Class)
au-ProcedureADHA Procedure (CDA Class)
au-RegionOfInterestADHA RegionOfInterest (CDA Class)
au-SectionADHA Section (CDA Class)
au-SpecimenRoleSpecimenRole (CDA Class)
au-SubstanceAdministrationADHA SubstanceAdministration (CDA Class)
au-SupplyADHA Supply (CDA Class)
containerADHA extension Container
controlActADHA extension controlAct
employerOrganizationADHA extension employerOrganization
entitlementADHA extension entitlement
ingredientManufacturedMaterialADHA extension ingredientManufacturedMaterial
personalRelationshipADHA extension personalRelationship
policyAgency extension policy
DeviceIdentifierObservationDevice Identifier Observation
2.16.840.1.113883.10.21.4.6--20230130093600UV Subordinate Substance Administration
2.16.840.1.113883.10.22.1.2--20240802130239International Patient Summary
2.16.840.1.113883.10.22.10--20180207120044IPS Allergy Certainty Observation
2.16.840.1.113883.10.22.15--20240612085101IPS Alerts Section
2.16.840.1.113883.10.22.16--20240612092602IPS Patient Story Section
2.16.840.1.113883.10.22.3.1--20161111000000IPS Medication Summary Section
2.16.840.1.113883.10.22.3.10--20200510185232IPS Social History Section
2.16.840.1.113883.10.22.3.11--20200507184608IPS History of Pregnancy Section
2.16.840.1.113883.10.22.3.12--20200508163849IPS Advance Directives Section
2.16.840.1.113883.10.22.3.2--20240804100736IPS Allergies and Intolerances Section
2.16.840.1.113883.10.22.3.3--20170215000000IPS Problems Section
2.16.840.1.113883.10.22.3.4--20170327000000IPS History of Procedures Section
2.16.840.1.113883.10.22.3.5--20170405000000IPS Immunizations Section
2.16.840.1.113883.10.22.3.6--20211020171142IPS Medical Devices Section
2.16.840.1.113883.10.22.3.7--20170412000000IPS History of Past Illness Section
2.16.840.1.113883.10.22.3.8--20200508191737IPS Functional Status Section
2.16.840.1.113883.10.22.3.9--20200508182838IPS Plan of Care Section
2.16.840.1.113883.10.22.4.1--20240804094850IPS Allergy or Intolerance
2.16.840.1.113883.10.22.4.10--20170302000000IPS Result Observation
2.16.840.1.113883.10.22.4.11--20240804111042IPS Pathology Result Observation
2.16.840.1.113883.10.22.4.12--20240804201800IPS Radiology Result Observation
2.16.840.1.113883.10.22.4.13--20240804111020IPS Laboratory Result Observation
2.16.840.1.113883.10.22.4.15--20240804212024IPS Immunization
2.16.840.1.113883.10.22.4.16--20240804211600IPS Immunization Medication Information
2.16.840.1.113883.10.22.4.17--20240804110835IPS Procedure Entry
2.16.840.1.113883.10.22.4.18--20170327000000IPS Criticality Observation
2.16.840.1.113883.10.22.4.19--20240610095919IPS Certainty Observation
2.16.840.1.113883.10.22.4.20--20170329000000IPS Problem Status Observation
2.16.840.1.113883.10.22.4.21--20170524000000IPS Allergy Status Observation
2.16.840.1.113883.10.22.4.22--20170405000000IPS Comment Activity
2.16.840.1.113883.10.22.4.23--20210902120216IPS ObservationMedia
2.16.840.1.113883.10.22.4.25--20170407000000IPS Severity Observation
2.16.840.1.113883.10.22.4.26--20170411000000IPS Medical Device
2.16.840.1.113883.10.22.4.27--20200714163153IPS Pregnancy Status Observation
2.16.840.1.113883.10.22.4.28--20170413000000IPS Pregnancy Outcome Observation
2.16.840.1.113883.10.22.4.29--20240804110242IPS Pregnancy Expected Delivery Date Observation
2.16.840.1.113883.10.22.4.30--20240804210307IPS Specimen Collection
2.16.840.1.113883.10.22.4.31--20170502000000IPS Internal Reference
2.16.840.1.113883.10.22.4.34--20170620000000IPS Social History Tobacco Use
2.16.840.1.113883.10.22.4.35--20170629000000IPS Social History Alcohol Use
2.16.840.1.113883.10.22.4.37--20200508162154IPS Advance Directive Observation
2.16.840.1.113883.10.22.4.38--20200508173848IPS Planned Procedure
2.16.840.1.113883.10.22.4.39--20220715135511IPS Planned Act
2.16.840.1.113883.10.22.4.4--20240804104154IPS Medication Statement
2.16.840.1.113883.10.22.4.40--20200508181838IPS Planned Encounter
2.16.840.1.113883.10.22.4.41--20200508183442IPS Planned Observation
2.16.840.1.113883.10.22.4.42--20200508190226IPS Survey Panel
2.16.840.1.113883.10.22.4.43--20200508190511IPS Survey Observation
2.16.840.1.113883.10.22.4.46--20200508161148IPS Advance Directive Organizer
2.16.840.1.113883.10.22.4.47--20200508172918IPS Planned Immunization
2.16.840.1.113883.10.22.4.48--20200510151616IPS Social History Observation
2.16.840.1.113883.10.22.4.5--20240804100924IPS Allergy and Intolerance Concern
2.16.840.1.113883.10.22.4.6--20240804101847IPS Reaction Manifestation
2.16.840.1.113883.10.22.4.7--20210804084927IPS Problem Concern Entry
2.16.840.1.113883.10.22.4.8--20240804110603IPS Problem Entry
2.16.840.1.113883.10.22.4.9--20170302000000IPS Result Organizer

Resources that this resource uses

StructureDefinition
ANYANY: DataValue (V3 Data Type)
bl-simplebl: Boolean
oidoid: ISO Object Identifier
ruidruid: HL7 Reserved Identifier Scheme
st-simplest: Character String
uuiduuid: DCE Universal Unique Identifier

Narrative

Note: links and images are rebased to the (stated) source

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.


Source

{
  "resourceType": "StructureDefinition",
  "id": "II",
  "text": {
    "status": "generated",
    "div": "<!-- snip (see above) -->"
  },
  "extension": [
    {
      "url": "http://hl7.org/fhir/tools/StructureDefinition/logical-target",
      "_valueBoolean": {
        "extension": [
          {
            "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason",
            "valueCode": "not-applicable"
          }
        ]
      }
    },
    {
      "url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
      "valueUri": "urn:hl7-org:v3"
    },
    {
      "url": "http://hl7.org/fhir/tools/StructureDefinition/logical-container",
      "valueUri": "http://hl7.org/cda/stds/core/StructureDefinition/ClinicalDocument"
    }
  ],
  "url": "http://hl7.org/cda/stds/core/StructureDefinition/II",
  "version": "1.0.0",
  "name": "II",
  "title": "II: InstanceIdentifier (V3 Data Type)",
  "status": "active",
  "experimental": false,
  "date": "2025-07-21T22:05:27+00:00",
  "publisher": "HL7",
  "description": "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.",
  "fhirVersion": "5.0.0",
  "mapping": [
    {
      "identity": "rim",
      "uri": "http://hl7.org/v3",
      "name": "RIM Mapping"
    }
  ],
  "kind": "logical",
  "abstract": false,
  "type": "http://hl7.org/cda/stds/core/StructureDefinition/II",
  "baseDefinition": "http://hl7.org/cda/stds/core/StructureDefinition/ANY",
  "derivation": "specialization",
  "snapshot": {
    "extension": [
      {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
        "valueString": "1.0.0"
      }
    ],
    "element": [
      {
        "id": "II",
        "path": "II",
        "short": "Base for all types and resources",
        "definition": "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": 1,
        "max": "*",
        "base": {
          "path": "Base",
          "min": 0,
          "max": "*"
        },
        "constraint": [
          {
            "key": "II-1",
            "severity": "error",
            "human": "An II instance must have either a root or an nullFlavor.",
            "expression": "root.exists() or nullFlavor.exists()"
          }
        ],
        "isModifier": false,
        "mapping": [
          {
            "identity": "rim",
            "map": "n/a"
          }
        ]
      },
      {
        "id": "II.nullFlavor",
        "path": "II.nullFlavor",
        "representation": [
          "xmlAttr"
        ],
        "label": "Exceptional Value Detail",
        "definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
        "min": 0,
        "max": "1",
        "base": {
          "path": "ANY.nullFlavor",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "code",
            "profile": [
              "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
            ]
          }
        ],
        "binding": {
          "strength": "required",
          "valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
        }
      },
      {
        "id": "II.assigningAuthorityName",
        "path": "II.assigningAuthorityName",
        "representation": [
          "xmlAttr"
        ],
        "label": "Assigning Authority Name",
        "definition": "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": 0,
        "max": "1",
        "base": {
          "path": "II.assigningAuthorityName",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "string",
            "profile": [
              "http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
            ]
          }
        ]
      },
      {
        "id": "II.displayable",
        "path": "II.displayable",
        "representation": [
          "xmlAttr"
        ],
        "label": "Displayable",
        "definition": "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
        "min": 0,
        "max": "1",
        "base": {
          "path": "II.displayable",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "boolean",
            "profile": [
              "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple"
            ]
          }
        ]
      },
      {
        "id": "II.root",
        "path": "II.root",
        "representation": [
          "xmlAttr"
        ],
        "label": "Root",
        "definition": "A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier.",
        "min": 0,
        "max": "1",
        "base": {
          "path": "II.root",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "string",
            "profile": [
              "http://hl7.org/cda/stds/core/StructureDefinition/oid",
              "http://hl7.org/cda/stds/core/StructureDefinition/uuid",
              "http://hl7.org/cda/stds/core/StructureDefinition/ruid"
            ]
          }
        ]
      },
      {
        "id": "II.extension",
        "path": "II.extension",
        "representation": [
          "xmlAttr"
        ],
        "label": "Extension",
        "definition": "A character string as a unique identifier within the scope of the identifier root.",
        "min": 0,
        "max": "1",
        "base": {
          "path": "II.extension",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "string",
            "profile": [
              "http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
            ]
          }
        ]
      }
    ]
  },
  "differential": {
    "element": [
      {
        "id": "II",
        "path": "II",
        "definition": "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": 1,
        "max": "*",
        "constraint": [
          {
            "key": "II-1",
            "severity": "error",
            "human": "An II instance must have either a root or an nullFlavor.",
            "expression": "root.exists() or nullFlavor.exists()"
          }
        ]
      },
      {
        "id": "II.assigningAuthorityName",
        "path": "II.assigningAuthorityName",
        "representation": [
          "xmlAttr"
        ],
        "label": "Assigning Authority Name",
        "definition": "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": 0,
        "max": "1",
        "type": [
          {
            "code": "string",
            "profile": [
              "http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
            ]
          }
        ]
      },
      {
        "id": "II.displayable",
        "path": "II.displayable",
        "representation": [
          "xmlAttr"
        ],
        "label": "Displayable",
        "definition": "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "boolean",
            "profile": [
              "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple"
            ]
          }
        ]
      },
      {
        "id": "II.root",
        "path": "II.root",
        "representation": [
          "xmlAttr"
        ],
        "label": "Root",
        "definition": "A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "string",
            "profile": [
              "http://hl7.org/cda/stds/core/StructureDefinition/oid",
              "http://hl7.org/cda/stds/core/StructureDefinition/uuid",
              "http://hl7.org/cda/stds/core/StructureDefinition/ruid"
            ]
          }
        ]
      },
      {
        "id": "II.extension",
        "path": "II.extension",
        "representation": [
          "xmlAttr"
        ],
        "label": "Extension",
        "definition": "A character string as a unique identifier within the scope of the identifier root.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "string",
            "profile": [
              "http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
            ]
          }
        ]
      }
    ]
  }
}