Package | au.digitalhealth.cda.schema |
Type | StructureDefinition |
Id | II |
FHIR Version | R5 |
Source | http://ns.electronichealth.net.au/cda/https://build.fhir.org/ig/AuDigitalHealth/cda-au-schema/StructureDefinition-II.html |
URL | http://hl7.org/cda/stds/core/StructureDefinition/II |
Version | 1.0.0 |
Status | active |
Date | 2025-07-21T22:05:27+00:00 |
Name | II |
Title | II: InstanceIdentifier (V3 Data Type) |
Realm | au |
Authority | national |
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. |
Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
Kind | logical |
StructureDefinition | |
Act | Act (CDA Class) |
AlternateIdentification | AlternateIdentification (CDA Class) |
AssignedAuthor | AssignedAuthor (CDA Class) |
AssignedEntity | AssignedEntity (CDA Class) |
AssociatedEntity | AssociatedEntity (CDA Class) |
ClinicalDocument | ClinicalDocument (CDA Class) |
Consent | Consent (CDA Class) |
Criterion | Criterion (CDA Class) |
CustodianOrganization | CustodianOrganization (CDA Class) |
EncompassingEncounter | EncompassingEncounter (CDA Class) |
Encounter | Encounter (CDA Class) |
Entity | Entity (CDA Class) |
ExternalAct | ExternalAct (CDA Class) |
ExternalDocument | ExternalDocument (CDA Class) |
ExternalObservation | ExternalObservation (CDA Class) |
ExternalProcedure | ExternalProcedure (CDA Class) |
Guardian | Guardian (CDA Class) |
HealthCareFacility | HealthCareFacility (CDA Class) |
InFulfillmentOf1 | InFulfillmentOf1 (CDA Class) |
InfrastructureRoot | InfrastructureRoot (Base Type for all CDA Classes) |
IntendedRecipient | IntendedRecipient (CDA Class) |
ManufacturedProduct | ManufacturedProduct (CDA Class) |
Observation | Observation (CDA Class) |
ObservationMedia | ObservationMedia (CDA Class) |
ObservationRange | ObservationRange (CDA Class) |
Order | Order (CDA Class) |
Organization | Organization (CDA Class) |
OrganizationPartOf | OrganizationPartOf (CDA Class) |
Organizer | Organizer (CDA Class) |
ParentDocument | ParentDocument (CDA Class) |
ParticipantRole | ParticipantRole (CDA Class) |
Patient | Patient (CDA Class) |
PatientRole | PatientRole (CDA Class) |
PolicyOrAccount | Agency extension PolicyOrAccount |
PreconditionBase | PreconditionBase (CDA Class) |
Procedure | Procedure (CDA Class) |
RegionOfInterest | RegionOfInterest (CDA Class) |
RelatedSubject | RelatedSubject (CDA Class) |
Section | Section (CDA Class) |
ServiceEvent | ServiceEvent (CDA Class) |
SpecimenRole | SpecimenRole (CDA Class) |
SubjectPerson | SubjectPerson (CDA Class) |
SubstanceAdministration | SubstanceAdministration (CDA Class) |
Supply | Supply (CDA Class) |
asIngredient | ADHA extension asIngredient |
asPersonalRelationship | ADHA extension asPersonalRelationship |
au-Act | ADHA Act (CDA Class) |
au-AssignedAuthor | ADHA AssignedAuthor (CDA Class) |
au-AssignedEntity | ADHA AssignedEntity (CDA Class) |
au-AssociatedEntity | ADHA AssociatedEntity (CDA Class) |
au-ClinicalDocument | ADHA ClinicalDocument (CDA Class) |
au-CustodianOrganization | ADHA CustodianOrganization (CDA Class) |
au-EncompassingEncounter | ADHA EncompassingEncounter (CDA Class) |
au-Encounter | ADHA Encounter (CDA Class) |
au-Entity | ADHA Entity (CDA Class) |
au-ExternalAct | ADHA ExternalAct (CDA Class) |
au-ExternalDocument | ADHA ExternalDocument (CDA Class) |
au-HealthCareFacility | ADHA HealthCareFacility (CDA Class) |
au-IntendedRecipient | ADHA IntendedRecipient (CDA Class) |
au-ManufacturedProduct | ADHA ManufacturedProduct (CDA Class) |
au-Observation | ADHA Observation (CDA Class) |
au-ObservationMedia | ADHA ObservationMedia (CDA Class) |
au-ObservationRange | ADHA ObservationRange (CDA Class) |
au-Order | ADHA Order (CDA Class) |
au-Organization | ADHA Organization (CDA Class) |
au-OrganizationPartOf | ADHA OrganizationPartOf (CDA Class) |
au-Organizer | ADHA Organizer (CDA Class) |
au-ParentDocument | ADHA ParentDocument (CDA Class) |
au-Patient | ADHA Patient (CDA Class) |
au-PatientRole | ADHA PatientRole (CDA Class) |
au-Procedure | ADHA Procedure (CDA Class) |
au-RegionOfInterest | ADHA RegionOfInterest (CDA Class) |
au-Section | ADHA Section (CDA Class) |
au-SpecimenRole | SpecimenRole (CDA Class) |
au-SubstanceAdministration | ADHA SubstanceAdministration (CDA Class) |
au-Supply | ADHA Supply (CDA Class) |
container | ADHA extension Container |
controlAct | ADHA extension controlAct |
employerOrganization | ADHA extension employerOrganization |
entitlement | ADHA extension entitlement |
ingredientManufacturedMaterial | ADHA extension ingredientManufacturedMaterial |
personalRelationship | ADHA extension personalRelationship |
policy | Agency extension policy |
DeviceIdentifierObservation | Device Identifier Observation |
2.16.840.1.113883.10.21.4.6--20230130093600 | UV Subordinate Substance Administration |
2.16.840.1.113883.10.22.1.2--20240802130239 | International Patient Summary |
2.16.840.1.113883.10.22.10--20180207120044 | IPS Allergy Certainty Observation |
2.16.840.1.113883.10.22.15--20240612085101 | IPS Alerts Section |
2.16.840.1.113883.10.22.16--20240612092602 | IPS Patient Story Section |
2.16.840.1.113883.10.22.3.1--20161111000000 | IPS Medication Summary Section |
2.16.840.1.113883.10.22.3.10--20200510185232 | IPS Social History Section |
2.16.840.1.113883.10.22.3.11--20200507184608 | IPS History of Pregnancy Section |
2.16.840.1.113883.10.22.3.12--20200508163849 | IPS Advance Directives Section |
2.16.840.1.113883.10.22.3.2--20240804100736 | IPS Allergies and Intolerances Section |
2.16.840.1.113883.10.22.3.3--20170215000000 | IPS Problems Section |
2.16.840.1.113883.10.22.3.4--20170327000000 | IPS History of Procedures Section |
2.16.840.1.113883.10.22.3.5--20170405000000 | IPS Immunizations Section |
2.16.840.1.113883.10.22.3.6--20211020171142 | IPS Medical Devices Section |
2.16.840.1.113883.10.22.3.7--20170412000000 | IPS History of Past Illness Section |
2.16.840.1.113883.10.22.3.8--20200508191737 | IPS Functional Status Section |
2.16.840.1.113883.10.22.3.9--20200508182838 | IPS Plan of Care Section |
2.16.840.1.113883.10.22.4.1--20240804094850 | IPS Allergy or Intolerance |
2.16.840.1.113883.10.22.4.10--20170302000000 | IPS Result Observation |
2.16.840.1.113883.10.22.4.11--20240804111042 | IPS Pathology Result Observation |
2.16.840.1.113883.10.22.4.12--20240804201800 | IPS Radiology Result Observation |
2.16.840.1.113883.10.22.4.13--20240804111020 | IPS Laboratory Result Observation |
2.16.840.1.113883.10.22.4.15--20240804212024 | IPS Immunization |
2.16.840.1.113883.10.22.4.16--20240804211600 | IPS Immunization Medication Information |
2.16.840.1.113883.10.22.4.17--20240804110835 | IPS Procedure Entry |
2.16.840.1.113883.10.22.4.18--20170327000000 | IPS Criticality Observation |
2.16.840.1.113883.10.22.4.19--20240610095919 | IPS Certainty Observation |
2.16.840.1.113883.10.22.4.20--20170329000000 | IPS Problem Status Observation |
2.16.840.1.113883.10.22.4.21--20170524000000 | IPS Allergy Status Observation |
2.16.840.1.113883.10.22.4.22--20170405000000 | IPS Comment Activity |
2.16.840.1.113883.10.22.4.23--20210902120216 | IPS ObservationMedia |
2.16.840.1.113883.10.22.4.25--20170407000000 | IPS Severity Observation |
2.16.840.1.113883.10.22.4.26--20170411000000 | IPS Medical Device |
2.16.840.1.113883.10.22.4.27--20200714163153 | IPS Pregnancy Status Observation |
2.16.840.1.113883.10.22.4.28--20170413000000 | IPS Pregnancy Outcome Observation |
2.16.840.1.113883.10.22.4.29--20240804110242 | IPS Pregnancy Expected Delivery Date Observation |
2.16.840.1.113883.10.22.4.30--20240804210307 | IPS Specimen Collection |
2.16.840.1.113883.10.22.4.31--20170502000000 | IPS Internal Reference |
2.16.840.1.113883.10.22.4.34--20170620000000 | IPS Social History Tobacco Use |
2.16.840.1.113883.10.22.4.35--20170629000000 | IPS Social History Alcohol Use |
2.16.840.1.113883.10.22.4.37--20200508162154 | IPS Advance Directive Observation |
2.16.840.1.113883.10.22.4.38--20200508173848 | IPS Planned Procedure |
2.16.840.1.113883.10.22.4.39--20220715135511 | IPS Planned Act |
2.16.840.1.113883.10.22.4.4--20240804104154 | IPS Medication Statement |
2.16.840.1.113883.10.22.4.40--20200508181838 | IPS Planned Encounter |
2.16.840.1.113883.10.22.4.41--20200508183442 | IPS Planned Observation |
2.16.840.1.113883.10.22.4.42--20200508190226 | IPS Survey Panel |
2.16.840.1.113883.10.22.4.43--20200508190511 | IPS Survey Observation |
2.16.840.1.113883.10.22.4.46--20200508161148 | IPS Advance Directive Organizer |
2.16.840.1.113883.10.22.4.47--20200508172918 | IPS Planned Immunization |
2.16.840.1.113883.10.22.4.48--20200510151616 | IPS Social History Observation |
2.16.840.1.113883.10.22.4.5--20240804100924 | IPS Allergy and Intolerance Concern |
2.16.840.1.113883.10.22.4.6--20240804101847 | IPS Reaction Manifestation |
2.16.840.1.113883.10.22.4.7--20210804084927 | IPS Problem Concern Entry |
2.16.840.1.113883.10.22.4.8--20240804110603 | IPS Problem Entry |
2.16.840.1.113883.10.22.4.9--20170302000000 | IPS Result Organizer |
StructureDefinition | |
ANY | ANY: DataValue (V3 Data Type) |
bl-simple | bl: Boolean |
oid | oid: ISO Object Identifier |
ruid | ruid: HL7 Reserved Identifier Scheme |
st-simple | st: Character String |
uuid | uuid: DCE Universal Unique Identifier |
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.
{ "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" ] } ] } ] } }