IE (Ireland) Core Implementation Guide
1.0.0-ballot - Ballot Ireland flag

Publication Build: This will be filled in by the publication tooling

Data Type Profile: IE Individual Healthcare Identifier (IHI)

Official URL: http://iehr.ai/fhir/ie/core/StructureDefinition/ie-core-individual-healthcare-identifier Version: 1.0.0-ballot
Standards status: Trial-use Maturity Level: 3 Computable Name: IECoreIndividualHealthcareIdentifier
Other Identifiers: OID:1.3.6.1.4.1.54392.5.2690.42.77

Copyright/Legal: iEHR.ai, all rights reserved Creative Commons License

This identifier profile defines an Individual Healthcare Identifier (IHI) in an Irish context (see Individual Health Identifier (IHI) )

Usage:

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)
ie-core-ihi-0: IHI shall be an exactly 18 digit number
ie-core-ihi-1: IHI shall pass the position 17 modulus 11 check digit
ie-core-ihi-2: IHI shall pass the position 18 GS1 check digit
... Slices for extension Content/Rules for all slices
.... ihiStatus 0..1 Coding IHI status
URL: http://iehr.ai/fhir/ie/core/StructureDefinition/ie-core-ihi-status
Binding: IE Core Individual Healthcare Identifier Status (required)
.... ihiRecordStatus 0..1 Coding IHI record status
URL: http://iehr.ai/fhir/ie/core/StructureDefinition/ie-core-ihi-record-status
Binding: IE Core Individual Healthcare Identifier Record Status (required)
.... ihiVerifiedDate 0..1 dateTime IHI Verification Date
URL: http://iehr.ai/fhir/ie/core/StructureDefinition/ie-core-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://iehr.ai/fhir/sid/ie/hse/ihi
... value C 1..1 string IHI
Max Length:18

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
ie-core-ihi-0errorIdentifierIHI shall be an exactly 18 digit number
: value.matches('^([0-9]{18})$')
ie-core-ihi-1errorIdentifierIHI shall pass the position 17 modulus 11 check digit
: ( ( (select(value.substring(0,1).toInteger()).select($this*17))+ (select(value.substring(1,1).toInteger()).select($this*16))+ (select(value.substring(2,1).toInteger()).select($this*15))+ (select(value.substring(3,1).toInteger()).select($this*14))+ (select(value.substring(4,1).toInteger()).select($this*13))+ (select(value.substring(5,1).toInteger()).select($this*12))+ (select(value.substring(6,1).toInteger()).select($this*11))+ (select(value.substring(7,1).toInteger()).select($this*10))+ (select(value.substring(8,1).toInteger()).select($this*9))+ (select(value.substring(9,1).toInteger()).select($this*8))+ (select(value.substring(10,1).toInteger()).select($this*7))+ (select(value.substring(11,1).toInteger()).select($this*6))+ (select(value.substring(12,1).toInteger()).select($this*5))+ (select(value.substring(13,1).toInteger()).select($this*4))+ (select(value.substring(14,1).toInteger()).select($this*3))+ (select(value.substring(15,1).toInteger()).select($this*2))+ (select(value.substring(16,1).toInteger()).select($this)) )mod 11=0 )
ie-core-ihi-2errorIdentifierIHI shall pass the position 18 GS1 check digit
: ( ( (select(value.substring(0,1).toInteger()).select($this*3))+ (value.substring(1,1).toInteger())+ (select(value.substring(2,1).toInteger()).select($this*3))+ (value.substring(3,1).toInteger())+ (select(value.substring(4,1).toInteger()).select($this*3))+ (value.substring(5,1).toInteger())+ (select(value.substring(6,1).toInteger()).select($this*3))+ (value.substring(7,1).toInteger())+ (select(value.substring(8,1).toInteger()).select($this*3))+ (value.substring(9,1).toInteger())+ (select(value.substring(10,1).toInteger()).select($this*3))+ (value.substring(11,1).toInteger())+ (select(value.substring(12,1).toInteger()).select($this*3))+ (value.substring(13,1).toInteger())+ (select(value.substring(14,1).toInteger()).select($this*3))+ (value.substring(15,1).toInteger())+ (select(value.substring(16,1).toInteger()).select($this*3))+ (value.substring(17,1).toInteger()) )mod 10=0 )
NameFlagsCard.TypeDescription & Constraintsdoco
.. Identifier C 0..* Identifier Individual Healthcare Identifier (IHI)
ie-core-ihi-0: IHI shall be an exactly 18 digit number
ie-core-ihi-1: IHI shall pass the position 17 modulus 11 check digit
ie-core-ihi-2: IHI shall pass the position 18 GS1 check digit
... Slices for extension Content/Rules for all slices
.... ihiStatus 0..1 Coding IHI status
URL: http://iehr.ai/fhir/ie/core/StructureDefinition/ie-core-ihi-status
Binding: IE Core Individual Healthcare Identifier Status (required)
.... ihiRecordStatus 0..1 Coding IHI record status
URL: http://iehr.ai/fhir/ie/core/StructureDefinition/ie-core-ihi-record-status
Binding: IE Core Individual Healthcare Identifier Record Status (required)
.... ihiVerifiedDate 0..1 dateTime IHI Verification Date
URL: http://iehr.ai/fhir/ie/core/StructureDefinition/ie-core-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
.... 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://iehr.ai/fhir/sid/ie/hse/ihi
... value ΣC 1..1 string IHI
Example General: 123456
Max Length:18

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Identifier.typeextensiblePattern: NI
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
ie-core-ihi-0errorIdentifierIHI shall be an exactly 18 digit number
: value.matches('^([0-9]{18})$')
ie-core-ihi-1errorIdentifierIHI shall pass the position 17 modulus 11 check digit
: ( ( (select(value.substring(0,1).toInteger()).select($this*17))+ (select(value.substring(1,1).toInteger()).select($this*16))+ (select(value.substring(2,1).toInteger()).select($this*15))+ (select(value.substring(3,1).toInteger()).select($this*14))+ (select(value.substring(4,1).toInteger()).select($this*13))+ (select(value.substring(5,1).toInteger()).select($this*12))+ (select(value.substring(6,1).toInteger()).select($this*11))+ (select(value.substring(7,1).toInteger()).select($this*10))+ (select(value.substring(8,1).toInteger()).select($this*9))+ (select(value.substring(9,1).toInteger()).select($this*8))+ (select(value.substring(10,1).toInteger()).select($this*7))+ (select(value.substring(11,1).toInteger()).select($this*6))+ (select(value.substring(12,1).toInteger()).select($this*5))+ (select(value.substring(13,1).toInteger()).select($this*4))+ (select(value.substring(14,1).toInteger()).select($this*3))+ (select(value.substring(15,1).toInteger()).select($this*2))+ (select(value.substring(16,1).toInteger()).select($this)) )mod 11=0 )
ie-core-ihi-2errorIdentifierIHI shall pass the position 18 GS1 check digit
: ( ( (select(value.substring(0,1).toInteger()).select($this*3))+ (value.substring(1,1).toInteger())+ (select(value.substring(2,1).toInteger()).select($this*3))+ (value.substring(3,1).toInteger())+ (select(value.substring(4,1).toInteger()).select($this*3))+ (value.substring(5,1).toInteger())+ (select(value.substring(6,1).toInteger()).select($this*3))+ (value.substring(7,1).toInteger())+ (select(value.substring(8,1).toInteger()).select($this*3))+ (value.substring(9,1).toInteger())+ (select(value.substring(10,1).toInteger()).select($this*3))+ (value.substring(11,1).toInteger())+ (select(value.substring(12,1).toInteger()).select($this*3))+ (value.substring(13,1).toInteger())+ (select(value.substring(14,1).toInteger()).select($this*3))+ (value.substring(15,1).toInteger())+ (select(value.substring(16,1).toInteger()).select($this*3))+ (value.substring(17,1).toInteger()) )mod 10=0 )
NameFlagsCard.TypeDescription & Constraintsdoco
.. Identifier C 0..* Identifier Individual Healthcare Identifier (IHI)
ie-core-ihi-0: IHI shall be an exactly 18 digit number
ie-core-ihi-1: IHI shall pass the position 17 modulus 11 check digit
ie-core-ihi-2: IHI shall pass the position 18 GS1 check digit
... 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
.... ihiStatus 0..1 Coding IHI status
URL: http://iehr.ai/fhir/ie/core/StructureDefinition/ie-core-ihi-status
Binding: IE Core Individual Healthcare Identifier Status (required)
.... ihiRecordStatus 0..1 Coding IHI record status
URL: http://iehr.ai/fhir/ie/core/StructureDefinition/ie-core-ihi-record-status
Binding: IE Core Individual Healthcare Identifier Record Status (required)
.... ihiVerifiedDate 0..1 dateTime IHI Verification Date
URL: http://iehr.ai/fhir/ie/core/StructureDefinition/ie-core-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://iehr.ai/fhir/sid/ie/hse/ihi
... value ΣC 1..1 string IHI
Example General: 123456
Max Length:18
... 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)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Identifier.typeextensiblePattern: NI
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
ie-core-ihi-0errorIdentifierIHI shall be an exactly 18 digit number
: value.matches('^([0-9]{18})$')
ie-core-ihi-1errorIdentifierIHI shall pass the position 17 modulus 11 check digit
: ( ( (select(value.substring(0,1).toInteger()).select($this*17))+ (select(value.substring(1,1).toInteger()).select($this*16))+ (select(value.substring(2,1).toInteger()).select($this*15))+ (select(value.substring(3,1).toInteger()).select($this*14))+ (select(value.substring(4,1).toInteger()).select($this*13))+ (select(value.substring(5,1).toInteger()).select($this*12))+ (select(value.substring(6,1).toInteger()).select($this*11))+ (select(value.substring(7,1).toInteger()).select($this*10))+ (select(value.substring(8,1).toInteger()).select($this*9))+ (select(value.substring(9,1).toInteger()).select($this*8))+ (select(value.substring(10,1).toInteger()).select($this*7))+ (select(value.substring(11,1).toInteger()).select($this*6))+ (select(value.substring(12,1).toInteger()).select($this*5))+ (select(value.substring(13,1).toInteger()).select($this*4))+ (select(value.substring(14,1).toInteger()).select($this*3))+ (select(value.substring(15,1).toInteger()).select($this*2))+ (select(value.substring(16,1).toInteger()).select($this)) )mod 11=0 )
ie-core-ihi-2errorIdentifierIHI shall pass the position 18 GS1 check digit
: ( ( (select(value.substring(0,1).toInteger()).select($this*3))+ (value.substring(1,1).toInteger())+ (select(value.substring(2,1).toInteger()).select($this*3))+ (value.substring(3,1).toInteger())+ (select(value.substring(4,1).toInteger()).select($this*3))+ (value.substring(5,1).toInteger())+ (select(value.substring(6,1).toInteger()).select($this*3))+ (value.substring(7,1).toInteger())+ (select(value.substring(8,1).toInteger()).select($this*3))+ (value.substring(9,1).toInteger())+ (select(value.substring(10,1).toInteger()).select($this*3))+ (value.substring(11,1).toInteger())+ (select(value.substring(12,1).toInteger()).select($this*3))+ (value.substring(13,1).toInteger())+ (select(value.substring(14,1).toInteger()).select($this*3))+ (value.substring(15,1).toInteger())+ (select(value.substring(16,1).toInteger()).select($this*3))+ (value.substring(17,1).toInteger()) )mod 10=0 )

Differential View

This structure is derived from Identifier

NameFlagsCard.TypeDescription & Constraintsdoco
.. Identifier C 0..* Identifier Individual Healthcare Identifier (IHI)
ie-core-ihi-0: IHI shall be an exactly 18 digit number
ie-core-ihi-1: IHI shall pass the position 17 modulus 11 check digit
ie-core-ihi-2: IHI shall pass the position 18 GS1 check digit
... Slices for extension Content/Rules for all slices
.... ihiStatus 0..1 Coding IHI status
URL: http://iehr.ai/fhir/ie/core/StructureDefinition/ie-core-ihi-status
Binding: IE Core Individual Healthcare Identifier Status (required)
.... ihiRecordStatus 0..1 Coding IHI record status
URL: http://iehr.ai/fhir/ie/core/StructureDefinition/ie-core-ihi-record-status
Binding: IE Core Individual Healthcare Identifier Record Status (required)
.... ihiVerifiedDate 0..1 dateTime IHI Verification Date
URL: http://iehr.ai/fhir/ie/core/StructureDefinition/ie-core-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://iehr.ai/fhir/sid/ie/hse/ihi
... value C 1..1 string IHI
Max Length:18

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
ie-core-ihi-0errorIdentifierIHI shall be an exactly 18 digit number
: value.matches('^([0-9]{18})$')
ie-core-ihi-1errorIdentifierIHI shall pass the position 17 modulus 11 check digit
: ( ( (select(value.substring(0,1).toInteger()).select($this*17))+ (select(value.substring(1,1).toInteger()).select($this*16))+ (select(value.substring(2,1).toInteger()).select($this*15))+ (select(value.substring(3,1).toInteger()).select($this*14))+ (select(value.substring(4,1).toInteger()).select($this*13))+ (select(value.substring(5,1).toInteger()).select($this*12))+ (select(value.substring(6,1).toInteger()).select($this*11))+ (select(value.substring(7,1).toInteger()).select($this*10))+ (select(value.substring(8,1).toInteger()).select($this*9))+ (select(value.substring(9,1).toInteger()).select($this*8))+ (select(value.substring(10,1).toInteger()).select($this*7))+ (select(value.substring(11,1).toInteger()).select($this*6))+ (select(value.substring(12,1).toInteger()).select($this*5))+ (select(value.substring(13,1).toInteger()).select($this*4))+ (select(value.substring(14,1).toInteger()).select($this*3))+ (select(value.substring(15,1).toInteger()).select($this*2))+ (select(value.substring(16,1).toInteger()).select($this)) )mod 11=0 )
ie-core-ihi-2errorIdentifierIHI shall pass the position 18 GS1 check digit
: ( ( (select(value.substring(0,1).toInteger()).select($this*3))+ (value.substring(1,1).toInteger())+ (select(value.substring(2,1).toInteger()).select($this*3))+ (value.substring(3,1).toInteger())+ (select(value.substring(4,1).toInteger()).select($this*3))+ (value.substring(5,1).toInteger())+ (select(value.substring(6,1).toInteger()).select($this*3))+ (value.substring(7,1).toInteger())+ (select(value.substring(8,1).toInteger()).select($this*3))+ (value.substring(9,1).toInteger())+ (select(value.substring(10,1).toInteger()).select($this*3))+ (value.substring(11,1).toInteger())+ (select(value.substring(12,1).toInteger()).select($this*3))+ (value.substring(13,1).toInteger())+ (select(value.substring(14,1).toInteger()).select($this*3))+ (value.substring(15,1).toInteger())+ (select(value.substring(16,1).toInteger()).select($this*3))+ (value.substring(17,1).toInteger()) )mod 10=0 )

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Identifier C 0..* Identifier Individual Healthcare Identifier (IHI)
ie-core-ihi-0: IHI shall be an exactly 18 digit number
ie-core-ihi-1: IHI shall pass the position 17 modulus 11 check digit
ie-core-ihi-2: IHI shall pass the position 18 GS1 check digit
... Slices for extension Content/Rules for all slices
.... ihiStatus 0..1 Coding IHI status
URL: http://iehr.ai/fhir/ie/core/StructureDefinition/ie-core-ihi-status
Binding: IE Core Individual Healthcare Identifier Status (required)
.... ihiRecordStatus 0..1 Coding IHI record status
URL: http://iehr.ai/fhir/ie/core/StructureDefinition/ie-core-ihi-record-status
Binding: IE Core Individual Healthcare Identifier Record Status (required)
.... ihiVerifiedDate 0..1 dateTime IHI Verification Date
URL: http://iehr.ai/fhir/ie/core/StructureDefinition/ie-core-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
.... 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://iehr.ai/fhir/sid/ie/hse/ihi
... value ΣC 1..1 string IHI
Example General: 123456
Max Length:18

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Identifier.typeextensiblePattern: NI
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
ie-core-ihi-0errorIdentifierIHI shall be an exactly 18 digit number
: value.matches('^([0-9]{18})$')
ie-core-ihi-1errorIdentifierIHI shall pass the position 17 modulus 11 check digit
: ( ( (select(value.substring(0,1).toInteger()).select($this*17))+ (select(value.substring(1,1).toInteger()).select($this*16))+ (select(value.substring(2,1).toInteger()).select($this*15))+ (select(value.substring(3,1).toInteger()).select($this*14))+ (select(value.substring(4,1).toInteger()).select($this*13))+ (select(value.substring(5,1).toInteger()).select($this*12))+ (select(value.substring(6,1).toInteger()).select($this*11))+ (select(value.substring(7,1).toInteger()).select($this*10))+ (select(value.substring(8,1).toInteger()).select($this*9))+ (select(value.substring(9,1).toInteger()).select($this*8))+ (select(value.substring(10,1).toInteger()).select($this*7))+ (select(value.substring(11,1).toInteger()).select($this*6))+ (select(value.substring(12,1).toInteger()).select($this*5))+ (select(value.substring(13,1).toInteger()).select($this*4))+ (select(value.substring(14,1).toInteger()).select($this*3))+ (select(value.substring(15,1).toInteger()).select($this*2))+ (select(value.substring(16,1).toInteger()).select($this)) )mod 11=0 )
ie-core-ihi-2errorIdentifierIHI shall pass the position 18 GS1 check digit
: ( ( (select(value.substring(0,1).toInteger()).select($this*3))+ (value.substring(1,1).toInteger())+ (select(value.substring(2,1).toInteger()).select($this*3))+ (value.substring(3,1).toInteger())+ (select(value.substring(4,1).toInteger()).select($this*3))+ (value.substring(5,1).toInteger())+ (select(value.substring(6,1).toInteger()).select($this*3))+ (value.substring(7,1).toInteger())+ (select(value.substring(8,1).toInteger()).select($this*3))+ (value.substring(9,1).toInteger())+ (select(value.substring(10,1).toInteger()).select($this*3))+ (value.substring(11,1).toInteger())+ (select(value.substring(12,1).toInteger()).select($this*3))+ (value.substring(13,1).toInteger())+ (select(value.substring(14,1).toInteger()).select($this*3))+ (value.substring(15,1).toInteger())+ (select(value.substring(16,1).toInteger()).select($this*3))+ (value.substring(17,1).toInteger()) )mod 10=0 )

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Identifier C 0..* Identifier Individual Healthcare Identifier (IHI)
ie-core-ihi-0: IHI shall be an exactly 18 digit number
ie-core-ihi-1: IHI shall pass the position 17 modulus 11 check digit
ie-core-ihi-2: IHI shall pass the position 18 GS1 check digit
... 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
.... ihiStatus 0..1 Coding IHI status
URL: http://iehr.ai/fhir/ie/core/StructureDefinition/ie-core-ihi-status
Binding: IE Core Individual Healthcare Identifier Status (required)
.... ihiRecordStatus 0..1 Coding IHI record status
URL: http://iehr.ai/fhir/ie/core/StructureDefinition/ie-core-ihi-record-status
Binding: IE Core Individual Healthcare Identifier Record Status (required)
.... ihiVerifiedDate 0..1 dateTime IHI Verification Date
URL: http://iehr.ai/fhir/ie/core/StructureDefinition/ie-core-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://iehr.ai/fhir/sid/ie/hse/ihi
... value ΣC 1..1 string IHI
Example General: 123456
Max Length:18
... 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)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Identifier.typeextensiblePattern: NI
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
ie-core-ihi-0errorIdentifierIHI shall be an exactly 18 digit number
: value.matches('^([0-9]{18})$')
ie-core-ihi-1errorIdentifierIHI shall pass the position 17 modulus 11 check digit
: ( ( (select(value.substring(0,1).toInteger()).select($this*17))+ (select(value.substring(1,1).toInteger()).select($this*16))+ (select(value.substring(2,1).toInteger()).select($this*15))+ (select(value.substring(3,1).toInteger()).select($this*14))+ (select(value.substring(4,1).toInteger()).select($this*13))+ (select(value.substring(5,1).toInteger()).select($this*12))+ (select(value.substring(6,1).toInteger()).select($this*11))+ (select(value.substring(7,1).toInteger()).select($this*10))+ (select(value.substring(8,1).toInteger()).select($this*9))+ (select(value.substring(9,1).toInteger()).select($this*8))+ (select(value.substring(10,1).toInteger()).select($this*7))+ (select(value.substring(11,1).toInteger()).select($this*6))+ (select(value.substring(12,1).toInteger()).select($this*5))+ (select(value.substring(13,1).toInteger()).select($this*4))+ (select(value.substring(14,1).toInteger()).select($this*3))+ (select(value.substring(15,1).toInteger()).select($this*2))+ (select(value.substring(16,1).toInteger()).select($this)) )mod 11=0 )
ie-core-ihi-2errorIdentifierIHI shall pass the position 18 GS1 check digit
: ( ( (select(value.substring(0,1).toInteger()).select($this*3))+ (value.substring(1,1).toInteger())+ (select(value.substring(2,1).toInteger()).select($this*3))+ (value.substring(3,1).toInteger())+ (select(value.substring(4,1).toInteger()).select($this*3))+ (value.substring(5,1).toInteger())+ (select(value.substring(6,1).toInteger()).select($this*3))+ (value.substring(7,1).toInteger())+ (select(value.substring(8,1).toInteger()).select($this*3))+ (value.substring(9,1).toInteger())+ (select(value.substring(10,1).toInteger()).select($this*3))+ (value.substring(11,1).toInteger())+ (select(value.substring(12,1).toInteger()).select($this*3))+ (value.substring(13,1).toInteger())+ (select(value.substring(14,1).toInteger()).select($this*3))+ (value.substring(15,1).toInteger())+ (select(value.substring(16,1).toInteger()).select($this*3))+ (value.substring(17,1).toInteger()) )mod 10=0 )

 

Other representations of profile: CSV, Excel, Schematron