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
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 used in this profile:
Multiple IHIs are supported particularly to support the recording of IHI values where the status and/or record status varies (e.g. deceased, provisional).
Patient with IHI, Medicare card, and Health Care Card
Patient with IHI and DVA number
Benedicte du Marche as a next of kin
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.
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Identifier | I | 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 | |
ihi-status | 0..1 | Coding | IHI 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..1 | Coding | IHI 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..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 | |
value | 1..1 | string | IHI Example IHI: 8003608833357361 Max Length: 16 | |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Identifier | I | 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 |
id | 0..1 | string | Unique id for inter-element referencing | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
ihi-status | 0..1 | Coding | IHI 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..1 | Coding | IHI 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..1 | dateTime | IHI Verification Date URL: http://hl7.org.au/fhir/StructureDefinition/ihi-verified-date | |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
type | Σ | 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: At least the following |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |
version | 0..1 | string | Version of the system - if relevant | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: NI | |
display | 0..1 | string | Representation defined by the system | |
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |
text | 0..1 | string | Plain text representation of the concept | |
system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: http://ns.electronichealth.net.au/id/hi/ihi/1.0 |
value | Σ | 1..1 | string | IHI Example General: 123456 Example IHI: 8003608833357361 Max Length: 16 |
period | Σ | 0..1 | Period | Time period when id is/was valid for use |
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
Documentation for this format |
Differential View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Identifier | I | 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 | |
ihi-status | 0..1 | Coding | IHI 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..1 | Coding | IHI 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..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 | |
value | 1..1 | string | IHI Example IHI: 8003608833357361 Max Length: 16 | |
Documentation for this format |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Identifier | I | 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 |
id | 0..1 | string | Unique id for inter-element referencing | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
ihi-status | 0..1 | Coding | IHI 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..1 | Coding | IHI 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..1 | dateTime | IHI Verification Date URL: http://hl7.org.au/fhir/StructureDefinition/ihi-verified-date | |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
type | Σ | 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: At least the following |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |
version | 0..1 | string | Version of the system - if relevant | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: NI | |
display | 0..1 | string | Representation defined by the system | |
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |
text | 0..1 | string | Plain text representation of the concept | |
system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: http://ns.electronichealth.net.au/id/hi/ihi/1.0 |
value | Σ | 1..1 | string | IHI Example General: 123456 Example IHI: 8003608833357361 Max Length: 16 |
period | Σ | 0..1 | Period | Time period when id is/was valid for use |
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
Documentation for this format |
Downloads: StructureDefinition: (XML, JSON), Schema: XML Schematron
Below is an overview of the required search and read operations.
Summary of Search Criteria for StructureDefinition-au-ihi
none defined