Common Components FHIR Implementation Guide, published by Australian Digital Health Agency. This guide is not an authorized publication; it is the continuous build for version 26.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/AuDigitalHealth/common-components/ and changes regularly. See the Directory of published versions

Data Type Profile: CDA Instance Identifier

Official URL: http://digitalhealth.gov.au/fhir/cc/StructureDefinition/cda-instance-identifier Version: 26.0.0
Draft as of 2026-10-16 Computable Name: CDA_Instance_Identifier

Copyright/Legal: This content is licensed under a Creative Commons Attribution 4.0 International License. See https://creativecommons.org/licenses/by/4.0/

Identifier datatype profile for representing the source CDA document instance identifier in a FHIR context. The identifier value is expressed as a URN OID (urn:ietf:rfc:3986), with the assigner carrying the PCEHR repository OID and display name.

The purpose of this profile is to provide a consistent Identifier profile for CDA instance identifiers so source document provenance can be carried into FHIR using the mandated URN OID representation and assigner semantics.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Identifier 0..* Identifier(4.0.1) An identifier intended for computation
Identifier.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Identifier.type This element is included in summaries. 1..1 CodeableConcept Description of identifier
Binding: IdentifierTypeVS (26.0.0) (required)
Required Pattern: 
{
  "coding" : [
    {
      "system" : "http://digitalhealth.gov.au/fhir/cc/CodeSystem/identifier-type-cs",
      "code" : "CDII",
      "display" : "CDA Instance Identifier"
    }
  ]
}
Identifier.system This element is included in summaries. 1..1 uri The namespace for the identifier value
Required Pattern: urn:ietf:rfc:3986 (extensions allowed)
Identifier.value This element is included in summaries. 1..1 string The value that is unique
Example General: 123456
Identifier.assigner This element is included in summaries. 1..1 Reference(Organization) Organization that issued id (may be just text)
Identifier.assigner.identifier This element is included in summaries. 1..1 Identifier Logical reference, when literal reference is not known
Identifier.assigner.identifier.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Identifier.assigner.identifier.system This element is included in summaries. 1..1 uri The namespace for the identifier value
Required Pattern: urn:ietf:rfc:3986 (extensions allowed)
Identifier.assigner.identifier.value This element is included in summaries. 1..1 string The value that is unique
Example General: 123456
Identifier.assigner.display This element is included in summaries. 0..1 string Text alternative for the resource
Required Pattern: PCEHR Assigned Identifier - Repository (extensions allowed)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Identifier.use Base required IdentifierUse 📍4.0.1 FHIR Std.
Identifier.type Base required Identifier Type 📍26.0.0 This IG
Identifier.assigner.​identifier.use Base required IdentifierUse 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression

This structure is derived from Identifier

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Identifier 0..* Identifier(4.0.1) An identifier intended for computation
Identifier.type 1..1 CodeableConcept Description of identifier
Binding: IdentifierTypeVS (26.0.0) (required)
Required Pattern: 
{
  "coding" : [
    {
      "system" : "http://digitalhealth.gov.au/fhir/cc/CodeSystem/identifier-type-cs",
      "code" : "CDII",
      "display" : "CDA Instance Identifier"
    }
  ]
}
Identifier.system 1..1 uri The namespace for the identifier value
Required Pattern: urn:ietf:rfc:3986 (extensions allowed)
Identifier.value 1..1 string The value that is unique
Identifier.assigner.identifier 1..1 Identifier Logical reference, when literal reference is not known
Identifier.assigner.identifier.system 1..1 uri The namespace for the identifier value
Required Pattern: urn:ietf:rfc:3986 (extensions allowed)
Identifier.assigner.identifier.value 1..1 string The value that is unique
Identifier.assigner.display 0..1 string Text alternative for the resource
Required Pattern: PCEHR Assigned Identifier - Repository (extensions allowed)

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Identifier.type Base required Identifier Type 📍26.0.0 This IG
NameFlagsCard.TypeDescription & Constraints    Filter: doco
Identifier 0..* Identifier(4.0.1) An identifier intended for computation
Identifier.id 0..1 string Unique id for inter-element referencing
Identifier.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
Identifier.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Identifier.type This element is included in summaries. 1..1 CodeableConcept Description of identifier
Binding: IdentifierTypeVS (26.0.0) (required)
Required Pattern: 
{
  "coding" : [
    {
      "system" : "http://digitalhealth.gov.au/fhir/cc/CodeSystem/identifier-type-cs",
      "code" : "CDII",
      "display" : "CDA Instance Identifier"
    }
  ]
}
Identifier.system This element is included in summaries. 1..1 uri The namespace for the identifier value
Required Pattern: urn:ietf:rfc:3986 (extensions allowed)
Identifier.value This element is included in summaries. 1..1 string The value that is unique
Example General: 123456
Identifier.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
Identifier.assigner This element is included in summaries. 1..1 Reference(Organization) Organization that issued id (may be just text)
Identifier.assigner.id 0..1 string Unique id for inter-element referencing
Identifier.assigner.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
Identifier.assigner.reference This element is included in summaries. C 0..1 string Literal reference, Relative, internal or absolute URL
Identifier.assigner.type This element is included in summaries. 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
Identifier.assigner.identifier This element is included in summaries. 1..1 Identifier Logical reference, when literal reference is not known
Identifier.assigner.identifier.id 0..1 string Unique id for inter-element referencing
Identifier.assigner.identifier.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
Identifier.assigner.identifier.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Identifier.assigner.identifier.type This element is included in summaries. 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Identifier.assigner.identifier.system This element is included in summaries. 1..1 uri The namespace for the identifier value
Required Pattern: urn:ietf:rfc:3986 (extensions allowed)
Identifier.assigner.identifier.value This element is included in summaries. 1..1 string The value that is unique
Example General: 123456
Identifier.assigner.identifier.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
Identifier.assigner.identifier.assigner This element is included in summaries. 0..1 Reference(Organization) Organization that issued id (may be just text)
Identifier.assigner.display This element is included in summaries. 0..1 string Text alternative for the resource
Required Pattern: PCEHR Assigned Identifier - Repository (extensions allowed)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Identifier.use Base required IdentifierUse 📍4.0.1 FHIR Std.
Identifier.type Base required Identifier Type 📍26.0.0 This IG
Identifier.assigner.​type Base extensible ResourceType 📍4.0.1 FHIR Std.
Identifier.assigner.​identifier.use Base required IdentifierUse 📍4.0.1 FHIR Std.
Identifier.assigner.​identifier.type Base extensible IdentifierType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression

This structure is derived from Identifier

Summary

Mandatory: 7 elements

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Identifier 0..* Identifier(4.0.1) An identifier intended for computation
Identifier.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Identifier.type This element is included in summaries. 1..1 CodeableConcept Description of identifier
Binding: IdentifierTypeVS (26.0.0) (required)
Required Pattern: 
{
  "coding" : [
    {
      "system" : "http://digitalhealth.gov.au/fhir/cc/CodeSystem/identifier-type-cs",
      "code" : "CDII",
      "display" : "CDA Instance Identifier"
    }
  ]
}
Identifier.system This element is included in summaries. 1..1 uri The namespace for the identifier value
Required Pattern: urn:ietf:rfc:3986 (extensions allowed)
Identifier.value This element is included in summaries. 1..1 string The value that is unique
Example General: 123456
Identifier.assigner This element is included in summaries. 1..1 Reference(Organization) Organization that issued id (may be just text)
Identifier.assigner.identifier This element is included in summaries. 1..1 Identifier Logical reference, when literal reference is not known
Identifier.assigner.identifier.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Identifier.assigner.identifier.system This element is included in summaries. 1..1 uri The namespace for the identifier value
Required Pattern: urn:ietf:rfc:3986 (extensions allowed)
Identifier.assigner.identifier.value This element is included in summaries. 1..1 string The value that is unique
Example General: 123456
Identifier.assigner.display This element is included in summaries. 0..1 string Text alternative for the resource
Required Pattern: PCEHR Assigned Identifier - Repository (extensions allowed)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Identifier.use Base required IdentifierUse 📍4.0.1 FHIR Std.
Identifier.type Base required Identifier Type 📍26.0.0 This IG
Identifier.assigner.​identifier.use Base required IdentifierUse 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression

Differential View

This structure is derived from Identifier

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Identifier 0..* Identifier(4.0.1) An identifier intended for computation
Identifier.type 1..1 CodeableConcept Description of identifier
Binding: IdentifierTypeVS (26.0.0) (required)
Required Pattern: 
{
  "coding" : [
    {
      "system" : "http://digitalhealth.gov.au/fhir/cc/CodeSystem/identifier-type-cs",
      "code" : "CDII",
      "display" : "CDA Instance Identifier"
    }
  ]
}
Identifier.system 1..1 uri The namespace for the identifier value
Required Pattern: urn:ietf:rfc:3986 (extensions allowed)
Identifier.value 1..1 string The value that is unique
Identifier.assigner 1..1 Reference(Organization) Organization that issued id (may be just text)
Identifier.assigner.identifier 1..1 Identifier Logical reference, when literal reference is not known
Identifier.assigner.identifier.system 1..1 uri The namespace for the identifier value
Required Pattern: urn:ietf:rfc:3986 (extensions allowed)
Identifier.assigner.identifier.value 1..1 string The value that is unique
Identifier.assigner.display 0..1 string Text alternative for the resource
Required Pattern: PCEHR Assigned Identifier - Repository (extensions allowed)

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Identifier.type Base required Identifier Type 📍26.0.0 This IG

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Identifier 0..* Identifier(4.0.1) An identifier intended for computation
Identifier.id 0..1 string Unique id for inter-element referencing
Identifier.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
Identifier.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Identifier.type This element is included in summaries. 1..1 CodeableConcept Description of identifier
Binding: IdentifierTypeVS (26.0.0) (required)
Required Pattern: 
{
  "coding" : [
    {
      "system" : "http://digitalhealth.gov.au/fhir/cc/CodeSystem/identifier-type-cs",
      "code" : "CDII",
      "display" : "CDA Instance Identifier"
    }
  ]
}
Identifier.system This element is included in summaries. 1..1 uri The namespace for the identifier value
Required Pattern: urn:ietf:rfc:3986 (extensions allowed)
Identifier.value This element is included in summaries. 1..1 string The value that is unique
Example General: 123456
Identifier.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
Identifier.assigner This element is included in summaries. 1..1 Reference(Organization) Organization that issued id (may be just text)
Identifier.assigner.id 0..1 string Unique id for inter-element referencing
Identifier.assigner.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
Identifier.assigner.reference This element is included in summaries. C 0..1 string Literal reference, Relative, internal or absolute URL
Identifier.assigner.type This element is included in summaries. 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
Identifier.assigner.identifier This element is included in summaries. 1..1 Identifier Logical reference, when literal reference is not known
Identifier.assigner.identifier.id 0..1 string Unique id for inter-element referencing
Identifier.assigner.identifier.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
Identifier.assigner.identifier.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Identifier.assigner.identifier.type This element is included in summaries. 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Identifier.assigner.identifier.system This element is included in summaries. 1..1 uri The namespace for the identifier value
Required Pattern: urn:ietf:rfc:3986 (extensions allowed)
Identifier.assigner.identifier.value This element is included in summaries. 1..1 string The value that is unique
Example General: 123456
Identifier.assigner.identifier.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
Identifier.assigner.identifier.assigner This element is included in summaries. 0..1 Reference(Organization) Organization that issued id (may be just text)
Identifier.assigner.display This element is included in summaries. 0..1 string Text alternative for the resource
Required Pattern: PCEHR Assigned Identifier - Repository (extensions allowed)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Identifier.use Base required IdentifierUse 📍4.0.1 FHIR Std.
Identifier.type Base required Identifier Type 📍26.0.0 This IG
Identifier.assigner.​type Base extensible ResourceType 📍4.0.1 FHIR Std.
Identifier.assigner.​identifier.use Base required IdentifierUse 📍4.0.1 FHIR Std.
Identifier.assigner.​identifier.type Base extensible IdentifierType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression

This structure is derived from Identifier

Summary

Mandatory: 7 elements

 

Other representations of profile: CSV, Excel, Schematron