AU Base on FHIR R4

Australian Base Implementation Guide

This page is part of AU Base v4.0.0 based on FHIR R4. For a full list of available versions, see the Directory of published versions

1.0 StructureDefinition-au-australianregistredbodynumber

AU Australian Registered Body Number [FMM 2]

This identifier profile defines an Australian Registered Body Number (ARBN) ^[1] in an Australian context.

Extensions

No extensions are used in this profile.

Usage Notes

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

Examples

ACME Pathology with NATA accreditation number, ARBN, ABN, ACN, HPI-O, PAI-O and CSP registration number

1.0.1 Formal Views of Profile Content

The official URL for this profile is:

http://hl7.org.au/fhir/StructureDefinition/au-australianregistredbodynumber

This identifier profile defines an Australian Registered Body Number (ARBN) in an Australian context.

This profile builds on Identifier.

This profile was published on 2022-04-03 as a active by Health Level Seven Australia (Patient Administration WG).

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

Differential Table
Snapshot Table
All

Name	Flags	Card.	Type	Description & Constraints
Identifier	I	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

Name	Flags	Card.	Type	Description & Constraints
Identifier	I	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

Differential View

Name	Flags	Card.	Type	Description & Constraints
Identifier	I	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

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Identifier	I	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

Downloads: StructureDefinition: (XML, JSON), Schema: XML Schematron

1.0.2 Quick Start

Below is an overview of the required search and read operations.

Summary of Search Criteria for StructureDefinition-au-australianregistredbodynumber

none defined