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: CZ_AddressObligationsHdr - Detailed Descriptions

Page standards status: Informative | Maturity Level: 0

Definitions for the cz-address-obl-hdr data type profile.

- Key Elements Table
- Differential Elements Table
- Snapshot Elements Table

Guidance on how to interpret the contents of this table can be foundhere

0. Address
Definition | Address according to Czech postal conventions. The address can be used both for delivering mail and for locating locations that do not have a valid mailing address. The use of extensions is not mandatory. An address expressed using postal conventions (as opposed to GPS or other location definition formats). This data type may be used to convey addresses for use in delivering mail as well as for visiting locations which might not be valid for mail delivery. There are a variety of postal address formats defined around the world.
Short | Address according to Czech postal conventionsAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
Comments | Note: address is intended to describe postal addresses for administrative purposes, not to describe absolute geographical coordinates. Postal addresses are often used as proxies for physical locations (also see the Location resource). Note: address is intended to describe postal addresses for administrative purposes, not to describe absolute geographical coordinates. Postal addresses are often used as proxies for physical locations (also see the Location resource).
Control | 0..* This element is affected by the following invariants: ele-1
Is Modifier | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) text-or-ctry: Address must contain at least text or country element (`( line.all($this.empty()) and city.empty() ) implies (text.exists() or country.exists())`) POB-and-PCS: 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())`) street-and-city: 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()`) POB-only-postal: 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()`) POB-ext-only: 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()))`)
2. Address.extension:addressPoint
Slice Name | addressPoint
Definition | This extension allows the entry of an address point according to the RÚIAN registry.
Short | Address location code according to the system RÚIAN (ČÚZK)
Control | 0..1
Type | Extension(Address location code according to the system RÚIAN (ČÚZK)) (Extension Type: Identifier)
Is Modifier | false
Obligations |
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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
4. Address.extension:permanentResidence
Slice Name | permanentResidence
Definition | This extension allows to specify whether or not the address is an official address (permanent address) or to indicate that it is the official address for that country.
Short | Address permanent residence
Control | 0..1
Type | Extension(Address permanent residence) (Extension Type: Choice of: boolean, CodeableConcept)
Is Modifier | false
Obligations |
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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
6. Address.use
Definition | Address use The purpose of this address.
Short | home | work | temp | old | billing - purpose of this address
Comments | Applications can assume that an address is current unless it explicitly says that it is temporary or old.
Control | 0..1
Binding | The codes SHALL be taken from AddressUse http://hl7.org/fhir/ValueSet/address-use|4.0.1 (required to `http://hl7.org/fhir/ValueSet/address-use|4.0.1` ) The use of an address.
Type | code
Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary or old address etc.for a current/permanent one
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Obligations |
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
Summary | true
Requirements | Allows an appropriate address to be chosen from a list of many.
Example | General: home
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
8. Address.line
Definition | This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.
Short | Street name, number, direction & P.O. Box etc.
Control | 0..*
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Obligations |
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
Summary | true
Example | General: 137 Nowhere Street
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
10. Address.line.extension:streetName
Slice Name | streetName
Definition | streetName.
Short | streetName
Control | 0..*
Type | Extension(ADXP Street Name) (Extension Type: string)
Is Modifier | false
Obligations |
Obligations | Actor
SHALL:able-to-populate | Creator_L2
SHALL:display | Consumer_L2
SHALL:able-to-populate | Creator_L3
SHALL:display | Consumer_L2
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
12. Address.line.extension:houseNumber
Slice Name | houseNumber
Definition | The number of a building, house or lot alongside the street. Also known as "primary street number". This does not number the street but rather the building.
Short | houseNumber
Control | 0..*
Type | Extension(ADXP House Number) (Extension Type: string)
Is Modifier | false
Obligations |
Obligations | Actor
SHALL:able-to-populate | Creator_L2
SHALL:display | Consumer_L2
SHALL:able-to-populate | Creator_L3
SHALL:display | Consumer_L2
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
14. Address.line.extension:postBox
Slice Name | postBox
Definition | A numbered box located in a post station.
Short | postBox
Control | 0..*
Type | Extension(ADXP Post Box) (Extension Type: string)
Is Modifier | false
Obligations |
Obligations | Actor
SHALL:able-to-populate | Creator_L2
SHALL:display | Consumer_L2
SHALL:able-to-populate | Creator_L3
SHALL:display | Consumer_L2
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
16. Address.line.value
Definition | The actual value
Short | Primitive value for string
Control | 0..1
Type | string
Is Modifier | false
Obligations |
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
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
Max Length: | 1048576
18. Address.city
Definition | The name of the city, town, suburb, village or other community or delivery center.
Short | Name of city, town etc.
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Obligations |
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
Summary | true
Alternate Names | Municpality
Example | General: Erewhon
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
20. Address.postalCode
Definition | A postal code designating a region defined by the postal service.
Short | Postal code for area
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Obligations |
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
Summary | true
Alternate Names | Zip
Example | General: 9132
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
22. Address.country
Definition | Country - a nation as commonly understood or generally accepted.
Short | Country (e.g. can be ISO 3166 2 letter code)Country (e.g. can be ISO 3166 2 or 3 letter code)
Comments | ISO 3166 3 letter codes can be used in place of a human readable country name.
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Obligations |
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
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
24. Address.country.extension:countryCode
Slice Name | countryCode
Definition | Provides a coded expression for the content represented in a string.
Short | code for string
Control | 0..1
Type | Extension(SC Coding) (Extension Type: Coding)
Is Modifier | false
Obligations |
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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
26. Address.country.extension:countryCode.extension
Definition | An Extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | ExtensionAdditional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..0*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
Slicing | This element introduces a set of slices on `Address.country.extension.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
28. Address.country.extension:countryCode.url
Definition | Source of the definition for the extension code - a logical name or a URL.
Short | identifies the meaning of the extension
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
Control | 1..1
Type | uri
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
Fixed Value | `http://hl7.org/fhir/StructureDefinition/iso21090-SC-coding`
30. Address.country.extension:countryCode.value[x]
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Short | Value of extension
Control | 10..1 This element is affected by the following invariants: ext-1
Binding | The codes SHALL be taken from For codes, see Iso3166-1-2 (required to `http://hl7.org/fhir/ValueSet/iso3166-1-2` )
Type | Coding, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
32. Address.country.value
Definition | The actual value
Short | Primitive value for string
Control | 0..1
Type | string
Is Modifier | false
Obligations |
Obligations | Actor
SHALL:able-to-populate | Creator_L1
SHALL:able-to-populate | Creator_L2
SHALL:able-to-populate | Creator_L3
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
Max Length: | 1048576

Guidance on how to interpret the contents of this table can be foundhere

0. Address
2. Address.extension:addressPoint
Slice Name | addressPoint
Obligations |
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
4. Address.extension:permanentResidence
Slice Name | permanentResidence
Obligations |
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
6. Address.use
Obligations |
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
8. Address.line
Obligations |
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
10. Address.line.extension:streetName
Slice Name | streetName
Obligations |
Obligations | Actor
SHALL:able-to-populate | Creator_L2
SHALL:display | Consumer_L2
SHALL:able-to-populate | Creator_L3
SHALL:display | Consumer_L2
12. Address.line.extension:houseNumber
Slice Name | houseNumber
Obligations |
Obligations | Actor
SHALL:able-to-populate | Creator_L2
SHALL:display | Consumer_L2
SHALL:able-to-populate | Creator_L3
SHALL:display | Consumer_L2
14. Address.line.extension:postBox
Slice Name | postBox
Obligations |
Obligations | Actor
SHALL:able-to-populate | Creator_L2
SHALL:display | Consumer_L2
SHALL:able-to-populate | Creator_L3
SHALL:display | Consumer_L2
16. Address.line.value
Obligations |
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
18. Address.city
Obligations |
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
20. Address.postalCode
Obligations |
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
22. Address.country
Obligations |
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
24. Address.country.extension:countryCode
Slice Name | countryCode
Obligations |
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
26. Address.country.value
Obligations |
Obligations | Actor
SHALL:able-to-populate | Creator_L1
SHALL:able-to-populate | Creator_L2
SHALL:able-to-populate | Creator_L3

Guidance on how to interpret the contents of this table can be foundhere

0. Address
Definition | Address according to Czech postal conventions. The address can be used both for delivering mail and for locating locations that do not have a valid mailing address. The use of extensions is not mandatory.
Short | Address according to Czech postal conventions
Comments | Note: address is intended to describe postal addresses for administrative purposes, not to describe absolute geographical coordinates. Postal addresses are often used as proxies for physical locations (also see the Location resource).
Control | 0..* This element is affected by the following invariants: ele-1
Is Modifier | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) text-or-ctry: Address must contain at least text or country element (`( line.all($this.empty()) and city.empty() ) implies (text.exists() or country.exists())`) POB-and-PCS: 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())`) street-and-city: 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()`) POB-only-postal: 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()`) POB-ext-only: 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()))`)
2. Address.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
4. Address.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `Address.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
6. Address.extension:addressPoint
Slice Name | addressPoint
Definition | This extension allows the entry of an address point according to the RÚIAN registry.
Short | Address location code according to the system RÚIAN (ČÚZK)
Control | 0..1
Type | Extension(Address location code according to the system RÚIAN (ČÚZK)) (Extension Type: Identifier)
Is Modifier | false
Obligations |
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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
8. Address.extension:permanentResidence
Slice Name | permanentResidence
Definition | This extension allows to specify whether or not the address is an official address (permanent address) or to indicate that it is the official address for that country.
Short | Address permanent residence
Control | 0..1
Type | Extension(Address permanent residence) (Extension Type: Choice of: boolean, CodeableConcept)
Is Modifier | false
Obligations |
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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
10. Address.use
Definition | Address use
Short | home | work | temp | old | billing - purpose of this address
Comments | Applications can assume that an address is current unless it explicitly says that it is temporary or old.
Control | 0..1
Binding | The codes SHALL be taken from AddressUse (required to `http://hl7.org/fhir/ValueSet/address-use|4.0.1` ) The use of an address.
Type | code
Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary or old address etc.for a current/permanent one
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Obligations |
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
Summary | true
Requirements | Allows an appropriate address to be chosen from a list of many.
Example | General: home
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
12. Address.type
Definition | Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both.
Short | postal | physical | both
Comments | The definition of Address states that "address is intended to describe postal addresses, not physical locations". However, many applications track whether an address has a dual purpose of being a location that can be visited as well as being a valid delivery destination, and Postal addresses are often used as proxies for physical locations (also see the Location resource).
Control | 0..1
Binding | The codes SHALL be taken from AddressType (required to `http://hl7.org/fhir/ValueSet/address-type|4.0.1` ) The type of an address (physical / postal).
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Example | General: both
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
14. Address.text
Definition | Specifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts.
Short | Text representation of the address
Comments | Can provide both a text representation and parts. Applications updating an address SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part.
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | A renderable, unencoded form.
Example | General: 137 Nowhere Street, Erewhon 9132
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
16. Address.line
Definition | This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.
Short | Street name, number, direction & P.O. Box etc.
Control | 0..*
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Obligations |
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
Summary | true
Example | General: 137 Nowhere Street
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
18. Address.line.id
Definition | unique id for the element within a resource (for internal references)
Short | xml:id (or equivalent in JSON)
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
20. Address.line.extension
Definition | An Extension
Short | Extension
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `Address.line.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
22. Address.line.extension:streetName
Slice Name | streetName
Definition | streetName.
Short | streetName
Control | 0..*
Type | Extension(ADXP Street Name) (Extension Type: string)
Is Modifier | false
Obligations |
Obligations | Actor
SHALL:able-to-populate | Creator_L2
SHALL:display | Consumer_L2
SHALL:able-to-populate | Creator_L3
SHALL:display | Consumer_L2
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
24. Address.line.extension:houseNumber
Slice Name | houseNumber
Definition | The number of a building, house or lot alongside the street. Also known as "primary street number". This does not number the street but rather the building.
Short | houseNumber
Control | 0..*
Type | Extension(ADXP House Number) (Extension Type: string)
Is Modifier | false
Obligations |
Obligations | Actor
SHALL:able-to-populate | Creator_L2
SHALL:display | Consumer_L2
SHALL:able-to-populate | Creator_L3
SHALL:display | Consumer_L2
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
26. Address.line.extension:postBox
Slice Name | postBox
Definition | A numbered box located in a post station.
Short | postBox
Control | 0..*
Type | Extension(ADXP Post Box) (Extension Type: string)
Is Modifier | false
Obligations |
Obligations | Actor
SHALL:able-to-populate | Creator_L2
SHALL:display | Consumer_L2
SHALL:able-to-populate | Creator_L3
SHALL:display | Consumer_L2
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
28. Address.line.value
Definition | The actual value
Short | Primitive value for string
Control | 0..1
Type | string
Is Modifier | false
Obligations |
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
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
Max Length: | 1048576
30. Address.city
Definition | The name of the city, town, suburb, village or other community or delivery center.
Short | Name of city, town etc.
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Obligations |
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
Summary | true
Alternate Names | Municpality
Example | General: Erewhon
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
32. Address.district
Definition | The name of the administrative area (county).
Short | District name (aka county)
Comments | District is sometimes known as county, but in some regions 'county' is used in place of city (municipality), so county name should be conveyed in city instead.
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Alternate Names | County
Example | General: Madison
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
34. Address.state
Definition | Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (e.g. US 2 letter state codes).
Short | Sub-unit of country (abbreviations ok)
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Alternate Names | Province, Territory
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
36. Address.postalCode
Definition | A postal code designating a region defined by the postal service.
Short | Postal code for area
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Obligations |
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
Summary | true
Alternate Names | Zip
Example | General: 9132
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
38. Address.country
Definition | Country - a nation as commonly understood or generally accepted.
Short | Country (e.g. can be ISO 3166 2 letter code)
Comments | ISO 3166 3 letter codes can be used in place of a human readable country name.
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Obligations |
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
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
40. Address.country.id
Definition | unique id for the element within a resource (for internal references)
Short | xml:id (or equivalent in JSON)
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
42. Address.country.extension
Definition | An Extension
Short | Extension
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `Address.country.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
44. Address.country.extension:countryCode
Slice Name | countryCode
Definition | Provides a coded expression for the content represented in a string.
Short | code for string
Control | 0..1
Type | Extension(SC Coding) (Extension Type: Coding)
Is Modifier | false
Obligations |
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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
46. Address.country.extension:countryCode.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1 This element is affected by the following invariants: ele-1
Type | id
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
48. Address.country.extension:countryCode.extension
Definition | An Extension
Short | Extension
Control | 0..0
Type | Extension
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `Address.country.extension.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
50. Address.country.extension:countryCode.url
Definition | Source of the definition for the extension code - a logical name or a URL.
Short | identifies the meaning of the extension
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
Control | 1..1
Type | uri
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
Fixed Value | `http://hl7.org/fhir/StructureDefinition/iso21090-SC-coding`
52. Address.country.extension:countryCode.value[x]
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Short | Value of extension
Control | 1..1 This element is affected by the following invariants: ext-1
Binding | The codes SHALL be taken from Iso3166-1-2 (required to `http://hl7.org/fhir/ValueSet/iso3166-1-2` )
Type | Coding
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
54. Address.country.value
Definition | The actual value
Short | Primitive value for string
Control | 0..1
Type | string
Is Modifier | false
Obligations |
Obligations | Actor
SHALL:able-to-populate | Creator_L1
SHALL:able-to-populate | Creator_L2
SHALL:able-to-populate | Creator_L3
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
Max Length: | 1048576
56. Address.period
Definition | Time period when address was/is in use.
Short | Time period when address was/is in use
Control | 0..1
Type | Period
Is Modifier | false
Summary | true
Requirements | Allows addresses to be placed in historical context.
Example | General: { "start" : "2010-03-23", "end" : "2010-07-01" }
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)