HL7 Czech Base and Core FHIR IG
0.3.0 - ci-build
HL7 Czech Base and Core FHIR IG
0.3.0 - ci-build
This page is part of the Czech National FHIR R4 Core and Base Implementation Guide STU 1 (v0.3.0: STU 1) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions
| Official URL: https://hl7.cz/fhir/core/StructureDefinition/id-card-identifier | Version: 0.3.0 | |||
| Standards status: Trial-use | Maturity Level: 2 | Computable Name: Id_Card_Identifier | ||
Identifier for personal ID card number using FHIR SID and v2-0203#CZ.
An additional identifier for a patient, which can be used in situations where the national health sector identifier (RID/DRID) has not been assigned yet. It is particularly useful for foreign EU citizens.
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 |
0..* | Identifier | National ID card number including the country code | |
  use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: official |
  type |
Σ | 0..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. Fixed Value: As shown (Citizenship Card) |
  id |
0..0 | string | Unique id for inter-element referencing | |
| extension |
0..0 | Extension | Additional content defined by implementations | |
| coding |
1..1 | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
| id |
0..0 | string | Unique id for inter-element referencing | |
| extension |
0..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..0 | string | Version of the system - if relevant | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: CZ | |
| display |
0..0 | string | Representation defined by the system | |
 userSelected |
0..0 | boolean | If this coding was chosen directly by the user | |
| text |
0..0 | string | Plain text representation of the concept | |
| system |
ΣC | 1..1 | uri | Name space according to the national ID card issuer. FHIR records namespaces for personal ID cards in the format - https://hl7.cz/fhir/sid/idcard-XXX, where XXX is the three-letter country code according to ISO 3166 Binding: ID Card URIs (required) Constraints: idcard-system-iso3 Example General: http://www.acme.com/identifiers/patient |
| value |
Σ | 1..1 | string | The value that is unique Example General: 123456 |
 assigner |
Σ | 0..1 | Reference(Organization (CZ core)) | 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. |
| Identifier.system | Base | required | ID Card URIs | 📦0.3.0 | This IG |
| Id | Grade | Path(s) | Description | Expression |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| idcard-system-iso3 | error | Identifier.system | Identifier.system SHALL be https://hl7.cz/fhir/sid/idcard-XXX where XXX is ISO 3166-1 alpha-3. |
matches('^https://hl7.cz/fhir/sid/idcard-[A-Z]{3}$')
|
This structure is derived from Identifier
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Identifier |
0..* | Identifier | National ID card number including the country code | |
| use |
0..1 | code | usual | official | temp | secondary | old (If known) Fixed Value: official | |
| type |
0..1 | CodeableConcept | Description of identifier Fixed Value: As shown (Citizenship Card) | |
 coding |
1..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: CZ | |
| system |
C | 1..1 | uri | Name space according to the national ID card issuer. FHIR records namespaces for personal ID cards in the format - https://hl7.cz/fhir/sid/idcard-XXX, where XXX is the three-letter country code according to ISO 3166 Binding: ID Card URIs (required) Constraints: idcard-system-iso3 |
| value |
1..1 | string | The value that is unique | |
| assigner |
0..1 | Reference(Organization (CZ core)) | Organization that issued id (may be just text) | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Identifier.system | Base | required | ID Card URIs | 📦0.3.0 | This IG |
| Id | Grade | Path(s) | Description | Expression |
| idcard-system-iso3 | error | Identifier.system | Identifier.system SHALL be https://hl7.cz/fhir/sid/idcard-XXX where XXX is ISO 3166-1 alpha-3. |
matches('^https://hl7.cz/fhir/sid/idcard-[A-Z]{3}$')
|
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Identifier |
0..* | Identifier | National ID card number including the country code | |
| 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 . Fixed Value: official |
| type |
Σ | 0..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. Fixed Value: As shown (Citizenship Card) |
| id |
0..0 | string | Unique id for inter-element referencing | |
| extension |
0..0 | Extension | Additional content defined by implementations | |
| coding |
1..1 | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
| id |
0..0 | string | Unique id for inter-element referencing | |
| extension |
0..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..0 | string | Version of the system - if relevant | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: CZ | |
| display |
0..0 | string | Representation defined by the system | |
| userSelected |
0..0 | boolean | If this coding was chosen directly by the user | |
| text |
0..0 | string | Plain text representation of the concept | |
| system |
ΣC | 1..1 | uri | Name space according to the national ID card issuer. FHIR records namespaces for personal ID cards in the format - https://hl7.cz/fhir/sid/idcard-XXX, where XXX is the three-letter country code according to ISO 3166 Binding: ID Card URIs (required) Constraints: idcard-system-iso3 Example General: http://www.acme.com/identifiers/patient |
| value |
Σ | 1..1 | string | The value that is unique Example General: 123456 |
| period |
Σ | 0..1 | Period | Time period when id is/was valid for use |
| assigner |
Σ | 0..1 | Reference(Organization (CZ core)) | 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. |
| Identifier.system | Base | required | ID Card URIs | 📦0.3.0 | This IG |
| Id | Grade | Path(s) | Description | Expression |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| idcard-system-iso3 | error | Identifier.system | Identifier.system SHALL be https://hl7.cz/fhir/sid/idcard-XXX where XXX is ISO 3166-1 alpha-3. |
matches('^https://hl7.cz/fhir/sid/idcard-[A-Z]{3}$')
|
This structure is derived from Identifier
Summary
Mandatory: 2 elements
Fixed: 2 elements
Structures
This structure refers to these other structures:
Maturity: 2
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Identifier |
0..* | Identifier | National ID card number including the country code | |
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: official |
| type |
Σ | 0..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. Fixed Value: As shown (Citizenship Card) |
| id |
0..0 | string | Unique id for inter-element referencing | |
| extension |
0..0 | Extension | Additional content defined by implementations | |
| coding |
1..1 | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
| id |
0..0 | string | Unique id for inter-element referencing | |
| extension |
0..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..0 | string | Version of the system - if relevant | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: CZ | |
| display |
0..0 | string | Representation defined by the system | |
| userSelected |
0..0 | boolean | If this coding was chosen directly by the user | |
| text |
0..0 | string | Plain text representation of the concept | |
| system |
ΣC | 1..1 | uri | Name space according to the national ID card issuer. FHIR records namespaces for personal ID cards in the format - https://hl7.cz/fhir/sid/idcard-XXX, where XXX is the three-letter country code according to ISO 3166 Binding: ID Card URIs (required) Constraints: idcard-system-iso3 Example General: http://www.acme.com/identifiers/patient |
| value |
Σ | 1..1 | string | The value that is unique Example General: 123456 |
| assigner |
Σ | 0..1 | Reference(Organization (CZ core)) | 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. |
| Identifier.system | Base | required | ID Card URIs | 📦0.3.0 | This IG |
| Id | Grade | Path(s) | Description | Expression |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| idcard-system-iso3 | error | Identifier.system | Identifier.system SHALL be https://hl7.cz/fhir/sid/idcard-XXX where XXX is ISO 3166-1 alpha-3. |
matches('^https://hl7.cz/fhir/sid/idcard-[A-Z]{3}$')
|
Differential View
This structure is derived from Identifier
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Identifier |
0..* | Identifier | National ID card number including the country code | |
| use |
0..1 | code | usual | official | temp | secondary | old (If known) Fixed Value: official | |
| type |
0..1 | CodeableConcept | Description of identifier Fixed Value: As shown (Citizenship Card) | |
| coding |
1..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: CZ | |
| system |
C | 1..1 | uri | Name space according to the national ID card issuer. FHIR records namespaces for personal ID cards in the format - https://hl7.cz/fhir/sid/idcard-XXX, where XXX is the three-letter country code according to ISO 3166 Binding: ID Card URIs (required) Constraints: idcard-system-iso3 |
| value |
1..1 | string | The value that is unique | |
| assigner |
0..1 | Reference(Organization (CZ core)) | Organization that issued id (may be just text) | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Identifier.system | Base | required | ID Card URIs | 📦0.3.0 | This IG |
| Id | Grade | Path(s) | Description | Expression |
| idcard-system-iso3 | error | Identifier.system | Identifier.system SHALL be https://hl7.cz/fhir/sid/idcard-XXX where XXX is ISO 3166-1 alpha-3. |
matches('^https://hl7.cz/fhir/sid/idcard-[A-Z]{3}$')
|
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Identifier |
0..* | Identifier | National ID card number including the country code | |
| 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 . Fixed Value: official |
| type |
Σ | 0..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. Fixed Value: As shown (Citizenship Card) |
| id |
0..0 | string | Unique id for inter-element referencing | |
| extension |
0..0 | Extension | Additional content defined by implementations | |
| coding |
1..1 | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
| id |
0..0 | string | Unique id for inter-element referencing | |
| extension |
0..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..0 | string | Version of the system - if relevant | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: CZ | |
| display |
0..0 | string | Representation defined by the system | |
| userSelected |
0..0 | boolean | If this coding was chosen directly by the user | |
| text |
0..0 | string | Plain text representation of the concept | |
| system |
ΣC | 1..1 | uri | Name space according to the national ID card issuer. FHIR records namespaces for personal ID cards in the format - https://hl7.cz/fhir/sid/idcard-XXX, where XXX is the three-letter country code according to ISO 3166 Binding: ID Card URIs (required) Constraints: idcard-system-iso3 Example General: http://www.acme.com/identifiers/patient |
| value |
Σ | 1..1 | string | The value that is unique Example General: 123456 |
| period |
Σ | 0..1 | Period | Time period when id is/was valid for use |
| assigner |
Σ | 0..1 | Reference(Organization (CZ core)) | 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. |
| Identifier.system | Base | required | ID Card URIs | 📦0.3.0 | This IG |
| Id | Grade | Path(s) | Description | Expression |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| idcard-system-iso3 | error | Identifier.system | Identifier.system SHALL be https://hl7.cz/fhir/sid/idcard-XXX where XXX is ISO 3166-1 alpha-3. |
matches('^https://hl7.cz/fhir/sid/idcard-[A-Z]{3}$')
|
This structure is derived from Identifier
Summary
Mandatory: 2 elements
Fixed: 2 elements
Structures
This structure refers to these other structures:
Maturity: 2
Other representations of profile: CSV, Excel, Schematron