Leitfaden Basis DE

Adresse

Canonical URL: http://fhir.de/StructureDefinition/address-de-basis/0.2

Address		0..*	Address	Short 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 for postal addresses, not physical locations. Data Type Address Constraints ele-1:All FHIR elements must have a @value or children `hasValue() \| (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()))` 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
use	Σ ?!	0..1	codeBinding	Short description home \| work \| temp \| old - purpose of this address Definition The purpose of this address. Requirements Allows an appropriate address to be chosen from a list of many. Comments This is labeled as "Is Modifier" because applications should not mistake a temporary or old address etc.for a current/permanent one. Applications can assume that an address is current unless it explicitly says that it is temporary or old. Data Type code Binding address-use (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() \| (children().count() > id.count())` Examples General home Mappings rim:n/a v2:XAD.7 rim:unique(./use) servd:./AddressPurpose
type	Σ	0..1	codeBinding	Short 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 Note that FHIR strings may not exceed 1MB in size Data Type code Binding address-type (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() \| (children().count() > id.count())` Examples General both Mappings rim:n/a v2:XAD.18 rim:unique(./use) vcard:address type parameter BDT:1202 (1=physical, 2=postal)
text	Σ	0..1	string	Short description Text representation of the address Definition A full text representation of the address. Requirements A renderable, unencoded form. Comments Can provide both a text representation and parts. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() \| (children().count() > id.count())` Examples General 137 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..*	string	Short 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. Requirements home \| work \| temp \| old - purpose of this address. Comments Note that FHIR strings may not exceed 1MB in size Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() \| (children().count() > id.count())` Examples General 137 Nowhere Street Beipiel für Adresszeile mit Extensions für Straße und Hausnummer Musterweg 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	Short 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. In order 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 is allowed to 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() \| (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
Strasse		0..1	Extension	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 Extension URL http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName Constraints ele-1:All FHIR elements must have a @value or children `hasValue() \| (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
url		1..1	uriFixed Value	Short description identifies the meaning of the extension Definition Source of the definition for the extension code - a logical name or a URL. 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. Data Type uri Constraints ele-1:All FHIR elements must have a @value or children `hasValue() \| (children().count() > id.count())` Fixed Value http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName Mappings rim:n/a rim:N/A
valueString		0..1	string	Short description Value of extension Definition Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). Comments A stream of bytes, base64 encoded Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() \| (children().count() > id.count())` Mappings rim:n/a rim:N/A
Hausnummer		0..1	Extension	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 Extension URL http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber Constraints ele-1:All FHIR elements must have a @value or children `hasValue() \| (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
url		1..1	uriFixed Value	Short description identifies the meaning of the extension Definition Source of the definition for the extension code - a logical name or a URL. 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. Data Type uri Constraints ele-1:All FHIR elements must have a @value or children `hasValue() \| (children().count() > id.count())` Fixed Value http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber Mappings rim:n/a rim:N/A
valueString		0..1	string	Short description Value of extension Definition Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). Comments A stream of bytes, base64 encoded Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() \| (children().count() > id.count())` Mappings rim:n/a rim:N/A
Adresszusatz		0..1	Extension	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 Extension URL http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator Constraints ele-1:All FHIR elements must have a @value or children `hasValue() \| (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
url		1..1	uriFixed Value	Short description identifies the meaning of the extension Definition Source of the definition for the extension code - a logical name or a URL. 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. Data Type uri Constraints ele-1:All FHIR elements must have a @value or children `hasValue() \| (children().count() > id.count())` Fixed Value http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator Mappings rim:n/a rim:N/A
valueString		0..1	string	Short description Value of extension Definition Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). Comments A stream of bytes, base64 encoded Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() \| (children().count() > id.count())` Mappings rim:n/a rim:N/A
Postfach		0..1	Extension	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 Extension URL http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox Constraints ele-1:All FHIR elements must have a @value or children `hasValue() \| (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
url		1..1	uriFixed Value	Short description identifies the meaning of the extension Definition Source of the definition for the extension code - a logical name or a URL. 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. Data Type uri Constraints ele-1:All FHIR elements must have a @value or children `hasValue() \| (children().count() > id.count())` Fixed Value http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox Mappings rim:n/a rim:N/A
valueString		0..1	string	Short description Value of extension Definition Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). Comments A stream of bytes, base64 encoded Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() \| (children().count() > id.count())` Mappings rim:n/a rim:N/A
city	Σ	0..1	string	Short description Name of city, town etc. Alternate names Municpality Definition The name of the city, town, village or other community or delivery center. Comments Note that FHIR strings may not exceed 1MB in size Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() \| (children().count() > id.count())` Examples General Erewhon 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	Short 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() \| (children().count() > id.count())` Examples General Madison Mappings rim:n/a v2:XAD.9 rim:AD.part[parttype = CNT \| CPA]
state	Σ	0..1	stringBinding	Short description Bundesland Alternate names Province, Territory Definition Name (oder Kürzel) des Bundeslandes. Comments Note that FHIR strings may not exceed 1MB in size Data Type string Binding iso-bundeslaender (preferred) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() \| (children().count() > id.count())` Mappings rim:n/a v2:XAD.4 rim:AD.part[parttype = STA] vcard:region servd:./Region
postalCode	Σ	0..1	string	Short description Postleitzahl Alternate names Zip Definition Postleitzahl gemäß der im jeweiligen Land gültigen Konventionen Comments Note that FHIR strings may not exceed 1MB in size Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() \| (children().count() > id.count())` Examples General 9132 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	Short 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 full country name. Data Type string Binding jurisdiction (preferred) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() \| (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	Short 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 This is not a duration - that's a measure of time (a separate type), but a duration that occurs at a fixed value of time. 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"). If duration is required, specify the type as Interval\|Duration. Data Type Period Constraints ele-1:All FHIR elements must have a @value or children `hasValue() \| (children().count() > id.count())` per-1:If present, start SHALL have a lower value than end `start.empty() or end.empty() 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	Short 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() \| (children().count() > id.count())` Mappings rim:n/a v2:DR.1 rim:./low BDT:8226
end	Σ	0..1	dateTime	Short 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 that the period is ongoing. 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 a end value of 2012-02-03. Data Type dateTime Constraints ele-1:All FHIR elements must have a @value or children `hasValue() \| (children().count() > id.count())` Mappings rim:n/a v2:DR.2 rim:./high BDT:8227

Beispiele

XML-Format

Hier in der Verwendung als Patienten-Adresse:

<Patient>
    <meta>
        <profile value="http://fhir.de/StructureDefinition/patient-de-basis/0.2" />
    </meta>
    <name>
        <use value="official" />
        <text value="Martina Mustermann" />
        <family value="Mustermann" />
        <given value="Martina" />
    </name>
    <address>
        <use value="home" />
        <type value="physical" />
        <text value="Musterweg 42, Hinterhof 2. Etage, 10787 Berlin, Deutschland" />
        <line value="Musterweg 42">
            <extension url="http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName">
                <valueString value="Musterweg" />
            </extension>
            <extension url="http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber">
                <valueString value="42" />
            </extension>
        </line>
        <line value="Hinterhof 2. Etage">
            <extension url="http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator">
                <valueString value="Hinterhof 2. Etage" />
            </extension>
        </line>
        <city value="Berlin" />
        <state value="DE-BE" />
        <postalCode value="10787" />
        <country value="DE" />
    </address>
    <address>
        <use value="home" />
        <type value="postal" />
        <text value="Postfach 74656, 76297 Spöck, Deutschland" />
        <line value="Postfach 74656">
            <extension url="http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox">
                <valueString value="Postfach 74656" />
            </extension>
        </line>
        <city value="Spöck" />
        <state value="DE-BW" />
        <postalCode value="76297" />
        <country value="DE" />
    </address>
</Patient>

JSON-Format

Hier in der Verwendung als Patienten-Adresse:

{
    "resourceType":"Patient",
    "meta":{
        "profile": [
            "http://fhir.de/StructureDefinition/patient-de-basis/0.2"
        ]
    },
    "name": [
        {
            "use":"official",
            "text":"Martina Mustermann",
            "family":"Mustermann",
            "given": [
                "Martina"
            ]
        }
    ],
    "address": [
        {
            "use":"home",
            "type":"physical",
            "text":"Musterweg 42, Hinterhof 2. Etage, 10787 Berlin, Deutschland",
            "line": [
                "Musterweg 42",
                "Hinterhof 2. Etage"
            ],
            "_line": [
                {
                    "extension": [
                        {
                            "url":"http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName",
                            "valueString":"Musterweg"
                        },
                        {
                            "url":"http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber",
                            "valueString":"42"
                        }
                    ]
                },
                {
                    "extension": [
                        {
                            "url":"http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator",
                            "valueString":"Hinterhof 2. Etage"
                        }
                    ]
                }
            ],
            "city":"Berlin",
            "state":"DE-BE",
            "postalCode":"10787",
            "country":"DE"
        },
        {
            "use":"home",
            "type":"postal",
            "text":"Postfach 74656, 76297 Spöck, Deutschland",
            "line": [
                "Postfach 74656"
            ],
            "_line": [
                {
                    "extension": [
                        {
                            "url":"http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox",
                            "valueString":"Postfach 74656"
                        }
                    ]
                }
            ],
            "city":"Spöck",
            "state":"DE-BW",
            "postalCode":"76297",
            "country":"DE"
        }
    ]
}