HL7 Czech Imaging Report IG
0.1.0-ballot - ci-build
HL7 Czech Imaging Report IG
0.1.0-ballot - ci-build
HL7 Czech Imaging Report IG, published by HL7 Czech Republic. This guide is not an authorized publication; it is the continuous build for version 0.1.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/img/ and changes regularly. See the Directory of published versions
| Official URL: https://hl7.cz/fhir/img/StructureDefinition/cz-address-obl-img | Version: 0.1.0-ballot | |||
| Standards status: Informative | Maturity Level: 0 | Computable Name: CZ_AddressObligationsImg | ||
This profile defines obligations for an address in FHIR for the purpose of this guide.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Path | Status | Usage | ValueSet | Version | Source |
| Address.use | Base | required | AddressUse | 📍4.0.1 | FHIR Std. |
| Address.country.extension:countryCode.value[x] | Base | preferred | Iso 3166 Part 1: 2 Letter Codes | 📦4.0.1 | FHIR Std. |
| 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())
|
This structure is derived from CZ_Address
| Name | Flags | Card. | Type | Description & Constraints Filter:   | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
  Address |
0..* | CZ_Address | Address according to Czech postal conventions | |||||||||||||||
  Slices for extension |
Content/Rules for all slices | |||||||||||||||||
   extension:addressPoint |
O | 0..1 | AddressPointCz | Address location code according to the system RÚIAN (ČÚZK)
| ||||||||||||||
 use |
O | 0..1 | code | home | work | temp | old | billing - purpose of this address
| ||||||||||||||
| line |
O | 0..* | string | Street name, number, direction & P.O. Box etc.
| ||||||||||||||
| Slices for extension |
Content/Rules for all slices | |||||||||||||||||
 extension:streetName |
O | 0..* | ADXPStreetName(5.2.0) | streetName
| ||||||||||||||
| extension:houseNumber |
O | 0..* | ADXPHouseNumber(5.2.0) | houseNumber
| ||||||||||||||
| extension:postBox |
O | 0..* | ADXPPostBox(5.2.0) | postBox
| ||||||||||||||
 value |
O | 0..1 | string | Primitive value for string
| ||||||||||||||
| city |
O | 0..1 | string | Name of city, town etc.
| ||||||||||||||
| postalCode |
O | 0..1 | string | Postal code for area
| ||||||||||||||
 country |
O | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code)
| ||||||||||||||
 Slices for extension |
Content/Rules for all slices | |||||||||||||||||
| extension:countryCode |
O | 0..1 | SCCoding(5.2.0) | code for string
| ||||||||||||||
| value |
O | 0..1 | string | Primitive value for string
| ||||||||||||||
| Documentation for this format | ||||||||||||||||||
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Address |
C | 0..* | CZ_Address | 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 |
O | 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 |
?!OΣ | 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 |
OΣ | 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 |
O | 0..* | string | streetName URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName
| ||||||||||||||
| extension:houseNumber |
O | 0..* | string | houseNumber URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber
| ||||||||||||||
| extension:postBox |
O | 0..* | string | postBox URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox
| ||||||||||||||
| value |
O | 0..1 | string | Primitive value for string
Max Length:1048576 | ||||||||||||||
| city |
OΣ | 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 |
OΣ | 0..1 | string | Postal code for area Example General: 9132
| ||||||||||||||
| country |
OΣ | 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 |
O | 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 |
O | 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 | 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 | preferred | Iso 3166 Part 1: 2 Letter Codes | 📦4.0.1 | FHIR Std. |
| 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())
|
This structure is derived from CZ_Address
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Address |
C | 0..* | CZ_Address | 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 |
O | 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 |
?!OΣ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
| ||||||||||||||
| line |
OΣ | 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
| ||||||||||||||
| Slices for extension |
Content/Rules for all slices | |||||||||||||||||
| extension:streetName |
O | 0..* | string | streetName URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName
| ||||||||||||||
| extension:houseNumber |
O | 0..* | string | houseNumber URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber
| ||||||||||||||
| extension:postBox |
O | 0..* | string | postBox URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox
| ||||||||||||||
| value |
O | 0..1 | string | Primitive value for string
Max Length:1048576 | ||||||||||||||
| city |
OΣ | 0..1 | string | Name of city, town etc. Example General: Erewhon
| ||||||||||||||
| postalCode |
OΣ | 0..1 | string | Postal code for area Example General: 9132
| ||||||||||||||
| country |
OΣ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code)
| ||||||||||||||
| Slices for extension |
Content/Rules for all slices | |||||||||||||||||
| extension:countryCode |
O | 0..1 | (Complex) | code for string URL: http://hl7.org/fhir/StructureDefinition/iso21090-SC-coding
| ||||||||||||||
| 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 |
O | 0..1 | string | Primitive value for string
Max Length:1048576 | ||||||||||||||
| Documentation for this format | ||||||||||||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Address.use | Base | required | AddressUse | 📍4.0.1 | FHIR Std. |
| Address.country.extension:countryCode.value[x] | Base | preferred | Iso 3166 Part 1: 2 Letter Codes | 📦4.0.1 | FHIR Std. |
| 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
This structure is derived from CZ_Address
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Address |
0..* | CZ_Address | Address according to Czech postal conventions | |||||||||||||||
| Slices for extension |
Content/Rules for all slices | |||||||||||||||||
| extension:addressPoint |
O | 0..1 | AddressPointCz | Address location code according to the system RÚIAN (ČÚZK)
| ||||||||||||||
| use |
O | 0..1 | code | home | work | temp | old | billing - purpose of this address
| ||||||||||||||
| line |
O | 0..* | string | Street name, number, direction & P.O. Box etc.
| ||||||||||||||
| Slices for extension |
Content/Rules for all slices | |||||||||||||||||
| extension:streetName |
O | 0..* | ADXPStreetName(5.2.0) | streetName
| ||||||||||||||
| extension:houseNumber |
O | 0..* | ADXPHouseNumber(5.2.0) | houseNumber
| ||||||||||||||
| extension:postBox |
O | 0..* | ADXPPostBox(5.2.0) | postBox
| ||||||||||||||
| value |
O | 0..1 | string | Primitive value for string
| ||||||||||||||
| city |
O | 0..1 | string | Name of city, town etc.
| ||||||||||||||
| postalCode |
O | 0..1 | string | Postal code for area
| ||||||||||||||
| country |
O | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code)
| ||||||||||||||
| Slices for extension |
Content/Rules for all slices | |||||||||||||||||
| extension:countryCode |
O | 0..1 | SCCoding(5.2.0) | code for string
| ||||||||||||||
| value |
O | 0..1 | string | Primitive value for string
| ||||||||||||||
| Documentation for this format | ||||||||||||||||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Address |
C | 0..* | CZ_Address | 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 |
O | 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 |
?!OΣ | 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 |
OΣ | 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 |
O | 0..* | string | streetName URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName
| ||||||||||||||
| extension:houseNumber |
O | 0..* | string | houseNumber URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber
| ||||||||||||||
| extension:postBox |
O | 0..* | string | postBox URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox
| ||||||||||||||
| value |
O | 0..1 | string | Primitive value for string
Max Length:1048576 | ||||||||||||||
| city |
OΣ | 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 |
OΣ | 0..1 | string | Postal code for area Example General: 9132
| ||||||||||||||
| country |
OΣ | 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 |
O | 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 |
O | 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 | 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 | preferred | Iso 3166 Part 1: 2 Letter Codes | 📦4.0.1 | FHIR Std. |
| 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())
|
This structure is derived from CZ_Address
Other representations of profile: CSV, Excel, Schematron