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-ihi

AU IHI [FMM 2]

This identifier profile defines an Individual Healthcare Identifier (IHI)[1][2] in an Australian context. An IHI is assigned under the Healthcare Identifiers (HI) Service to a patient.

Extensions

Extensions used in this profile:

Usage Notes

Multiple IHIs are supported particularly to support the recording of IHI values where the status and/or record status varies (e.g. deceased, provisional).

Examples

Patient with IHI, Medicare card, and Health Care Card

Patient with IHI and DVA number

Benedicte du Marche as a next of kin

Mary Smith as a carer

1.0.1 Formal Views of Profile Content

The official URL for this profile is:

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

This identifier profile defines an Individual Healthcare Identifier (IHI) 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.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Identifier I0..*IdentifierIndividual 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..*ExtensionExtension
Slice: Unordered, Open by value:url
... ihi-status 0..1CodingIHI status
URL: http://hl7.org.au/fhir/StructureDefinition/ihi-status
Binding: https://healthterminologies.gov.au/fhir/ValueSet/ihi-status-1 (required)
... ihi-record-status 0..1CodingIHI record status
URL: http://hl7.org.au/fhir/StructureDefinition/ihi-record-status
Binding: https://healthterminologies.gov.au/fhir/ValueSet/ihi-record-status-1 (required)
... ihi-verified-date 0..1dateTimeIHI Verification Date
URL: http://hl7.org.au/fhir/StructureDefinition/ihi-verified-date
... type 1..1CodeableConceptDescription of identifier
Required Pattern: At least the following
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: NI
... system 1..1uriThe namespace for the identifier value
Fixed Value: http://ns.electronichealth.net.au/id/hi/ihi/1.0
... value 1..1stringIHI
Example IHI: 8003608833357361
Max Length: 16

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Identifier I0..*IdentifierIndividual 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
... id 0..1stringUnique id for inter-element referencing
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... ihi-status 0..1CodingIHI status
URL: http://hl7.org.au/fhir/StructureDefinition/ihi-status
Binding: https://healthterminologies.gov.au/fhir/ValueSet/ihi-status-1 (required)
... ihi-record-status 0..1CodingIHI record status
URL: http://hl7.org.au/fhir/StructureDefinition/ihi-record-status
Binding: https://healthterminologies.gov.au/fhir/ValueSet/ihi-record-status-1 (required)
... ihi-verified-date 0..1dateTimeIHI Verification Date
URL: http://hl7.org.au/fhir/StructureDefinition/ihi-verified-date
... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

... type Σ1..1CodeableConceptDescription 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: At least the following
.... id0..1stringUnique id for inter-element referencing
.... extension0..*ExtensionAdditional content defined by implementations
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
..... version0..1stringVersion of the system - if relevant
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: NI
..... display0..1stringRepresentation defined by the system
..... userSelected0..1booleanIf this coding was chosen directly by the user
.... text0..1stringPlain text representation of the concept
... system Σ1..1uriThe namespace for the identifier value
Fixed Value: http://ns.electronichealth.net.au/id/hi/ihi/1.0
... value Σ1..1stringIHI
Example General: 123456
Example IHI: 8003608833357361
Max Length: 16
... period Σ0..1PeriodTime period when id is/was valid for use
... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)

doco Documentation for this format

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Identifier I0..*IdentifierIndividual 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..*ExtensionExtension
Slice: Unordered, Open by value:url
... ihi-status 0..1CodingIHI status
URL: http://hl7.org.au/fhir/StructureDefinition/ihi-status
Binding: https://healthterminologies.gov.au/fhir/ValueSet/ihi-status-1 (required)
... ihi-record-status 0..1CodingIHI record status
URL: http://hl7.org.au/fhir/StructureDefinition/ihi-record-status
Binding: https://healthterminologies.gov.au/fhir/ValueSet/ihi-record-status-1 (required)
... ihi-verified-date 0..1dateTimeIHI Verification Date
URL: http://hl7.org.au/fhir/StructureDefinition/ihi-verified-date
... type 1..1CodeableConceptDescription of identifier
Required Pattern: At least the following
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: NI
... system 1..1uriThe namespace for the identifier value
Fixed Value: http://ns.electronichealth.net.au/id/hi/ihi/1.0
... value 1..1stringIHI
Example IHI: 8003608833357361
Max Length: 16

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Identifier I0..*IdentifierIndividual 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
... id 0..1stringUnique id for inter-element referencing
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... ihi-status 0..1CodingIHI status
URL: http://hl7.org.au/fhir/StructureDefinition/ihi-status
Binding: https://healthterminologies.gov.au/fhir/ValueSet/ihi-status-1 (required)
... ihi-record-status 0..1CodingIHI record status
URL: http://hl7.org.au/fhir/StructureDefinition/ihi-record-status
Binding: https://healthterminologies.gov.au/fhir/ValueSet/ihi-record-status-1 (required)
... ihi-verified-date 0..1dateTimeIHI Verification Date
URL: http://hl7.org.au/fhir/StructureDefinition/ihi-verified-date
... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

... type Σ1..1CodeableConceptDescription 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: At least the following
.... id0..1stringUnique id for inter-element referencing
.... extension0..*ExtensionAdditional content defined by implementations
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
..... version0..1stringVersion of the system - if relevant
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: NI
..... display0..1stringRepresentation defined by the system
..... userSelected0..1booleanIf this coding was chosen directly by the user
.... text0..1stringPlain text representation of the concept
... system Σ1..1uriThe namespace for the identifier value
Fixed Value: http://ns.electronichealth.net.au/id/hi/ihi/1.0
... value Σ1..1stringIHI
Example General: 123456
Example IHI: 8003608833357361
Max Length: 16
... period Σ0..1PeriodTime period when id is/was valid for use
... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)

doco 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-ihi

none defined

Issues & Feedback