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

This page is part of the Australian Base IG (v4.2.1-preview: QA Preview) based on FHIR (HL7® FHIR® Standard) R4. The current version which supersedes this version is 4.1.0. 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.2.2-ci-build
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 C 0..* Identifier Australian Registered Body Number (ARBN)
inv-arbn-0: ARBN shall be 9 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/arbn
... value 1..1 string ARBN

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Identifier.typeextensibleHl7VSIdentifierTypeAUExtended
http://terminology.hl7.org.au/ValueSet/v2-0203-extended
from this IG

Constraints

IdGradePath(s)DetailsRequirements
inv-arbn-0errorIdentifierARBN shall be 9 digits
: value.matches('^([0-9]{9})$')
NameFlagsCard.TypeDescription & Constraintsdoco
.. Identifier C 0..* Identifier Australian Registered Body Number (ARBN)
inv-arbn-0: ARBN shall be 9 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/arbn

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Identifier.typeextensibleHl7VSIdentifierTypeAUExtended
http://terminology.hl7.org.au/ValueSet/v2-0203-extended
from this IG

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 C 0..* Identifier Australian Registered Body Number (ARBN)
inv-arbn-0: ARBN shall be 9 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 .

... system Σ 1..1 uri The namespace for the identifier value
Fixed Value: http://hl7.org.au/id/arbn
... value Σ 1..1 string ARBN
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

PathConformanceValueSetURI
Identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Identifier.typeextensibleHl7VSIdentifierTypeAUExtended
http://terminology.hl7.org.au/ValueSet/v2-0203-extended
from this IG

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: 1 element

Maturity: 2

Differential View

This structure is derived from Identifier

NameFlagsCard.TypeDescription & Constraintsdoco
.. Identifier C 0..* Identifier Australian Registered Body Number (ARBN)
inv-arbn-0: ARBN shall be 9 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/arbn
... value 1..1 string ARBN

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Identifier.typeextensibleHl7VSIdentifierTypeAUExtended
http://terminology.hl7.org.au/ValueSet/v2-0203-extended
from this IG

Constraints

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

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Identifier C 0..* Identifier Australian Registered Body Number (ARBN)
inv-arbn-0: ARBN shall be 9 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/arbn

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Identifier.typeextensibleHl7VSIdentifierTypeAUExtended
http://terminology.hl7.org.au/ValueSet/v2-0203-extended
from this IG

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 C 0..* Identifier Australian Registered Body Number (ARBN)
inv-arbn-0: ARBN shall be 9 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 .

... system Σ 1..1 uri The namespace for the identifier value
Fixed Value: http://hl7.org.au/id/arbn
... value Σ 1..1 string ARBN
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

PathConformanceValueSetURI
Identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Identifier.typeextensibleHl7VSIdentifierTypeAUExtended
http://terminology.hl7.org.au/ValueSet/v2-0203-extended
from this IG

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: 1 element

Maturity: 2

 

Other representations of profile: CSV, Excel, Schematron