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-address | Version: 0.3.0-ballot | |||
| Standards status: Draft | Maturity Level: 1 | Computable Name: CZ_Address | ||
Czech national profile on address, to provide the possibility in the 'line' element to provide a seperate streetname, housenumber and postal box. It is always RECOMMENDED to give these elements separately. The national specification also includes the option of entering the address location according to the RUIAN register and marking the address as the permanent residence address.
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:   |
|---|---|---|---|---|
  Address |
C | 0..* | AddressEu | Address according to Czech postal conventions Constraints: text-or-ctry, POB-and-PCS, street-and-city, POB-only-postal, POB-ext-only |
  Slices for extension |
Content/Rules for all slices | |||
   extension:addressPoint |
0..1 | Identifier | Address location code according to the system RÚIAN (ČÚZK) URL: https://hl7.cz/fhir/core/StructureDefinition/address-point-cz | |
 extension:permanentResidence |
0..1 | CodeableConcept | Address permanent residence URL: https://hl7.cz/fhir/core/StructureDefinition/permanent-residencer-address-cz Binding: Iso3166-1-2 (preferred) | |
  use |
?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Address.use | required | AddressUsehttp://hl7.org/fhir/ValueSet/address-use|4.0.1From the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| POB-and-PCS | error | Address | If P.O.Box extension is present, Postal code must be present too : line.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox').empty()) or (postalCode.exists()) | |
| POB-ext-only | warning | Address | If the extension 'P.O.Box' is used, the extensions 'Street' and 'House number' must not be used. : line.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox').empty() or ($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName').empty() and $this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber').empty())) | |
| POB-only-postal | warning | Address | Address with P.O.Box cannot be "physical" or "both" : line.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox').empty()) or type='postal' or type.empty() | |
| 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() | |
| street-and-city | error | Address | If streetName extension is present, Postal code or city must be present too : line.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName').empty()) or postalCode.exists() or city.exists() | |
| text-or-ctry | error | Address | Address must contain at least text or country element : ( line.all($this.empty()) and city.empty() ) implies (text.exists() or country.exists()) |
This structure is derived from AddressEu
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Address |
C | 0..* | AddressEu | Address according to Czech postal conventions Constraints: text-or-ctry, POB-and-PCS, street-and-city, POB-only-postal, POB-ext-only |
| Slices for extension |
Content/Rules for all slices | |||
| extension:addressPoint |
0..1 | Identifier | Address location code according to the system RÚIAN (ČÚZK) URL: https://hl7.cz/fhir/core/StructureDefinition/address-point-cz | |
| extension:permanentResidence |
0..1 | CodeableConcept | Address permanent residence URL: https://hl7.cz/fhir/core/StructureDefinition/permanent-residencer-address-cz Binding: Iso3166-1-2 (preferred) | |
| use |
0..1 | code | home | work | temp | old | billing - purpose of this address | |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Details | Requirements |
| POB-and-PCS | error | Address | If P.O.Box extension is present, Postal code must be present too : line.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox').empty()) or (postalCode.exists()) | |
| POB-ext-only | warning | Address | If the extension 'P.O.Box' is used, the extensions 'Street' and 'House number' must not be used. : line.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox').empty() or ($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName').empty() and $this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber').empty())) | |
| POB-only-postal | warning | Address | Address with P.O.Box cannot be "physical" or "both" : line.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox').empty()) or type='postal' or type.empty() | |
| street-and-city | error | Address | If streetName extension is present, Postal code or city must be present too : line.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName').empty()) or postalCode.exists() or city.exists() | |
| text-or-ctry | error | Address | Address must contain at least text or country element : ( line.all($this.empty()) and city.empty() ) implies (text.exists() or country.exists()) |
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Address |
C | 0..* | AddressEu | Address according to Czech postal conventions Constraints: text-or-ctry, POB-and-PCS, street-and-city, POB-only-postal, POB-ext-only |
 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 | |
| extension:addressPoint |
0..1 | Identifier | Address location code according to the system RÚIAN (ČÚZK) URL: https://hl7.cz/fhir/core/StructureDefinition/address-point-cz | |
| extension:permanentResidence |
0..1 | CodeableConcept | Address permanent residence URL: https://hl7.cz/fhir/core/StructureDefinition/permanent-residencer-address-cz Binding: Iso3166-1-2 (preferred) | |
| use |
?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home |
| type |
Σ | 0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both |
| text |
Σ | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 |
| line |
Σ | 0..* | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street |
| id |
0..1 | string | xml:id (or equivalent in JSON) | |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:streetName |
0..* | string | streetName URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName | |
| extension:houseNumber |
0..* | string | houseNumber URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber | |
| extension:postBox |
0..* | string | postBox URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox | |
| value |
0..1 | string | Primitive value for string Max Length:1048576 | |
| city |
Σ | 0..1 | string | Name of city, town etc. Example General: Erewhon |
| district |
Σ | 0..1 | string | District name (aka county) Example General: Madison |
| state |
Σ | 0..1 | string | Sub-unit of country (abbreviations ok) |
| postalCode |
Σ | 0..1 | string | Postal code for area Example General: 9132 |
| country |
Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) |
| id |
0..1 | string | xml:id (or equivalent in JSON) | |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
 extension:countryCode |
0..1 | (Complex) | code for string URL: http://hl7.org/fhir/StructureDefinition/iso21090-SC-coding | |
  id |
0..1 | id | Unique id for inter-element referencing | |
| extension |
0..0 | |||
| url |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/iso21090-SC-coding" | |
  value[x] |
1..1 | Coding | Value of extension Binding: Iso3166-1-2 (preferred) | |
| value |
0..1 | string | Primitive value for string Max Length:1048576 | |
| period |
Σ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"} |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Address.use | required | AddressUsehttp://hl7.org/fhir/ValueSet/address-use|4.0.1From the FHIR Standard | |
| Address.type | required | AddressTypehttp://hl7.org/fhir/ValueSet/address-type|4.0.1From the FHIR Standard | |
| Address.country.extension:countryCode.value[x] | preferred | Iso3166-1-2http://hl7.org/fhir/ValueSet/iso3166-1-2From the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| POB-and-PCS | error | Address | If P.O.Box extension is present, Postal code must be present too : line.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox').empty()) or (postalCode.exists()) | |
| POB-ext-only | warning | Address | If the extension 'P.O.Box' is used, the extensions 'Street' and 'House number' must not be used. : line.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox').empty() or ($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName').empty() and $this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber').empty())) | |
| POB-only-postal | warning | Address | Address with P.O.Box cannot be "physical" or "both" : line.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox').empty()) or type='postal' or type.empty() | |
| 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() | |
| street-and-city | error | Address | If streetName extension is present, Postal code or city must be present too : line.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName').empty()) or postalCode.exists() or city.exists() | |
| text-or-ctry | error | Address | Address must contain at least text or country element : ( line.all($this.empty()) and city.empty() ) implies (text.exists() or country.exists()) |
This structure is derived from AddressEu
Summary
Extensions
This structure refers to these extensions:
Maturity: 1
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Address |
C | 0..* | AddressEu | Address according to Czech postal conventions Constraints: text-or-ctry, POB-and-PCS, street-and-city, POB-only-postal, POB-ext-only |
| Slices for extension |
Content/Rules for all slices | |||
| extension:addressPoint |
0..1 | Identifier | Address location code according to the system RÚIAN (ČÚZK) URL: https://hl7.cz/fhir/core/StructureDefinition/address-point-cz | |
| extension:permanentResidence |
0..1 | CodeableConcept | Address permanent residence URL: https://hl7.cz/fhir/core/StructureDefinition/permanent-residencer-address-cz Binding: Iso3166-1-2 (preferred) | |
| use |
?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Address.use | required | AddressUsehttp://hl7.org/fhir/ValueSet/address-use|4.0.1From the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| POB-and-PCS | error | Address | If P.O.Box extension is present, Postal code must be present too : line.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox').empty()) or (postalCode.exists()) | |
| POB-ext-only | warning | Address | If the extension 'P.O.Box' is used, the extensions 'Street' and 'House number' must not be used. : line.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox').empty() or ($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName').empty() and $this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber').empty())) | |
| POB-only-postal | warning | Address | Address with P.O.Box cannot be "physical" or "both" : line.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox').empty()) or type='postal' or type.empty() | |
| 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() | |
| street-and-city | error | Address | If streetName extension is present, Postal code or city must be present too : line.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName').empty()) or postalCode.exists() or city.exists() | |
| text-or-ctry | error | Address | Address must contain at least text or country element : ( line.all($this.empty()) and city.empty() ) implies (text.exists() or country.exists()) |
Differential View
This structure is derived from AddressEu
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Address |
C | 0..* | AddressEu | Address according to Czech postal conventions Constraints: text-or-ctry, POB-and-PCS, street-and-city, POB-only-postal, POB-ext-only |
| Slices for extension |
Content/Rules for all slices | |||
| extension:addressPoint |
0..1 | Identifier | Address location code according to the system RÚIAN (ČÚZK) URL: https://hl7.cz/fhir/core/StructureDefinition/address-point-cz | |
| extension:permanentResidence |
0..1 | CodeableConcept | Address permanent residence URL: https://hl7.cz/fhir/core/StructureDefinition/permanent-residencer-address-cz Binding: Iso3166-1-2 (preferred) | |
| use |
0..1 | code | home | work | temp | old | billing - purpose of this address | |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Details | Requirements |
| POB-and-PCS | error | Address | If P.O.Box extension is present, Postal code must be present too : line.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox').empty()) or (postalCode.exists()) | |
| POB-ext-only | warning | Address | If the extension 'P.O.Box' is used, the extensions 'Street' and 'House number' must not be used. : line.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox').empty() or ($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName').empty() and $this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber').empty())) | |
| POB-only-postal | warning | Address | Address with P.O.Box cannot be "physical" or "both" : line.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox').empty()) or type='postal' or type.empty() | |
| street-and-city | error | Address | If streetName extension is present, Postal code or city must be present too : line.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName').empty()) or postalCode.exists() or city.exists() | |
| text-or-ctry | error | Address | Address must contain at least text or country element : ( line.all($this.empty()) and city.empty() ) implies (text.exists() or country.exists()) |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Address |
C | 0..* | AddressEu | Address according to Czech postal conventions Constraints: text-or-ctry, POB-and-PCS, street-and-city, POB-only-postal, POB-ext-only |
| 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 | |
| extension:addressPoint |
0..1 | Identifier | Address location code according to the system RÚIAN (ČÚZK) URL: https://hl7.cz/fhir/core/StructureDefinition/address-point-cz | |
| extension:permanentResidence |
0..1 | CodeableConcept | Address permanent residence URL: https://hl7.cz/fhir/core/StructureDefinition/permanent-residencer-address-cz Binding: Iso3166-1-2 (preferred) | |
| use |
?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home |
| type |
Σ | 0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both |
| text |
Σ | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 |
| line |
Σ | 0..* | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street |
| id |
0..1 | string | xml:id (or equivalent in JSON) | |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:streetName |
0..* | string | streetName URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName | |
| extension:houseNumber |
0..* | string | houseNumber URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber | |
| extension:postBox |
0..* | string | postBox URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox | |
| value |
0..1 | string | Primitive value for string Max Length:1048576 | |
| city |
Σ | 0..1 | string | Name of city, town etc. Example General: Erewhon |
| district |
Σ | 0..1 | string | District name (aka county) Example General: Madison |
| state |
Σ | 0..1 | string | Sub-unit of country (abbreviations ok) |
| postalCode |
Σ | 0..1 | string | Postal code for area Example General: 9132 |
| country |
Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) |
| id |
0..1 | string | xml:id (or equivalent in JSON) | |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:countryCode |
0..1 | (Complex) | code for string URL: http://hl7.org/fhir/StructureDefinition/iso21090-SC-coding | |
| id |
0..1 | id | Unique id for inter-element referencing | |
| extension |
0..0 | |||
| url |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/iso21090-SC-coding" | |
| value[x] |
1..1 | Coding | Value of extension Binding: Iso3166-1-2 (preferred) | |
| value |
0..1 | string | Primitive value for string Max Length:1048576 | |
| period |
Σ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"} |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Address.use | required | AddressUsehttp://hl7.org/fhir/ValueSet/address-use|4.0.1From the FHIR Standard | |
| Address.type | required | AddressTypehttp://hl7.org/fhir/ValueSet/address-type|4.0.1From the FHIR Standard | |
| Address.country.extension:countryCode.value[x] | preferred | Iso3166-1-2http://hl7.org/fhir/ValueSet/iso3166-1-2From the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| POB-and-PCS | error | Address | If P.O.Box extension is present, Postal code must be present too : line.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox').empty()) or (postalCode.exists()) | |
| POB-ext-only | warning | Address | If the extension 'P.O.Box' is used, the extensions 'Street' and 'House number' must not be used. : line.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox').empty() or ($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName').empty() and $this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber').empty())) | |
| POB-only-postal | warning | Address | Address with P.O.Box cannot be "physical" or "both" : line.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox').empty()) or type='postal' or type.empty() | |
| 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() | |
| street-and-city | error | Address | If streetName extension is present, Postal code or city must be present too : line.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName').empty()) or postalCode.exists() or city.exists() | |
| text-or-ctry | error | Address | Address must contain at least text or country element : ( line.all($this.empty()) and city.empty() ) implies (text.exists() or country.exists()) |
This structure is derived from AddressEu
Summary
Extensions
This structure refers to these extensions:
Maturity: 1
Other representations of profile: CSV, Excel, Schematron