This page is part of the HL7 Italia FHIR Implementation Guide (base) (v0.1.0: Public Comment 1 Ballot 1) based on FHIR R4. This is the current published version. For a full list of available versions, see the Directory of published versions
Definitions for the Address-it-base Profile.
1. Address | |
Definition | Esiste una varietà di formati di indirizzi postali definiti in tutto il mondo. Questo profilo (Address-it-base) estende il datatype base Address includendo una serie di informazioni rilevanti per esprimere gli indirizzi in Italia. Un Address-it-base è un indirizzo FHIR valido; i sistemi che non supportano le estensioni utilizzate saranno in grado comunque di eseguire il rendering e lavorare con un Address-it-base. Un indirizzo Address-it-base rende alcune parti di indirizzo comunicabili separatamente. Queste parti sono necessarie in alcuni scenari d'uso italiani, ma potrebbero non avere valore per i sistemi internazionali quando le informazioni vengono inviate all'estero. |
Control | 0..* This element is affected by the following invariants: ele-1 |
Alternate Names | Indirizzo |
Comments | Nota: address è per indirizzi postali, non per la localizzazione fisica. |
Example | Completo:<valueAddress xmlns="http://hl7.org/fhir"> <line value="Via dei Ciliegi 15"/> <city value="Artimino"/> <state value="PO"/> <postalCode value="59015"/> <country value="IT"/> </valueAddress> |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) it-address-official: Se Address rappresenta la residenza allora city e line devono essere inclusi (: extension.where(url = 'http://hl7.org/fhir/StructureDefinition/address-official').valueBoolean.where(true).empty() or ( line.exists() and city.exists() )) |
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. |
Control | 0..1 |
Type | string |
3. 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. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
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. |
Invariants | Defined on this element 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 are unordered and Open, and can be differentiated using the following discriminators:
|
4. Address.extension:residenza | |
SliceName | residenza |
Definition | Indica se questo indirizzo è quello di residenza, come indirizzo 'ufficialmente registrato' address. |
Control | 0..1 |
Type | Extension(OfficialAddress) (Extension Type: Choice of: boolean, CodeableConcept) |
Invariants | Defined on this element 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()) |
5. Address.extension:certificazioneIndirizzo | |
SliceName | certificazioneIndirizzo |
Definition | Indica che i dati di questo indirizzo sono stati certificati da una specifica entità |
Control | 0..* |
Type | Extension(ExtRecordCertification) (Extension Type: Choice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta) |
Invariants | Defined on this element 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 | The purpose of this address. |
Control | 0..1 |
Binding | The use of an address. The codes SHALL be taken from AddressUse |
Type | code |
Is Modifier | true |
Requirements | Allows an appropriate address to be chosen from a list of many. |
Comments | Applications can assume that an address is current unless it explicitly says that it is temporary or old. |
Example | General:home |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
7. 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. |
Control | 0..1 |
Binding | The type of an address (physical / postal). The codes SHALL be taken from AddressType |
Type | code |
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). |
Example | General:both |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
8. 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. |
Control | 0..1 |
Type | string |
Requirements | A renderable, unencoded form. |
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. |
Example | General:137 Nowhere Street, Erewhon 9132 |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
9. 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. |
Control | 0..* |
Type | string |
Example | General:137 Nowhere Street ex-1:Via Corta 1, interno 2 |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
10. Address.line.id | |
Definition | unique id for the element within a resource (for internal references) |
Control | 0..1 |
Type | string |
11. Address.line.extension | |
Definition | An Extension |
Control | 0..* |
Type | Extension |
Invariants | Defined on this element 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 are unordered and Open, and can be differentiated using the following discriminators:
|
12. Address.line.extension:odonimo | |
SliceName | odonimo |
Definition | streetName. |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | Extension(ADXP-streetName) (Extension Type: string) |
Requirements | Nome della Strada |
Alternate Names | Toponimo Stradale |
Example | ex-1:Via Corta |
Invariants | Defined on this element 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()) |
13. Address.line.extension:denominazioneUrbanisticaGenerica | |
SliceName | denominazioneUrbanisticaGenerica |
Definition | The designation given to the street. (e.g. Street, Avenue, Crescent, etc.). |
Control | 0..* This element is affected by the following invariants: ele-1 |
Type | Extension(ADXP-streetNameType) (Extension Type: string) |
Example | ex-1:Via |
Invariants | Defined on this element 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:dugCode | |
SliceName | dugCode |
Definition | An Extension |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | Extension(ExtDug) (Extension Type: CodeableConcept) |
Alternate Names | specie |
Example | ex-1:<valueCodeableConcept xmlns="http://hl7.org/fhir"> <coding> <system value="http://registry.geodati.gov.it/dug"/> <code value="67"/> <display value="via"/> </coding> </valueCodeableConcept> |
Invariants | Defined on this element 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()) |
15. Address.line.extension:denominazioneUrbanisticaUfficiale | |
SliceName | denominazioneUrbanisticaUfficiale |
Definition | The base name of a roadway or artery recognized by a municipality (excluding street type and direction). |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | Extension(ADXP-streetNameBase) (Extension Type: string) |
Alternate Names | denominazione |
Example | ex-1:Corta |
Invariants | Defined on this element 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.extension:houseNumber | |
SliceName | 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. |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | Extension(ADXP-houseNumber) (Extension Type: string) |
Requirements | Numero Civico |
Example | ex-1:1 |
Invariants | Defined on this element 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()) |
17. Address.line.value | |
Definition | The actual value |
Control | 0..1 |
Type | string |
Max Length | 1048576 |
18. Address.city | |
Definition | The name of the city, town, village or other community or delivery center. |
Control | 0..1 |
Type | string |
Alternate Names | Municpality, Comune |
Example | General:Erewhon General:Bagno a Ripoli |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
19. Address.city.id | |
Definition | unique id for the element within a resource (for internal references) |
Control | 0..1 |
Type | string |
20. Address.city.extension | |
Definition | An Extension |
Control | 0..* |
Type | Extension |
Invariants | Defined on this element 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.city.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
21. Address.city.extension:codiceComune | |
SliceName | codiceComune |
Definition | Provides a coded expression for the content represented in a string. |
Control | 0..* This element is affected by the following invariants: ele-1 |
Type | Extension(SC-coding) (Extension Type: Coding) |
Invariants | Defined on this element 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()) |
22. Address.city.value | |
Definition | The actual value |
Control | 0..1 |
Type | string |
Max Length | 1048576 |
23. Address.district | |
Definition | Nome dell'area amministrativa (county). Per gli indirizzi italiani è usato per indicare la Provincia |
Control | 0..1 |
Type | string |
Alternate Names | County, Provincia |
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. |
Example | General:Madison General:Campobasso |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
24. Address.district.id | |
Definition | unique id for the element within a resource (for internal references) |
Control | 0..1 |
Type | string |
25. Address.district.extension | |
Definition | An Extension |
Control | 0..* |
Type | Extension |
Invariants | Defined on this element 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.district.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
26. Address.district.extension:codiceProvincia | |
SliceName | codiceProvincia |
Definition | Provides a coded expression for the content represented in a string. |
Control | 0..* This element is affected by the following invariants: ele-1 |
Type | Extension(SC-coding) (Extension Type: Coding) |
Invariants | Defined on this element 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()) |
27. Address.district.value | |
Definition | The actual value |
Control | 0..1 |
Type | string |
Max Length | 1048576 |
28. Address.state | |
Definition | Sotto-unità dello stato con limitata sovranità in uno stato oragnizzato federalmente. Nel contesto italiano indica la "Regione" |
Control | 0..1 |
Type | string |
Alternate Names | Province, Territory, Regione |
Example | Regione:Lazio |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
29. Address.state.id | |
Definition | unique id for the element within a resource (for internal references) |
Control | 0..1 |
Type | string |
30. Address.state.extension | |
Definition | An Extension |
Control | 0..* |
Type | Extension |
Invariants | Defined on this element 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.state.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
31. Address.state.extension:codiceRegione | |
SliceName | codiceRegione |
Definition | Provides a coded expression for the content represented in a string. |
Control | 0..* This element is affected by the following invariants: ele-1 |
Type | Extension(SC-coding) (Extension Type: Coding) |
Invariants | Defined on this element 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()) |
32. Address.state.value | |
Definition | The actual value |
Control | 0..1 |
Type | string |
Max Length | 1048576 |
33. Address.postalCode | |
Definition | A postal code designating a region defined by the postal service. |
Control | 0..1 This element is affected by the following invariants: it-postal-code-pattern |
Type | string |
Alternate Names | Zip, CAP, postcode |
Comments | I codici postali italiani hanno un pattern '[1,9]\d{4}'. |
Example | General:9132 General:50125 |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) it-postal-code-pattern: I codici postali italiani hanno un pattern 'nnnnn' (n intero) (: (country in 'it' | 'ita' | 'italia' | 'italy').not() or matches('^[1-9]\\d{4}$')) |
34. Address.country | |
Definition | Country - a nation as commonly understood or generally accepted. |
Control | 0..1 |
Type | string |
Comments | ISO 3166 3 letter codes can be used in place of a human readable country name. |
Example | Nome Stato:Italia |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
35. Address.country.id | |
Definition | unique id for the element within a resource (for internal references) |
Control | 0..1 |
Type | string |
36. Address.country.extension | |
Definition | An Extension |
Control | 0..* |
Type | Extension |
Invariants | Defined on this element 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 are unordered and Open, and can be differentiated using the following discriminators:
|
37. Address.country.extension:codiceStato | |
SliceName | codiceStato |
Definition | Provides a coded expression for the content represented in a string. |
Control | 0..* This element is affected by the following invariants: ele-1 |
Type | Extension(SC-coding) (Extension Type: Coding) |
Invariants | Defined on this element 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()) |
38. Address.country.value | |
Definition | The actual value |
Control | 0..1 |
Type | string |
Max Length | 1048576 |
39. Address.period | |
Definition | Time period when address was/is in use. |
Control | 0..1 |
Type | Period |
Requirements | Allows addresses to be placed in historical context. |
Example | General:<valuePeriod xmlns="http://hl7.org/fhir"> <start value="2010-03-23"/> <end value="2010-07-01"/> </valuePeriod> |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |