HL7 Czech Base and Core FHIR IG
0.3.0 - ci-build

HL7 Czech Base and Core FHIR IG - Downloaded Version 0.3.0 See the Directory of published versions

## Data Type Profile: Passport identifier

Official URL: https://hl7.cz/fhir/core/StructureDefinition/cz-passport-identifier | Version: 0.3.0
Standards status: Trial-use | Maturity Level: 2 | Computable Name: CZ_Passport_Identifier

This structure specifies the passport identifier.

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 citizens.

Usages:

- Use this DataType Profile: Patient (CZ base) and Related Person (CZ base)

You can also check for usages in the FHIR IG Statistics

### Formal Views of Profile Content

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

- Key Elements Table
- Differential Table
- Snapshot Table
- Statistics/References
- All

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Identifier |  | 0..* | Identifier | Passport number including the country code
use | ?!Σ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: official
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. Fixed Value: As shown (Passport number)
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: PPN
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 passport issuer. FHIR records namespaces for passports in the format - http://hl7.org/fhir/sid/passport-XXX, where XXX is the three-letter country code according to ISO 3166 Binding: Passport URIs (required) Constraints: passport-system-iso3 Example General: http://www.acme.com/identifiers/patient
value | Σ C | 1..1 | string | The value that is unique Constraints: passport-rule Example General: 123456 Max Length:9
assigner | Σ | 0..1 | Reference(Organization (CZ core)) | Organization that issued id (may be just text)
Documentation for this format

#### Terminology Bindings

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 | Passport URIs | 📦0.3.0 | This IG

#### Constraints

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())`
passport-rule | error | Identifier.value | General passport number rule Requirements: Passport number rules. | `matches('[0-9A-Z]{6,9}')`
passport-system-iso3 | error | Identifier.system | Identifier.system SHALL be http://hl7.org/fhir/sid/passport-XXX where XXX is ISO 3166-1 alpha-3. | `matches('^http://hl7.org/fhir/sid/passport-[A-Z]{3}$')`

This structure is derived from Identifier

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Identifier |  | 0..* | Identifier | Passport number including the country code
use |  | 1..1 | code | usual | official | temp | secondary | old (If known) Fixed Value: official
type |  | 1..1 | CodeableConcept | Description of identifier Fixed Value: As shown (Passport number)
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: PPN
system | C | 1..1 | uri | Name space according to the passport issuer. FHIR records namespaces for passports in the format - http://hl7.org/fhir/sid/passport-XXX, where XXX is the three-letter country code according to ISO 3166 Binding: Passport URIs (required) Constraints: passport-system-iso3
value | C | 1..1 | string | The value that is unique Constraints: passport-rule Max Length:9
assigner |  | 0..1 | Reference(Organization (CZ core)) | Organization that issued id (may be just text)
Documentation for this format

#### Terminology Bindings (Differential)

Path | Status | Usage | ValueSet | Version | Source
Identifier.system | Base | required | Passport URIs | 📦0.3.0 | This IG

#### Constraints

Id | Grade | Path(s) | Description | Expression
passport-rule | error | Identifier.value | General passport number rule Requirements: Passport number rules. | `matches('[0-9A-Z]{6,9}')`
passport-system-iso3 | error | Identifier.system | Identifier.system SHALL be http://hl7.org/fhir/sid/passport-XXX where XXX is ISO 3166-1 alpha-3. | `matches('^http://hl7.org/fhir/sid/passport-[A-Z]{3}$')`

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Identifier |  | 0..* | Identifier | Passport 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 | ?!Σ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: official
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. Fixed Value: As shown (Passport number)
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: PPN
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 passport issuer. FHIR records namespaces for passports in the format - http://hl7.org/fhir/sid/passport-XXX, where XXX is the three-letter country code according to ISO 3166 Binding: Passport URIs (required) Constraints: passport-system-iso3 Example General: http://www.acme.com/identifiers/patient
value | Σ C | 1..1 | string | The value that is unique Constraints: passport-rule Example General: 123456 Max Length:9
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

#### Terminology Bindings

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 | Passport URIs | 📦0.3.0 | This IG

#### Constraints

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()`
passport-rule | error | Identifier.value | General passport number rule Requirements: Passport number rules. | `matches('[0-9A-Z]{6,9}')`
passport-system-iso3 | error | Identifier.system | Identifier.system SHALL be http://hl7.org/fhir/sid/passport-XXX where XXX is ISO 3166-1 alpha-3. | `matches('^http://hl7.org/fhir/sid/passport-[A-Z]{3}$')`

This structure is derived from Identifier

Summary

Mandatory: 4 elements
Fixed: 2 elements

Structures

This structure refers to these other structures:

- Organization (CZ core) (https://hl7.cz/fhir/core/StructureDefinition/cz-organization-core)

Maturity: 2

Key Elements View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Identifier |  | 0..* | Identifier | Passport number including the country code
use | ?!Σ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: official
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. Fixed Value: As shown (Passport number)
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: PPN
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 passport issuer. FHIR records namespaces for passports in the format - http://hl7.org/fhir/sid/passport-XXX, where XXX is the three-letter country code according to ISO 3166 Binding: Passport URIs (required) Constraints: passport-system-iso3 Example General: http://www.acme.com/identifiers/patient
value | Σ C | 1..1 | string | The value that is unique Constraints: passport-rule Example General: 123456 Max Length:9
assigner | Σ | 0..1 | Reference(Organization (CZ core)) | Organization that issued id (may be just text)
Documentation for this format

#### Terminology Bindings

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 | Passport URIs | 📦0.3.0 | This IG

#### Constraints

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())`
passport-rule | error | Identifier.value | General passport number rule Requirements: Passport number rules. | `matches('[0-9A-Z]{6,9}')`
passport-system-iso3 | error | Identifier.system | Identifier.system SHALL be http://hl7.org/fhir/sid/passport-XXX where XXX is ISO 3166-1 alpha-3. | `matches('^http://hl7.org/fhir/sid/passport-[A-Z]{3}$')`

Differential View

This structure is derived from Identifier

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Identifier |  | 0..* | Identifier | Passport number including the country code
use |  | 1..1 | code | usual | official | temp | secondary | old (If known) Fixed Value: official
type |  | 1..1 | CodeableConcept | Description of identifier Fixed Value: As shown (Passport number)
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: PPN
system | C | 1..1 | uri | Name space according to the passport issuer. FHIR records namespaces for passports in the format - http://hl7.org/fhir/sid/passport-XXX, where XXX is the three-letter country code according to ISO 3166 Binding: Passport URIs (required) Constraints: passport-system-iso3
value | C | 1..1 | string | The value that is unique Constraints: passport-rule Max Length:9
assigner |  | 0..1 | Reference(Organization (CZ core)) | Organization that issued id (may be just text)
Documentation for this format

#### Terminology Bindings (Differential)

Path | Status | Usage | ValueSet | Version | Source
Identifier.system | Base | required | Passport URIs | 📦0.3.0 | This IG

#### Constraints

Id | Grade | Path(s) | Description | Expression
passport-rule | error | Identifier.value | General passport number rule Requirements: Passport number rules. | `matches('[0-9A-Z]{6,9}')`
passport-system-iso3 | error | Identifier.system | Identifier.system SHALL be http://hl7.org/fhir/sid/passport-XXX where XXX is ISO 3166-1 alpha-3. | `matches('^http://hl7.org/fhir/sid/passport-[A-Z]{3}$')`

Snapshot View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Identifier |  | 0..* | Identifier | Passport 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 | ?!Σ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: official
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. Fixed Value: As shown (Passport number)
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: PPN
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 passport issuer. FHIR records namespaces for passports in the format - http://hl7.org/fhir/sid/passport-XXX, where XXX is the three-letter country code according to ISO 3166 Binding: Passport URIs (required) Constraints: passport-system-iso3 Example General: http://www.acme.com/identifiers/patient
value | Σ C | 1..1 | string | The value that is unique Constraints: passport-rule Example General: 123456 Max Length:9
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

#### Terminology Bindings

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 | Passport URIs | 📦0.3.0 | This IG

#### Constraints

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()`
passport-rule | error | Identifier.value | General passport number rule Requirements: Passport number rules. | `matches('[0-9A-Z]{6,9}')`
passport-system-iso3 | error | Identifier.system | Identifier.system SHALL be http://hl7.org/fhir/sid/passport-XXX where XXX is ISO 3166-1 alpha-3. | `matches('^http://hl7.org/fhir/sid/passport-[A-Z]{3}$')`

This structure is derived from Identifier

Summary

Mandatory: 4 elements
Fixed: 2 elements

Structures

This structure refers to these other structures:

- Organization (CZ core) (https://hl7.cz/fhir/core/StructureDefinition/cz-organization-core)

Maturity: 2

Other representations of profile: CSV, Excel, Schematron