AU Base Implementation Guide
6.0.0-ci-build - CI Build Australia flag

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

Data Type Profile: AU Australian Business Number

Official URL: http://hl7.org.au/fhir/StructureDefinition/au-australianbusinessnumber Version: 6.0.0-ci-build
Standards status: Trial-use Maturity Level: 2 Computable Name: AUAustralianBusinessNumber

Copyright/Legal: HL7 Australia© 2018+; Licensed Under Creative Commons No Rights Reserved.

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 Notes

Profile specific implementation guidance:

  • When coding Identifier.type, the preferred coding from the hl7VS-identifierType - AU Extended value set is "XX" (Organization identifier), sent with a text value "ABN".

Usages:

You can also check for usages in the FHIR IG Statistics

Changes since version 5.0.0:

  • No changes

    • Formal Views of Profile Content

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

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Identifier C 0..* Identifier Australian Business Number (ABN)
    Constraints: inv-abn-0
    ... 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

    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 hl7VS-identifierType - AU Extended 📦6.0.0-ci-build This IG

    Constraints

    Id Grade Path(s) Description Expression
    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})$')

    This structure is derived from Identifier

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Identifier C 0..* Identifier Australian Business Number (ABN)
    Constraints: inv-abn-0
    ... 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

    doco Documentation for this format

    Terminology Bindings (Differential)

    Path Status Usage ValueSet Version Source
    Identifier.type Base extensible hl7VS-identifierType - AU Extended 📦6.0.0-ci-build This IG

    Constraints

    Id Grade Path(s) Description Expression
    inv-abn-0 error Identifier ABN shall be 11 digits value.matches('^([0-9]{11})$')
    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Identifier C 0..* Identifier Australian Business Number (ABN)
    Constraints: inv-abn-0
    ... 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 .
    ... 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)

    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 hl7VS-identifierType - AU Extended 📦6.0.0-ci-build This IG

    Constraints

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

    This structure is derived from Identifier

    Summary

    Mandatory: 3 elements
    Fixed: 1 element

    Maturity: 2

    Key Elements View

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Identifier C 0..* Identifier Australian Business Number (ABN)
    Constraints: inv-abn-0
    ... 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

    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 hl7VS-identifierType - AU Extended 📦6.0.0-ci-build This IG

    Constraints

    Id Grade Path(s) Description Expression
    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})$')

    Differential View

    This structure is derived from Identifier

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Identifier C 0..* Identifier Australian Business Number (ABN)
    Constraints: inv-abn-0
    ... 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

    doco Documentation for this format

    Terminology Bindings (Differential)

    Path Status Usage ValueSet Version Source
    Identifier.type Base extensible hl7VS-identifierType - AU Extended 📦6.0.0-ci-build This IG

    Constraints

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

    Snapshot View

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Identifier C 0..* Identifier Australian Business Number (ABN)
    Constraints: inv-abn-0
    ... 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 .
    ... 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)

    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 hl7VS-identifierType - AU Extended 📦6.0.0-ci-build This IG

    Constraints

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

    This structure is derived from Identifier

    Summary

    Mandatory: 3 elements
    Fixed: 1 element

    Maturity: 2

     

    Other representations of profile: CSV, Excel, Schematron