HL7 Czech Base and Core FHIR IG
0.4.0 - ci-build CZ

HL7 Czech Base and Core FHIR IG, published by HL7 Czech Republic. This guide is not an authorized publication; it is the continuous build for version 0.4.0 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

Data Type Profile: Address (CZ)

Official URL: https://hl7.cz/fhir/core/StructureDefinition/cz-address Version: 0.4.0
Standards status: Trial-use Maturity Level: 2 Computable Name: CZ_Address

This profile is derived from EU address profile and extends the Address data type for supporting streetname, housenumber and postal box. It is always RECOMMENDED to provide these elements separately. This profile also allows for using RUIAN codes and marking the address as the permanent residence address.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description Differentials, Snapshots, and other representations.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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 (required)
... use ?!Σ 0..1 code Purpose of this address
Binding: AddressUse (required): The use of an address.
Example General: home
... country Σ 0..1 string Country (use of ISO 3166 2 letter code is RECOMMENDED)
.... Slices for extension Content/Rules for all slices
..... extension:countryCode 0..1 (Complex) code for string
URL: http://hl7.org/fhir/StructureDefinition/iso21090-codedString
...... extension 0..0 Extension
Slice: Unordered, Open by value:url
...... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/iso21090-codedString"
...... value[x] 1..1 Coding Value of extension
Binding: Iso3166-1-2 (required)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Address.use Base required AddressUse 📍4.0.1 FHIR Std.
Address.country.extension:countryCode.​value[x] Base required Iso 3166 Part 1: 2 Letter Codes 📦4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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())

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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 (required)
... use 0..1 code Purpose of this address
... country 0..1 string Country (use of ISO 3166 2 letter code is RECOMMENDED)
.... Slices for extension Content/Rules for all slices
..... extension:countryCode 0..1 CodedString(5.3.0) code for string
...... value[x] 1..1 Coding Value of extension
Binding: Iso3166-1-2 (required)

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Address.country.extension:countryCode.​value[x] Base required Iso 3166 Part 1: 2 Letter Codes 📦4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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())
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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 (required)
... use ?!Σ 0..1 code Purpose of this address
Binding: AddressUse (required): The use of an address.
Example General: home
... 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 City
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
Example General: 9132
... country Σ 0..1 string Country (use of ISO 3166 2 letter code is RECOMMENDED)
.... 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-codedString
...... id 0..1 id Unique id for inter-element referencing
...... extension 0..0 Extension
Slice: Unordered, Open by value:url
...... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/iso21090-codedString"
...... value[x] 1..1 Coding Value of extension
Binding: Iso3166-1-2 (required)
.... 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"}

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Address.use Base required AddressUse 📍4.0.1 FHIR Std.
Address.type Base required AddressType 📍4.0.1 FHIR Std.
Address.country.extension:countryCode.​value[x] Base required Iso 3166 Part 1: 2 Letter Codes 📦4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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())

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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 (required)
... use ?!Σ 0..1 code Purpose of this address
Binding: AddressUse (required): The use of an address.
Example General: home
... country Σ 0..1 string Country (use of ISO 3166 2 letter code is RECOMMENDED)
.... Slices for extension Content/Rules for all slices
..... extension:countryCode 0..1 (Complex) code for string
URL: http://hl7.org/fhir/StructureDefinition/iso21090-codedString
...... extension 0..0 Extension
Slice: Unordered, Open by value:url
...... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/iso21090-codedString"
...... value[x] 1..1 Coding Value of extension
Binding: Iso3166-1-2 (required)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Address.use Base required AddressUse 📍4.0.1 FHIR Std.
Address.country.extension:countryCode.​value[x] Base required Iso 3166 Part 1: 2 Letter Codes 📦4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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 (required)
... use 0..1 code Purpose of this address
... country 0..1 string Country (use of ISO 3166 2 letter code is RECOMMENDED)
.... Slices for extension Content/Rules for all slices
..... extension:countryCode 0..1 CodedString(5.3.0) code for string
...... value[x] 1..1 Coding Value of extension
Binding: Iso3166-1-2 (required)

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Address.country.extension:countryCode.​value[x] Base required Iso 3166 Part 1: 2 Letter Codes 📦4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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 ViewView

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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 (required)
... use ?!Σ 0..1 code Purpose of this address
Binding: AddressUse (required): The use of an address.
Example General: home
... 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 City
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
Example General: 9132
... country Σ 0..1 string Country (use of ISO 3166 2 letter code is RECOMMENDED)
.... 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-codedString
...... id 0..1 id Unique id for inter-element referencing
...... extension 0..0 Extension
Slice: Unordered, Open by value:url
...... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/iso21090-codedString"
...... value[x] 1..1 Coding Value of extension
Binding: Iso3166-1-2 (required)
.... 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"}

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Address.use Base required AddressUse 📍4.0.1 FHIR Std.
Address.type Base required AddressType 📍4.0.1 FHIR Std.
Address.country.extension:countryCode.​value[x] Base required Iso 3166 Part 1: 2 Letter Codes 📦4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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())

 

Other representations of profile: CSV, Excel, Schematron