Australian Base Implementation Guide (AU Base 2)

This page is part of the Australian Base IG (v2.1.0: AU Base 2 on R4) based on FHIR R4. For a full list of available versions, see the Directory of published versions

1.0 StructureDefinition-au-australianbusinessnumber

AU Australian Business Number [FMM Level 0]

This identifier profile defines an Australian Business Number - ABN [1] in an Australian healthcare context.

Examples

Albion Hospital with Australian Business Number

Devonport Family Medicine Clinic with Australian Business Number

ACME Pathology with NATA Number, ARBN, ABN, ACN, HPI-O, PAI-O and CSP

1.0.1 Formal Views of Profile Content

The official URL for this profile is: 

http://hl7.org.au/fhir/StructureDefinition/au-australianbusinessnumber

This identifier profile defines an Australian Business Number (ABN) in an Australian context.

This profile builds on Identifier.

This profile was published on Sat Jul 25 00:00:00 AEST 2020 as a draft by Health Level Seven Australia (Patient Administration WG).

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. Identifier I0..*IdentifierAustralian Business Number (ABN)
inv-abn-0: ABN shall be 11 digits
... type 0..1CodeableConceptCoded identifier type for ABN
.... text 0..1stringPlain text representation of the concept
Fixed Value: ABN
... system 1..1uriNamespace for ABN
Fixed Value: http://hl7.org.au/id/abn
... value 1..1stringABN

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Identifier I0..*IdentifierAustralian Business Number (ABN)
inv-abn-0: ABN shall be 11 digits
... id 0..1stringUnique id for inter-element referencing
... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... use ?!ΣI0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
... type ΣI0..1CodeableConceptCoded identifier type for ABN
Binding: Identifier Type Codes (extensible)
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... coding ΣI0..*CodingCode defined by a terminology system
.... text ΣI0..1stringPlain text representation of the concept
Fixed Value: ABN
... system ΣI1..1uriNamespace for ABN
Fixed Value: http://hl7.org.au/id/abn
... value ΣI1..1stringABN
Example General: 123456
... period ΣI0..1PeriodTime period when id is/was valid for use
... assigner ΣI0..1Reference(Organization)Organization that issued id (may be just text)

doco Documentation for this format

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Identifier I0..*IdentifierAustralian Business Number (ABN)
inv-abn-0: ABN shall be 11 digits
... type 0..1CodeableConceptCoded identifier type for ABN
.... text 0..1stringPlain text representation of the concept
Fixed Value: ABN
... system 1..1uriNamespace for ABN
Fixed Value: http://hl7.org.au/id/abn
... value 1..1stringABN

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Identifier I0..*IdentifierAustralian Business Number (ABN)
inv-abn-0: ABN shall be 11 digits
... id 0..1stringUnique id for inter-element referencing
... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... use ?!ΣI0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
... type ΣI0..1CodeableConceptCoded identifier type for ABN
Binding: Identifier Type Codes (extensible)
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... coding ΣI0..*CodingCode defined by a terminology system
.... text ΣI0..1stringPlain text representation of the concept
Fixed Value: ABN
... system ΣI1..1uriNamespace for ABN
Fixed Value: http://hl7.org.au/id/abn
... value ΣI1..1stringABN
Example General: 123456
... period ΣI0..1PeriodTime period when id is/was valid for use
... assigner ΣI0..1Reference(Organization)Organization that issued id (may be just text)

doco Documentation for this format

Downloads: StructureDefinition: (XML, JSON), Schema: XML Schematron

 

1.0.2 Quick Start

Below is an overview of the required search and read operations.

Summary of Search Criteria for StructureDefinition-au-australianbusinessnumber

none defined