AU Base Implementation Guide
5.0.1-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 5.0.1-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 IHI

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

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

This identifier profile defines an Individual Healthcare Identifier in an Australian context (see Australian Digital Health Agency for further information). An IHI is assigned under the Healthcare Identifiers (HI) Service to a patient.

Usage Notes

Profile specific implementation guidance:

  • Multiple Individual Healthcare Identifiers (IHIs) can be used in where the IHI status and/or IHI record status varies (e.g. deceased, provisional) though implementers should be aware when exchanging patient information that systems may not support multiple IHIs for an individual.

Usage:

Changes since version 5.0.0:

  • No changes

    • Formal Views of Profile Content

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

    This structure is derived from Identifier

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Identifier C 0..* Identifier Individual Healthcare Identifier (IHI)
    inv-ihi-value-0: IHI shall be an exactly 16 digit number
    inv-ihi-value-1: IHI prefix is 800360
    inv-ihi-value-2: IHI shall pass the Luhn algorithm check
    ... Slices for extension 0..* Extension Extension
    Slice: Unordered, Open by value:url
    .... extension:ihiStatus 0..1 Coding IHI status
    URL: http://hl7.org.au/fhir/StructureDefinition/ihi-status
    Binding: Individual Healthcare Identifier Status . (required)
    .... extension:ihiRecordStatus 0..1 Coding IHI record status
    URL: http://hl7.org.au/fhir/StructureDefinition/ihi-record-status
    Binding: Individual Healthcare Identifier Record Status . (required)
    .... extension:ihiVerifiedDate 0..1 dateTime IHI Verification Date
    URL: http://hl7.org.au/fhir/StructureDefinition/ihi-verified-date
    ... type 1..1 CodeableConcept Description of identifier
    Required Pattern: At least the following
    .... coding 1..* Coding Code defined by a terminology system
    Fixed Value: (complex)
    ..... system 1..1 uri Identity of the terminology system
    Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
    ..... code 1..1 code Symbol in syntax defined by the system
    Fixed Value: NI
    ... system 1..1 uri The namespace for the identifier value
    Fixed Value: http://ns.electronichealth.net.au/id/hi/ihi/1.0

    doco Documentation for this format

    Constraints

    IdGradePath(s)DetailsRequirements
    inv-ihi-value-0errorIdentifierIHI shall be an exactly 16 digit number
    : value.matches('^([0-9]{16})$')
    inv-ihi-value-1errorIdentifierIHI prefix is 800360
    : value.startsWith('800360')
    inv-ihi-value-2errorIdentifierIHI 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)

     

    Other representations of profile: CSV, Excel, Schematron