HL7 Czech Base and Core Implementation Guide
0.3.0-ballot - ci-build
HL7 Czech Base and Core Implementation Guide
0.3.0-ballot - ci-build
HL7 Czech Base and Core Implementation Guide, published by HL7 Czech Republic. This guide is not an authorized publication; it is the continuous build for version 0.3.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7-cz/cz-core/ and changes regularly. See the Directory of published versions
| Official URL: https://hl7.cz/fhir/core/StructureDefinition/cz-passport-identifier | Version: 0.3.0-ballot | |||
| Standards status: Draft | Maturity Level: 1 | 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:
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 | Passport 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. 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: PPN | |
| 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 | 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: Standard namespaces for passports (required) 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 | ||||
| Path | Conformance | ValueSet / Code | URI |
| Identifier.use | required | Fixed Value: officialhttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1From the FHIR Standard | |
| Identifier.type | extensible | Pattern Value: PPNhttp://hl7.org/fhir/ValueSet/identifier-type|4.0.1From the FHIR Standard | |
| Identifier.system | required | PassportNSVShttps://ncez.mzcr.cz/fhir/ValueSet/PassportNS-vs |
| Id | Grade | Path(s) | Details | Requirements |
| 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 : matches('[0-9A-Z]{6,9}') | Passport number rules. |
This structure is derived from Identifier
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Identifier |
0..* | Identifier | Passport 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 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: PPN | |
| system |
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: Standard namespaces for passports (required) | |
| 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 | ||||
| Path | Conformance | ValueSet | URI |
| Identifier.system | required | PassportNSVShttps://ncez.mzcr.cz/fhir/ValueSet/PassportNS-vs |
| Id | Grade | Path(s) | Details | Requirements |
| passport-rule | error | Identifier.value | General passport number rule : matches('[0-9A-Z]{6,9}') | Passport number rules. |
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| 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 |
?!Σ | 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. 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: PPN | |
| 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 | 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: Standard namespaces for passports (required) 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 | ||||
| Path | Conformance | ValueSet / Code | URI |
| Identifier.use | required | Fixed Value: officialhttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1From the FHIR Standard | |
| Identifier.type | extensible | Pattern Value: PPNhttp://hl7.org/fhir/ValueSet/identifier-type|4.0.1From the FHIR Standard | |
| Identifier.system | required | PassportNSVShttps://ncez.mzcr.cz/fhir/ValueSet/PassportNS-vs |
| Id | Grade | Path(s) | Details | Requirements |
| 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 : matches('[0-9A-Z]{6,9}') | Passport number rules. |
This structure is derived from Identifier
Summary
Mandatory: 2 elements
Fixed: 1 element
Structures
This structure refers to these other structures:
Maturity: 1
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Identifier |
0..* | Identifier | Passport 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. 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: PPN | |
| 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 | 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: Standard namespaces for passports (required) 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 | ||||
| Path | Conformance | ValueSet / Code | URI |
| Identifier.use | required | Fixed Value: officialhttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1From the FHIR Standard | |
| Identifier.type | extensible | Pattern Value: PPNhttp://hl7.org/fhir/ValueSet/identifier-type|4.0.1From the FHIR Standard | |
| Identifier.system | required | PassportNSVShttps://ncez.mzcr.cz/fhir/ValueSet/PassportNS-vs |
| Id | Grade | Path(s) | Details | Requirements |
| 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 : matches('[0-9A-Z]{6,9}') | Passport number rules. |
Differential View
This structure is derived from Identifier
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Identifier |
0..* | Identifier | Passport 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 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: PPN | |
| system |
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: Standard namespaces for passports (required) | |
| 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 | ||||
| Path | Conformance | ValueSet | URI |
| Identifier.system | required | PassportNSVShttps://ncez.mzcr.cz/fhir/ValueSet/PassportNS-vs |
| Id | Grade | Path(s) | Details | Requirements |
| passport-rule | error | Identifier.value | General passport number rule : matches('[0-9A-Z]{6,9}') | Passport number rules. |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| 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 |
?!Σ | 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. 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: PPN | |
| 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 | 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: Standard namespaces for passports (required) 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 | ||||
| Path | Conformance | ValueSet / Code | URI |
| Identifier.use | required | Fixed Value: officialhttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1From the FHIR Standard | |
| Identifier.type | extensible | Pattern Value: PPNhttp://hl7.org/fhir/ValueSet/identifier-type|4.0.1From the FHIR Standard | |
| Identifier.system | required | PassportNSVShttps://ncez.mzcr.cz/fhir/ValueSet/PassportNS-vs |
| Id | Grade | Path(s) | Details | Requirements |
| 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 : matches('[0-9A-Z]{6,9}') | Passport number rules. |
This structure is derived from Identifier
Summary
Mandatory: 2 elements
Fixed: 1 element
Structures
This structure refers to these other structures:
Maturity: 1
Other representations of profile: CSV, Excel, Schematron