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

AU Base Implementation Guide, published by HL7 Australia. This guide is not an authorized publication; it is the continuous build for version 7.0.0-ci-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7au/au-fhir-base/ and changes regularly. 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: 7.0.0-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

Usages:

You can also check for usages in the FHIR IG Statistics

Changes since version 6.0.0:

  • The data elements list has changed

    • Formal Views of Profile Content

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

    NameFlagsCard.TypeDescription & Constraints    Filter: doco
    Identifier C 0..* Identifier Australian Registered Body Number (ARBN)
    Constraints: inv-arbn-0
    Identifier.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
    Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
    Identifier.type This element is included in summaries. 1..1 CodeableConcept Description of identifier
    Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
    Required Pattern: 
    {
  "coding" : [
    {
      "system" : "http://terminology.hl7.org.au/CodeSystem/v2-0203",
      "code" : "ARBN"
    }
  ]
}
    Identifier.system This element is included in summaries. 1..1 uri The namespace for the identifier value
    Fixed Value: http://hl7.org.au/id/arbn (no extensions allowed)
    Identifier.value This element is included in summaries. 1..1 string ARBN
    Example General: 123456

    doco Documentation for this format

    Terminology Bindings

    Path Status Usage ValueSet Version Source
    Identifier.use Base required IdentifierUse 📍4.0.1 FHIR Std.
    Identifier.type Base extensible IdentifierType 📍4.0.1 FHIR Std.

    Constraints

    Id Grade Path(s) Description Expression
    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})$')

    This structure is derived from Identifier

    NameFlagsCard.TypeDescription & Constraints    Filter: doco
    Identifier C 0..* Identifier Australian Registered Body Number (ARBN)
    Constraints: inv-arbn-0
    Identifier.type 1..1 CodeableConcept Description of identifier
    Required Pattern: 
    {
  "coding" : [
    {
      "system" : "http://terminology.hl7.org.au/CodeSystem/v2-0203",
      "code" : "ARBN"
    }
  ]
}
    Identifier.system 1..1 uri The namespace for the identifier value
    Fixed Value: http://hl7.org.au/id/arbn (no extensions allowed)
    Identifier.value 1..1 string ARBN

    doco Documentation for this format

    Constraints

    Id Grade Path(s) Description Expression
    inv-arbn-0 error Identifier ARBN shall be 9 digits value.matches('^([0-9]{9})$')
    NameFlagsCard.TypeDescription & Constraints    Filter: doco
    Identifier C 0..* Identifier Australian Registered Body Number (ARBN)
    Constraints: inv-arbn-0
    Identifier.id 0..1 string Unique id for inter-element referencing
    Identifier.extension 0..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    Identifier.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
    Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
    Identifier.type This element is included in summaries. 1..1 CodeableConcept Description of identifier
    Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
    Required Pattern: 
    {
  "coding" : [
    {
      "system" : "http://terminology.hl7.org.au/CodeSystem/v2-0203",
      "code" : "ARBN"
    }
  ]
}
    Identifier.system This element is included in summaries. 1..1 uri The namespace for the identifier value
    Fixed Value: http://hl7.org.au/id/arbn (no extensions allowed)
    Identifier.value This element is included in summaries. 1..1 string ARBN
    Example General: 123456
    Identifier.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
    Identifier.assigner This element is included in summaries. 0..1 Reference(Organization) Organization that issued id (may be just text)

    doco Documentation for this format

    Terminology Bindings

    Path Status Usage ValueSet Version Source
    Identifier.use Base required IdentifierUse 📍4.0.1 FHIR Std.
    Identifier.type Base extensible IdentifierType 📍4.0.1 FHIR Std.

    Constraints

    Id Grade Path(s) Description Expression
    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()
    inv-arbn-0 error Identifier ARBN shall be 9 digits value.matches('^([0-9]{9})$')

    This structure is derived from Identifier

    Summary

    Mandatory: 3 elements
    Fixed: 1 element

    Maturity: 2

    Key Elements View

    NameFlagsCard.TypeDescription & Constraints    Filter: doco
    Identifier C 0..* Identifier Australian Registered Body Number (ARBN)
    Constraints: inv-arbn-0
    Identifier.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
    Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
    Identifier.type This element is included in summaries. 1..1 CodeableConcept Description of identifier
    Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
    Required Pattern: 
    {
  "coding" : [
    {
      "system" : "http://terminology.hl7.org.au/CodeSystem/v2-0203",
      "code" : "ARBN"
    }
  ]
}
    Identifier.system This element is included in summaries. 1..1 uri The namespace for the identifier value
    Fixed Value: http://hl7.org.au/id/arbn (no extensions allowed)
    Identifier.value This element is included in summaries. 1..1 string ARBN
    Example General: 123456

    doco Documentation for this format

    Terminology Bindings

    Path Status Usage ValueSet Version Source
    Identifier.use Base required IdentifierUse 📍4.0.1 FHIR Std.
    Identifier.type Base extensible IdentifierType 📍4.0.1 FHIR Std.

    Constraints

    Id Grade Path(s) Description Expression
    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})$')

    Differential View

    This structure is derived from Identifier

    NameFlagsCard.TypeDescription & Constraints    Filter: doco
    Identifier C 0..* Identifier Australian Registered Body Number (ARBN)
    Constraints: inv-arbn-0
    Identifier.type 1..1 CodeableConcept Description of identifier
    Required Pattern: 
    {
  "coding" : [
    {
      "system" : "http://terminology.hl7.org.au/CodeSystem/v2-0203",
      "code" : "ARBN"
    }
  ]
}
    Identifier.system 1..1 uri The namespace for the identifier value
    Fixed Value: http://hl7.org.au/id/arbn (no extensions allowed)
    Identifier.value 1..1 string ARBN

    doco Documentation for this format

    Constraints

    Id Grade Path(s) Description Expression
    inv-arbn-0 error Identifier ARBN shall be 9 digits value.matches('^([0-9]{9})$')

    Snapshot View

    NameFlagsCard.TypeDescription & Constraints    Filter: doco
    Identifier C 0..* Identifier Australian Registered Body Number (ARBN)
    Constraints: inv-arbn-0
    Identifier.id 0..1 string Unique id for inter-element referencing
    Identifier.extension 0..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    Identifier.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
    Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
    Identifier.type This element is included in summaries. 1..1 CodeableConcept Description of identifier
    Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
    Required Pattern: 
    {
  "coding" : [
    {
      "system" : "http://terminology.hl7.org.au/CodeSystem/v2-0203",
      "code" : "ARBN"
    }
  ]
}
    Identifier.system This element is included in summaries. 1..1 uri The namespace for the identifier value
    Fixed Value: http://hl7.org.au/id/arbn (no extensions allowed)
    Identifier.value This element is included in summaries. 1..1 string ARBN
    Example General: 123456
    Identifier.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
    Identifier.assigner This element is included in summaries. 0..1 Reference(Organization) Organization that issued id (may be just text)

    doco Documentation for this format

    Terminology Bindings

    Path Status Usage ValueSet Version Source
    Identifier.use Base required IdentifierUse 📍4.0.1 FHIR Std.
    Identifier.type Base extensible IdentifierType 📍4.0.1 FHIR Std.

    Constraints

    Id Grade Path(s) Description Expression
    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()
    inv-arbn-0 error Identifier ARBN 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