AU Base Implementation Guide, published by HL7 Australia. This guide is not an authorized publication; it is the continuous build for version 6.0.0-ci-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7au/au-fhir-base/ and changes regularly. See the Directory of published versions

• Content
• Detailed Descriptions
• XML
• JSON
• TTL

Data Type Profile: AU Patient Internal Identifier

This identifier profile defines a patient internal identifier in an Australian context. A patient internal identifier is assigned to a patient by an application (e.g. practice management system or a cloud-based electronic medical record) to uniquely identify a patient within that application.

While a patient internal identifier can be exchanged with other applications, its scope for sharing is limited and typically occurs for context-specific patient matching (e.g. a patient internal identifier included in a pathology request can be returned in the associated pathology report). This identifier is only unique within the assigning application and is not suitable for broader use as a persistent identifier, unlike a Medical Record Number (MRN), which is unique within an institution.

Usages:

• Use this DataType Profile: AU Base Patient

Formal Views of Profile Content

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

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

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Identifier		0..*	Identifier	Patient Internal Identifier
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: PI
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	System identifier namespace for the application that assigned the patient internal identifier Example General: http://www.acme.com/identifiers/patient
value	Σ	1..1	string	Patient internal identifier Example General: 123456
assigner	Σ	1..1	Reference(Organization)	Organisation that assigned the patient internal identifier
display	Σ	1..1	string	Name of the assigning organisation
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard
Identifier.type	extensible	Pattern Value: PI http://hl7.org/fhir/ValueSet/identifier-type From the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
ele-1	error	**ALL** elements	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	Patient Internal Identifier
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: PI
system		1..1	uri	System identifier namespace for the application that assigned the patient internal identifier
value		1..1	string	Patient internal identifier
assigner		1..1	Reference(Organization)	Organisation that assigned the patient internal identifier
display		1..1	string	Name of the assigning organisation
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Identifier		0..*	Identifier	Patient Internal Identifier
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
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: PI
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	System identifier namespace for the application that assigned the patient internal identifier Example General: http://www.acme.com/identifiers/patient
value	Σ	1..1	string	Patient internal identifier Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	1..1	Reference(Organization)	Organisation that assigned the patient internal identifier
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
reference	ΣC	0..1	string	Literal reference, Relative, internal or absolute URL
type	Σ	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	Σ	0..1	Identifier	Logical reference, when literal reference is not known
display	Σ	1..1	string	Name of the assigning organisation
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard
Identifier.type	extensible	Pattern Value: PI http://hl7.org/fhir/ValueSet/identifier-type From the FHIR Standard
Identifier.assigner.type	extensible	ResourceType http://hl7.org/fhir/ValueSet/resource-types From the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

This structure is derived from Identifier

Summary

Mandatory: 5 elements

Maturity: 0

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Identifier		0..*	Identifier	Patient Internal Identifier
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: PI
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	System identifier namespace for the application that assigned the patient internal identifier Example General: http://www.acme.com/identifiers/patient
value	Σ	1..1	string	Patient internal identifier Example General: 123456
assigner	Σ	1..1	Reference(Organization)	Organisation that assigned the patient internal identifier
display	Σ	1..1	string	Name of the assigning organisation
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard
Identifier.type	extensible	Pattern Value: PI http://hl7.org/fhir/ValueSet/identifier-type From the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
ele-1	error	**ALL** elements	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	Patient Internal Identifier
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: PI
system		1..1	uri	System identifier namespace for the application that assigned the patient internal identifier
value		1..1	string	Patient internal identifier
assigner		1..1	Reference(Organization)	Organisation that assigned the patient internal identifier
display		1..1	string	Name of the assigning organisation
Documentation for this format

Snapshot View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Identifier		0..*	Identifier	Patient Internal Identifier
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
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: PI
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	System identifier namespace for the application that assigned the patient internal identifier Example General: http://www.acme.com/identifiers/patient
value	Σ	1..1	string	Patient internal identifier Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	1..1	Reference(Organization)	Organisation that assigned the patient internal identifier
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
reference	ΣC	0..1	string	Literal reference, Relative, internal or absolute URL
type	Σ	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	Σ	0..1	Identifier	Logical reference, when literal reference is not known
display	Σ	1..1	string	Name of the assigning organisation
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard
Identifier.type	extensible	Pattern Value: PI http://hl7.org/fhir/ValueSet/identifier-type From the FHIR Standard
Identifier.assigner.type	extensible	ResourceType http://hl7.org/fhir/ValueSet/resource-types From the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

This structure is derived from Identifier

Summary

Mandatory: 5 elements

Maturity: 0

Other representations of profile: CSV, Excel, Schematron