AU Base Implementation Guide
4.1.1-preview - Preview
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 
| Official URL: http://hl7.org.au/fhir/StructureDefinition/au-australianregistredbodynumber | Version: 4.1.1-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.
Profile specific implementation guidance:
Identifier.type, the preferred coding from the hl7VS-identifierType - AU Extended value set is “XX” (Organization identifier), sent with a text value “ABN”.Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Identifier
| Name | Flags | Card. | Type | Description & Constraints![]() |
|---|---|---|---|---|
![]() | C | 0..* | Identifier | Australian Registered Body Number (ARBN) inv-arbn-0: ARBN shall be 9 digits |
![]() ![]() | 1..1 | CodeableConcept | Description of identifier Binding: hl7VS-identifierType - AU Extended (extensible) | |
![]() ![]() | 1..1 | uri | The namespace for the identifier value Fixed Value: http://hl7.org.au/id/arbn | |
![]() ![]() | 1..1 | string | ARBN | |
Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Identifier.type | extensible | Hl7VSIdentifierTypeAUExtended |
| Id | Grade | Path(s) | Details | Requirements |
| inv-arbn-0 | error | Identifier | ARBN shall be 9 digits : value.matches('^([0-9]{9})$') |
| Name | Flags | Card. | Type | Description & Constraints![]() |
|---|---|---|---|---|
![]() | C | 0..* | Identifier | Australian Registered Body Number (ARBN) inv-arbn-0: ARBN shall be 9 digits |
![]() ![]() | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
![]() ![]() | Σ | 1..1 | CodeableConcept | Description of identifier Binding: hl7VS-identifierType - AU Extended (extensible) |
![]() ![]() | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: http://hl7.org.au/id/arbn |
![]() ![]() | Σ | 1..1 | string | ARBN Example General: 123456 |
Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Identifier.use | required | IdentifierUse |
| Identifier.type | extensible | Hl7VSIdentifierTypeAUExtended |
| 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-arbn-0 | error | Identifier | ARBN shall be 9 digits : value.matches('^([0-9]{9})$') |
| Name | Flags | Card. | Type | Description & Constraints![]() |
|---|---|---|---|---|
![]() | C | 0..* | Identifier | Australian Registered Body Number (ARBN) inv-arbn-0: ARBN shall be 9 digits |
![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
![]() ![]() | Σ | 1..1 | CodeableConcept | Description of identifier Binding: hl7VS-identifierType - AU Extended (extensible) |
![]() ![]() | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: http://hl7.org.au/id/arbn |
![]() ![]() | Σ | 1..1 | string | ARBN Example General: 123456 |
![]() ![]() | Σ | 0..1 | Period | Time period when id is/was valid for use |
![]() ![]() | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Identifier.use | required | IdentifierUse |
| Identifier.type | extensible | Hl7VSIdentifierTypeAUExtended |
| 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
Differential View
This structure is derived from Identifier
| Name | Flags | Card. | Type | Description & Constraints![]() |
|---|---|---|---|---|
![]() | C | 0..* | Identifier | Australian Registered Body Number (ARBN) inv-arbn-0: ARBN shall be 9 digits |
![]() ![]() | 1..1 | CodeableConcept | Description of identifier Binding: hl7VS-identifierType - AU Extended (extensible) | |
![]() ![]() | 1..1 | uri | The namespace for the identifier value Fixed Value: http://hl7.org.au/id/arbn | |
![]() ![]() | 1..1 | string | ARBN | |
Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Identifier.type | extensible | Hl7VSIdentifierTypeAUExtended |
| Id | Grade | Path(s) | Details | Requirements |
| inv-arbn-0 | error | Identifier | ARBN shall be 9 digits : value.matches('^([0-9]{9})$') |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints![]() |
|---|---|---|---|---|
![]() | C | 0..* | Identifier | Australian Registered Body Number (ARBN) inv-arbn-0: ARBN shall be 9 digits |
![]() ![]() | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
![]() ![]() | Σ | 1..1 | CodeableConcept | Description of identifier Binding: hl7VS-identifierType - AU Extended (extensible) |
![]() ![]() | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: http://hl7.org.au/id/arbn |
![]() ![]() | Σ | 1..1 | string | ARBN Example General: 123456 |
Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Identifier.use | required | IdentifierUse |
| Identifier.type | extensible | Hl7VSIdentifierTypeAUExtended |
| 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-arbn-0 | error | Identifier | ARBN shall be 9 digits : value.matches('^([0-9]{9})$') |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints![]() |
|---|---|---|---|---|
![]() | C | 0..* | Identifier | Australian Registered Body Number (ARBN) inv-arbn-0: ARBN shall be 9 digits |
![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
![]() ![]() | Σ | 1..1 | CodeableConcept | Description of identifier Binding: hl7VS-identifierType - AU Extended (extensible) |
![]() ![]() | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: http://hl7.org.au/id/arbn |
![]() ![]() | Σ | 1..1 | string | ARBN Example General: 123456 |
![]() ![]() | Σ | 0..1 | Period | Time period when id is/was valid for use |
![]() ![]() | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Identifier.use | required | IdentifierUse |
| Identifier.type | extensible | Hl7VSIdentifierTypeAUExtended |
| 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
Other representations of profile: CSV, Excel, Schematron