Health Connect Australia Provider Directory FHIR Implementation Guide

HCD Local Identifier

Beyond the identifiers already defined in AU Core, the following HCPD resource profiles: Location, PractitionerRole, HealthcareService & Endpoint explicitly support a unique Health Connect Provider Directory attributed slice. The value of this identifier is uniquely assigned at creation, therefore this prevents duplications of values regardless of resource type.

Publishing guidance:

• The HCPD Local Identifier (HCPD-LI) is the canonical identifier for resources internally within the Health Connect Provider Directory system and SHALL be supplied when known. Publishing systems SHALL NOT manipulate the HCPD-LI value themselves — the HCPD service SHALL generate and manage this identifier.

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

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Identifier		0..*	Identifier(4.0.1)	HCPD Local Identifier (HCPD-LI)
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	1..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. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (Complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: XX
display		0..1	string	Representation defined by the system
userSelected		0..1	boolean	If this coding was chosen directly by the user
text		0..1	string	Plain text representation of the concept
system	Σ	1..1	uri	HCPD Local Identifier system Fixed Value: http://digitalhealth.gov.au/fhir/hcpd/id/hcpd-local-identifier
value	Σ	1..1	string	HCPD-LI Example General: 123456
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
ele-1	error	Identifier, Identifier.use, Identifier.type, Identifier.system, Identifier.value	All FHIR elements must have a @value or children	hasValue() or (children().count() > id.count())

This structure is derived from Identifier

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Identifier		0..*	Identifier(4.0.1)	HCPD Local Identifier (HCPD-LI)
type		1..1	CodeableConcept	Description of identifier Required Pattern: At least the following
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (Complex)
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
code		1..1	code	Symbol in syntax defined by the system Fixed Value: XX
system		1..1	uri	HCPD Local Identifier system Fixed Value: http://digitalhealth.gov.au/fhir/hcpd/id/hcpd-local-identifier
value		1..1	string	HCPD-LI
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Identifier		0..*	Identifier(4.0.1)	HCPD Local Identifier (HCPD-LI)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	1..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. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (Complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: XX
display		0..1	string	Representation defined by the system
userSelected		0..1	boolean	If this coding was chosen directly by the user
text		0..1	string	Plain text representation of the concept
system	Σ	1..1	uri	HCPD Local Identifier system Fixed Value: http://digitalhealth.gov.au/fhir/hcpd/id/hcpd-local-identifier
value	Σ	1..1	string	HCPD-LI Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
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
ele-1	error	Identifier, Identifier.extension, Identifier.use, Identifier.type, Identifier.system, Identifier.value, Identifier.period, Identifier.assigner	All FHIR elements must have a @value or children	hasValue() or (children().count() > id.count())
ext-1	error	Identifier.extension	Must have either extensions or value[x], not both	extension.exists() != value.exists()

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Identifier		0..*	Identifier(4.0.1)	HCPD Local Identifier (HCPD-LI)
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	1..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. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (Complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: XX
display		0..1	string	Representation defined by the system
userSelected		0..1	boolean	If this coding was chosen directly by the user
text		0..1	string	Plain text representation of the concept
system	Σ	1..1	uri	HCPD Local Identifier system Fixed Value: http://digitalhealth.gov.au/fhir/hcpd/id/hcpd-local-identifier
value	Σ	1..1	string	HCPD-LI Example General: 123456
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
ele-1	error	Identifier, Identifier.use, Identifier.type, Identifier.system, Identifier.value	All FHIR elements must have a @value or children	hasValue() or (children().count() > id.count())

Differential View

This structure is derived from Identifier

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Identifier		0..*	Identifier(4.0.1)	HCPD Local Identifier (HCPD-LI)
type		1..1	CodeableConcept	Description of identifier Required Pattern: At least the following
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (Complex)
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
code		1..1	code	Symbol in syntax defined by the system Fixed Value: XX
system		1..1	uri	HCPD Local Identifier system Fixed Value: http://digitalhealth.gov.au/fhir/hcpd/id/hcpd-local-identifier
value		1..1	string	HCPD-LI
Documentation for this format

Snapshot View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Identifier		0..*	Identifier(4.0.1)	HCPD Local Identifier (HCPD-LI)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	1..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. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (Complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: XX
display		0..1	string	Representation defined by the system
userSelected		0..1	boolean	If this coding was chosen directly by the user
text		0..1	string	Plain text representation of the concept
system	Σ	1..1	uri	HCPD Local Identifier system Fixed Value: http://digitalhealth.gov.au/fhir/hcpd/id/hcpd-local-identifier
value	Σ	1..1	string	HCPD-LI Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
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
ele-1	error	Identifier, Identifier.extension, Identifier.use, Identifier.type, Identifier.system, Identifier.value, Identifier.period, Identifier.assigner	All FHIR elements must have a @value or children	hasValue() or (children().count() > id.count())
ext-1	error	Identifier.extension	Must have either extensions or value[x], not both	extension.exists() != value.exists()

This structure is derived from Identifier

Summary

Mandatory: 3 elements
Fixed: 1 element