AU Base Implementation Guide
6.0.0-ci-build - CI Build

AU Base Implementation Guide, published by HL7 Australia. This guide is not an authorized publication; it is the continuous build for version 6.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: AUIHI - Detailed Descriptions

Page standards status: Trial-use | Maturity Level: 2

Definitions for the au-ihi data type profile.

- Key Elements Table
- Differential Elements Table
- Snapshot Elements Table

Guidance on how to interpret the contents of this table can be foundhere

0. Identifier
Definition | Individual Healthcare Identifier (IHI) assigned under the HI Service to a patient. An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.
Short | Individual Healthcare Identifier (IHI)An identifier intended for computation
Control | 0..* This element is affected by the following invariants: ele-1
Is Modifier | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) inv-ihi-value-0: IHI shall be an exactly 16 digit number (`value.matches('^([0-9]{16})$')`) inv-ihi-value-1: IHI prefix is 800360 (`value.startsWith('800360')`) inv-ihi-value-2: IHI 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)`)
2. Identifier.extension
Definition | An Extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | ExtensionAdditional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
Slicing | This element introduces a set of slices on `Identifier.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
4. Identifier.extension:ihiStatus
Slice Name | ihiStatus
Definition | IHI number status associated with an IHI identifier.
Short | IHI status
Control | 0..1
Type | Extension(IHI Status) (Extension Type: Coding)
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
6. Identifier.extension:ihiRecordStatus
Slice Name | ihiRecordStatus
Definition | Known IHI record status associated with an IHI identifier.
Short | IHI record status
Control | 0..1
Type | Extension(IHI Record Status) (Extension Type: Coding)
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
8. Identifier.extension:ihiVerifiedDate
Slice Name | ihiVerifiedDate
Definition | The date, and optionally time, that the IHI was verified with HI Services.
Short | IHI Verification Date
Control | 0..1
Type | Extension(IHI Verification Date) (Extension Type: dateTime)
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
10. Identifier.use
Definition | The purpose of this identifier.
Short | usual | official | temp | secondary | old (If known)
Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
Control | 0..1
Binding | The codes SHALL be taken from IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 (required to `http://hl7.org/fhir/ValueSet/identifier-use|4.0.1` ) Identifies the purpose for this identifier, if known .
Type | code
Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
12. Identifier.type
Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
Short | Description of identifier
Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.
Control | 10..1
Binding | Unless not suitable, these codes SHALL be taken from Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type|4.0.1 (extensible to `http://hl7.org/fhir/ValueSet/identifier-type|4.0.1` ) A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Type | CodeableConcept
Is Modifier | false
Summary | true
Requirements | Allows users to make use of identifiers when the identifier system is not known.
Pattern Value | `{ "coding" : [{ "system" : "http://terminology.hl7.org/CodeSystem/v2-0203", "code" : "NI" }] }`
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
14. Identifier.system
Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique.
Short | The namespace for the identifier value
Comments | Identifier.system is always case sensitive.
Control | 10..1
Type | uri
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.
Fixed Value | `http://ns.electronichealth.net.au/id/hi/ihi/1.0`
Example | General: http://www.acme.com/identifiers/patient
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
16. Identifier.value
Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system.
Short | IHIThe value that is unique
Comments | This concept is equivalent to Australian Institute of Health and Welfare data element 743458 Person—Individual Healthcare Identifier, N(16). If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
Control | 10..1 This element is affected by the following invariants: inv-ihi-0, inv-ihi-1, inv-ihi-2
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Max Length: | 16
Example | General: 123456 IHI: 8003608833357361
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

Guidance on how to interpret the contents of this table can be foundhere

0. Identifier
Definition | Individual Healthcare Identifier (IHI) assigned under the HI Service to a patient.
Short | Individual Healthcare Identifier (IHI)
Invariants | inv-ihi-value-0: IHI shall be an exactly 16 digit number (`value.matches('^([0-9]{16})$')`) inv-ihi-value-1: IHI prefix is 800360 (`value.startsWith('800360')`) inv-ihi-value-2: IHI 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)`)
2. Identifier.extension
Slicing | This element introduces a set of slices on `Identifier.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
4. Identifier.extension:ihiStatus
Slice Name | ihiStatus
Control | 0..1
Type | Extension(IHI Status) (Extension Type: Coding)
6. Identifier.extension:ihiRecordStatus
Slice Name | ihiRecordStatus
Control | 0..1
Type | Extension(IHI Record Status) (Extension Type: Coding)
8. Identifier.extension:ihiVerifiedDate
Slice Name | ihiVerifiedDate
Control | 0..1
Type | Extension(IHI Verification Date) (Extension Type: dateTime)
10. Identifier.type
Control | 1..?
Pattern Value | `{ "coding" : [{ "system" : "http://terminology.hl7.org/CodeSystem/v2-0203", "code" : "NI" }] }`
12. Identifier.system
Control | 1..?
Fixed Value | `http://ns.electronichealth.net.au/id/hi/ihi/1.0`
14. Identifier.value
Short | IHI
Comments | This concept is equivalent to Australian Institute of Health and Welfare data element 743458 Person—Individual Healthcare Identifier, N(16).
Control | 1..? This element is affected by the following invariants: inv-ihi-0, inv-ihi-1, inv-ihi-2
Max Length: | 16
Example | IHI: 8003608833357361

Guidance on how to interpret the contents of this table can be foundhere

0. Identifier
Definition | Individual Healthcare Identifier (IHI) assigned under the HI Service to a patient.
Short | Individual Healthcare Identifier (IHI)
Control | 0..* This element is affected by the following invariants: ele-1
Is Modifier | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) inv-ihi-value-0: IHI shall be an exactly 16 digit number (`value.matches('^([0-9]{16})$')`) inv-ihi-value-1: IHI prefix is 800360 (`value.startsWith('800360')`) inv-ihi-value-2: IHI 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)`)
2. Identifier.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
4. Identifier.extension
Definition | An Extension
Short | Extension
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `Identifier.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
6. Identifier.extension:ihiStatus
Slice Name | ihiStatus
Definition | IHI number status associated with an IHI identifier.
Short | IHI status
Control | 0..1
Type | Extension(IHI Status) (Extension Type: Coding)
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
8. Identifier.extension:ihiRecordStatus
Slice Name | ihiRecordStatus
Definition | Known IHI record status associated with an IHI identifier.
Short | IHI record status
Control | 0..1
Type | Extension(IHI Record Status) (Extension Type: Coding)
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
10. Identifier.extension:ihiVerifiedDate
Slice Name | ihiVerifiedDate
Definition | The date, and optionally time, that the IHI was verified with HI Services.
Short | IHI Verification Date
Control | 0..1
Type | Extension(IHI Verification Date) (Extension Type: dateTime)
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
12. Identifier.use
Definition | The purpose of this identifier.
Short | usual | official | temp | secondary | old (If known)
Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
Control | 0..1
Binding | The codes SHALL be taken from IdentifierUse (required to `http://hl7.org/fhir/ValueSet/identifier-use|4.0.1` ) Identifies the purpose for this identifier, if known .
Type | code
Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
14. Identifier.type
Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
Short | Description of identifier
Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.
Control | 1..1
Binding | Unless not suitable, these codes SHALL be taken from Identifier Type Codes (extensible to `http://hl7.org/fhir/ValueSet/identifier-type|4.0.1` ) A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Type | CodeableConcept
Is Modifier | false
Summary | true
Requirements | Allows users to make use of identifiers when the identifier system is not known.
Pattern Value | `{ "coding" : [{ "system" : "http://terminology.hl7.org/CodeSystem/v2-0203", "code" : "NI" }] }`
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
16. Identifier.system
Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique.
Short | The namespace for the identifier value
Comments | Identifier.system is always case sensitive.
Control | 1..1
Type | uri
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.
Fixed Value | `http://ns.electronichealth.net.au/id/hi/ihi/1.0`
Example | General: http://www.acme.com/identifiers/patient
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
18. Identifier.value
Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system.
Short | IHI
Comments | This concept is equivalent to Australian Institute of Health and Welfare data element 743458 Person—Individual Healthcare Identifier, N(16).
Control | 1..1 This element is affected by the following invariants: inv-ihi-0, inv-ihi-1, inv-ihi-2
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Max Length: | 16
Example | General: 123456 IHI: 8003608833357361
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
20. Identifier.period
Definition | Time period during which identifier is/was valid for use.
Short | Time period when id is/was valid for use
Control | 0..1
Type | Period
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
22. Identifier.assigner
Definition | Organization that issued/manages the identifier.
Short | Organization that issued id (may be just text)
Comments | The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.
Control | 0..1
Type | Reference(Organization)
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)