Address | | 0..* | Address | Element IdShort description Eine Adresse gemäß postalischer Konventionen Definition Eine Adresse gemäß postalischer Konventionen (im Gegensatz zu bspw. GPS-Koordinaten). Die Adresse kann sowohl zur Zustellung von Postsendungen oder zum Aufsuchen von Orten, die keine gültige Postadresse haben, verwendet werden.
Die verwendeten Extensions in diesem Profil bilden die Struktur der Adresse ab, wie sie im VSDM-Format der elektronischen Versichertenkarte verwendet wird.
Insbesondere bei ausländischen Adresse oder Adressen, die nicht durch Einlesen einer elektronischen Versichertenkarte erfasst wurden, sind abweichende Strukturen möglich. Die Verwendung der Extensions ist nicht verpflichtend.
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).
Data Type Address Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - add-1:Wenn die Extension 'Hausnummer' verwendet wird, muss auch Address.line gefüllt werden
line.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber').empty() or $this.hasValue()) - add-2:Wenn die Extension 'Strasse' verwendet wird, muss auch Address.line gefüllt werden
line.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName').empty() or $this.hasValue()) - add-3:Wenn die Extension 'Postfach' verwendet wird, muss auch Address.line gefüllt werden
line.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox').empty() or $this.hasValue()) - add-4:Eine Postfach-Adresse darf nicht vom Type "physical" oder "both" sein.
line.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox').empty() or $this.hasValue()) or type='postal' or type.empty() - add-5:Wenn die Extension 'Adresszusatz' verwendet wird, muss auch Address.line gefüllt werden
line.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator').empty() or $this.hasValue()) - add-6:Wenn die Extension 'Postfach' verwendet wird, dürfen die Extensions 'Strasse' und 'Hausnummer' nicht verwendet werden
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())) - add-7:Wenn die Extension 'Precinct' (Stadtteil) verwendet wird, dann muss diese Information auch als separates line-item abgebildet sein.
extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-precinct').empty() or line.where(extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-precinct').valueString=$this).exists()
Examples Beispiel für einfache Adresse{
"use": "home",
"type": "postal",
"line": [
"Musterweg 42"
],
"city": "Musterhausen",
"postalCode": "99999"
} Mappings- rim:n/a
- v2:XAD
- rim:AD
- servd:Address
|
extension | | 0..* | Extension | Element IdShort description Additional content defined by implementations Alternate names extensions, user content 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.
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.
Data Type Extension Sliced: Unordered, Open, by url(Value) Constraints- 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()
Mappings |
Stadtteil | | 0..1 | Extension(string) | Element IdAddress.extension:Stadtteil Short description Stadt- oder Ortsteil Alternate names extensions, user content Definition A subsection of a municipality.
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.
Data Type Extension(string) Extension URL http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-precinct Constraints- 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()
Mappings- rim:n/a
- rim:N/A
- rim:ADXP[partType=PRE]
|
use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element IdShort description home | work | temp | old | billing - purpose of this address Definition The purpose of this address.
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.
Data Type code Binding AddressUse (required) Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Examples Mappings- rim:n/a
- v2:XAD.7
- rim:unique(./use)
- servd:./AddressPurpose
|
type | Σ | 0..1 | codeBinding | Element IdShort description postal | physical | both Definition Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are 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).
Data Type code Binding AddressType (required) Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Examples Mappings- rim:n/a
- v2:XAD.18
- rim:unique(./use)
- vcard:address type parameter
- BDT:1202 (1=physical, 2=postal)
|
text | Σ | 0..1 | string | There are no (further) constraints on this element Element IdShort description Text representation of the address 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.
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.
Data Type string Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Examples General137 Nowhere Street, Erewhon 9132 Mappings- rim:n/a
- v2:XAD.1 + XAD.2 + XAD.3 + XAD.4 + XAD.5 + XAD.6
- rim:./formatted
- vcard:address label parameter
|
line | Σ | 0..3 | string | Element IdShort description Straßenname mit Hausnummer oder Postfach sowie weitere Angaben zur Zustellung Definition Diese Komponente kann Straßennamen, Hausnummer, Appartmentnummer, Postfach, c/o sowie weitere Zustellungshinweise enthalten. Die Informationen können in mehrere line-Komponenten aufgeteilt werden.
Bei Verwendung der Extensions, um Straße, Hausnnummer und Postleitzahl strukturiert zu übermitteln, müssen diese Informationen stets vollständig auch in der line-Komponente, die sie erweitern, enthalten sein, um es Systemen, die diese Extensions nicht verwenden zu ermöglichen, auf diese Informationen zugreifen zu können.
Comments Note that FHIR strings SHALL NOT exceed 1MB in size
Data Type string Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Examples General137 Nowhere Street
Beipiel für Adresszeile mit Extensions für Straße und HausnummerMusterweg 42 Mappings- rim:n/a
- v2:XAD.1 + XAD.2 (note: XAD.1 and XAD.2 have different meanings for a company address than for a person address)
- rim:AD.part[parttype = AL]
- vcard:street
- servd:./StreetAddress (newline delimitted)
- KVDT:3107 + 3109 + 3115 oder 3123
- BDT:3107 + 3109 + 3115 oder 3123
|
extension | | 0..* | Extension | Element IdShort description Additional content defined by implementations Alternate names extensions, user content 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.
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.
Data Type Extension Sliced: Unordered, Open, by url(Value) Constraints- 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()
Mappings |
Strasse | | 0..1 | Extension(string) | Element IdAddress.line.extension:Strasse Short description Strassenname (ohne Hausnummer) Alternate names extensions, user content Definition Strassenname (ohne Hausnummer)
Bei Angabe einer Strasse in dieser Extension muss diese auch in Address.line angegeben werden um die Interoperabilität mit Systemen zu gewährleisten, die diese Extension nicht verwenden.
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.
Data Type Extension(string) Extension URL http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName Constraints- 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()
Mappings- rim:n/a
- rim:N/A
- rim:ADXP[partType=STR]
- KVDT:3107
- BDT:3107
|
Hausnummer | | 0..1 | Extension(string) | Element IdAddress.line.extension:Hausnummer Short description Hausnummer Alternate names extensions, user content Definition Hausnummer, sowie Zusätze (Appartmentnummer, Etage...)
Bei Angabe einer Hausnummer in dieser Extension muss diese auch in Address.line angegeben werden um die Interoperabilität mit Systemen zu gewährleisten, die diese Extension nicht verwenden.
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.
Data Type Extension(string) Extension URL http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber Constraints- 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()
Mappings- rim:n/a
- rim:N/A
- rim:ADXP[partType=BNR]
- KVDT:3109
- BDT:3109
|
Adresszusatz | | 0..1 | Extension(string) | Element IdAddress.line.extension:Adresszusatz Short description Adresszusatz Alternate names extensions, user content Definition Zusätzliche Informationen, wie z.B. "3. Etage", "Appartment C"
Bei Angabe einer Zusatzinformation in dieser Extension muss diese auch in Address.line angegeben werden um die Interoperabilität mit Systemen zu gewährleisten, die diese Extension nicht verwenden.
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.
Data Type Extension(string) Extension URL http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator Constraints- 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()
Mappings- rim:n/a
- rim:N/A
- rim:ADXP[partType=ADL]
- KVDT:3115
- BDT:3115
|
Postfach | | 0..1 | Extension(string) | Element IdAddress.line.extension:Postfach Short description Postfach Alternate names extensions, user content Definition Postfach-Adresse.
Bei Angabe eines Postfaches in dieser Extension muss das Postfach auch in Address.line angegeben werden um die Interoperabilität mit Systemen zu gewährleisten, die diese Extension nicht verwenden.
Eine Postfach-Adresse darf nicht in Verbindung mit Address.type "physical" oder "both" verwendet werden.
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.
Data Type Extension(string) Extension URL http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox Constraints- 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()
Mappings- rim:n/a
- rim:N/A
- rim:ADXP[partType=POB]
- KVDT:3123
- BDT:3123
|
city | Σ | 0..1 | string | Element IdShort description Name of city, town etc. Alternate names Municpality Definition The name of the city, town, suburb, village or other community or delivery center.
Comments Note that FHIR strings SHALL NOT exceed 1MB in size
Data Type string Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Examples Mappings- rim:n/a
- v2:XAD.3
- rim:AD.part[parttype = CTY]
- vcard:locality
- servd:./Jurisdiction
- BDT:3113 oder 3122 (Postfach)
- KVDT:3113 oder 3122 (Postfach)
|
district | Σ | 0..0 | string | There are no (further) constraints on this element Element IdShort description District name (aka county) Alternate names County Definition The name of the administrative area (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.
Data Type string Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Examples Mappings- rim:n/a
- v2:XAD.9
- rim:AD.part[parttype = CNT | CPA]
|
state | Σ | 0..1 | stringBinding | Element IdShort description Bundesland Alternate names Province, Territory Definition Name (oder Kürzel) des Bundeslandes.
Comments Note that FHIR strings SHALL NOT exceed 1MB in size
Data Type string Binding ValueSetISO31662DE (preferred) Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim:n/a
- v2:XAD.4
- rim:AD.part[parttype = STA]
- vcard:region
- servd:./Region
|
postalCode | Σ | 0..1 | string | Element IdShort description Postleitzahl Alternate names Zip Definition Postleitzahl gemäß der im jeweiligen Land gültigen Konventionen
Comments Note that FHIR strings SHALL NOT exceed 1MB in size
Data Type string Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Examples Mappings- rim:n/a
- v2:XAD.5
- rim:AD.part[parttype = ZIP]
- vcard:code
- servd:./PostalIdentificationCode
- BDT:3112 oder 3121 (Postfach)
- KVDT:3112 oder 3121 (Postfach)
|
country | Σ | 0..1 | stringBinding | Element IdShort description Staat Definition Staat (vorzugsweise als 2-Stelliger ISO-Ländercode).
Es obliegt abgeleiteten Profilen, hier die Verwendung der ISO-Ländercodes verbindlich vorzuschreiben
Comments ISO 3166 3 letter codes can be used in place of a human readable country name.
Data Type string Binding Iso3166-1-2 (preferred) Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim:n/a
- v2:XAD.6
- rim:AD.part[parttype = CNT]
- vcard:country
- servd:./Country
- BDT:3114 oder 3124 (Postfach), abweichendes CodeSystem
- KVDT:3114 oder 3124 (Postfach), abweichendes CodeSystem
|
period | Σ | 0..1 | Period | There are no (further) constraints on this element Element IdShort description Time period when address was/is in use Definition Time period when address was/is in use.
Requirements Allows addresses to be placed in historical context.
Comments A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times").
Period is not used for a duration (a measure of elapsed time). See Duration.
Data Type Period Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - per-1:If present, start SHALL have a lower value than end
start.hasValue().not() or end.hasValue().not() or (start <= end)
Examples General{
"start": "2010-03-23",
"end": "2010-07-01"
} Mappings- rim:n/a
- v2:DR
- rim:IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
- v2:XAD.12 / XAD.13 + XAD.14
- rim:./usablePeriod[type="IVL<TS>"]
- servd:./StartDate and ./EndDate
|
start | Σ | 0..1 | dateTime | Element IdShort description Starting time with inclusive boundary Definition The start of the period. The boundary is inclusive.
Comments If the low element is missing, the meaning is that the low boundary is not known.
Data Type dateTime Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim:n/a
- v2:DR.1
- rim:./low
- BDT:8226
|
end | Σ | 0..1 | dateTime | Element IdShort description End time with inclusive boundary, if not ongoing Definition The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.
Comments The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03.
Data Type dateTime Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim:n/a
- v2:DR.2
- rim:./high
- BDT:8227
|