AU Base Implementation Guide
4.1.0-ballot - CI Build
AU
AU Base Implementation Guide
4.1.0-ballot - CI Build
AU
This page is part of AU Base v4.1.0 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.0-ballot | |||
| Active as of 2022-11-10 | 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)[1] in an Australian context.
When coding type, the current recommended coding from the required hl7VS-identifierType - AU Extended value set is ‘XX’ (Organization identifier) sent with a text value ‘ARBN’. However, it is expected that future versions of the Identifier Type valueset may contain a specific coding as ‘ARBN’.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Identifier
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  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 | |
| 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 |
|---|---|---|---|---|
| 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 |
| value | Σ | 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 |
| inv-arbn-0 | error | Identifier | ARBN shall be 9 digits : value.matches('^([0-9]{9})$') |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| 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 . |
| 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 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) |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Identifier.use | required | IdentifierUse |
| Identifier.type | extensible | Hl7VSIdentifierTypeAUExtended |
This structure is derived from Identifier
Differential View
This structure is derived from Identifier
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| 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 | |
| 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 |
|---|---|---|---|---|
| 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 |
| value | Σ | 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 |
| inv-arbn-0 | error | Identifier | ARBN shall be 9 digits : value.matches('^([0-9]{9})$') |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| 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 . |
| 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 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) |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Identifier.use | required | IdentifierUse |
| Identifier.type | extensible | Hl7VSIdentifierTypeAUExtended |
This structure is derived from Identifier
Other representations of profile: CSV, Excel, Schematron
none defined
IG © 2017+ HL7 Australia. Package hl7.fhir.au.base#4.1.0-ballot based on FHIR 4.0.1. Generated 2022-11-10
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change