Leitfaden Basis DE (R4)

PatientIn (Patient)

Im Gegensatz zu den Deutschen Basisprofile für die FHIR Version STU3 gibt es in der vorliegenden Version der Deutschen Basisprofile für FHIR R4 kein Patient-Profil mehr. Die Gründe dafür sind unter dem Abschnitt FAQ erläutert.

Identifikatoren

Als Identifier für Patienten (FHIR-Element: Patient.identifier) sind verschiedene Ausprägungen möglich, z.B. Krankenversichertennummer, eine einrichtungsinterne ID ("PID"), Sozialversicherungsnummer, Führerscheinnummer, Teilnehmerkennungen an speziellen Forschungs- oder Versorgungsprogrammen usw.

Welche Identifier jeweils geeignet, verfügbar und zulässig sind, muss abhängig vom UseCase entschieden werden.

Folgende Identifier-Profile werden durch die Deutschen Basisprofile spezifiziert, sodass diese Use-Case und Profil-übergreifend einheitlich verwendet werden können. Siehe Übersicht Identifier für Patient.

Name

Im Datentyp HumanName sind Felder für die üblicherweise verwendeten Namensbestandteile wie Vorname, Nachname und Präfix vorgesehen. Die Auswahl der Elemente folgt der Regel, dass im FHIR-Kern-Standard nur die Dinge spezifiziert werden, die in 80% der Fälle tatsächlich gebraucht werden (Siehe FHIR and Architectural Principles).

Die Datenstruktur, die auf den Deutschen gesetzlichen Krankenversichertenkarten ausgelesen werden kann, sieht jedoch zusätzliche Felder vor (z.B. Namenszusatz, Vorsatzwort) bzw. schränkt die Nutzung von Feldern ein (z.B. akademischer Titel).

Daher wurde das deutsche Profil für HumanName mit Extensions versehen, die es erlauben, die Granularität der Daten von den Versichertenkarten in FHIR 1:1 abzubilden.

Alle Extensions sind im Abschnitt Extensions für Patient dokumentiert.

Häufig ist dies jedoch nicht erforderlich, da die Standard-Felder family, given, prefix den meisten Systemen ausreichend Information bieten. Die Implementierung der Extensions ist daher nicht zwingend erforderlich. Es ist jedoch stets zu beachten, dass alle Informationen, die in den Extensions abgebildet werden, stets auch in den Standard-Feldern enthalten sein müssen, so dass Systeme, die die Extensions ignorieren, zwar Granularität, nicht jedoch Information verlieren.

Basis-Profil für Datentyp HumanName

Name: HumannameDeBasis (Simplifier Projekt Link)

Canonical: http://fhir.de/StructureDefinition/humanname-de-basis

HumanName	I		HumanName	Element Id HumanName Short description Personenname Definition Personenname mit in Deutschland üblichen Erweiterungen Comments Names may be changed, or repudiated, or people may have different names in different contexts. Names may be divided into parts of different type that have variable significance depending on context, though the division into parts does not always matter. With personal names, the different parts may or may not be imbued with some implicit meaning; various cultures associate different importance with the name parts and the degree to which systems must care about name parts around the world varies widely. Data Type HumanName Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` hum-1:Wenn die Extension 'namenszusatz' verwendet wird, dann muss der vollständige Name im Attribut 'family' angegeben werden `family.extension('http://fhir.de/StructureDefinition/humanname-namenszusatz').empty() or family.hasValue()` hum-2:Wenn die Extension 'nachname' verwendet wird, dann muss der vollständige Name im Attribut 'family' angegeben werden `family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-name').empty() or family.hasValue()` hum-3:Wenn die Extension 'vorsatzwort' verwendet wird, dann muss der vollständige Name im Attribut 'family' angegeben werden `family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-prefix').empty() or family.hasValue()` hum-4:Wenn die Extension 'prefix-qualifier' verwendet wird, dann muss ein Namenspräfix im Attribut 'prefix' angegeben werden `prefix.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier').empty() or $this.hasValue())` Mappings rim:n/a v2:XPN rim:EN (actually, PN) servd:ProviderName
use	Σ ?!	0..1	codeBinding	Element Id HumanName.use Short description usual \| official \| temp \| nickname \| anonymous \| old \| maiden Definition Identifies the purpose for this name. Requirements Allows the appropriate name for a particular context of use to be selected from among a set of names. Comments Applications can assume that a name is current unless it explicitly says that it is temporary or old. Data Type code Binding The use of a human name. NameUse (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:XPN.7, but often indicated by which field contains the name rim:unique(./use) servd:./NamePurpose BDT:1211 (in BDT als Freitext!)
text	Σ	0..1	string	There are no (further) constraints on this element Element Id HumanName.text Short description Text representation of the full name Definition Specifies the entire name as it should be displayed e.g. on an application UI. 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 a name 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())` Mappings rim:n/a v2:implied by XPN.11 rim:./formatted
family	Σ	0..1	string	Element Id HumanName.family Short description Familienname Alternate names surname Definition Der vollständige Familienname, einschließlich aller Vorsatz- und Zusatzwörter, mit Leerzeichen getrennt. Comments Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures). Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:XPN.1/FN.1 rim:./part[partType = FAM] servd:./FamilyName BDT:3120 + 3100 + 3101 KVDT:3100 + 3120 + 3101
extension	I	0..*	Extension	Element Id HumanName.family.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. 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 rim:n/a rim:N/A
namenszusatz	I	0..1	Extension(string)	Element Id HumanName.family.extension:namenszusatz Short description Namenszusatz gemäß VSDM (Versichertenstammdatenmanagement, "eGK") Alternate names extensions, user content Definition Namenszusatz als Bestandteil das Nachnamens, wie in VSDM (Versichertenstammdatenmanagement, "eGK") definiert. Beispiele: Gräfin, Prinz oder Fürst Comments Die Extension wurde erstellt aufgrund der Anforderung, die auf der eGK vorhandenen Patientenstammdaten in FHIR abbilden zu können. Auf der eGK werden die Namensbestandteile "Namenszusatz" und "Vorsatzwort" getrennt vom Nachnamen gespeichert. Anhand der Liste der zulässigen Namenszusätze ist deutlich erkennbar, dass es sich hierbei sinngemäß um Adelstitel handelt. Das Vorsatzwort kann durch die Core-Extension own-prefix (Canonical: http://hl7.org/fhir/StructureDefinition/humanname-own-prefix) abgebildet werden, für den Namenszusatz ergibt sich jedoch die Notwendikeit einer nationalen Extension, da in andern Ländern Adelstitel entweder gar nicht oder als reguläres Namenspräfix erfasst werden. Data Type Extension(string) Extension URL http://fhir.de/StructureDefinition/humanname-namenszusatz 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 KVDT:3100 BDT:3100
nachname	I	0..1	Extension(string)	Element Id HumanName.family.extension:nachname Short description Nachname ohne Vor- und Zusätze Alternate names extensions, user content Definition Nachname ohne Vor- und Zusätze. Dient z.B. der alphabetischen Einordnung des Namens. Comments If the person's surname has legally changed to become (or incorporate) the surname of the person's partner or spouse, this is the person's surname immediately prior to such change. Often this is the person's "maiden name". Data Type Extension(string) Extension URL http://hl7.org/fhir/StructureDefinition/humanname-own-name 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 v2:FN.3 rim:ENXP where Qualifiers = (BR) KVDT:3101 BDT:3101
vorsatzwort	I	0..1	Extension(string)	Element Id HumanName.family.extension:vorsatzwort Short description Vorsatzwort Alternate names extensions, user content Definition Vorsatzwort wie z.B.: von, van, zu Vgl. auch VSDM-Spezifikation der Gematik (Versichertenstammdatenmanagement, "eGK") Comments An example of a voorvoegsel is the "van" in "Ludwig van Beethoven". Since the voorvoegsel doesn't sort completely alphabetically, it is reasonable to specify it as a separate sub-component. Data Type Extension(string) Extension URL http://hl7.org/fhir/StructureDefinition/humanname-own-prefix 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 v2:FN.2 rim:ENXP where Qualifiers = (VV, R) BDT:3120 KVDT:3120
given	Σ	0..*	string	Element Id HumanName.given Short description Vorname Alternate names first name, middle name Definition Vorname der Person Comments If only initials are recorded, they may be used in place of the full name parts. Initials may be separated into multiple given names but often aren't due to paractical limitations. This element is not called "first name" since given names do not always come first. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:XPN.2 + XPN.3 rim:./part[partType = GIV] servd:./GivenNames KVDT:3102 BDT:3102
prefix	Σ	0..*	string	Element Id HumanName.prefix Short description Namensteile vor dem Vornamen Definition Namensteile vor dem Vornamen, z.B. akademischer Titel. 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())` Mappings rim:n/a v2:XPN.5 rim:./part[partType = PFX] servd:./TitleCode KVDT:3104 BDT:3104
extension	I	0..*	Extension	Element Id HumanName.prefix.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. 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 rim:n/a rim:N/A
prefix-qualifier	I	0..*	Extension(code)	Element Id HumanName.prefix.extension:prefix-qualifier Short description LS \| AC \| NB \| PR \| HON \| BR \| AD \| SP \| MID \| CL \| IN \| VV Alternate names extensions, user content Definition Spezialisierung der Art des Präfixes, z.B. "AC" für Akademische Titel Comments Used to indicate additional information about the name part and how it should be used. Data Type Extension(code) Extension URL http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier 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:ENXP.qualifier
suffix	Σ	0..*	string	Element Id HumanName.suffix Short description Namensteile nach dem Nachnamen Definition Namensteile nach dem Nachnamen 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())` Mappings rim:n/a v2:XPN/4 rim:./part[partType = SFX]
period	Σ I	0..1	Period	There are no (further) constraints on this element Element Id HumanName.period Short description Time period when name was/is in use Definition Indicates the period of time when this name was valid for the named person. Requirements Allows names 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)` Mappings rim:n/a v2:DR rim:IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"] v2:XPN.13 + XPN.14 rim:./usablePeriod[type="IVL<TS>"] servd:./StartDate and ./EndDate

Die Constraints hum-1 bis hum-4 zu beachten:

key	severity	human	expression
hum-1	error	Wenn die Extension 'namenszusatz' verwendet wird, dann muss der vollständige Name im Attribut 'family' angegeben werden	family.extension('http://fhir.de/StructureDefinition/humanname-namenszusatz').empty() or family.hasValue()
hum-2	error	Wenn die Extension 'nachname' verwendet wird, dann muss der vollständige Name im Attribut 'family' angegeben werden	family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-name').empty() or family.hasValue()
hum-3	error	Wenn die Extension 'vorsatzwort' verwendet wird, dann muss der vollständige Name im Attribut 'family' angegeben werden	family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-prefix').empty() or family.hasValue()
hum-4	error	Wenn die Extension 'prefix-qualifier' verwendet wird, dann muss ein Namenspräfix im Attribut 'prefix' angegeben werden	prefix.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier').empty() or $this.hasValue())

Beispiel: einfacher Name ohne Extensions

    <name>
        <family value="Mustermann" />
        <given value="Max" />
    </name>

Beispiel: Geburtsname

    <name>
        <use value="maiden" />
        <family value="Testinghausen" />
    </name>

Beispiel: Name mit Vorsatzwort

    <name>
        <use value="official" />
        <text value="Ludwig van Beethoven" />
        <family value="van Beethoven">
            <extension url="http://hl7.org/fhir/StructureDefinition/humanname-own-prefix">
                <valueString value="van" />
            </extension>
            <extension url="http://hl7.org/fhir/StructureDefinition/humanname-own-name">
                <valueString value="Beethoven" />
            </extension>
        </family>
        <given value="Ludwig" />
    </name>

Beispiel: Name mit Vorsatzwort, Namenszusatz und akademischem Titel

    <name>
        <use value="official" />
        <text value="Prof. Dr. med. Dr. rer. nat. Fritz Julius Karl Freiherr von und zu Rathenburg vor der Isar, MdB" />
        <family value="Freiherr von und zu Rathenburg vor der Isar">
            <extension url="http://fhir.de/StructureDefinition/humanname-namenszusatz">
                <valueString value="Freiherr" />
            </extension>
            <extension url="http://hl7.org/fhir/StructureDefinition/humanname-own-prefix">
                <valueString value="von und zu" />
            </extension>
            <extension url="http://hl7.org/fhir/StructureDefinition/humanname-own-name">
                <valueString value="Rathenburg vor der Isar" />
            </extension>
        </family>
        <given value="Fritz" />
        <given value="Julius" />
        <given value="Karl" />
        <prefix value="Prof. Dr. med. Dr. rer. nat.">
            <extension url="http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier">
                <valueCode value="AC" />
            </extension>
        </prefix>
        <suffix value="MdB" />
    </name>

Anrede

Der vollständige Name inkl. Anrede sollte, falls für den Use-Case erforderlich, in HumanName.text in korrekter Reihenfolge dokumentiert werden (z.B. "Frau Dr. Martha Musterfrau"). Andernfalls kann die Anrede teilweise aus dem Administrativen Geschlecht der Person (Patien.gender) abgeleitet werden. Hier sind jedoch Extensions zur Abbildung des Geschlechts 'Divers' und einer abweichenden Gender Identity (Siehe Geschlecht) in Betracht zu ziehen um nicht fälschlicherweise eine falsche Anrede zu verwenden.

Das Element HumanName.prefix wird nur für akademische Titel und andere Namensbestandteile verwendet und sollte nicht zur Abbildung der Anrede verwendet werden

Geschlecht

Beispiel: weiblich

<gender value="female"/>

Beispiel: männlich

<gender value="male"/>

Geschlechtskennzeichen "unbestimmt" und "divers"

Für die Geschlechtskennzeichen "unbestimmt" und "divers" ist der code "other" zu verwenden:

<gender value="other"/>

Falls ein administratives Geschlecht 'divers' abzubilden ist (z.B. da dieses Geschlecht auf offiziellen Ausweisen eingetragen ist) muss eine Differenzierung zwischen 'other' und 'divers' als positiver Geschlechtseintrag erfolgen. Hierfür ist die 'other-amtlich'-Extension zu verwenden. Siehe Extensions-Dokumentation für Extensions für Patient.

Beispiel: divers

<gender value="other">
    <extension url="http://fhir.de/StructureDefinition/gender-amtlich-de"/>
        <valueCoding>
            <system value="http://fhir.de/CodeSystem/gender-amtlich-de"/>
            <code value="D"/>
        </valueCoding>
    </extension>
</gender>

Folgende Constraints sind im Kontext der Gender-Amtlich-De Extension zu beachten:

key	severity	human	expression
gender-amtlich-1	error	Die amtliche Differenzierung der Geschlechtsangabe 'other' darf nur gefüllt sein, wenn das Geschlecht 'other' angegeben ist	%resource.where(gender='other').exists()

Zudem wird empfohlen bei der Einbindung der Extension in ein eigenes FHIR-Profil einen weiteren Constraint hinzuzufügen um zu überprüfen, dass die Extension konsequent verwendet wird:

gender.exists() and gender = 'other' implies gender.extension('http://fhir.de/StructureDefinition/gender-amtlich-de').exists()

Für Extensions zur Differenzierung von z.B. Gender Identity, Sex Assigned At Brith, siehe Patient Gender and Sex

Beispiel: unbestimmt

<gender value="other">
    <extension url="http://fhir.de/StructureDefinition/gender-amtlich-de"/>
        <valueCoding>
            <system value="http://fhir.de/CodeSystem/gender-amtlich-de"/>
            <code value="X"/>
        </valueCoding>
    </extension>
</gender>

Adresse

Nach DIN 5008 (Schreib- und Gestaltungsregeln für die Text- und Informationsverarbeitung) besteht eine postalische Anschrift aus folgende Bestandteilen:

Name
Zustell- oder Abholangabe
Postleitzahl
Ort
Land (Bei internationanlen Adressen)

Dies Address-bezogenen Bestandteilen der Anschrift lassen sich in FHIR wie folgt abbilden:

DIN 5008 Element	FHIR-Repräsentation
Name	Siehe Name oder Patient.contact.organization (z.B. bei der Anschrift eines Arbeitgebers)
Zustell- oder Abholangabe	Address.line
Postleitzahl	Address.postalCode
Ort	Address.city
Land	Address.country

Basisprofil für Adresse

Name: AddressDeBasis (Simplifier Projekt Link)

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

Address	I		Address	Element Id 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 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 all(line contains extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-precinct').value.ofType(string))` 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	I	0..*	Extension	Element Id Address.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. 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 rim:n/a rim:N/A
Stadtteil	I	0..1	Extension(string)	Element Id Address.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 Id Address.use Short 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 The use of an address. AddressUse (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Examples General home Mappings rim:n/a v2:XAD.7 rim:unique(./use) servd:./AddressPurpose
type	Σ	0..1	codeBinding	Element Id Address.type 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 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 The type of an address (physical / postal). AddressType (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (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	There are no (further) constraints on this element Element Id Address.text Short 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 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..3	string	Element Id Address.line 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. 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 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	I	0..*	Extension	Element Id Address.line.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. 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 rim:n/a rim:N/A
Strasse	I	0..1	Extension(string)	Element Id Address.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	I	0..1	Extension(string)	Element Id Address.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	I	0..1	Extension(string)	Element Id Address.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	I	0..1	Extension(string)	Element Id Address.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 Id Address.city Short 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 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	There are no (further) constraints on this element Element Id Address.district 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() or (children().count() > id.count())` Examples General Madison Mappings rim:n/a v2:XAD.9 rim:AD.part[parttype = CNT \| CPA]
state	Σ	0..1	stringBinding	Element Id Address.state Short 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 Id Address.postalCode Short 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 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	Element Id Address.country 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 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	Σ I	0..1	Period	There are no (further) constraints on this element Element Id Address.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 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	Σ I	0..1	dateTime	Element Id Address.period.start 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() or (children().count() > id.count())` Mappings rim:n/a v2:DR.1 rim:./low BDT:8226
end	Σ I	0..1	dateTime	Element Id Address.period.end 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 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

Die Constraints add-1 bis add-7 zu beachten:

key	severity	human	expression
add-1	error	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	error	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	error	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	warning	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	error	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	warning	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	warning	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 all(line contains extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-precinct').value.ofType(string))

Abbildung der Zustell- oder Abholangabe

Für Zustell- (z.B. Straße und Hausnummer) oder Abholangabe (z.B. Postfach mit Nummer) wird im FHIR-Standard bei der Adresse nicht zwischen Straße, Hausnummer, Postfach oder weiteren Zusätzen unterschieden. Sämtliche Angaben werden schlicht in ein oder mehrere line-Items geschrieben:

Abbildung einer Zustellangabe	FHIR-Repräsentation (inkl. Index der Zeile)
Zustellangabe (z.B. Straße und Hausnummer)	Address.line[0]
Gebäudeteil, Stockwerk, Wohnungsnummer	Address.line[0] (offiziell abgetrennt durch "//" von der Straße, Hausnummer)

Abbildung einer Zustellangabe ("c/o")	FHIR-Repräsentation (inkl. Index der Zeile)
Name des Wohnungsinhabers	Address.line[0]
Zustellangabe (z.B. Straße und Hausnummer)	Address.line[1]
Gebäudeteil, Stockwerk, Wohnungsnummer	Address.line[1] (offiziell abgetrennt durch "//" von der Straße, Hausnummer )

Abbildung einer Abholangabe (Postfach)	FHIR-Repräsentation (inkl. Index der Zeile)
Postfach	Address.line[0]

Abbildung einer Abholangabe (Packstation)	FHIR-Repräsentation (inkl. Index der Zeile)
Postnummer	Address.line[0]
Packstationsnummer	Address.line[1]

Alle Adresse können zusätzlich einen Ortsteil enthalten. Weitere Infos siehe Abschnitt Stadtteil/Ortsteil.

In machen Fällen kann die explizite Differenzierung der Adressbestandteile in eigene Elemente erforderlich sein, sei es nur, um einen von der eGK eingelesenen Datensatz, in dem eine solche Differenzierung stattfindet, exakt reproduzieren zu können. Für diesen Fall stehen diverse Extensions zur Verfügung.

Alle Extensions die innerhalb der Deutschen Basisprofile spezifiziert werden sind im Abschnitt Extensions für Patient dokumentiert.

Es ist jedoch zu beachten, dass Address.line auch bei Verwendung der Extensions stets gefüllt sein muss, da nicht davon ausgegangen werden kann, dass alle Systeme die Extensions interpretieren können!

Im Allgemeinen wird der Code "both" zur Codierung von Address.type empfohlen. Ein Postfach inkl. Postfach Extension für Address.line muss mit "postal" als Type codiert werden.

Beispiele für Adressen ohne Extensions

<address>
    <line value="221B Baker Street"/>
    <city value="London"/>
</address>

<address>
    <use value="home" />
    <type value="both" />
    <line value="Milchstrasse 42" />
    <city value="Spöck" />
    <postalCode value="76297" />
    <country value="DE" />
 </address>

Beispiel für Addresse mit Straße-/Hausnummer-Extension

<address>
    <line value="Musterstraße 1">
        <extension url="http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber">
            <valueString value="1" />
        </extension>
        <extension url="http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName">
            <valueString value="Musterstraße" />
        </extension>
    </line>
    <city value="Musterstadt" />
    <postalCode value="77777" />
    <country value="DE" />
</address>

Beispiel für Postfach-Adresse

<address>
    <type value="postal" />
    <line value="Postfach 670525">
        <extension url="http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox">
            <valueString value="Postfach 670525" />
        </extension>
    </line>
    <city value="Musterstadt" />
    <postalCode value="77777" />
    <country value="DE" />
</address>

Bei der Angabe einer Postfach-Adresse ist auf die Verwendung der entsprecheneden Angabe eines "type"-Elementes zu achten.

Stadtteil/Ortsteil

Nach § 21 KHEntgG muss beim Wohnort eines Patienten in Stadtstaaten zusätzlich in der Adresse der Stadtteil (oft auch "Ortsteil" genannt) angeben werden. Z.b. "Musterstraße 1a, 10409 Berlin, Kreuzberg". Es ist zu beachten, dass "Kreuzberg" hier ein eigenständiges Datenelement ist und nicht mit dem Wohnort (Address.city) vermischt werden sollte.

Der Ortsteil wird in FHIR als Address.line abgebildet. Zusätzlich kann die Extension iso21090-ADXP-precinct zur Differenzierung von anderen Adresskomponenten genutzt werden.

Beispiel:

<address>
  <extension url="http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-precinct">
      <valueString value="Kreuzberg"/>
  </extension>
  <line value="Erlanger Allee 112"/>
  <line value="Kreuzberg"/>
  <city value="Berlin"/>
</address>

Amtlicher Gemeindeschlüssel

Für Forschungsdatensätzen mit Bezug auf regionale Auswertungen kann zusätzlich zur PLZ der Amtliche Gemeindeschlüssel angegeben werden. Hierzu kann die Extension Extension-destatis-ags verwendet werden. Siehe Extensions für Patient.

Patient.maritalStatus

Beispiel unverheiratet:

<maritalStatus>
    <coding>
        <system value="http://terminology.hl7.org/CodeSystem/v3-MaritalStatus" />
        <code value="U" />
    </coding>
</maritalStatus>

Beispiel verheiratet/eingetragene Lebenspartnerschaft:

<maritalStatus>
    <coding>
        <system value="http://terminology.hl7.org/CodeSystem/v3-MaritalStatus" />
        <code value="M" />
    </coding>
</maritalStatus>

Hinweis zur Eingetragenen Lebenspartnerschaft

Für die eingetragene Lebenspartnerschaft findet sich im internationalen ValueSet "MaritalStatus" kein entsprechender Code. Das Technische Komitee hat jedoch beschlossen, dafür keinen zusätzlichen Code einzuführen, da die Unterschiede zwischen eingetragener Lebenspartnerschaft und Ehe (z.B. Steuer-/Adoptionsrecht) im Kontext der Erfassung von administrativen Patientendaten keine Rolle spielen.

Für die eingetragene Lebenspartnerschaft ist daher der Code "M" (verheiratet) zu verwenden.

Dieser Leitfaden enthält ein Supplement zum CodeSystem v3-MaritalStatus mit deutschen Anzeigetexten:
marital-status

Patient.birthDate

Das Element birthDate kann ein tages-, monat- oder jahresgenaues Datum enthalten.

<birthDate value="1980-09-02"/>

Zeitgenaue Angabe des Geburtsdatums

Wenn eine höhrere Genauigkeit benötigt wird, so mus die Extension patient-birthtime dafür verwendet werden.

Beispiel:

  <birthDate value="2017-09-05">
    <extension url="http://hl7.org/fhir/StructureDefinition/patient-birthTime">
      <valueDateTime value="2017-09-05T17:11:00+01:00"/> 
    </extension> 
  </birthDate>

Fehlende Angaben

Es ist zubeachten, dass fehlende Genauigkeit in den VSDM-Datensätzen auf der Verichertenkate mit Null-Stellen angegeben werden, z.B. "19800000" oder "19990100". Bei der Abbildung in FHIR sind fehlden Informationen einfach wegzulassen.

Ein Geburtsdatum, bei dem lediglich das Jahr bekannt ist, wird wie folgt notiert:

<birthDate value="1980"/>

In VSDM ist auch die Angabe "00000000" für ein vollständig fehlendes Geburtsdatum möglich. In FHIR würde dies durch das Weglassen des birthDate-Elementes ausgedrückt.

Sofern bekannt kann auch die data-absent-reasons-Extension eingesetzt werden, genauere Angaben zum Grund der fehlenden Information anzugeben.

Beispiel: Angabe zum Geburtsdatum fehlt, da es nicht erfragt wurde:

<birthDate>
    <extension url="http://hl7.org/fhir/StructureDefinition/data-absent-reason">
        <valueCode value="not-asked"/>
    </extension>
</birthDate>