HL7 Czech Hospital Discharge Report Implementation Guide
0.1.0 - ci-build

HL7 Czech Hospital Discharge Report Implementation Guide, published by HL7 Czech Republic. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7-cz/hdr/ and changes regularly. See the Directory of published versions

## Data Type Profile: Address Obligations (HDR CZ)

Official URL: https://hl7.cz/fhir/hdr/StructureDefinition/cz-address-obl-hdr | Version: 0.1.0
Standards status: Informative | Maturity Level: 0 | Computable Name: CZ_AddressObligationsHdr

Obligations for Address in Czech Republic - HDR

Usages:

- This DataType Profile is not used by any profiles in this Implementation Guide

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
--- | --- | --- | --- | ---
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
Obligations | Actor
SHOULD:populate-if-known | Creator_L1
SHALL:process | Consumer_L1
SHALL:populate-if-known | Creator_L2
SHALL:process | Consumer_L2
SHALL:populate-if-known | Creator_L3
SHOULD:display | Consumer_L3
extension:permanentResidence | O | 0..1 | CodeableConcept | Address permanent residence URL: https://hl7.cz/fhir/core/StructureDefinition/permanent-residencer-address-cz Binding: Iso3166-1-2 (required)
Obligations | Actor
SHOULD:populate-if-known | Creator_L1
SHOULD:display | Consumer_L1
SHOULD:populate-if-known | Creator_L2
SHOULD:display | Consumer_L2
SHOULD:populate-if-known | Creator_L2
SHOULD:display | Consumer_L3
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
Obligations | Actor
SHALL:able-to-populate | Creator_L1
SHALL:display | Consumer_L1
SHALL:able-to-populate | Creator_L2
SHALL:display | Consumer_L2
SHALL:able-to-populate | Creator_L3
SHALL:display | Consumer_L3
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
Obligations | Actor
SHALL:able-to-populate | Creator_L1
SHALL:display | Consumer_L1
SHALL:able-to-populate | Creator_L2
SHALL:display | Consumer_L2
SHALL:able-to-populate | Creator_L3
SHALL:display | Consumer_L3
Slices for extension |  |  |  | Content/Rules for all slices
extension:streetName | O | 0..* | string | streetName URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName
Obligations | Actor
SHALL:able-to-populate | Creator_L2
SHALL:display | Consumer_L2
SHALL:able-to-populate | Creator_L3
SHALL:display | Consumer_L2
extension:houseNumber | O | 0..* | string | houseNumber URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber
Obligations | Actor
SHALL:able-to-populate | Creator_L2
SHALL:display | Consumer_L2
SHALL:able-to-populate | Creator_L3
SHALL:display | Consumer_L2
extension:postBox | O | 0..* | string | postBox URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox
Obligations | Actor
SHALL:able-to-populate | Creator_L2
SHALL:display | Consumer_L2
SHALL:able-to-populate | Creator_L3
SHALL:display | Consumer_L2
value | O | 0..1 | string | Primitive value for string
Obligations | Actor
SHALL:able-to-populate | Creator_L1
SHALL:display | Consumer_L1
SHALL:able-to-populate | Creator_L2
SHALL:display | Consumer_L2
SHALL:able-to-populate | Creator_L3
SHALL:display | Consumer_L3
Max Length:1048576
city | O Σ | 0..1 | string | Name of city, town etc. Example General: Erewhon
Obligations | Actor
SHALL:able-to-populate | Creator_L1
SHALL:display | Consumer_L1
SHALL:able-to-populate | Creator_L2
SHALL:display | Consumer_L2
SHALL:able-to-populate | Creator_L3
SHALL:display | Consumer_L3
postalCode | O Σ | 0..1 | string | Postal code for area Example General: 9132
Obligations | Actor
SHALL:able-to-populate | Creator_L1
SHALL:display | Consumer_L1
SHALL:able-to-populate | Creator_L2
SHALL:display | Consumer_L2
SHALL:able-to-populate | Creator_L3
SHALL:display | Consumer_L3
country | O Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 letter code)
Obligations | Actor
SHALL:able-to-populate | Creator_L1
SHALL:display | Consumer_L1
SHALL:able-to-populate | Creator_L2
SHALL:display | Consumer_L2
SHALL:able-to-populate | Creator_L3
SHALL:display | Consumer_L3
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
Obligations | Actor
SHOULD:able-to-populate | Creator_L1
SHALL:display | Consumer_L1
SHOULD:able-to-populate | Creator_L2
SHALL:display | Consumer_L2
SHOULD:able-to-populate | Creator_L3
SHALL:display | Consumer_L3
extension |  | 0..0 |  | Extension Slice: Unordered, Open by value:url
url |  | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/iso21090-SC-coding"
value[x] |  | 1..1 | Coding | Value of extension Binding: Iso3166-1-2 (required)
value | O | 0..1 | string | Primitive value for string
Obligations | Actor
SHALL:able-to-populate | Creator_L1
SHALL:able-to-populate | Creator_L2
SHALL:able-to-populate | Creator_L3
Max Length:1048576
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())`

This structure is derived from CZ_Address

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
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)
Obligations | Actor
SHOULD:populate-if-known | Creator_L1
SHALL:process | Consumer_L1
SHALL:populate-if-known | Creator_L2
SHALL:process | Consumer_L2
SHALL:populate-if-known | Creator_L3
SHOULD:display | Consumer_L3
extension:permanentResidence | O | 0..1 | PermanentResidenceAddressCz | Address permanent residence
Obligations | Actor
SHOULD:populate-if-known | Creator_L1
SHOULD:display | Consumer_L1
SHOULD:populate-if-known | Creator_L2
SHOULD:display | Consumer_L2
SHOULD:populate-if-known | Creator_L2
SHOULD:display | Consumer_L3
use | O | 0..1 | code | home | work | temp | old | billing - purpose of this address
Obligations | Actor
SHALL:able-to-populate | Creator_L1
SHALL:display | Consumer_L1
SHALL:able-to-populate | Creator_L2
SHALL:display | Consumer_L2
SHALL:able-to-populate | Creator_L3
SHALL:display | Consumer_L3
line | O | 0..* | string | Street name, number, direction & P.O. Box etc.
Obligations | Actor
SHALL:able-to-populate | Creator_L1
SHALL:display | Consumer_L1
SHALL:able-to-populate | Creator_L2
SHALL:display | Consumer_L2
SHALL:able-to-populate | Creator_L3
SHALL:display | Consumer_L3
Slices for extension |  |  |  | Content/Rules for all slices
extension:streetName | O | 0..* | ADXPStreetName(5.2.0) | streetName
Obligations | Actor
SHALL:able-to-populate | Creator_L2
SHALL:display | Consumer_L2
SHALL:able-to-populate | Creator_L3
SHALL:display | Consumer_L2
extension:houseNumber | O | 0..* | ADXPHouseNumber(5.2.0) | houseNumber
Obligations | Actor
SHALL:able-to-populate | Creator_L2
SHALL:display | Consumer_L2
SHALL:able-to-populate | Creator_L3
SHALL:display | Consumer_L2
extension:postBox | O | 0..* | ADXPPostBox(5.2.0) | postBox
Obligations | Actor
SHALL:able-to-populate | Creator_L2
SHALL:display | Consumer_L2
SHALL:able-to-populate | Creator_L3
SHALL:display | Consumer_L2
value | O | 0..1 | string | Primitive value for string
Obligations | Actor
SHALL:able-to-populate | Creator_L1
SHALL:display | Consumer_L1
SHALL:able-to-populate | Creator_L2
SHALL:display | Consumer_L2
SHALL:able-to-populate | Creator_L3
SHALL:display | Consumer_L3
city | O | 0..1 | string | Name of city, town etc.
Obligations | Actor
SHALL:able-to-populate | Creator_L1
SHALL:display | Consumer_L1
SHALL:able-to-populate | Creator_L2
SHALL:display | Consumer_L2
SHALL:able-to-populate | Creator_L3
SHALL:display | Consumer_L3
postalCode | O | 0..1 | string | Postal code for area
Obligations | Actor
SHALL:able-to-populate | Creator_L1
SHALL:display | Consumer_L1
SHALL:able-to-populate | Creator_L2
SHALL:display | Consumer_L2
SHALL:able-to-populate | Creator_L3
SHALL:display | Consumer_L3
country | O | 0..1 | string | Country (e.g. can be ISO 3166 2 letter code)
Obligations | Actor
SHALL:able-to-populate | Creator_L1
SHALL:display | Consumer_L1
SHALL:able-to-populate | Creator_L2
SHALL:display | Consumer_L2
SHALL:able-to-populate | Creator_L3
SHALL:display | Consumer_L3
Slices for extension |  |  |  | Content/Rules for all slices
extension:countryCode | O | 0..1 | SCCoding(5.2.0) | code for string
Obligations | Actor
SHOULD:able-to-populate | Creator_L1
SHALL:display | Consumer_L1
SHOULD:able-to-populate | Creator_L2
SHALL:display | Consumer_L2
SHOULD:able-to-populate | Creator_L3
SHALL:display | Consumer_L3
value | O | 0..1 | string | Primitive value for string
Obligations | Actor
SHALL:able-to-populate | Creator_L1
SHALL:able-to-populate | Creator_L2
SHALL:able-to-populate | Creator_L3
Documentation for this format

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
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
Obligations | Actor
SHOULD:populate-if-known | Creator_L1
SHALL:process | Consumer_L1
SHALL:populate-if-known | Creator_L2
SHALL:process | Consumer_L2
SHALL:populate-if-known | Creator_L3
SHOULD:display | Consumer_L3
extension:permanentResidence | O | 0..1 | CodeableConcept | Address permanent residence URL: https://hl7.cz/fhir/core/StructureDefinition/permanent-residencer-address-cz Binding: Iso3166-1-2 (required)
Obligations | Actor
SHOULD:populate-if-known | Creator_L1
SHOULD:display | Consumer_L1
SHOULD:populate-if-known | Creator_L2
SHOULD:display | Consumer_L2
SHOULD:populate-if-known | Creator_L2
SHOULD:display | Consumer_L3
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
Obligations | Actor
SHALL:able-to-populate | Creator_L1
SHALL:display | Consumer_L1
SHALL:able-to-populate | Creator_L2
SHALL:display | Consumer_L2
SHALL:able-to-populate | Creator_L3
SHALL:display | Consumer_L3
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
Obligations | Actor
SHALL:able-to-populate | Creator_L1
SHALL:display | Consumer_L1
SHALL:able-to-populate | Creator_L2
SHALL:display | Consumer_L2
SHALL:able-to-populate | Creator_L3
SHALL:display | Consumer_L3
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
Obligations | Actor
SHALL:able-to-populate | Creator_L2
SHALL:display | Consumer_L2
SHALL:able-to-populate | Creator_L3
SHALL:display | Consumer_L2
extension:houseNumber | O | 0..* | string | houseNumber URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber
Obligations | Actor
SHALL:able-to-populate | Creator_L2
SHALL:display | Consumer_L2
SHALL:able-to-populate | Creator_L3
SHALL:display | Consumer_L2
extension:postBox | O | 0..* | string | postBox URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox
Obligations | Actor
SHALL:able-to-populate | Creator_L2
SHALL:display | Consumer_L2
SHALL:able-to-populate | Creator_L3
SHALL:display | Consumer_L2
value | O | 0..1 | string | Primitive value for string
Obligations | Actor
SHALL:able-to-populate | Creator_L1
SHALL:display | Consumer_L1
SHALL:able-to-populate | Creator_L2
SHALL:display | Consumer_L2
SHALL:able-to-populate | Creator_L3
SHALL:display | Consumer_L3
Max Length:1048576
city | O Σ | 0..1 | string | Name of city, town etc. Example General: Erewhon
Obligations | Actor
SHALL:able-to-populate | Creator_L1
SHALL:display | Consumer_L1
SHALL:able-to-populate | Creator_L2
SHALL:display | Consumer_L2
SHALL:able-to-populate | Creator_L3
SHALL:display | Consumer_L3
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
Obligations | Actor
SHALL:able-to-populate | Creator_L1
SHALL:display | Consumer_L1
SHALL:able-to-populate | Creator_L2
SHALL:display | Consumer_L2
SHALL:able-to-populate | Creator_L3
SHALL:display | Consumer_L3
country | O Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 letter code)
Obligations | Actor
SHALL:able-to-populate | Creator_L1
SHALL:display | Consumer_L1
SHALL:able-to-populate | Creator_L2
SHALL:display | Consumer_L2
SHALL:able-to-populate | Creator_L3
SHALL:display | Consumer_L3
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
Obligations | Actor
SHOULD:able-to-populate | Creator_L1
SHALL:display | Consumer_L1
SHOULD:able-to-populate | Creator_L2
SHALL:display | Consumer_L2
SHOULD:able-to-populate | Creator_L3
SHALL:display | Consumer_L3
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-SC-coding"
value[x] |  | 1..1 | Coding | Value of extension Binding: Iso3166-1-2 (required)
value | O | 0..1 | string | Primitive value for string
Obligations | Actor
SHALL:able-to-populate | Creator_L1
SHALL:able-to-populate | Creator_L2
SHALL:able-to-populate | Creator_L3
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

#### 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())`

This structure is derived from CZ_Address

Summary

Maturity: 0

Key Elements View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
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
Obligations | Actor
SHOULD:populate-if-known | Creator_L1
SHALL:process | Consumer_L1
SHALL:populate-if-known | Creator_L2
SHALL:process | Consumer_L2
SHALL:populate-if-known | Creator_L3
SHOULD:display | Consumer_L3
extension:permanentResidence | O | 0..1 | CodeableConcept | Address permanent residence URL: https://hl7.cz/fhir/core/StructureDefinition/permanent-residencer-address-cz Binding: Iso3166-1-2 (required)
Obligations | Actor
SHOULD:populate-if-known | Creator_L1
SHOULD:display | Consumer_L1
SHOULD:populate-if-known | Creator_L2
SHOULD:display | Consumer_L2
SHOULD:populate-if-known | Creator_L2
SHOULD:display | Consumer_L3
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
Obligations | Actor
SHALL:able-to-populate | Creator_L1
SHALL:display | Consumer_L1
SHALL:able-to-populate | Creator_L2
SHALL:display | Consumer_L2
SHALL:able-to-populate | Creator_L3
SHALL:display | Consumer_L3
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
Obligations | Actor
SHALL:able-to-populate | Creator_L1
SHALL:display | Consumer_L1
SHALL:able-to-populate | Creator_L2
SHALL:display | Consumer_L2
SHALL:able-to-populate | Creator_L3
SHALL:display | Consumer_L3
Slices for extension |  |  |  | Content/Rules for all slices
extension:streetName | O | 0..* | string | streetName URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName
Obligations | Actor
SHALL:able-to-populate | Creator_L2
SHALL:display | Consumer_L2
SHALL:able-to-populate | Creator_L3
SHALL:display | Consumer_L2
extension:houseNumber | O | 0..* | string | houseNumber URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber
Obligations | Actor
SHALL:able-to-populate | Creator_L2
SHALL:display | Consumer_L2
SHALL:able-to-populate | Creator_L3
SHALL:display | Consumer_L2
extension:postBox | O | 0..* | string | postBox URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox
Obligations | Actor
SHALL:able-to-populate | Creator_L2
SHALL:display | Consumer_L2
SHALL:able-to-populate | Creator_L3
SHALL:display | Consumer_L2
value | O | 0..1 | string | Primitive value for string
Obligations | Actor
SHALL:able-to-populate | Creator_L1
SHALL:display | Consumer_L1
SHALL:able-to-populate | Creator_L2
SHALL:display | Consumer_L2
SHALL:able-to-populate | Creator_L3
SHALL:display | Consumer_L3
Max Length:1048576
city | O Σ | 0..1 | string | Name of city, town etc. Example General: Erewhon
Obligations | Actor
SHALL:able-to-populate | Creator_L1
SHALL:display | Consumer_L1
SHALL:able-to-populate | Creator_L2
SHALL:display | Consumer_L2
SHALL:able-to-populate | Creator_L3
SHALL:display | Consumer_L3
postalCode | O Σ | 0..1 | string | Postal code for area Example General: 9132
Obligations | Actor
SHALL:able-to-populate | Creator_L1
SHALL:display | Consumer_L1
SHALL:able-to-populate | Creator_L2
SHALL:display | Consumer_L2
SHALL:able-to-populate | Creator_L3
SHALL:display | Consumer_L3
country | O Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 letter code)
Obligations | Actor
SHALL:able-to-populate | Creator_L1
SHALL:display | Consumer_L1
SHALL:able-to-populate | Creator_L2
SHALL:display | Consumer_L2
SHALL:able-to-populate | Creator_L3
SHALL:display | Consumer_L3
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
Obligations | Actor
SHOULD:able-to-populate | Creator_L1
SHALL:display | Consumer_L1
SHOULD:able-to-populate | Creator_L2
SHALL:display | Consumer_L2
SHOULD:able-to-populate | Creator_L3
SHALL:display | Consumer_L3
extension |  | 0..0 |  | Extension Slice: Unordered, Open by value:url
url |  | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/iso21090-SC-coding"
value[x] |  | 1..1 | Coding | Value of extension Binding: Iso3166-1-2 (required)
value | O | 0..1 | string | Primitive value for string
Obligations | Actor
SHALL:able-to-populate | Creator_L1
SHALL:able-to-populate | Creator_L2
SHALL:able-to-populate | Creator_L3
Max Length:1048576
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

This structure is derived from CZ_Address

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
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)
Obligations | Actor
SHOULD:populate-if-known | Creator_L1
SHALL:process | Consumer_L1
SHALL:populate-if-known | Creator_L2
SHALL:process | Consumer_L2
SHALL:populate-if-known | Creator_L3
SHOULD:display | Consumer_L3
extension:permanentResidence | O | 0..1 | PermanentResidenceAddressCz | Address permanent residence
Obligations | Actor
SHOULD:populate-if-known | Creator_L1
SHOULD:display | Consumer_L1
SHOULD:populate-if-known | Creator_L2
SHOULD:display | Consumer_L2
SHOULD:populate-if-known | Creator_L2
SHOULD:display | Consumer_L3
use | O | 0..1 | code | home | work | temp | old | billing - purpose of this address
Obligations | Actor
SHALL:able-to-populate | Creator_L1
SHALL:display | Consumer_L1
SHALL:able-to-populate | Creator_L2
SHALL:display | Consumer_L2
SHALL:able-to-populate | Creator_L3
SHALL:display | Consumer_L3
line | O | 0..* | string | Street name, number, direction & P.O. Box etc.
Obligations | Actor
SHALL:able-to-populate | Creator_L1
SHALL:display | Consumer_L1
SHALL:able-to-populate | Creator_L2
SHALL:display | Consumer_L2
SHALL:able-to-populate | Creator_L3
SHALL:display | Consumer_L3
Slices for extension |  |  |  | Content/Rules for all slices
extension:streetName | O | 0..* | ADXPStreetName(5.2.0) | streetName
Obligations | Actor
SHALL:able-to-populate | Creator_L2
SHALL:display | Consumer_L2
SHALL:able-to-populate | Creator_L3
SHALL:display | Consumer_L2
extension:houseNumber | O | 0..* | ADXPHouseNumber(5.2.0) | houseNumber
Obligations | Actor
SHALL:able-to-populate | Creator_L2
SHALL:display | Consumer_L2
SHALL:able-to-populate | Creator_L3
SHALL:display | Consumer_L2
extension:postBox | O | 0..* | ADXPPostBox(5.2.0) | postBox
Obligations | Actor
SHALL:able-to-populate | Creator_L2
SHALL:display | Consumer_L2
SHALL:able-to-populate | Creator_L3
SHALL:display | Consumer_L2
value | O | 0..1 | string | Primitive value for string
Obligations | Actor
SHALL:able-to-populate | Creator_L1
SHALL:display | Consumer_L1
SHALL:able-to-populate | Creator_L2
SHALL:display | Consumer_L2
SHALL:able-to-populate | Creator_L3
SHALL:display | Consumer_L3
city | O | 0..1 | string | Name of city, town etc.
Obligations | Actor
SHALL:able-to-populate | Creator_L1
SHALL:display | Consumer_L1
SHALL:able-to-populate | Creator_L2
SHALL:display | Consumer_L2
SHALL:able-to-populate | Creator_L3
SHALL:display | Consumer_L3
postalCode | O | 0..1 | string | Postal code for area
Obligations | Actor
SHALL:able-to-populate | Creator_L1
SHALL:display | Consumer_L1
SHALL:able-to-populate | Creator_L2
SHALL:display | Consumer_L2
SHALL:able-to-populate | Creator_L3
SHALL:display | Consumer_L3
country | O | 0..1 | string | Country (e.g. can be ISO 3166 2 letter code)
Obligations | Actor
SHALL:able-to-populate | Creator_L1
SHALL:display | Consumer_L1
SHALL:able-to-populate | Creator_L2
SHALL:display | Consumer_L2
SHALL:able-to-populate | Creator_L3
SHALL:display | Consumer_L3
Slices for extension |  |  |  | Content/Rules for all slices
extension:countryCode | O | 0..1 | SCCoding(5.2.0) | code for string
Obligations | Actor
SHOULD:able-to-populate | Creator_L1
SHALL:display | Consumer_L1
SHOULD:able-to-populate | Creator_L2
SHALL:display | Consumer_L2
SHOULD:able-to-populate | Creator_L3
SHALL:display | Consumer_L3
value | O | 0..1 | string | Primitive value for string
Obligations | Actor
SHALL:able-to-populate | Creator_L1
SHALL:able-to-populate | Creator_L2
SHALL:able-to-populate | Creator_L3
Documentation for this format

Snapshot View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
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
Obligations | Actor
SHOULD:populate-if-known | Creator_L1
SHALL:process | Consumer_L1
SHALL:populate-if-known | Creator_L2
SHALL:process | Consumer_L2
SHALL:populate-if-known | Creator_L3
SHOULD:display | Consumer_L3
extension:permanentResidence | O | 0..1 | CodeableConcept | Address permanent residence URL: https://hl7.cz/fhir/core/StructureDefinition/permanent-residencer-address-cz Binding: Iso3166-1-2 (required)
Obligations | Actor
SHOULD:populate-if-known | Creator_L1
SHOULD:display | Consumer_L1
SHOULD:populate-if-known | Creator_L2
SHOULD:display | Consumer_L2
SHOULD:populate-if-known | Creator_L2
SHOULD:display | Consumer_L3
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
Obligations | Actor
SHALL:able-to-populate | Creator_L1
SHALL:display | Consumer_L1
SHALL:able-to-populate | Creator_L2
SHALL:display | Consumer_L2
SHALL:able-to-populate | Creator_L3
SHALL:display | Consumer_L3
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
Obligations | Actor
SHALL:able-to-populate | Creator_L1
SHALL:display | Consumer_L1
SHALL:able-to-populate | Creator_L2
SHALL:display | Consumer_L2
SHALL:able-to-populate | Creator_L3
SHALL:display | Consumer_L3
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
Obligations | Actor
SHALL:able-to-populate | Creator_L2
SHALL:display | Consumer_L2
SHALL:able-to-populate | Creator_L3
SHALL:display | Consumer_L2
extension:houseNumber | O | 0..* | string | houseNumber URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber
Obligations | Actor
SHALL:able-to-populate | Creator_L2
SHALL:display | Consumer_L2
SHALL:able-to-populate | Creator_L3
SHALL:display | Consumer_L2
extension:postBox | O | 0..* | string | postBox URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox
Obligations | Actor
SHALL:able-to-populate | Creator_L2
SHALL:display | Consumer_L2
SHALL:able-to-populate | Creator_L3
SHALL:display | Consumer_L2
value | O | 0..1 | string | Primitive value for string
Obligations | Actor
SHALL:able-to-populate | Creator_L1
SHALL:display | Consumer_L1
SHALL:able-to-populate | Creator_L2
SHALL:display | Consumer_L2
SHALL:able-to-populate | Creator_L3
SHALL:display | Consumer_L3
Max Length:1048576
city | O Σ | 0..1 | string | Name of city, town etc. Example General: Erewhon
Obligations | Actor
SHALL:able-to-populate | Creator_L1
SHALL:display | Consumer_L1
SHALL:able-to-populate | Creator_L2
SHALL:display | Consumer_L2
SHALL:able-to-populate | Creator_L3
SHALL:display | Consumer_L3
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
Obligations | Actor
SHALL:able-to-populate | Creator_L1
SHALL:display | Consumer_L1
SHALL:able-to-populate | Creator_L2
SHALL:display | Consumer_L2
SHALL:able-to-populate | Creator_L3
SHALL:display | Consumer_L3
country | O Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 letter code)
Obligations | Actor
SHALL:able-to-populate | Creator_L1
SHALL:display | Consumer_L1
SHALL:able-to-populate | Creator_L2
SHALL:display | Consumer_L2
SHALL:able-to-populate | Creator_L3
SHALL:display | Consumer_L3
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
Obligations | Actor
SHOULD:able-to-populate | Creator_L1
SHALL:display | Consumer_L1
SHOULD:able-to-populate | Creator_L2
SHALL:display | Consumer_L2
SHOULD:able-to-populate | Creator_L3
SHALL:display | Consumer_L3
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-SC-coding"
value[x] |  | 1..1 | Coding | Value of extension Binding: Iso3166-1-2 (required)
value | O | 0..1 | string | Primitive value for string
Obligations | Actor
SHALL:able-to-populate | Creator_L1
SHALL:able-to-populate | Creator_L2
SHALL:able-to-populate | Creator_L3
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

#### 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())`

This structure is derived from CZ_Address

Summary

Maturity: 0

Other representations of profile: CSV, Excel, Schematron