ISiK ICU
Version 6.0.0-rc - STU1

Resource Profile: ISiKAngehoeriger

Official URL: https://gematik.de/fhir/isik/StructureDefinition/ISiKAngehoeriger Version: 6.0.0-rc
Active as of 2025-12-17 Computable Name: ISiKAngehoeriger

Dieses Profil ermöglicht die Darstellung von Angehörigen in ISiK Szenarien.

Motivation

Der Angehörige wird vor allem im Zusammenhang mit Anwendungsszenarien verwendet, in denen das Versicherungsverhältnis eine Rolle spielt. Hier können Angehörige, bspw. der hauptversicherte Elternteil eines minderjährigen Kindes, in der Familienversicherung sein. In Selbstzahler-Szenarien können Angehörige die Zahler für eine im Krankenhaus erbrachte Leistung sein. In FHIR werden Angehörige von Patienten mit der RelatedPerson-Ressource repräsentiert.

Kompatibilität

Für das Profil ISiKAngehoeriger wurde bis zum Zeitpunkt der Veröffentlichung kein Abgleich der Kompatibilität zu anderen Profilen (der KBV und der Medizininformatik-Initiative) durchgeführt.

Hinweise zu Inkompatibilitäten können über die Portalseite gemeldet werden.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. RelatedPerson C 0..* RelatedPerson A person that is related to a patient, but who is not a direct target of care
Constraints: relatedp-de-1
... id SΣ 0..1 id serverseitige, interne ID des Datensatzes
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... patient SΣ 1..1 Reference(Patient) Patientenbezug
.... reference SΣC 1..1 string Patienten-Link
... relationship SΣ 0..* CodeableConcept Verwandtschaftsverhältnis
Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person.
... Slices for name SΣ 1..* HumanName Offizieller Name der angehörigen Person
Slice: Unordered, Open by pattern:$this
.... name:Name SΣ 1..1 HumannameDeBasis Slice für den offiziellen Namen der angehörigen Person

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... use 1..1 code usual | official | temp | nickname | anonymous | old | maiden
Fixed Value: official
..... text 0..1 string Text representation of the full name
..... family 0..1 string Family name (often called 'Surname')
..... given 0..* string Given names (not always 'first'). Includes middle names
..... prefix 0..* string Parts that come before the name
..... suffix 0..* string Parts that come after the name
..... period 0..1 Period Time period when name was/is in use
..... use ?!SΣ 0..1 code Verwendungszweck
Binding: NameUse (required): The use of a human name.
..... family SΣ 0..1 string Nachname
...... Slices for extension Content/Rules for all slices
....... extension:namenszusatz N 0..1 string Namenszusatz gemäß VSDM (Versichertenstammdatenmanagement, "eGK")
URL: http://fhir.de/StructureDefinition/humanname-namenszusatz
....... extension:nachname 0..1 string Nachname ohne Vor- und Zusätze
URL: http://hl7.org/fhir/StructureDefinition/humanname-own-name
....... extension:vorsatzwort 0..1 string Vorsatzwort
URL: http://hl7.org/fhir/StructureDefinition/humanname-own-prefix
..... given SΣ 0..* string Vorname
This repeating element order: Given Names appear in the correct order for presenting the name
..... prefix SΣ 0..* string Präfix
This repeating element order: Prefixes appear in the correct order for presenting the name
...... Slices for extension Content/Rules for all slices
....... extension:prefix-qualifier 0..1 code LS | AC | NB | PR | HON | BR | AD | SP | MID | CL | IN | VV
URL: http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier
Binding: EntityNamePartQualifier (required)
... telecom SΣ 0..* ContactPoint Telekommunikationsverbindung
.... system SΣC 1..1 code Art der Telekommunikationsverbindung
Binding: ContactPointSystem (required): Telecommunications form for contact point.
.... value SΣ 1..1 string Telekommunikations-Endpunkt
.... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
... Slices for address SΣ 0..* Address Offizielle Adresse der angehörigen Person
Slice: Unordered, Open by pattern:$this
.... address:Strassenanschrift SΣC 0..* AddressDeBasis Straßenanschrift
Constraints: address-cnt-2or3-char

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... use 0..1 code home | work | temp | old | billing - purpose of this address
..... type 1..1 code postal | physical | both
Fixed Value: both
..... text 0..1 string Text representation of the address
..... line 0..* string Street name, number, direction & P.O. Box etc.
..... city 0..1 string Name of city, town etc.
..... district 0..1 string District name (aka county)
..... state 0..1 string Sub-unit of country (abbreviations ok)
..... postalCode 0..1 string Postal code for area
..... country 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
..... period 0..1 Period Time period when address was/is in use
..... Slices for extension Content/Rules for all slices
...... extension:Stadtteil S 0..1 string precinct
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-precinct
..... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.
Example General: home
..... type SΣ 1..1 code Adresstyp
Binding: AddressType (required): The type of an address (physical / postal).
Example General: both
..... line SΣ 1..3 string Adresszeile
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
Example Beipiel für Adresszeile mit Extensions für Straße und Hausnummer: Musterweg 42
...... Slices for extension Content/Rules for all slices
....... extension:Strasse 0..1 string Strassenname
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName
....... extension:Hausnummer 0..1 string houseNumber
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber
....... extension:Adresszusatz 0..1 string additionalLocator
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator
..... city SΣ 1..1 string Stadt
Example General: Erewhon
..... postalCode SΣ 1..1 string Postleitzahl
Example General: 9132
..... country SΣ 1..1 string Land
Binding: Iso3166-1-2 (preferred)
.... address:Postfach SΣC 0..* AddressDeBasis Postfachadresse
Constraints: address-cnt-2or3-char

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... use 0..1 code home | work | temp | old | billing - purpose of this address
..... type 1..1 code postal | physical | both
Fixed Value: postal
..... text 0..1 string Text representation of the address
..... line 0..* string Street name, number, direction & P.O. Box etc.
..... city 0..1 string Name of city, town etc.
..... district 0..1 string District name (aka county)
..... state 0..1 string Sub-unit of country (abbreviations ok)
..... postalCode 0..1 string Postal code for area
..... country 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
..... period 0..1 Period Time period when address was/is in use
..... Slices for extension Content/Rules for all slices
...... extension:Stadtteil 0..1 string Stadt- oder Ortsteil
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-precinct
..... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.
Example General: home
..... type SΣ 1..1 code Adresstyp
Binding: AddressType (required): The type of an address (physical / postal).
Example General: both
..... line SΣ 1..3 string Adresszeile
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
Example Beipiel für Adresszeile mit Extensions für Straße und Hausnummer: Musterweg 42
...... Slices for extension Content/Rules for all slices
....... extension:Postfach 0..1 string Postfachnummer
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox
..... city SΣ 1..1 string Stadt
Example General: Erewhon
..... postalCode SΣ 1..1 string Postleitzahl
Example General: 9132
..... country SΣ 1..1 string Land
Binding: Iso3166-1-2 (preferred)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
RelatedPerson.relationship Base preferred Patient relationship type 📍4.0.1 FHIR Std.
RelatedPerson.name:Name.​use Base required NameUse 📍4.0.1 FHIR Std.
RelatedPerson.telecom.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
RelatedPerson.telecom.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
RelatedPerson.address:Strassenanschrift.​use Base required AddressUse 📍4.0.1 FHIR Std.
RelatedPerson.address:Strassenanschrift.​type Base required AddressType 📍4.0.1 FHIR Std.
RelatedPerson.address:Strassenanschrift.​country Base preferred Iso 3166 Part 1: 2 Letter Codes 📦4.0.1 FHIR Std.
RelatedPerson.address:Postfach.​use Base required AddressUse 📍4.0.1 FHIR Std.
RelatedPerson.address:Postfach.​type Base required AddressType 📍4.0.1 FHIR Std.
RelatedPerson.address:Postfach.​country Base preferred Iso 3166 Part 1: 2 Letter Codes 📦4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
address-cnt-2or3-char warning RelatedPerson.address:Strassenanschrift, RelatedPerson.address:Postfach The content of the country element (if present) SHALL be selected EITHER from ValueSet ISO Country Alpha-2 http://hl7.org/fhir/ValueSet/iso3166-1-2 OR MAY be selected from ISO Country Alpha-3 Value Set http://hl7.org/fhir/ValueSet/iso3166-1-3, IF the country is not specified in value Set ISO Country Alpha-2 http://hl7.org/fhir/ValueSet/iso3166-1-2. country.empty() or (country.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-2') or country.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-3'))
dom-2 error RelatedPerson If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error RelatedPerson If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error RelatedPerson If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error RelatedPerson If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice RelatedPerson A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
relatedp-de-1 error RelatedPerson Falls die Geschlechtsangabe 'other' gewählt wird, muss die amtliche Differenzierung per Extension angegeben werden gender.exists() and gender='other' implies gender.extension('http://fhir.de/StructureDefinition/gender-amtlich-de').exists()

This structure is derived from RelatedPerson

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. RelatedPerson C 0..* RelatedPerson A person that is related to a patient, but who is not a direct target of care
Constraints: relatedp-de-1
... id S 0..1 id serverseitige, interne ID des Datensatzes
... meta
.... versionId 0..1 id Eindeutiger Name der serverseitigen Version des Datensatzes
.... lastUpdated 0..1 instant Zeitpunkt der letzten Änderung
... active S 0..1 boolean Status des Datensatzes
.... reference S 1..1 string Patienten-Link
... relationship S 0..* CodeableConcept Verwandtschaftsverhältnis
... Slices for name S 1..* HumanName Offizieller Name der angehörigen Person
Slice: Unordered, Open by pattern:$this
.... name:Name S 1..1 HumannameDeBasis Slice für den offiziellen Namen der angehörigen Person
Required Pattern: At least the following
..... use 1..1 code usual | official | temp | nickname | anonymous | old | maiden
Fixed Value: official
..... use S 0..1 code Verwendungszweck
..... family S 0..1 string Nachname
..... given S 0..* string Vorname
..... prefix S 0..* string Präfix
... telecom S 0..* ContactPoint Telekommunikationsverbindung
.... system S 1..1 code Art der Telekommunikationsverbindung
.... value S 1..1 string Telekommunikations-Endpunkt
... Slices for address S 0..* Address Offizielle Adresse der angehörigen Person
Slice: Unordered, Open by pattern:$this
.... address:Strassenanschrift SC 0..* AddressDeBasis Straßenanschrift
Constraints: address-cnt-2or3-char

Required Pattern: At least the following
..... type 1..1 code postal | physical | both
Fixed Value: both
..... Slices for extension Content/Rules for all slices
...... extension:Stadtteil S 0..1 ADXPPrecinct(5.2.0) precinct
..... type S 1..1 code Adresstyp
..... line S 1..3 string Adresszeile
...... Slices for extension Content/Rules for all slices
....... extension:Strasse 0..1 ADXPStreetName(5.2.0) Strassenname
....... extension:Hausnummer 0..1 ADXPHouseNumber(5.2.0) houseNumber
....... extension:Adresszusatz 0..1 ADXPAdditionalLocator(5.2.0) additionalLocator
....... extension:Postfach 0..0 Postfachnummer
..... city S 1..1 string Stadt
..... postalCode S 1..1 string Postleitzahl
..... country S 1..1 string Land
.... address:Postfach SC 0..* AddressDeBasis Postfachadresse
Constraints: address-cnt-2or3-char

Required Pattern: At least the following
..... type 1..1 code postal | physical | both
Fixed Value: postal
..... type S 1..1 code Adresstyp
..... line S 1..3 string Adresszeile
...... Slices for extension Content/Rules for all slices
....... extension:Strasse 0..0 streetName
....... extension:Hausnummer 0..0 houseNumber
....... extension:Adresszusatz 0..0 additionalLocator
....... extension:Postfach 0..1 ADXPPostBox(5.2.0) Postfachnummer
..... city S 1..1 string Stadt
..... postalCode S 1..1 string Postleitzahl
..... country S 1..1 string Land

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
address-cnt-2or3-char warning RelatedPerson.address:Strassenanschrift, RelatedPerson.address:Postfach The content of the country element (if present) SHALL be selected EITHER from ValueSet ISO Country Alpha-2 http://hl7.org/fhir/ValueSet/iso3166-1-2 OR MAY be selected from ISO Country Alpha-3 Value Set http://hl7.org/fhir/ValueSet/iso3166-1-3, IF the country is not specified in value Set ISO Country Alpha-2 http://hl7.org/fhir/ValueSet/iso3166-1-2. country.empty() or (country.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-2') or country.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-3'))
relatedp-de-1 error RelatedPerson Falls die Geschlechtsangabe 'other' gewählt wird, muss die amtliche Differenzierung per Extension angegeben werden gender.exists() and gender='other' implies gender.extension('http://fhir.de/StructureDefinition/gender-amtlich-de').exists()
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. RelatedPerson C 0..* RelatedPerson A person that is related to a patient, but who is not a direct target of care
Constraints: relatedp-de-1
... id SΣ 0..1 id serverseitige, interne ID des Datensatzes
... meta Σ 0..1 Meta Metadata about the resource
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ 0..1 id Eindeutiger Name der serverseitigen Version des Datensatzes
.... lastUpdated Σ 0..1 instant Zeitpunkt der letzten Änderung
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile Σ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier A human identifier for this person
... active ?!SΣ 0..1 boolean Status des Datensatzes
... patient SΣ 1..1 Reference(Patient) Patientenbezug
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference SΣC 1..1 string Patienten-Link
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... relationship SΣ 0..* CodeableConcept Verwandtschaftsverhältnis
Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person.
... Slices for name SΣ 1..* HumanName Offizieller Name der angehörigen Person
Slice: Unordered, Open by pattern:$this
.... name:Name SΣ 1..1 HumannameDeBasis Slice für den offiziellen Namen der angehörigen Person

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... use 1..1 code usual | official | temp | nickname | anonymous | old | maiden
Fixed Value: official
..... text 0..1 string Text representation of the full name
..... family 0..1 string Family name (often called 'Surname')
..... given 0..* string Given names (not always 'first'). Includes middle names
..... prefix 0..* string Parts that come before the name
..... suffix 0..* string Parts that come after the name
..... period 0..1 Period Time period when name was/is in use
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!SΣ 0..1 code Verwendungszweck
Binding: NameUse (required): The use of a human name.
..... text Σ 0..1 string Text representation of the full name
..... family SΣ 0..1 string Nachname
...... id 0..1 string xml:id (or equivalent in JSON)
...... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... extension:namenszusatz N 0..1 string Namenszusatz gemäß VSDM (Versichertenstammdatenmanagement, "eGK")
URL: http://fhir.de/StructureDefinition/humanname-namenszusatz
....... extension:nachname 0..1 string Nachname ohne Vor- und Zusätze
URL: http://hl7.org/fhir/StructureDefinition/humanname-own-name
....... extension:vorsatzwort 0..1 string Vorsatzwort
URL: http://hl7.org/fhir/StructureDefinition/humanname-own-prefix
...... value 0..1 string Primitive value for string
Max Length:1048576
..... given SΣ 0..* string Vorname
This repeating element order: Given Names appear in the correct order for presenting the name
..... prefix SΣ 0..* string Präfix
This repeating element order: Prefixes appear in the correct order for presenting the name
...... id 0..1 string xml:id (or equivalent in JSON)
...... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... extension:prefix-qualifier 0..1 code LS | AC | NB | PR | HON | BR | AD | SP | MID | CL | IN | VV
URL: http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier
Binding: EntityNamePartQualifier (required)
...... value 0..1 string Primitive value for string
Max Length:1048576
..... suffix Σ 0..* string Namensteile nach dem Nachnamen
This repeating element order: Suffixes appear in the correct order for presenting the name
..... period Σ 0..1 Period Time period when name was/is in use
... telecom SΣ 0..* ContactPoint Telekommunikationsverbindung
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... system SΣC 1..1 code Art der Telekommunikationsverbindung
Binding: ContactPointSystem (required): Telecommunications form for contact point.
.... value SΣ 1..1 string Telekommunikations-Endpunkt
.... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
.... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
.... period Σ 0..1 Period Time period when the contact point was/is in use
... gender Σ 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
... birthDate Σ 0..1 date The date on which the related person was born
... Slices for address SΣ 0..* Address Offizielle Adresse der angehörigen Person
Slice: Unordered, Open by pattern:$this
.... address:Strassenanschrift SΣC 0..* AddressDeBasis Straßenanschrift
Constraints: address-cnt-2or3-char

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... use 0..1 code home | work | temp | old | billing - purpose of this address
..... type 1..1 code postal | physical | both
Fixed Value: both
..... text 0..1 string Text representation of the address
..... line 0..* string Street name, number, direction & P.O. Box etc.
..... city 0..1 string Name of city, town etc.
..... district 0..1 string District name (aka county)
..... state 0..1 string Sub-unit of country (abbreviations ok)
..... postalCode 0..1 string Postal code for area
..... country 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
..... period 0..1 Period Time period when address was/is in use
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... extension:Stadtteil S 0..1 string precinct
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-precinct
..... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.
Example General: home
..... type SΣ 1..1 code Adresstyp
Binding: AddressType (required): The type of an address (physical / postal).
Example General: both
..... text Σ 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
..... line SΣ 1..3 string Adresszeile
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
Example Beipiel für Adresszeile mit Extensions für Straße und Hausnummer: Musterweg 42
...... id 0..1 string xml:id (or equivalent in JSON)
...... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... extension:Strasse 0..1 string Strassenname
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName
....... extension:Hausnummer 0..1 string houseNumber
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber
....... extension:Adresszusatz 0..1 string additionalLocator
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator
...... value 0..1 string Primitive value for string
Max Length:1048576
..... city SΣ 1..1 string Stadt
Example General: Erewhon
..... state Σ 0..1 string Bundesland
Binding: ISO-3166-2:de-Laendercodes (preferred)
..... postalCode SΣ 1..1 string Postleitzahl
Example General: 9132
..... country SΣ 1..1 string Land
Binding: Iso3166-1-2 (preferred)
..... period Σ 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
.... address:Postfach SΣC 0..* AddressDeBasis Postfachadresse
Constraints: address-cnt-2or3-char

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... use 0..1 code home | work | temp | old | billing - purpose of this address
..... type 1..1 code postal | physical | both
Fixed Value: postal
..... text 0..1 string Text representation of the address
..... line 0..* string Street name, number, direction & P.O. Box etc.
..... city 0..1 string Name of city, town etc.
..... district 0..1 string District name (aka county)
..... state 0..1 string Sub-unit of country (abbreviations ok)
..... postalCode 0..1 string Postal code for area
..... country 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
..... period 0..1 Period Time period when address was/is in use
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... extension:Stadtteil 0..1 string Stadt- oder Ortsteil
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-precinct
..... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.
Example General: home
..... type SΣ 1..1 code Adresstyp
Binding: AddressType (required): The type of an address (physical / postal).
Example General: both
..... text Σ 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
..... line SΣ 1..3 string Adresszeile
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
Example Beipiel für Adresszeile mit Extensions für Straße und Hausnummer: Musterweg 42
...... id 0..1 string xml:id (or equivalent in JSON)
...... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... extension:Postfach 0..1 string Postfachnummer
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox
...... value 0..1 string Primitive value for string
Max Length:1048576
..... city SΣ 1..1 string Stadt
Example General: Erewhon
..... state Σ 0..1 string Bundesland
Binding: ISO-3166-2:de-Laendercodes (preferred)
..... postalCode SΣ 1..1 string Postleitzahl
Example General: 9132
..... country SΣ 1..1 string Land
Binding: Iso3166-1-2 (preferred)
..... period Σ 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... photo 0..* Attachment Image of the person
... period 0..1 Period Period of time that this relationship is considered valid
... communication 0..* BackboneElement A language which may be used to communicate with about the patient's health
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... language 1..1 CodeableConcept The language which can be used to communicate with the patient about his or her health
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
.... preferred 0..1 boolean Language preference indicator

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
RelatedPerson.meta.security Base extensible SecurityLabels 📍4.0.1 FHIR Std.
RelatedPerson.meta.tag Base example Common Tags 📍4.0.1 FHIR Std.
RelatedPerson.language Base preferred Common Languages 📍4.0.1 FHIR Std.
RelatedPerson.patient.​type Base extensible ResourceType 📍4.0.1 FHIR Std.
RelatedPerson.relationship Base preferred Patient relationship type 📍4.0.1 FHIR Std.
RelatedPerson.name:Name.​use Base required NameUse 📍4.0.1 FHIR Std.
RelatedPerson.telecom.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
RelatedPerson.telecom.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
RelatedPerson.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
RelatedPerson.address:Strassenanschrift.​use Base required AddressUse 📍4.0.1 FHIR Std.
RelatedPerson.address:Strassenanschrift.​type Base required AddressType 📍4.0.1 FHIR Std.
RelatedPerson.address:Strassenanschrift.​state Base preferred ISO-3166-2:de-Laendercodes 📦1.5.4 de.basisprofil.r4 v1.5
RelatedPerson.address:Strassenanschrift.​country Base preferred Iso 3166 Part 1: 2 Letter Codes 📦4.0.1 FHIR Std.
RelatedPerson.address:Postfach.​use Base required AddressUse 📍4.0.1 FHIR Std.
RelatedPerson.address:Postfach.​type Base required AddressType 📍4.0.1 FHIR Std.
RelatedPerson.address:Postfach.​state Base preferred ISO-3166-2:de-Laendercodes 📦1.5.4 de.basisprofil.r4 v1.5
RelatedPerson.address:Postfach.​country Base preferred Iso 3166 Part 1: 2 Letter Codes 📦4.0.1 FHIR Std.
RelatedPerson.communication.​language Base preferred Common Languages 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
address-cnt-2or3-char warning RelatedPerson.address:Strassenanschrift, RelatedPerson.address:Postfach The content of the country element (if present) SHALL be selected EITHER from ValueSet ISO Country Alpha-2 http://hl7.org/fhir/ValueSet/iso3166-1-2 OR MAY be selected from ISO Country Alpha-3 Value Set http://hl7.org/fhir/ValueSet/iso3166-1-3, IF the country is not specified in value Set ISO Country Alpha-2 http://hl7.org/fhir/ValueSet/iso3166-1-2. country.empty() or (country.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-2') or country.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-3'))
dom-2 error RelatedPerson If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error RelatedPerson If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error RelatedPerson If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error RelatedPerson If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice RelatedPerson A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
relatedp-de-1 error RelatedPerson Falls die Geschlechtsangabe 'other' gewählt wird, muss die amtliche Differenzierung per Extension angegeben werden gender.exists() and gender='other' implies gender.extension('http://fhir.de/StructureDefinition/gender-amtlich-de').exists()
ElementShort descriptionNotes
RelatedPerson.active Status des Datensatzes

Einschränkung der übergreifenden MS-Definition: Die Implementierung dieses Elements ist für Server optional. Die Kennzeichnung als Must-Support erfolgt, da es sich um ein als Modifier-Element markiertes Feld in der Kernspezifikation handelt.

Hinweis zur Verwendung:

  • true = Der Datensatz befindet sich in Verwendung/kann verwendet werden

  • false= Der Datensatz wurde storniert (z.B. bei Dubletten, Merge) oder archiviert

    WICHTIGER Hinweis für Implementierer:

    • Alle server-seitigen Implementierungen SOLLEN in der Lage sein, die systemintern möglichen Statuswerte korrekt in FHIR abzubilden.
    • Alle client-seitigen Implementierungen SOLLEN in der Lage sein, sämtliche Status-Codes zu interpretieren und dem Anwender in angemessener Form darstellen zu können.
RelatedPerson.address Offizielle Adresse der angehörigen Person

In order to differentiate between post box addresses and physical addresses, street names and house numbers, and to add city district names, vendors can opt to support the extensions as suggested in the German Address Base Profile http://fhir.de/StructureDefinition/address-de-basis. Such differentiations are however not required within the scope of this specification.
RelatedPerson.address:Postfach Postfachadresse

Adresse, die nur für postalische Zustellung genutzt werden kann.
RelatedPerson.address:Postfach.city Stadt

Begründung Pflichtfeld: Ohne diese Angabe ist die Adresse nicht zustellbar.
RelatedPerson.address:Postfach.country Land

Begründung Pflichtfeld: Ohne diese Angabe ist die Adresse nicht zustellbar.
RelatedPerson.address:Postfach.line Adresszeile

Diese Komponente enthält die Postfachadresse als String der Form ‘Postfach: 12345’. Bei Verwendung der Postfach-Extension, um die Postfachnummer 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.
Begründung Pflichtfeld: Ohne diese Angabe ist die Adresse nicht zustellbar.
Begründung für Reduktion der max. Kardinalität: Die maximale Kardinalität wurde in Übereinstimmung mit der DIN-Norm 5008 (Schreib- und Gestaltungsregeln für die Text- und Informationsverarbeitung) auf 3 beschränkt.
RelatedPerson.address:Postfach.postalCode

Begründung Pflichtfeld: Ohne diese Angabe ist die Adresse nicht zustellbar.
RelatedPerson.address:Postfach.type Adresstyp

Hier ist stets der Wert postal anzugeben.
Begründung Pflichtfeld: Dient als Unterscheidungs- und Auswahlkriterium
RelatedPerson.address:Strassenanschrift Straßenanschrift

Wohn- oder Aufenthaltsort des Angehörigen
RelatedPerson.address:Strassenanschrift.city Stadt

Begründung Pflichtfeld: Ohne diese Angabe ist die Adresse nicht zustellbar.
RelatedPerson.address:Strassenanschrift.country Land

Begründung Pflichtfeld: Ohne diese Angabe ist die Adresse nicht zustellbar.
RelatedPerson.address:Strassenanschrift.extension:Stadtteil
RelatedPerson.address:Strassenanschrift.line Adresszeile

Diese Komponente kann Straßennamen, Hausnummer, Appartmentnummer, 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.
Begründung Pflichtfeld: Ohne diese Angabe ist die Adresse nicht zustellbar.
Begründung für Reduktion der max. Kardinalität: Die maximale Kardinalität wurde in Übereinstimmung mit der DIN-Norm 5008 (Schreib- und Gestaltungsregeln für die Text- und Informationsverarbeitung) auf 3 beschränkt.
RelatedPerson.address:Strassenanschrift.postalCode

Begründung Pflichtfeld: Ohne diese Angabe ist die Adresse nicht zustellbar.
RelatedPerson.address:Strassenanschrift.type Adresstyp

Hier ist stets der Wert both anzugeben.
Begründung Pflichtfeld: Dient als Unterscheidungs- und Auswahlkriterium
RelatedPerson.id serverseitige, interne ID des Datensatzes

bedingtes Pflichtfeld/bedingtes MS: Alle von einem Server bereitgestellten Ressourcen MÜSSEN über eine id verfügen. Von Clients erzeugte Ressourcen, die im Kontext einer CREATE-Interaktion übermittelt werden, MÜSSEN NICHT über eine idverfügen.
RelatedPerson.name Offizieller Name der angehörigen Person

Aufgrund der primären Nutzung von Angehörigen-Informationen im ISiK-Kontext als Brief- und Rechnungsempfänger, ist die Angabe des offiziellen Namens relevant. Wenn kein Name vorliegt, MUSS die data-absent-reason-Extension eingesetzt werden.
Weitere Hinweise: siehe Deutsche Basisprofile
RelatedPerson.name:Name Slice für den offiziellen Namen der angehörigen Person

Basierend auf dem Pattern .use = official wird dieser Slice gewählt. Begründung MS: Siehe untergeordnete Elemente
RelatedPerson.name:Name.family Nachname

Vollständiger Nachname bzw. Familienname der Person, einschließlich Vor- und Zusätze.
Begründung Pflichtfeld: Ein offizieller Name ist nur zulässig, wenn der Nachname und mindestens ein Vorname angegeben sind.
RelatedPerson.name:Name.given

Kann mehrfach verwendet werden, um den Rufnamen sowie weitere Vornamen, Mittelnamen oder Mittel-Initialen abzubilden. Begründung Pflichtfeld: Ein offizieller Name ist nur zulässig, wenn der Nachname und mindestens ein Vorname angegeben sind.
RelatedPerson.name:Name.prefix Präfix

Präfix, z.B. akademischer Titel od. militärischer Rang
RelatedPerson.name:Name.use Verwendungszweck

Verwendungszweck des Namens. Der präferierte Namen für die Brief- und Rechnungszustellung SOLLTE als official gekennzeichnet werden und mindestens über einen Vor- und Nachnamen verfügen.
Begründung MS: Dient als Unterscheidungs- und Auswahlkriterium
RelatedPerson.patient Patientenbezug

Motivation Kardinalität und Must-Support: Referenz auf den Patienten, zu dem diese angehörige Person in Beziehung steht. Diese Verlinkung ist essentiell für die Dokumentation der Beziehung zwischen Patient und Angehörigem.
RelatedPerson.patient.reference Patienten-Link

Begründung Pflichtfeld: Die Verlinkung auf eine Patienten-Ressource dient der technischen Zuordnung der Dokumentation zu einem Patienten und ermöglicht wichtige API-Funktionen wie verkettete Suche, (Reverse-)Include etc. Im ISik Kontext MUSS die referenzierte Ressource konform zu ISiKPatient sein. Jenseits von ISiK KÖNNEN weitere Instanzen mit anderen Profilen referenziert werden.
RelatedPerson.relationship Verwandtschaftsverhältnis

Begründung MS: Harmonisierung mit KBV (KBV_PR_Base_RelatedPerson)
RelatedPerson.telecom Telekommunikationsverbindung

Telekommunikationsverbindung (z.B. Telefonnummer, eMail-Adresse)
Begründung MS: Harmonisierung mit KBV (KBV_PR_Base_RelatedPerson)
RelatedPerson.telecom.system Art der Telekommunikationsverbindung

Begründung Pflichtfeld: Harmonisierung mit KBV (KBV_PR_Base_RelatedPerson)
RelatedPerson.telecom.value Telekommunikations-Endpunkt

Begründung Pflichtfeld: Harmonisierung mit KBV (KBV_PR_Base_RelatedPerson)

This structure is derived from RelatedPerson

Summary

Mandatory: 3 elements(12 nested mandatory elements)
Must-Support: 28 elements
Prohibited: 4 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of RelatedPerson.name
  • The element 1 is sliced based on the value of RelatedPerson.address

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. RelatedPerson C 0..* RelatedPerson A person that is related to a patient, but who is not a direct target of care
Constraints: relatedp-de-1
... id SΣ 0..1 id serverseitige, interne ID des Datensatzes
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... patient SΣ 1..1 Reference(Patient) Patientenbezug
.... reference SΣC 1..1 string Patienten-Link
... relationship SΣ 0..* CodeableConcept Verwandtschaftsverhältnis
Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person.
... Slices for name SΣ 1..* HumanName Offizieller Name der angehörigen Person
Slice: Unordered, Open by pattern:$this
.... name:Name SΣ 1..1 HumannameDeBasis Slice für den offiziellen Namen der angehörigen Person

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... use 1..1 code usual | official | temp | nickname | anonymous | old | maiden
Fixed Value: official
..... text 0..1 string Text representation of the full name
..... family 0..1 string Family name (often called 'Surname')
..... given 0..* string Given names (not always 'first'). Includes middle names
..... prefix 0..* string Parts that come before the name
..... suffix 0..* string Parts that come after the name
..... period 0..1 Period Time period when name was/is in use
..... use ?!SΣ 0..1 code Verwendungszweck
Binding: NameUse (required): The use of a human name.
..... family SΣ 0..1 string Nachname
...... Slices for extension Content/Rules for all slices
....... extension:namenszusatz N 0..1 string Namenszusatz gemäß VSDM (Versichertenstammdatenmanagement, "eGK")
URL: http://fhir.de/StructureDefinition/humanname-namenszusatz
....... extension:nachname 0..1 string Nachname ohne Vor- und Zusätze
URL: http://hl7.org/fhir/StructureDefinition/humanname-own-name
....... extension:vorsatzwort 0..1 string Vorsatzwort
URL: http://hl7.org/fhir/StructureDefinition/humanname-own-prefix
..... given SΣ 0..* string Vorname
This repeating element order: Given Names appear in the correct order for presenting the name
..... prefix SΣ 0..* string Präfix
This repeating element order: Prefixes appear in the correct order for presenting the name
...... Slices for extension Content/Rules for all slices
....... extension:prefix-qualifier 0..1 code LS | AC | NB | PR | HON | BR | AD | SP | MID | CL | IN | VV
URL: http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier
Binding: EntityNamePartQualifier (required)
... telecom SΣ 0..* ContactPoint Telekommunikationsverbindung
.... system SΣC 1..1 code Art der Telekommunikationsverbindung
Binding: ContactPointSystem (required): Telecommunications form for contact point.
.... value SΣ 1..1 string Telekommunikations-Endpunkt
.... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
... Slices for address SΣ 0..* Address Offizielle Adresse der angehörigen Person
Slice: Unordered, Open by pattern:$this
.... address:Strassenanschrift SΣC 0..* AddressDeBasis Straßenanschrift
Constraints: address-cnt-2or3-char

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... use 0..1 code home | work | temp | old | billing - purpose of this address
..... type 1..1 code postal | physical | both
Fixed Value: both
..... text 0..1 string Text representation of the address
..... line 0..* string Street name, number, direction & P.O. Box etc.
..... city 0..1 string Name of city, town etc.
..... district 0..1 string District name (aka county)
..... state 0..1 string Sub-unit of country (abbreviations ok)
..... postalCode 0..1 string Postal code for area
..... country 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
..... period 0..1 Period Time period when address was/is in use
..... Slices for extension Content/Rules for all slices
...... extension:Stadtteil S 0..1 string precinct
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-precinct
..... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.
Example General: home
..... type SΣ 1..1 code Adresstyp
Binding: AddressType (required): The type of an address (physical / postal).
Example General: both
..... line SΣ 1..3 string Adresszeile
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
Example Beipiel für Adresszeile mit Extensions für Straße und Hausnummer: Musterweg 42
...... Slices for extension Content/Rules for all slices
....... extension:Strasse 0..1 string Strassenname
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName
....... extension:Hausnummer 0..1 string houseNumber
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber
....... extension:Adresszusatz 0..1 string additionalLocator
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator
..... city SΣ 1..1 string Stadt
Example General: Erewhon
..... postalCode SΣ 1..1 string Postleitzahl
Example General: 9132
..... country SΣ 1..1 string Land
Binding: Iso3166-1-2 (preferred)
.... address:Postfach SΣC 0..* AddressDeBasis Postfachadresse
Constraints: address-cnt-2or3-char

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... use 0..1 code home | work | temp | old | billing - purpose of this address
..... type 1..1 code postal | physical | both
Fixed Value: postal
..... text 0..1 string Text representation of the address
..... line 0..* string Street name, number, direction & P.O. Box etc.
..... city 0..1 string Name of city, town etc.
..... district 0..1 string District name (aka county)
..... state 0..1 string Sub-unit of country (abbreviations ok)
..... postalCode 0..1 string Postal code for area
..... country 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
..... period 0..1 Period Time period when address was/is in use
..... Slices for extension Content/Rules for all slices
...... extension:Stadtteil 0..1 string Stadt- oder Ortsteil
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-precinct
..... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.
Example General: home
..... type SΣ 1..1 code Adresstyp
Binding: AddressType (required): The type of an address (physical / postal).
Example General: both
..... line SΣ 1..3 string Adresszeile
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
Example Beipiel für Adresszeile mit Extensions für Straße und Hausnummer: Musterweg 42
...... Slices for extension Content/Rules for all slices
....... extension:Postfach 0..1 string Postfachnummer
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox
..... city SΣ 1..1 string Stadt
Example General: Erewhon
..... postalCode SΣ 1..1 string Postleitzahl
Example General: 9132
..... country SΣ 1..1 string Land
Binding: Iso3166-1-2 (preferred)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
RelatedPerson.relationship Base preferred Patient relationship type 📍4.0.1 FHIR Std.
RelatedPerson.name:Name.​use Base required NameUse 📍4.0.1 FHIR Std.
RelatedPerson.telecom.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
RelatedPerson.telecom.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
RelatedPerson.address:Strassenanschrift.​use Base required AddressUse 📍4.0.1 FHIR Std.
RelatedPerson.address:Strassenanschrift.​type Base required AddressType 📍4.0.1 FHIR Std.
RelatedPerson.address:Strassenanschrift.​country Base preferred Iso 3166 Part 1: 2 Letter Codes 📦4.0.1 FHIR Std.
RelatedPerson.address:Postfach.​use Base required AddressUse 📍4.0.1 FHIR Std.
RelatedPerson.address:Postfach.​type Base required AddressType 📍4.0.1 FHIR Std.
RelatedPerson.address:Postfach.​country Base preferred Iso 3166 Part 1: 2 Letter Codes 📦4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
address-cnt-2or3-char warning RelatedPerson.address:Strassenanschrift, RelatedPerson.address:Postfach The content of the country element (if present) SHALL be selected EITHER from ValueSet ISO Country Alpha-2 http://hl7.org/fhir/ValueSet/iso3166-1-2 OR MAY be selected from ISO Country Alpha-3 Value Set http://hl7.org/fhir/ValueSet/iso3166-1-3, IF the country is not specified in value Set ISO Country Alpha-2 http://hl7.org/fhir/ValueSet/iso3166-1-2. country.empty() or (country.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-2') or country.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-3'))
dom-2 error RelatedPerson If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error RelatedPerson If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error RelatedPerson If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error RelatedPerson If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice RelatedPerson A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
relatedp-de-1 error RelatedPerson Falls die Geschlechtsangabe 'other' gewählt wird, muss die amtliche Differenzierung per Extension angegeben werden gender.exists() and gender='other' implies gender.extension('http://fhir.de/StructureDefinition/gender-amtlich-de').exists()

Differential View

This structure is derived from RelatedPerson

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. RelatedPerson C 0..* RelatedPerson A person that is related to a patient, but who is not a direct target of care
Constraints: relatedp-de-1
... id S 0..1 id serverseitige, interne ID des Datensatzes
... meta
.... versionId 0..1 id Eindeutiger Name der serverseitigen Version des Datensatzes
.... lastUpdated 0..1 instant Zeitpunkt der letzten Änderung
... active S 0..1 boolean Status des Datensatzes
.... reference S 1..1 string Patienten-Link
... relationship S 0..* CodeableConcept Verwandtschaftsverhältnis
... Slices for name S 1..* HumanName Offizieller Name der angehörigen Person
Slice: Unordered, Open by pattern:$this
.... name:Name S 1..1 HumannameDeBasis Slice für den offiziellen Namen der angehörigen Person
Required Pattern: At least the following
..... use 1..1 code usual | official | temp | nickname | anonymous | old | maiden
Fixed Value: official
..... use S 0..1 code Verwendungszweck
..... family S 0..1 string Nachname
..... given S 0..* string Vorname
..... prefix S 0..* string Präfix
... telecom S 0..* ContactPoint Telekommunikationsverbindung
.... system S 1..1 code Art der Telekommunikationsverbindung
.... value S 1..1 string Telekommunikations-Endpunkt
... Slices for address S 0..* Address Offizielle Adresse der angehörigen Person
Slice: Unordered, Open by pattern:$this
.... address:Strassenanschrift SC 0..* AddressDeBasis Straßenanschrift
Constraints: address-cnt-2or3-char

Required Pattern: At least the following
..... type 1..1 code postal | physical | both
Fixed Value: both
..... Slices for extension Content/Rules for all slices
...... extension:Stadtteil S 0..1 ADXPPrecinct(5.2.0) precinct
..... type S 1..1 code Adresstyp
..... line S 1..3 string Adresszeile
...... Slices for extension Content/Rules for all slices
....... extension:Strasse 0..1 ADXPStreetName(5.2.0) Strassenname
....... extension:Hausnummer 0..1 ADXPHouseNumber(5.2.0) houseNumber
....... extension:Adresszusatz 0..1 ADXPAdditionalLocator(5.2.0) additionalLocator
....... extension:Postfach 0..0 Postfachnummer
..... city S 1..1 string Stadt
..... postalCode S 1..1 string Postleitzahl
..... country S 1..1 string Land
.... address:Postfach SC 0..* AddressDeBasis Postfachadresse
Constraints: address-cnt-2or3-char

Required Pattern: At least the following
..... type 1..1 code postal | physical | both
Fixed Value: postal
..... type S 1..1 code Adresstyp
..... line S 1..3 string Adresszeile
...... Slices for extension Content/Rules for all slices
....... extension:Strasse 0..0 streetName
....... extension:Hausnummer 0..0 houseNumber
....... extension:Adresszusatz 0..0 additionalLocator
....... extension:Postfach 0..1 ADXPPostBox(5.2.0) Postfachnummer
..... city S 1..1 string Stadt
..... postalCode S 1..1 string Postleitzahl
..... country S 1..1 string Land

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
address-cnt-2or3-char warning RelatedPerson.address:Strassenanschrift, RelatedPerson.address:Postfach The content of the country element (if present) SHALL be selected EITHER from ValueSet ISO Country Alpha-2 http://hl7.org/fhir/ValueSet/iso3166-1-2 OR MAY be selected from ISO Country Alpha-3 Value Set http://hl7.org/fhir/ValueSet/iso3166-1-3, IF the country is not specified in value Set ISO Country Alpha-2 http://hl7.org/fhir/ValueSet/iso3166-1-2. country.empty() or (country.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-2') or country.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-3'))
relatedp-de-1 error RelatedPerson Falls die Geschlechtsangabe 'other' gewählt wird, muss die amtliche Differenzierung per Extension angegeben werden gender.exists() and gender='other' implies gender.extension('http://fhir.de/StructureDefinition/gender-amtlich-de').exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. RelatedPerson C 0..* RelatedPerson A person that is related to a patient, but who is not a direct target of care
Constraints: relatedp-de-1
... id SΣ 0..1 id serverseitige, interne ID des Datensatzes
... meta Σ 0..1 Meta Metadata about the resource
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ 0..1 id Eindeutiger Name der serverseitigen Version des Datensatzes
.... lastUpdated Σ 0..1 instant Zeitpunkt der letzten Änderung
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile Σ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier A human identifier for this person
... active ?!SΣ 0..1 boolean Status des Datensatzes
... patient SΣ 1..1 Reference(Patient) Patientenbezug
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference SΣC 1..1 string Patienten-Link
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... relationship SΣ 0..* CodeableConcept Verwandtschaftsverhältnis
Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person.
... Slices for name SΣ 1..* HumanName Offizieller Name der angehörigen Person
Slice: Unordered, Open by pattern:$this
.... name:Name SΣ 1..1 HumannameDeBasis Slice für den offiziellen Namen der angehörigen Person

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... use 1..1 code usual | official | temp | nickname | anonymous | old | maiden
Fixed Value: official
..... text 0..1 string Text representation of the full name
..... family 0..1 string Family name (often called 'Surname')
..... given 0..* string Given names (not always 'first'). Includes middle names
..... prefix 0..* string Parts that come before the name
..... suffix 0..* string Parts that come after the name
..... period 0..1 Period Time period when name was/is in use
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!SΣ 0..1 code Verwendungszweck
Binding: NameUse (required): The use of a human name.
..... text Σ 0..1 string Text representation of the full name
..... family SΣ 0..1 string Nachname
...... id 0..1 string xml:id (or equivalent in JSON)
...... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... extension:namenszusatz N 0..1 string Namenszusatz gemäß VSDM (Versichertenstammdatenmanagement, "eGK")
URL: http://fhir.de/StructureDefinition/humanname-namenszusatz
....... extension:nachname 0..1 string Nachname ohne Vor- und Zusätze
URL: http://hl7.org/fhir/StructureDefinition/humanname-own-name
....... extension:vorsatzwort 0..1 string Vorsatzwort
URL: http://hl7.org/fhir/StructureDefinition/humanname-own-prefix
...... value 0..1 string Primitive value for string
Max Length:1048576
..... given SΣ 0..* string Vorname
This repeating element order: Given Names appear in the correct order for presenting the name
..... prefix SΣ 0..* string Präfix
This repeating element order: Prefixes appear in the correct order for presenting the name
...... id 0..1 string xml:id (or equivalent in JSON)
...... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... extension:prefix-qualifier 0..1 code LS | AC | NB | PR | HON | BR | AD | SP | MID | CL | IN | VV
URL: http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier
Binding: EntityNamePartQualifier (required)
...... value 0..1 string Primitive value for string
Max Length:1048576
..... suffix Σ 0..* string Namensteile nach dem Nachnamen
This repeating element order: Suffixes appear in the correct order for presenting the name
..... period Σ 0..1 Period Time period when name was/is in use
... telecom SΣ 0..* ContactPoint Telekommunikationsverbindung
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... system SΣC 1..1 code Art der Telekommunikationsverbindung
Binding: ContactPointSystem (required): Telecommunications form for contact point.
.... value SΣ 1..1 string Telekommunikations-Endpunkt
.... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
.... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
.... period Σ 0..1 Period Time period when the contact point was/is in use
... gender Σ 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
... birthDate Σ 0..1 date The date on which the related person was born
... Slices for address SΣ 0..* Address Offizielle Adresse der angehörigen Person
Slice: Unordered, Open by pattern:$this
.... address:Strassenanschrift SΣC 0..* AddressDeBasis Straßenanschrift
Constraints: address-cnt-2or3-char

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... use 0..1 code home | work | temp | old | billing - purpose of this address
..... type 1..1 code postal | physical | both
Fixed Value: both
..... text 0..1 string Text representation of the address
..... line 0..* string Street name, number, direction & P.O. Box etc.
..... city 0..1 string Name of city, town etc.
..... district 0..1 string District name (aka county)
..... state 0..1 string Sub-unit of country (abbreviations ok)
..... postalCode 0..1 string Postal code for area
..... country 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
..... period 0..1 Period Time period when address was/is in use
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... extension:Stadtteil S 0..1 string precinct
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-precinct
..... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.
Example General: home
..... type SΣ 1..1 code Adresstyp
Binding: AddressType (required): The type of an address (physical / postal).
Example General: both
..... text Σ 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
..... line SΣ 1..3 string Adresszeile
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
Example Beipiel für Adresszeile mit Extensions für Straße und Hausnummer: Musterweg 42
...... id 0..1 string xml:id (or equivalent in JSON)
...... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... extension:Strasse 0..1 string Strassenname
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName
....... extension:Hausnummer 0..1 string houseNumber
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber
....... extension:Adresszusatz 0..1 string additionalLocator
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator
...... value 0..1 string Primitive value for string
Max Length:1048576
..... city SΣ 1..1 string Stadt
Example General: Erewhon
..... state Σ 0..1 string Bundesland
Binding: ISO-3166-2:de-Laendercodes (preferred)
..... postalCode SΣ 1..1 string Postleitzahl
Example General: 9132
..... country SΣ 1..1 string Land
Binding: Iso3166-1-2 (preferred)
..... period Σ 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
.... address:Postfach SΣC 0..* AddressDeBasis Postfachadresse
Constraints: address-cnt-2or3-char

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... use 0..1 code home | work | temp | old | billing - purpose of this address
..... type 1..1 code postal | physical | both
Fixed Value: postal
..... text 0..1 string Text representation of the address
..... line 0..* string Street name, number, direction & P.O. Box etc.
..... city 0..1 string Name of city, town etc.
..... district 0..1 string District name (aka county)
..... state 0..1 string Sub-unit of country (abbreviations ok)
..... postalCode 0..1 string Postal code for area
..... country 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
..... period 0..1 Period Time period when address was/is in use
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... extension:Stadtteil 0..1 string Stadt- oder Ortsteil
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-precinct
..... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.
Example General: home
..... type SΣ 1..1 code Adresstyp
Binding: AddressType (required): The type of an address (physical / postal).
Example General: both
..... text Σ 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
..... line SΣ 1..3 string Adresszeile
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
Example Beipiel für Adresszeile mit Extensions für Straße und Hausnummer: Musterweg 42
...... id 0..1 string xml:id (or equivalent in JSON)
...... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... extension:Postfach 0..1 string Postfachnummer
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox
...... value 0..1 string Primitive value for string
Max Length:1048576
..... city SΣ 1..1 string Stadt
Example General: Erewhon
..... state Σ 0..1 string Bundesland
Binding: ISO-3166-2:de-Laendercodes (preferred)
..... postalCode SΣ 1..1 string Postleitzahl
Example General: 9132
..... country SΣ 1..1 string Land
Binding: Iso3166-1-2 (preferred)
..... period Σ 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... photo 0..* Attachment Image of the person
... period 0..1 Period Period of time that this relationship is considered valid
... communication 0..* BackboneElement A language which may be used to communicate with about the patient's health
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... language 1..1 CodeableConcept The language which can be used to communicate with the patient about his or her health
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
.... preferred 0..1 boolean Language preference indicator

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
RelatedPerson.meta.security Base extensible SecurityLabels 📍4.0.1 FHIR Std.
RelatedPerson.meta.tag Base example Common Tags 📍4.0.1 FHIR Std.
RelatedPerson.language Base preferred Common Languages 📍4.0.1 FHIR Std.
RelatedPerson.patient.​type Base extensible ResourceType 📍4.0.1 FHIR Std.
RelatedPerson.relationship Base preferred Patient relationship type 📍4.0.1 FHIR Std.
RelatedPerson.name:Name.​use Base required NameUse 📍4.0.1 FHIR Std.
RelatedPerson.telecom.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
RelatedPerson.telecom.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
RelatedPerson.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
RelatedPerson.address:Strassenanschrift.​use Base required AddressUse 📍4.0.1 FHIR Std.
RelatedPerson.address:Strassenanschrift.​type Base required AddressType 📍4.0.1 FHIR Std.
RelatedPerson.address:Strassenanschrift.​state Base preferred ISO-3166-2:de-Laendercodes 📦1.5.4 de.basisprofil.r4 v1.5
RelatedPerson.address:Strassenanschrift.​country Base preferred Iso 3166 Part 1: 2 Letter Codes 📦4.0.1 FHIR Std.
RelatedPerson.address:Postfach.​use Base required AddressUse 📍4.0.1 FHIR Std.
RelatedPerson.address:Postfach.​type Base required AddressType 📍4.0.1 FHIR Std.
RelatedPerson.address:Postfach.​state Base preferred ISO-3166-2:de-Laendercodes 📦1.5.4 de.basisprofil.r4 v1.5
RelatedPerson.address:Postfach.​country Base preferred Iso 3166 Part 1: 2 Letter Codes 📦4.0.1 FHIR Std.
RelatedPerson.communication.​language Base preferred Common Languages 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
address-cnt-2or3-char warning RelatedPerson.address:Strassenanschrift, RelatedPerson.address:Postfach The content of the country element (if present) SHALL be selected EITHER from ValueSet ISO Country Alpha-2 http://hl7.org/fhir/ValueSet/iso3166-1-2 OR MAY be selected from ISO Country Alpha-3 Value Set http://hl7.org/fhir/ValueSet/iso3166-1-3, IF the country is not specified in value Set ISO Country Alpha-2 http://hl7.org/fhir/ValueSet/iso3166-1-2. country.empty() or (country.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-2') or country.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-3'))
dom-2 error RelatedPerson If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error RelatedPerson If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error RelatedPerson If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error RelatedPerson If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice RelatedPerson A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
relatedp-de-1 error RelatedPerson Falls die Geschlechtsangabe 'other' gewählt wird, muss die amtliche Differenzierung per Extension angegeben werden gender.exists() and gender='other' implies gender.extension('http://fhir.de/StructureDefinition/gender-amtlich-de').exists()

This structure is derived from RelatedPerson

Summary

Mandatory: 3 elements(12 nested mandatory elements)
Must-Support: 28 elements
Prohibited: 4 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of RelatedPerson.name
  • The element 1 is sliced based on the value of RelatedPerson.address

 

Other representations of profile: CSV, Excel, Schematron