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 HPI-O

Official URL: http://hl7.org.au/fhir/StructureDefinition/au-hpio Version: 7.0.0-ci-build
Standards status: Trial-use Maturity Level: 2 Computable Name: AUHPIO

Copyright/Legal: HL7 Australia© 2018+; Licensed Under Creative Commons No Rights Reserved.

This identifier profile defines a Healthcare Provider Identifier – Organisation in an Australian context (see Australian Digital Health Agency for further information). An HPI-O is assigned under the HI Service to an organisation (such as a hospital or medical clinic) where healthcare is provided.

Usage Notes

Usages:

You can also check for usages in the FHIR IG Statistics

Changes since version 6.0.0:

  • No changes
  • Formal Views of Profile Content

    Description Differentials, Snapshots, and other representations.

    NameFlagsCard.TypeDescription & Constraints    Filter: doco
    Identifier C 0..* Identifier Healthcare Provider Identifier – Organisation (HPI-O)
    Constraints: inv-hpio-0, inv-hpio-1, inv-hpio-2
    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" : "NOI"
        }
      ]
    }
    Identifier.system This element is included in summaries. 1..1 uri The namespace for the identifier value
    Fixed Value: http://ns.electronichealth.net.au/id/hi/hpio/1.0 (no extensions allowed)
    Identifier.value This element is included in summaries. C 1..1 string HPI-O
    Example General: 123456
    Example HPI-O: 8003621566684455
    Max Length:16

    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-hpio-0 error Identifier HPI-O shall be 16 digits value.matches('^([0-9]{16})$')
    inv-hpio-1 error Identifier HPI-O prefix shall be 800362 value.startsWith('800362')
    inv-hpio-2 error Identifier HPI-O shall pass the Luhn algorithm check (((select(value.substring(0,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(1,1).toInteger())+(select(value.substring(2,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(3,1).toInteger())+(select(value.substring(4,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(5,1).toInteger())+(select(value.substring(6,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(7,1).toInteger())+(select(value.substring(8,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(9,1).toInteger())+(select(value.substring(10,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(11,1).toInteger())+(select(value.substring(12,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(13,1).toInteger())+(select(value.substring(14,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(15,1).toInteger()))mod 10=0)

    This structure is derived from Identifier

    NameFlagsCard.TypeDescription & Constraints    Filter: doco
    Identifier C 0..* Identifier Healthcare Provider Identifier – Organisation (HPI-O)
    Constraints: inv-hpio-0, inv-hpio-1, inv-hpio-2
    Identifier.type 1..1 CodeableConcept Description of identifier
    Required Pattern:
    {
      "coding" : [
        {
          "system" : "http://terminology.hl7.org.au/CodeSystem/v2-0203",
          "code" : "NOI"
        }
      ]
    }
    Identifier.system 1..1 uri The namespace for the identifier value
    Fixed Value: http://ns.electronichealth.net.au/id/hi/hpio/1.0 (no extensions allowed)
    Identifier.value C 1..1 string HPI-O
    Example HPI-O: 8003621566684455
    Max Length:16

    doco Documentation for this format

    Constraints

    Id Grade Path(s) Description Expression
    inv-hpio-0 error Identifier HPI-O shall be 16 digits value.matches('^([0-9]{16})$')
    inv-hpio-1 error Identifier HPI-O prefix shall be 800362 value.startsWith('800362')
    inv-hpio-2 error Identifier HPI-O shall pass the Luhn algorithm check (((select(value.substring(0,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(1,1).toInteger())+(select(value.substring(2,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(3,1).toInteger())+(select(value.substring(4,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(5,1).toInteger())+(select(value.substring(6,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(7,1).toInteger())+(select(value.substring(8,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(9,1).toInteger())+(select(value.substring(10,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(11,1).toInteger())+(select(value.substring(12,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(13,1).toInteger())+(select(value.substring(14,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(15,1).toInteger()))mod 10=0)
    NameFlagsCard.TypeDescription & Constraints    Filter: doco
    Identifier C 0..* Identifier Healthcare Provider Identifier – Organisation (HPI-O)
    Constraints: inv-hpio-0, inv-hpio-1, inv-hpio-2
    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" : "NOI"
        }
      ]
    }
    Identifier.system This element is included in summaries. 1..1 uri The namespace for the identifier value
    Fixed Value: http://ns.electronichealth.net.au/id/hi/hpio/1.0 (no extensions allowed)
    Identifier.value This element is included in summaries. C 1..1 string HPI-O
    Example General: 123456
    Example HPI-O: 8003621566684455
    Max Length:16
    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-hpio-0 error Identifier HPI-O shall be 16 digits value.matches('^([0-9]{16})$')
    inv-hpio-1 error Identifier HPI-O prefix shall be 800362 value.startsWith('800362')
    inv-hpio-2 error Identifier HPI-O shall pass the Luhn algorithm check (((select(value.substring(0,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(1,1).toInteger())+(select(value.substring(2,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(3,1).toInteger())+(select(value.substring(4,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(5,1).toInteger())+(select(value.substring(6,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(7,1).toInteger())+(select(value.substring(8,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(9,1).toInteger())+(select(value.substring(10,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(11,1).toInteger())+(select(value.substring(12,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(13,1).toInteger())+(select(value.substring(14,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(15,1).toInteger()))mod 10=0)

    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 Healthcare Provider Identifier – Organisation (HPI-O)
    Constraints: inv-hpio-0, inv-hpio-1, inv-hpio-2
    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" : "NOI"
        }
      ]
    }
    Identifier.system This element is included in summaries. 1..1 uri The namespace for the identifier value
    Fixed Value: http://ns.electronichealth.net.au/id/hi/hpio/1.0 (no extensions allowed)
    Identifier.value This element is included in summaries. C 1..1 string HPI-O
    Example General: 123456
    Example HPI-O: 8003621566684455
    Max Length:16

    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-hpio-0 error Identifier HPI-O shall be 16 digits value.matches('^([0-9]{16})$')
    inv-hpio-1 error Identifier HPI-O prefix shall be 800362 value.startsWith('800362')
    inv-hpio-2 error Identifier HPI-O shall pass the Luhn algorithm check (((select(value.substring(0,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(1,1).toInteger())+(select(value.substring(2,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(3,1).toInteger())+(select(value.substring(4,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(5,1).toInteger())+(select(value.substring(6,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(7,1).toInteger())+(select(value.substring(8,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(9,1).toInteger())+(select(value.substring(10,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(11,1).toInteger())+(select(value.substring(12,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(13,1).toInteger())+(select(value.substring(14,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(15,1).toInteger()))mod 10=0)

    Differential View

    This structure is derived from Identifier

    NameFlagsCard.TypeDescription & Constraints    Filter: doco
    Identifier C 0..* Identifier Healthcare Provider Identifier – Organisation (HPI-O)
    Constraints: inv-hpio-0, inv-hpio-1, inv-hpio-2
    Identifier.type 1..1 CodeableConcept Description of identifier
    Required Pattern:
    {
      "coding" : [
        {
          "system" : "http://terminology.hl7.org.au/CodeSystem/v2-0203",
          "code" : "NOI"
        }
      ]
    }
    Identifier.system 1..1 uri The namespace for the identifier value
    Fixed Value: http://ns.electronichealth.net.au/id/hi/hpio/1.0 (no extensions allowed)
    Identifier.value C 1..1 string HPI-O
    Example HPI-O: 8003621566684455
    Max Length:16

    doco Documentation for this format

    Constraints

    Id Grade Path(s) Description Expression
    inv-hpio-0 error Identifier HPI-O shall be 16 digits value.matches('^([0-9]{16})$')
    inv-hpio-1 error Identifier HPI-O prefix shall be 800362 value.startsWith('800362')
    inv-hpio-2 error Identifier HPI-O shall pass the Luhn algorithm check (((select(value.substring(0,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(1,1).toInteger())+(select(value.substring(2,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(3,1).toInteger())+(select(value.substring(4,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(5,1).toInteger())+(select(value.substring(6,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(7,1).toInteger())+(select(value.substring(8,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(9,1).toInteger())+(select(value.substring(10,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(11,1).toInteger())+(select(value.substring(12,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(13,1).toInteger())+(select(value.substring(14,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(15,1).toInteger()))mod 10=0)

    Snapshot ViewView

    NameFlagsCard.TypeDescription & Constraints    Filter: doco
    Identifier C 0..* Identifier Healthcare Provider Identifier – Organisation (HPI-O)
    Constraints: inv-hpio-0, inv-hpio-1, inv-hpio-2
    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" : "NOI"
        }
      ]
    }
    Identifier.system This element is included in summaries. 1..1 uri The namespace for the identifier value
    Fixed Value: http://ns.electronichealth.net.au/id/hi/hpio/1.0 (no extensions allowed)
    Identifier.value This element is included in summaries. C 1..1 string HPI-O
    Example General: 123456
    Example HPI-O: 8003621566684455
    Max Length:16
    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-hpio-0 error Identifier HPI-O shall be 16 digits value.matches('^([0-9]{16})$')
    inv-hpio-1 error Identifier HPI-O prefix shall be 800362 value.startsWith('800362')
    inv-hpio-2 error Identifier HPI-O shall pass the Luhn algorithm check (((select(value.substring(0,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(1,1).toInteger())+(select(value.substring(2,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(3,1).toInteger())+(select(value.substring(4,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(5,1).toInteger())+(select(value.substring(6,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(7,1).toInteger())+(select(value.substring(8,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(9,1).toInteger())+(select(value.substring(10,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(11,1).toInteger())+(select(value.substring(12,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(13,1).toInteger())+(select(value.substring(14,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(15,1).toInteger()))mod 10=0)

    This structure is derived from Identifier

    Summary

    Mandatory: 3 elements
    Fixed: 1 element

    Maturity: 2

     

    Other representations of profile: CSV, Excel, Schematron