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 Core Health Amendment Act

Official URL: http://iehr.ai/fhir/ie/core/StructureDefinition/ie-core-health-amendment-act Version: 1.0.0-ballot
Standards status: Trial-use Maturity Level: 3 Computable Name: IECoreHealthAmendmentAct
Other Identifiers: OID:1.3.6.1.4.1.54392.5.2690.42.81

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

This identifier profile defines a Health Amendment Act (HAA) in an Irish context.

Usage:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Identifier C 0..* Identifier Health Amendment Act (HAA)
ele-1: All FHIR elements must have a @value or children
ie-core-haa-0: HAA is 7 characters and contains 5 numbers and will always starts and end in a letter
... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


ele-1: All FHIR elements must have a @value or children
... 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.


ele-1: All FHIR elements must have a @value or children
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: MR
... system Σ 1..1 uri The namespace for the identifier value
ele-1: All FHIR elements must have a @value or children
Fixed Value: http://iehr.ai/fhir/sid/ie/haa
... value Σ 1..1 string HAA
ele-1: All FHIR elements must have a @value or children
Example General: 123456
Example HAA: A12345A
Max Length:7

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: MR
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
ie-core-haa-0errorIdentifierHAA is 7 characters and contains 5 numbers and will always starts and end in a letter
: identifier.where(system='http://iehr.ai/fhir/sid/ie/haa').empty() or identifier.where(system='http://iehr.ai/fhir/sid/ie/haa').value.matches('^[A-Z]{1}[0-9]{5}[A-Z]{1}$')

This structure is derived from Identifier

NameFlagsCard.TypeDescription & Constraintsdoco
.. Identifier C 0..* Identifier Health Amendment Act (HAA)
ie-core-haa-0: HAA is 7 characters and contains 5 numbers and will always starts and end in a letter
... 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: MR
... system 1..1 uri The namespace for the identifier value
Fixed Value: http://iehr.ai/fhir/sid/ie/haa
... value 1..1 string HAA
Example HAA: A12345A
Max Length:7

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
ie-core-haa-0errorIdentifierHAA is 7 characters and contains 5 numbers and will always starts and end in a letter
: identifier.where(system='http://iehr.ai/fhir/sid/ie/haa').empty() or identifier.where(system='http://iehr.ai/fhir/sid/ie/haa').value.matches('^[A-Z]{1}[0-9]{5}[A-Z]{1}$')
NameFlagsCard.TypeDescription & Constraintsdoco
.. Identifier C 0..* Identifier Health Amendment Act (HAA)
ie-core-haa-0: HAA is 7 characters and contains 5 numbers and will always starts and end in a letter
... id 0..1 string Unique id for inter-element referencing
... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
... 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: MR
..... 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/haa
... value Σ 1..1 string HAA
Example General: 123456
Example HAA: A12345A
Max Length:7
... 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: MR
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
ie-core-haa-0errorIdentifierHAA is 7 characters and contains 5 numbers and will always starts and end in a letter
: identifier.where(system='http://iehr.ai/fhir/sid/ie/haa').empty() or identifier.where(system='http://iehr.ai/fhir/sid/ie/haa').value.matches('^[A-Z]{1}[0-9]{5}[A-Z]{1}$')

This structure is derived from Identifier

Summary

Mandatory: 3 elements
Fixed: 1 element

Maturity: 3

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Identifier C 0..* Identifier Health Amendment Act (HAA)
ele-1: All FHIR elements must have a @value or children
ie-core-haa-0: HAA is 7 characters and contains 5 numbers and will always starts and end in a letter
... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


ele-1: All FHIR elements must have a @value or children
... 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.


ele-1: All FHIR elements must have a @value or children
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: MR
... system Σ 1..1 uri The namespace for the identifier value
ele-1: All FHIR elements must have a @value or children
Fixed Value: http://iehr.ai/fhir/sid/ie/haa
... value Σ 1..1 string HAA
ele-1: All FHIR elements must have a @value or children
Example General: 123456
Example HAA: A12345A
Max Length:7

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: MR
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
ie-core-haa-0errorIdentifierHAA is 7 characters and contains 5 numbers and will always starts and end in a letter
: identifier.where(system='http://iehr.ai/fhir/sid/ie/haa').empty() or identifier.where(system='http://iehr.ai/fhir/sid/ie/haa').value.matches('^[A-Z]{1}[0-9]{5}[A-Z]{1}$')

Differential View

This structure is derived from Identifier

NameFlagsCard.TypeDescription & Constraintsdoco
.. Identifier C 0..* Identifier Health Amendment Act (HAA)
ie-core-haa-0: HAA is 7 characters and contains 5 numbers and will always starts and end in a letter
... 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: MR
... system 1..1 uri The namespace for the identifier value
Fixed Value: http://iehr.ai/fhir/sid/ie/haa
... value 1..1 string HAA
Example HAA: A12345A
Max Length:7

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
ie-core-haa-0errorIdentifierHAA is 7 characters and contains 5 numbers and will always starts and end in a letter
: identifier.where(system='http://iehr.ai/fhir/sid/ie/haa').empty() or identifier.where(system='http://iehr.ai/fhir/sid/ie/haa').value.matches('^[A-Z]{1}[0-9]{5}[A-Z]{1}$')

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Identifier C 0..* Identifier Health Amendment Act (HAA)
ie-core-haa-0: HAA is 7 characters and contains 5 numbers and will always starts and end in a letter
... id 0..1 string Unique id for inter-element referencing
... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
... 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: MR
..... 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/haa
... value Σ 1..1 string HAA
Example General: 123456
Example HAA: A12345A
Max Length:7
... 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: MR
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
ie-core-haa-0errorIdentifierHAA is 7 characters and contains 5 numbers and will always starts and end in a letter
: identifier.where(system='http://iehr.ai/fhir/sid/ie/haa').empty() or identifier.where(system='http://iehr.ai/fhir/sid/ie/haa').value.matches('^[A-Z]{1}[0-9]{5}[A-Z]{1}$')

This structure is derived from Identifier

Summary

Mandatory: 3 elements
Fixed: 1 element

Maturity: 3

 

Other representations of profile: CSV, Excel, Schematron