This page is part of the AU Base Implementation Guide 4.1.1-preview based on FHIR R4. For a full list of available versions, see the Directory of published versions

• Content
• Detailed Descriptions
• XML
• JSON
• TTL

Data Type Profile: AU Australian Business Number

This identifier profile defines an Australian Business Number (ABN) in an Australian context. An ABN is issued to all entities registered in the Australian Business Register (ABR).

Usage:

• Use this DataType Constraint: AU Base Organisation

Formal Views of Profile Content

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

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

This structure is derived from Identifier

Name	Flags	Card.	Type	Description & Constraints
Identifier	C	0..*	Identifier	Australian Business Number (ABN) inv-abn-0: ABN shall be 11 digits
type		1..1	CodeableConcept	Description of identifier Binding: hl7VS-identifierType - AU Extended (extensible)
system		1..1	uri	The namespace for the identifier value Fixed Value: http://hl7.org.au/id/abn
value		1..1	string	ABN
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet
Identifier.type	extensible	Hl7VSIdentifierTypeAUExtended

Constraints

Id	Grade	Path(s)	Details	Requirements
inv-abn-0	error	Identifier	ABN shall be 11 digits : value.matches('^([0-9]{11})$')

Name	Flags	Card.	Type	Description & Constraints
Identifier	C	0..*	Identifier	Australian Business Number (ABN) inv-abn-0: ABN shall be 11 digits
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: hl7VS-identifierType - AU Extended (extensible)
system	Σ	1..1	uri	The namespace for the identifier value Fixed Value: http://hl7.org.au/id/abn
value	Σ	1..1	string	ABN Example General: 123456
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
Identifier.use	required	IdentifierUse
Identifier.type	extensible	Hl7VSIdentifierTypeAUExtended

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())
inv-abn-0	error	Identifier	ABN shall be 11 digits : value.matches('^([0-9]{11})$')

Name	Flags	Card.	Type	Description & Constraints
Identifier	C	0..*	Identifier	Australian Business Number (ABN) inv-abn-0: ABN shall be 11 digits
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: hl7VS-identifierType - AU Extended (extensible)
system	Σ	1..1	uri	The namespace for the identifier value Fixed Value: http://hl7.org.au/id/abn
value	Σ	1..1	string	ABN 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	Conformance	ValueSet
Identifier.use	required	IdentifierUse
Identifier.type	extensible	Hl7VSIdentifierTypeAUExtended

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: 3 elements
Fixed Value: 1 element

Maturity: 2

Differential View

This structure is derived from Identifier

Name	Flags	Card.	Type	Description & Constraints
Identifier	C	0..*	Identifier	Australian Business Number (ABN) inv-abn-0: ABN shall be 11 digits
type		1..1	CodeableConcept	Description of identifier Binding: hl7VS-identifierType - AU Extended (extensible)
system		1..1	uri	The namespace for the identifier value Fixed Value: http://hl7.org.au/id/abn
value		1..1	string	ABN
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet
Identifier.type	extensible	Hl7VSIdentifierTypeAUExtended

Constraints

Id	Grade	Path(s)	Details	Requirements
inv-abn-0	error	Identifier	ABN shall be 11 digits : value.matches('^([0-9]{11})$')

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Identifier	C	0..*	Identifier	Australian Business Number (ABN) inv-abn-0: ABN shall be 11 digits
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: hl7VS-identifierType - AU Extended (extensible)
system	Σ	1..1	uri	The namespace for the identifier value Fixed Value: http://hl7.org.au/id/abn
value	Σ	1..1	string	ABN Example General: 123456
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
Identifier.use	required	IdentifierUse
Identifier.type	extensible	Hl7VSIdentifierTypeAUExtended

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())
inv-abn-0	error	Identifier	ABN shall be 11 digits : value.matches('^([0-9]{11})$')

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Identifier	C	0..*	Identifier	Australian Business Number (ABN) inv-abn-0: ABN shall be 11 digits
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: hl7VS-identifierType - AU Extended (extensible)
system	Σ	1..1	uri	The namespace for the identifier value Fixed Value: http://hl7.org.au/id/abn
value	Σ	1..1	string	ABN 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	Conformance	ValueSet
Identifier.use	required	IdentifierUse
Identifier.type	extensible	Hl7VSIdentifierTypeAUExtended

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: 3 elements
Fixed Value: 1 element

Maturity: 2

Other representations of profile: CSV, Excel, Schematron