AU Base Implementation Guide
4.1.2-preview - Preview Australia flag

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

Data Type Profile: AU Australian Registered Body Number

Official URL: http://hl7.org.au/fhir/StructureDefinition/au-australianregistredbodynumber Version: 4.1.2-preview
Standards status: Trial-use Maturity Level: 2 Computable Name: AUAustralianRegisteredBodyNumber

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

This identifier profile defines an Australian Registered Body Number (ARBN) in an Australian context. ARBNs are issued to registrable Australian bodies and foreign companies.

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”.

Usage:

Formal Views of Profile Content

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

This structure is derived from Identifier

NameFlagsCard.TypeDescription & Constraintsdoco
.. Identifier C0..*IdentifierAustralian Registered Body Number (ARBN)
inv-arbn-0: ARBN shall be 9 digits
... type 1..1CodeableConceptDescription of identifier
Binding: hl7VS-identifierType - AU Extended (extensible)
... system 1..1uriThe namespace for the identifier value
Fixed Value: http://hl7.org.au/id/arbn
... value 1..1stringARBN

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Identifier.typeextensibleHl7VSIdentifierTypeAUExtended

Constraints

IdGradePath(s)DetailsRequirements
inv-arbn-0errorIdentifierARBN shall be 9 digits
: value.matches('^([0-9]{9})$')
NameFlagsCard.TypeDescription & Constraintsdoco
.. Identifier C0..*IdentifierAustralian Registered Body Number (ARBN)
inv-arbn-0: ARBN shall be 9 digits
... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

... type Σ1..1CodeableConceptDescription of identifier
Binding: hl7VS-identifierType - AU Extended (extensible)
... system Σ1..1uriThe namespace for the identifier value
Fixed Value: http://hl7.org.au/id/arbn

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Identifier.userequiredIdentifierUse
Identifier.typeextensibleHl7VSIdentifierTypeAUExtended

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
inv-arbn-0errorIdentifierARBN shall be 9 digits
: value.matches('^([0-9]{9})$')
NameFlagsCard.TypeDescription & Constraintsdoco
.. Identifier C0..*IdentifierAustralian Registered Body Number (ARBN)
inv-arbn-0: ARBN shall be 9 digits
... id 0..1stringUnique id for inter-element referencing
... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

... system Σ1..1uriThe namespace for the identifier value
Fixed Value: http://hl7.org.au/id/arbn
... value Σ1..1stringARBN
Example General: 123456
... period Σ0..1PeriodTime period when id is/was valid for use
... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Identifier.userequiredIdentifierUse
Identifier.typeextensibleHl7VSIdentifierTypeAUExtended

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
inv-arbn-0errorIdentifierARBN shall be 9 digits
: value.matches('^([0-9]{9})$')

This structure is derived from Identifier

Summary

Mandatory: 3 elements
Fixed Value: 1 element

Maturity: 2

Differential View

This structure is derived from Identifier

NameFlagsCard.TypeDescription & Constraintsdoco
.. Identifier C0..*IdentifierAustralian Registered Body Number (ARBN)
inv-arbn-0: ARBN shall be 9 digits
... type 1..1CodeableConceptDescription of identifier
Binding: hl7VS-identifierType - AU Extended (extensible)
... system 1..1uriThe namespace for the identifier value
Fixed Value: http://hl7.org.au/id/arbn
... value 1..1stringARBN

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Identifier.typeextensibleHl7VSIdentifierTypeAUExtended

Constraints

IdGradePath(s)DetailsRequirements
inv-arbn-0errorIdentifierARBN shall be 9 digits
: value.matches('^([0-9]{9})$')

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Identifier C0..*IdentifierAustralian Registered Body Number (ARBN)
inv-arbn-0: ARBN shall be 9 digits
... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

... type Σ1..1CodeableConceptDescription of identifier
Binding: hl7VS-identifierType - AU Extended (extensible)
... system Σ1..1uriThe namespace for the identifier value
Fixed Value: http://hl7.org.au/id/arbn

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Identifier.userequiredIdentifierUse
Identifier.typeextensibleHl7VSIdentifierTypeAUExtended

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
inv-arbn-0errorIdentifierARBN shall be 9 digits
: value.matches('^([0-9]{9})$')

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Identifier C0..*IdentifierAustralian Registered Body Number (ARBN)
inv-arbn-0: ARBN shall be 9 digits
... id 0..1stringUnique id for inter-element referencing
... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

... system Σ1..1uriThe namespace for the identifier value
Fixed Value: http://hl7.org.au/id/arbn
... value Σ1..1stringARBN
Example General: 123456
... period Σ0..1PeriodTime period when id is/was valid for use
... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Identifier.userequiredIdentifierUse
Identifier.typeextensibleHl7VSIdentifierTypeAUExtended

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
inv-arbn-0errorIdentifierARBN shall be 9 digits
: value.matches('^([0-9]{9})$')

This structure is derived from Identifier

Summary

Mandatory: 3 elements
Fixed Value: 1 element

Maturity: 2

 

Other representations of profile: CSV, Excel, Schematron