This page is part of the CDA: Clinical Document Architecture (v2.0.1-sd: CDA 2.0 - Informative) generated with FHIR (HL7® FHIR® Standard) v5.0.0. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

• Content
• Detailed Descriptions
• Mappings
• XML
• JSON

Logical Model: II: InstanceIdentifier (V3 Data Type)

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.

Usage:

• Use this Logical Model Profile: Act (CDA Class), AlternateIdentification (CDA Class), AssignedAuthor (CDA Class), AssignedEntity (CDA Class)... Show 39 more, AssociatedEntity (CDA Class), ClinicalDocument (CDA Class), Consent (CDA Class), Criterion (CDA Class), CustodianOrganization (CDA Class), EncompassingEncounter (CDA Class), Encounter (CDA Class), Entity (CDA Class), ExternalAct (CDA Class), ExternalDocument (CDA Class), ExternalObservation (CDA Class), ExternalProcedure (CDA Class), Guardian (CDA Class), HealthCareFacility (CDA Class), InFulfillmentOf1 (CDA Class), InfrastructureRoot (Base Type for all CDA Classes), IntendedRecipient (CDA Class), ManufacturedProduct (CDA Class), Observation (CDA Class), ObservationMedia (CDA Class), ObservationRange (CDA Class), Order (CDA Class), Organization (CDA Class), OrganizationPartOf (CDA Class), Organizer (CDA Class), ParentDocument (CDA Class), ParticipantRole (CDA Class), Patient (CDA Class), PatientRole (CDA Class), PreconditionBase (CDA Class), Procedure (CDA Class), RegionOfInterest (CDA Class), RelatedSubject (CDA Class), Section (CDA Class), ServiceEvent (CDA Class), SpecimenRole (CDA Class), SubjectPerson (CDA Class), SubstanceAdministration (CDA Class) and Supply (CDA Class)

Formal Views of Template Content

Description of Template, Differentials, Snapshots and how the different presentations work.

• Key Elements Table
• Differential Table
• Snapshot Table
• Statistics/References
• All

This structure is derived from ANY

Name	Flags	Card.	Type	Description & Constraints
II	C	1..*	ANY	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor Base for all types and resources Logical Container: ClinicalDocument (CDA Class) II-1: An II instance must have either a root or an nullFlavor.
@assigningAuthorityName		0..1	st
@displayable		0..1	bl
@root		0..1	oid, uuid, ruid
@extension		0..1	st
Documentation for this format

Constraints

Id	Grade	Path(s)	Details	Requirements
II-1	error	II	An II instance must have either a root or an nullFlavor. : root.exists() or nullFlavor.exists()

Name	Flags	Card.	Type	Description & Constraints
II	C	1..*	ANY	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor Base for all types and resources Logical Container: ClinicalDocument (CDA Class) II-1: An II instance must have either a root or an nullFlavor.
@nullFlavor		0..1	cs	Binding: CDANullFlavor (required)
@assigningAuthorityName		0..1	st
@displayable		0..1	bl
@root		0..1	oid, uuid, ruid
@extension		0..1	st
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
II.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor from this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
II-1	error	II	An II instance must have either a root or an nullFlavor. : root.exists() or nullFlavor.exists()

Name	Flags	Card.	Type	Description & Constraints
II	C	1..*	ANY	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor Base for all types and resources Logical Container: ClinicalDocument (CDA Class) II-1: An II instance must have either a root or an nullFlavor.
@nullFlavor		0..1	cs	Binding: CDANullFlavor (required)
@assigningAuthorityName		0..1	st
@displayable		0..1	bl
@root		0..1	oid, uuid, ruid
@extension		0..1	st
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
II.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor from this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
II-1	error	II	An II instance must have either a root or an nullFlavor. : root.exists() or nullFlavor.exists()

This structure is derived from ANY

Summary

Structures

This structure refers to these other structures:

• st: Character String (http://hl7.org/cda/stds/core/StructureDefinition/st-simple)
• bl: Boolean (http://hl7.org/cda/stds/core/StructureDefinition/bl-simple)
• oid: ISO Object Identifier (http://hl7.org/cda/stds/core/StructureDefinition/oid)
• uuid: DCE Universal Unique Identifier (http://hl7.org/cda/stds/core/StructureDefinition/uuid)
• ruid: HL7 Reserved Identifier Scheme (http://hl7.org/cda/stds/core/StructureDefinition/ruid)

Extensions

This structure refers to these extensions:

• http://hl7.org/cda/stds/core/StructureDefinition/st-simple

Differential View

This structure is derived from ANY

Name	Flags	Card.	Type	Description & Constraints
II	C	1..*	ANY	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor Base for all types and resources Logical Container: ClinicalDocument (CDA Class) II-1: An II instance must have either a root or an nullFlavor.
@assigningAuthorityName		0..1	st
@displayable		0..1	bl
@root		0..1	oid, uuid, ruid
@extension		0..1	st
Documentation for this format

Constraints

Id	Grade	Path(s)	Details	Requirements
II-1	error	II	An II instance must have either a root or an nullFlavor. : root.exists() or nullFlavor.exists()

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
II	C	1..*	ANY	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor Base for all types and resources Logical Container: ClinicalDocument (CDA Class) II-1: An II instance must have either a root or an nullFlavor.
@nullFlavor		0..1	cs	Binding: CDANullFlavor (required)
@assigningAuthorityName		0..1	st
@displayable		0..1	bl
@root		0..1	oid, uuid, ruid
@extension		0..1	st
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
II.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor from this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
II-1	error	II	An II instance must have either a root or an nullFlavor. : root.exists() or nullFlavor.exists()

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
II	C	1..*	ANY	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor Base for all types and resources Logical Container: ClinicalDocument (CDA Class) II-1: An II instance must have either a root or an nullFlavor.
@nullFlavor		0..1	cs	Binding: CDANullFlavor (required)
@assigningAuthorityName		0..1	st
@displayable		0..1	bl
@root		0..1	oid, uuid, ruid
@extension		0..1	st
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
II.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor from this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
II-1	error	II	An II instance must have either a root or an nullFlavor. : root.exists() or nullFlavor.exists()

This structure is derived from ANY

Summary

Structures

This structure refers to these other structures:

• st: Character String (http://hl7.org/cda/stds/core/StructureDefinition/st-simple)
• bl: Boolean (http://hl7.org/cda/stds/core/StructureDefinition/bl-simple)
• oid: ISO Object Identifier (http://hl7.org/cda/stds/core/StructureDefinition/oid)
• uuid: DCE Universal Unique Identifier (http://hl7.org/cda/stds/core/StructureDefinition/uuid)
• ruid: HL7 Reserved Identifier Scheme (http://hl7.org/cda/stds/core/StructureDefinition/ruid)

Extensions

This structure refers to these extensions:

• http://hl7.org/cda/stds/core/StructureDefinition/st-simple

Other representations of profile: CSV, Excel