Health Connect Australia Provider Directory 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/HCPD/ and changes regularly. See the Directory of published versions

Data Type Profile: HCPD Source Identifier (HCPD-SI)

Official URL: http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/hcpd-source-identifier Version: 26.0.0
Active as of 2026-11-03 Computable Name: HCPD_Source_Identifier

Copyright/Legal: Copyright © 2025 Australian Digital Health Agency - All rights reserved. This content is licensed under a Creative Commons Attribution 4.0 International License. See https://creativecommons.org/licenses/by/4.0/.

This profile of Identifier defines a HCPD Source Identifier (HCPD-SI).

HCPD Source Identifier (HCPD-SI)

The HCPD-SI is the primary external identifier assigned by a publisher to a HCPD instance for identification and integration with Health Connect. It is mandatory for all HealthcareService, Location, Endpoint & PractitionerRole HCPD resources published in the Health Connect directory.

  • identifier.type: fixed to RI (resource identifier).
  • identifier.value: the value defined by the source organisation.
  • identifier.system: populate with a stable URI to support authoritative reconciliation.

Guidance:

  • The combination of system and value MUST be globally unique within Health Connect and SHOULD be stable over the lifecycle of the resource.
  • Use identifier.system to record a canonical URI when organisations have a stable namespace for their identifiers.
  • This identifier SHALL respect the value, type and system attributed by the source system from where the data was initially ingested.

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) HCPD Source Identifier (HCPD-SI)
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 Coded identifier type for HCPD Source 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.
Required Pattern: 
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/v2-0203",
      "code" : "RI"
    }
  ]
}
Identifier.system This element is included in summaries. 1..1 uri HCPD Source Identifier system. Not fixed to receive individual source systems.
Example General: http://www.acme.com/identifiers/patient
Identifier.value This element is included in summaries. 1..1 string Vendor Directory Identifier
Example General: 123456

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 extensible IdentifierType 📍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) HCPD Source Identifier (HCPD-SI)
Identifier.type 1..1 CodeableConcept Coded identifier type for HCPD Source identifier
Required Pattern: 
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/v2-0203",
      "code" : "RI"
    }
  ]
}
Identifier.system 1..1 uri HCPD Source Identifier system. Not fixed to receive individual source systems.
Identifier.value 1..1 string Vendor Directory Identifier

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: doco
Identifier 0..* Identifier(4.0.1) HCPD Source Identifier (HCPD-SI)
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 Coded identifier type for HCPD Source 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.
Required Pattern: 
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/v2-0203",
      "code" : "RI"
    }
  ]
}
Identifier.system This element is included in summaries. 1..1 uri HCPD Source Identifier system. Not fixed to receive individual source systems.
Example General: http://www.acme.com/identifiers/patient
Identifier.value This element is included in summaries. 1..1 string Vendor Directory Identifier
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. 0..1 Reference(Organization) Organization that issued id (may be just text)

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 extensible IdentifierType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression

This structure is derived from Identifier

Summary

Mandatory: 3 elements

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Identifier 0..* Identifier(4.0.1) HCPD Source Identifier (HCPD-SI)
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 Coded identifier type for HCPD Source 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.
Required Pattern: 
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/v2-0203",
      "code" : "RI"
    }
  ]
}
Identifier.system This element is included in summaries. 1..1 uri HCPD Source Identifier system. Not fixed to receive individual source systems.
Example General: http://www.acme.com/identifiers/patient
Identifier.value This element is included in summaries. 1..1 string Vendor Directory Identifier
Example General: 123456

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 extensible IdentifierType 📍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) HCPD Source Identifier (HCPD-SI)
Identifier.type 1..1 CodeableConcept Coded identifier type for HCPD Source identifier
Required Pattern: 
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/v2-0203",
      "code" : "RI"
    }
  ]
}
Identifier.system 1..1 uri HCPD Source Identifier system. Not fixed to receive individual source systems.
Identifier.value 1..1 string Vendor Directory Identifier

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Identifier 0..* Identifier(4.0.1) HCPD Source Identifier (HCPD-SI)
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 Coded identifier type for HCPD Source 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.
Required Pattern: 
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/v2-0203",
      "code" : "RI"
    }
  ]
}
Identifier.system This element is included in summaries. 1..1 uri HCPD Source Identifier system. Not fixed to receive individual source systems.
Example General: http://www.acme.com/identifiers/patient
Identifier.value This element is included in summaries. 1..1 string Vendor Directory Identifier
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. 0..1 Reference(Organization) Organization that issued id (may be just text)

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 extensible IdentifierType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression

This structure is derived from Identifier

Summary

Mandatory: 3 elements

 

Other representations of profile: CSV, Excel, Schematron