IE (Ireland) Core Implementation Guide
0.3.0 - draft
IE (Ireland) Core Implementation Guide
0.3.0 - draft
IE (Ireland) Core Implementation Guide - Local Development build (v0.3.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Official URL: https://hl7-ie.github.io/ie-core/fhir/ie/core/StructureDefinition/ie-core-individual-healthcare-identifier | Version: 0.3.0 | |||
| Draft as of 2026-09-28 | Computable Name: IECoreIndividualHealthcareIdentifier | |||
The Individual Health Identifier (IHI) issued by the HSE. HIQA EP/PS 1.3.1 describe it as 'a unique 18 or 10-digit number'. The system URI is a placeholder pending an HSE-published URI (OI-003).
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter:   |
|---|---|---|---|---|
  Identifier |
C | 0..* | Identifier(4.0.1) | An identifier intended for computation Constraints: ie-pat-1 |
  Slices for extension |
Content/Rules for all slices | |||
   extension:ihiStatus |
S | 0..1 | code | IHI status (active, deceased, retired) URL: https://hl7-ie.github.io/ie-core/fhir/ie/core/StructureDefinition/ie-core-ihi-status Binding: IECoreIHIStatusVS (0.3.0) (required) Constraints: ext-1 |
| extension:ihiRecordStatus |
S | 0..1 | code | IHI record status (verified, unverified, provisional) URL: https://hl7-ie.github.io/ie-core/fhir/ie/core/StructureDefinition/ie-core-ihi-record-status Binding: IECoreIHIRecordStatusVS (0.3.0) (required) Constraints: ext-1 |
 extension:ihiVerifiedDate |
S | 0..1 | date | Date the IHI was last verified URL: https://hl7-ie.github.io/ie-core/fhir/ie/core/StructureDefinition/ie-core-ihi-verified-date Constraints: ext-1 |
 use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
 type |
SΣ | 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 |
1..1 | string | Representation defined by the system Fixed Value: National unique individual identifier | |
 userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |
| text |
0..1 | string | Plain text representation of the concept | |
| system |
SΣ | 1..1 | uri | The namespace for the identifier value Fixed Value: https://hl7-ie.github.io/ie-core/fhir/ie/core/sid/ihi |
| value |
SΣ | 1..1 | string | IHI number (18 or 10 digits) Example General: 123456 |
| Documentation for this format | ||||
| 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. |
| Id | Grade | Path(s) | Description | Expression |
| ele-1 | error | Identifier, Identifier.extension:ihiStatus, Identifier.extension:ihiRecordStatus, Identifier.extension:ihiVerifiedDate, Identifier.use, Identifier.type, Identifier.system, Identifier.value | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | Identifier.extension:ihiStatus, Identifier.extension:ihiRecordStatus, Identifier.extension:ihiVerifiedDate | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| ie-pat-1 | error | Identifier | IHI SHALL be 18 or 10 digits (HIQA EP/PS 1.3.1: 'A unique 18 or 10-digit number') |
value.matches('^([0-9]{18}|[0-9]{10})$')
|
This structure is derived from Identifier
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Identifier |
C | 0..* | Identifier(4.0.1) | An identifier intended for computation |
| Slices for extension |
Content/Rules for all slices | |||
| extension:ihiStatus |
S | 0..1 | code | IHI status (active, deceased, retired) URL: https://hl7-ie.github.io/ie-core/fhir/ie/core/StructureDefinition/ie-core-ihi-status Binding: IECoreIHIStatusVS (0.3.0) (required) |
| extension:ihiRecordStatus |
S | 0..1 | code | IHI record status (verified, unverified, provisional) URL: https://hl7-ie.github.io/ie-core/fhir/ie/core/StructureDefinition/ie-core-ihi-record-status Binding: IECoreIHIRecordStatusVS (0.3.0) (required) |
| extension:ihiVerifiedDate |
S | 0..1 | date | Date the IHI was last verified URL: https://hl7-ie.github.io/ie-core/fhir/ie/core/StructureDefinition/ie-core-ihi-verified-date |
| type |
S | 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 | |
| display |
1..1 | string | Representation defined by the system Fixed Value: National unique individual identifier | |
| system |
S | 1..1 | uri | The namespace for the identifier value Fixed Value: https://hl7-ie.github.io/ie-core/fhir/ie/core/sid/ihi |
| value |
S | 1..1 | string | IHI number (18 or 10 digits) |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Description | Expression |
| ie-pat-1 | error | Identifier | IHI SHALL be 18 or 10 digits (HIQA EP/PS 1.3.1: 'A unique 18 or 10-digit number') |
value.matches('^([0-9]{18}|[0-9]{10})$')
|
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Identifier |
C | 0..* | Identifier(4.0.1) | An identifier intended for computation Constraints: ie-pat-1 |
| id |
0..1 | string | Unique id for inter-element referencing | |
 Slices for extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |
| extension:ihiStatus |
S | 0..1 | code | IHI status (active, deceased, retired) URL: https://hl7-ie.github.io/ie-core/fhir/ie/core/StructureDefinition/ie-core-ihi-status Binding: IECoreIHIStatusVS (0.3.0) (required) Constraints: ext-1 |
| extension:ihiRecordStatus |
S | 0..1 | code | IHI record status (verified, unverified, provisional) URL: https://hl7-ie.github.io/ie-core/fhir/ie/core/StructureDefinition/ie-core-ihi-record-status Binding: IECoreIHIRecordStatusVS (0.3.0) (required) Constraints: ext-1 |
| extension:ihiVerifiedDate |
S | 0..1 | date | Date the IHI was last verified URL: https://hl7-ie.github.io/ie-core/fhir/ie/core/StructureDefinition/ie-core-ihi-verified-date Constraints: ext-1 |
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| type |
SΣ | 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 |
1..1 | string | Representation defined by the system Fixed Value: National unique individual identifier | |
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |
| text |
0..1 | string | Plain text representation of the concept | |
| system |
SΣ | 1..1 | uri | The namespace for the identifier value Fixed Value: https://hl7-ie.github.io/ie-core/fhir/ie/core/sid/ihi |
| value |
SΣ | 1..1 | string | IHI number (18 or 10 digits) Example General: 123456 |
| 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 | ||||
| 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. |
| Id | Grade | Path(s) | Description | Expression |
| ele-1 | error | Identifier, Identifier.extension, Identifier.extension:ihiStatus, Identifier.extension:ihiRecordStatus, Identifier.extension:ihiVerifiedDate, Identifier.use, Identifier.type, Identifier.system, Identifier.value, Identifier.period, Identifier.assigner | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | Identifier.extension, Identifier.extension:ihiStatus, Identifier.extension:ihiRecordStatus, Identifier.extension:ihiVerifiedDate | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| ie-pat-1 | error | Identifier | IHI SHALL be 18 or 10 digits (HIQA EP/PS 1.3.1: 'A unique 18 or 10-digit number') |
value.matches('^([0-9]{18}|[0-9]{10})$')
|
This structure is derived from Identifier
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Identifier |
C | 0..* | Identifier(4.0.1) | An identifier intended for computation Constraints: ie-pat-1 |
| Slices for extension |
Content/Rules for all slices | |||
| extension:ihiStatus |
S | 0..1 | code | IHI status (active, deceased, retired) URL: https://hl7-ie.github.io/ie-core/fhir/ie/core/StructureDefinition/ie-core-ihi-status Binding: IECoreIHIStatusVS (0.3.0) (required) Constraints: ext-1 |
| extension:ihiRecordStatus |
S | 0..1 | code | IHI record status (verified, unverified, provisional) URL: https://hl7-ie.github.io/ie-core/fhir/ie/core/StructureDefinition/ie-core-ihi-record-status Binding: IECoreIHIRecordStatusVS (0.3.0) (required) Constraints: ext-1 |
| extension:ihiVerifiedDate |
S | 0..1 | date | Date the IHI was last verified URL: https://hl7-ie.github.io/ie-core/fhir/ie/core/StructureDefinition/ie-core-ihi-verified-date Constraints: ext-1 |
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| type |
SΣ | 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 |
1..1 | string | Representation defined by the system Fixed Value: National unique individual identifier | |
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |
| text |
0..1 | string | Plain text representation of the concept | |
| system |
SΣ | 1..1 | uri | The namespace for the identifier value Fixed Value: https://hl7-ie.github.io/ie-core/fhir/ie/core/sid/ihi |
| value |
SΣ | 1..1 | string | IHI number (18 or 10 digits) Example General: 123456 |
| Documentation for this format | ||||
| 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. |
| Id | Grade | Path(s) | Description | Expression |
| ele-1 | error | Identifier, Identifier.extension:ihiStatus, Identifier.extension:ihiRecordStatus, Identifier.extension:ihiVerifiedDate, Identifier.use, Identifier.type, Identifier.system, Identifier.value | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | Identifier.extension:ihiStatus, Identifier.extension:ihiRecordStatus, Identifier.extension:ihiVerifiedDate | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| ie-pat-1 | error | Identifier | IHI SHALL be 18 or 10 digits (HIQA EP/PS 1.3.1: 'A unique 18 or 10-digit number') |
value.matches('^([0-9]{18}|[0-9]{10})$')
|
Differential View
This structure is derived from Identifier
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Identifier |
C | 0..* | Identifier(4.0.1) | An identifier intended for computation |
| Slices for extension |
Content/Rules for all slices | |||
| extension:ihiStatus |
S | 0..1 | code | IHI status (active, deceased, retired) URL: https://hl7-ie.github.io/ie-core/fhir/ie/core/StructureDefinition/ie-core-ihi-status Binding: IECoreIHIStatusVS (0.3.0) (required) |
| extension:ihiRecordStatus |
S | 0..1 | code | IHI record status (verified, unverified, provisional) URL: https://hl7-ie.github.io/ie-core/fhir/ie/core/StructureDefinition/ie-core-ihi-record-status Binding: IECoreIHIRecordStatusVS (0.3.0) (required) |
| extension:ihiVerifiedDate |
S | 0..1 | date | Date the IHI was last verified URL: https://hl7-ie.github.io/ie-core/fhir/ie/core/StructureDefinition/ie-core-ihi-verified-date |
| type |
S | 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 | |
| display |
1..1 | string | Representation defined by the system Fixed Value: National unique individual identifier | |
| system |
S | 1..1 | uri | The namespace for the identifier value Fixed Value: https://hl7-ie.github.io/ie-core/fhir/ie/core/sid/ihi |
| value |
S | 1..1 | string | IHI number (18 or 10 digits) |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Description | Expression |
| ie-pat-1 | error | Identifier | IHI SHALL be 18 or 10 digits (HIQA EP/PS 1.3.1: 'A unique 18 or 10-digit number') |
value.matches('^([0-9]{18}|[0-9]{10})$')
|
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Identifier |
C | 0..* | Identifier(4.0.1) | An identifier intended for computation Constraints: ie-pat-1 |
| id |
0..1 | string | Unique id for inter-element referencing | |
| Slices for extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |
| extension:ihiStatus |
S | 0..1 | code | IHI status (active, deceased, retired) URL: https://hl7-ie.github.io/ie-core/fhir/ie/core/StructureDefinition/ie-core-ihi-status Binding: IECoreIHIStatusVS (0.3.0) (required) Constraints: ext-1 |
| extension:ihiRecordStatus |
S | 0..1 | code | IHI record status (verified, unverified, provisional) URL: https://hl7-ie.github.io/ie-core/fhir/ie/core/StructureDefinition/ie-core-ihi-record-status Binding: IECoreIHIRecordStatusVS (0.3.0) (required) Constraints: ext-1 |
| extension:ihiVerifiedDate |
S | 0..1 | date | Date the IHI was last verified URL: https://hl7-ie.github.io/ie-core/fhir/ie/core/StructureDefinition/ie-core-ihi-verified-date Constraints: ext-1 |
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| type |
SΣ | 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 |
1..1 | string | Representation defined by the system Fixed Value: National unique individual identifier | |
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |
| text |
0..1 | string | Plain text representation of the concept | |
| system |
SΣ | 1..1 | uri | The namespace for the identifier value Fixed Value: https://hl7-ie.github.io/ie-core/fhir/ie/core/sid/ihi |
| value |
SΣ | 1..1 | string | IHI number (18 or 10 digits) Example General: 123456 |
| 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 | ||||
| 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. |
| Id | Grade | Path(s) | Description | Expression |
| ele-1 | error | Identifier, Identifier.extension, Identifier.extension:ihiStatus, Identifier.extension:ihiRecordStatus, Identifier.extension:ihiVerifiedDate, Identifier.use, Identifier.type, Identifier.system, Identifier.value, Identifier.period, Identifier.assigner | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | Identifier.extension, Identifier.extension:ihiStatus, Identifier.extension:ihiRecordStatus, Identifier.extension:ihiVerifiedDate | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| ie-pat-1 | error | Identifier | IHI SHALL be 18 or 10 digits (HIQA EP/PS 1.3.1: 'A unique 18 or 10-digit number') |
value.matches('^([0-9]{18}|[0-9]{10})$')
|
This structure is derived from Identifier
Other representations of profile: CSV, Excel, Schematron