Leitfaden Basis DE (STU3)

Personenname

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

humanname-de-basis-0.2 (HumanName)	I		HumanName	Element id HumanName Short description Personenname Definition Personenname mit in Deutschland üblichen Erweiterungen Comments Hinweis zur Repräsentation von Anreden: Diese sollten, sofern erforderlich, ausschließlich in HumanName.text erscheinen (z.B. "Frsu Dr. Martha Musterfrau"). Nach Möglichkeit sollte die Anrede aus dem Geschlecht der Person abgeleitet werden. Das Element prefix wird nur für akademische Titel und andere Namensbestandteile verwendet. Data type HumanName Constraints ele-1: All FHIR elements must have a @value or children `hasValue() \| (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
id		0..1	string	There are no (further) constraints on this element Element id HumanName.id Short description xml:id (or equivalent in JSON) Definition unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Mappings rim: n/a
extension		0..*	Extension	There are no (further) constraints on this element Element id HumanName.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) Extensions are always sliced by (at least) url Mappings rim: n/a
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 This is labeled as "Is Modifier" because applications should not mistake a temporary or old name etc.for a current/permanent one. 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) Mappings 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 A full text representation of the name. Requirements A renderable, unencoded form. Comments Can provide both a text representation and structured parts. Data type string Mappings v2: implied by XPN.11 rim: ./formatted
family	Σ I	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 Mappings v2: XPN.1/FN.1 rim: ./part[partType = FAM] servd: ./FamilyName BDT: 3120 + 3100 + 3101 KVDT: 3120 + 3100 + 3101
id		0..1	string	There are no (further) constraints on this element Element id HumanName.family.id Short description xml:id (or equivalent in JSON) Definition unique id for the element within a resource (for internal references) Data type string
extension		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 resource. 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)
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 http://build.fhir.org/extension-humanname-own-name.html 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/0.2 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 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() \| (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings v2: FN.3 rim: ENXP where Qualifiers = (BR) KVDT: 3101 BDT: 3101
id		0..1	string	There are no (further) constraints on this element Element id HumanName.family.extension:nachname.id Short description xml:id (or equivalent in JSON) Definition unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Mappings rim: n/a
extension		0..*	Extension	There are no (further) constraints on this element Element id HumanName.family.extension:nachname.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) Extensions are always sliced by (at least) url Mappings rim: n/a
url		1..1	uriFixed Value	There are no (further) constraints on this element Element id HumanName.family.extension:nachname.url 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 Fixed value http://hl7.org/fhir/StructureDefinition/humanname-own-name Mappings rim: N/A
valueString		0..1	string	There are no (further) constraints on this element Element id HumanName.family.extension:nachname.valueString:valueString 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). Data type string Mappings rim: N/A
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() \| (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings v2: FN.2 rim: ENXP where Qualifiers = (VV, R) BDT: 3120 KVDT: 3120
id		0..1	string	There are no (further) constraints on this element Element id HumanName.family.extension:vorsatzwort.id Short description xml:id (or equivalent in JSON) Definition unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Mappings rim: n/a
extension		0..*	Extension	There are no (further) constraints on this element Element id HumanName.family.extension:vorsatzwort.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) Extensions are always sliced by (at least) url Mappings rim: n/a
url		1..1	uriFixed Value	There are no (further) constraints on this element Element id HumanName.family.extension:vorsatzwort.url 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 Fixed value http://hl7.org/fhir/StructureDefinition/humanname-own-prefix Mappings rim: N/A
valueString		0..1	string	There are no (further) constraints on this element Element id HumanName.family.extension:vorsatzwort.valueString:valueString 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). Data type string Mappings rim: N/A
value		0..1		There are no (further) constraints on this element Element id HumanName.family.value Short description Primitive value for string Definition The actual value Maximum string length 1048576
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. Not called "first name" since given names do not always come first. Data type string Mappings v2: XPN.2 + XPN.3 rim: ./part[partType = GIV] servd: ./GivenNames KVDT: 3102 BDT: 3102
prefix	Σ I	0..*	string	Element id HumanName.prefix Short description Namensteile vor dem Vornamen Definition Namensteile vor dem Vornamen, z.B. akademischer Titel. Data type string Mappings v2: XPN.5 rim: ./part[partType = PFX] servd: ./TitleCode KVDT: 3104 BDT: 3104
id		0..1	string	There are no (further) constraints on this element Element id HumanName.prefix.id Short description xml:id (or equivalent in JSON) Definition unique id for the element within a resource (for internal references) Data type string
extension		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 resource. 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)
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() \| (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: ENXP.qualifier
id		0..1	string	There are no (further) constraints on this element Element id HumanName.prefix.extension:prefix-qualifier.id Short description xml:id (or equivalent in JSON) Definition unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Mappings rim: n/a
extension		0..*	Extension	There are no (further) constraints on this element Element id HumanName.prefix.extension:prefix-qualifier.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) Extensions are always sliced by (at least) url Mappings rim: n/a
url		1..1	uriFixed Value	There are no (further) constraints on this element Element id HumanName.prefix.extension:prefix-qualifier.url 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 Fixed value http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier Mappings rim: N/A
valueCode		0..1	codeBinding	There are no (further) constraints on this element Element id HumanName.prefix.extension:prefix-qualifier.valueCode:valueCode 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). Data type code Binding A set of codes each of which specifies a certain subcategory of the name part in addition to the main name part type EntityNamePartQualifier (required) Mappings rim: N/A
value		0..1		There are no (further) constraints on this element Element id HumanName.prefix.value Short description Primitive value for string Definition The actual value Maximum string length 1048576
suffix	Σ	0..*	string	Element id HumanName.suffix Short description Namensteile nach dem Nachnamen Definition Namensteile nach dem Nachnamen Data type string Mappings v2: XPN/4 rim: ./part[partType = SFX]
period	Σ	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. Data type Period Mappings v2: XPN.13 + XPN.14 rim: ./usablePeriod[type="IVL<TS>"] servd: ./StartDate and ./EndDate

Beispiele

XML-Format

Geburtsname und früherer Name:

<Patient xmlns="http://hl7.org/fhir">
    <meta>
        <profile value="http://fhir.de/StructureDefinition/patient-de-basis/0.2" />
    </meta>
    <text>
        <status value="generated" />
        --- We have skipped the narrative for better readability of the resource ---
    </text>
    <name>
        <use value="official" />
        <text value="Martha Mustermann" />
        <family value="Mustermann" />
        <given value="Martha" />
    </name>
    <name>
        <use value="maiden" />
        <family value="Testinghausen" />
    </name>
    <name>
        <use value="old" />
        <family value="Beisp&#252;hl" />
    </name>
</Patient>

Namenszusatz und Titel:

<Patient xmlns="http://hl7.org/fhir">
    <meta>
        <profile value="http://fhir.de/StructureDefinition/patient-de-basis/0.2" />
    </meta>
    <text>
        <status value="generated" />
        --- We have skipped the narrative for better readability of the resource ---
    </text>
    <name>
        <use value="official" />
        <text value="Dr. Otto Graf Lambsdorff" />
        <family value="Graf Lambsdorff">
            <extension url="http://fhir.de/StructureDefinition/humanname-namenszusatz/0.2">
                <valueString value="Graf" />
            </extension>
            <extension url="http://hl7.org/fhir/StructureDefinition/humanname-own-name">
                <valueString value="Lambsdorff" />
            </extension>
        </family>
        <given value="Otto" />
        <prefix value="Dr.">
            <extension url="http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier">
                <valueCode value="AC" />
            </extension>
        </prefix>
    </name>
</Patient>

Vorsatzwort:

<Patient xmlns="http://hl7.org/fhir">
    <meta>
        <profile value="http://fhir.de/StructureDefinition/patient-de-basis/0.2" />
    </meta>
    <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>
</Patient>

komplexer Name:

<Patient xmlns="http://hl7.org/fhir">
    <meta>
        <profile value="http://fhir.de/StructureDefinition/patient-de-basis/0.2" />
    </meta>
    <text>
        <status value="generated" />
        --- We have skipped the narrative for better readability of the resource ---
    </text>
    <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/0.2">
                <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>
</Patient>

JSON-Format

Geburtsname und früherer Name:

{
    "resourceType": "Patient",
    "meta": {
        "profile":  [
            "http://fhir.de/StructureDefinition/patient-de-basis/0.2"
        ]
    },
    "text": {
        "status": "generated",
        --- We have skipped the narrative for better readability of the resource ---
    },
    "name":  [
        {
            "use": "official",
            "text": "Martha Mustermann",
            "family": "Mustermann",
            "given":  [
                "Martha"
            ]
        },
        {
            "use": "maiden",
            "family": "Testinghausen"
        },
        {
            "use": "old",
            "family": "Beispühl"
        }
    ]
}

Namenszusatz und Titel:

{
    "resourceType": "Patient",
    "meta": {
        "profile":  [
            "http://fhir.de/StructureDefinition/patient-de-basis/0.2"
        ]
    },
    "text": {
        "status": "generated",
        --- We have skipped the narrative for better readability of the resource ---
    },
    "name":  [
        {
            "use": "official",
            "text": "Dr. Otto Graf Lambsdorff",
            "family": "Graf Lambsdorff",
            "_family": {
                "extension":  [
                    {
                        "url": "http://fhir.de/StructureDefinition/humanname-namenszusatz/0.2",
                        "valueString": "Graf"
                    },
                    {
                        "url": "http://hl7.org/fhir/StructureDefinition/humanname-own-name",
                        "valueString": "Lambsdorff"
                    }
                ]
            },
            "given":  [
                "Otto"
            ],
            "prefix":  [
                "Dr."
            ],
            "_prefix":  [
                {
                    "extension":  [
                        {
                            "url": "http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier",
                            "valueCode": "AC"
                        }
                    ]
                }
            ]
        }
    ]
}

Vorsatzwort:

{
    "resourceType": "Patient",
    "meta": {
        "profile":  [
            "http://fhir.de/StructureDefinition/patient-de-basis/0.2"
        ]
    },
    "name":  [
        {
            "use": "official",
            "text": "Ludwig van Beethoven",
            "family": "van Beethoven",
            "_family": {
                "extension":  [
                    {
                        "url": "http://hl7.org/fhir/StructureDefinition/humanname-own-prefix",
                        "valueString": "van"
                    },
                    {
                        "url": "http://hl7.org/fhir/StructureDefinition/humanname-own-name",
                        "valueString": "Beethoven"
                    }
                ]
            },
            "given":  [
                "Ludwig"
            ]
        }
    ]
}

komplexer Name:

{
    "resourceType": "Patient",
    "meta": {
        "profile":  [
            "http://fhir.de/StructureDefinition/patient-de-basis/0.2"
        ]
    },
    "text": {
        "status": "generated",
        --- We have skipped the narrative for better readability of the resource ---
    },
    "name":  [
        {
            "use": "official",
            "text": "Prof. Dr. med. Dr. rer. nat. Fritz Julius Karl Freiherr von und zu Rathenburg vor der Isar, MdB",
            "family": "Freiherr von und zu Rathenburg vor der Isar",
            "_family": {
                "extension":  [
                    {
                        "url": "http://fhir.de/StructureDefinition/humanname-namenszusatz/0.2",
                        "valueString": "Freiherr"
                    },
                    {
                        "url": "http://hl7.org/fhir/StructureDefinition/humanname-own-prefix",
                        "valueString": "von und zu"
                    },
                    {
                        "url": "http://hl7.org/fhir/StructureDefinition/humanname-own-name",
                        "valueString": "Rathenburg vor der Isar"
                    }
                ]
            },
            "given":  [
                "Fritz",
                "Julius",
                "Karl"
            ],
            "prefix":  [
                "Prof. Dr. med. Dr. rer. nat."
            ],
            "_prefix":  [
                {
                    "extension":  [
                        {
                            "url": "http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier",
                            "valueCode": "AC"
                        }
                    ]
                }
            ],
            "suffix":  [
                "MdB"
            ]
        }
    ]
}