Recare Search FHIR Implementation Guide
0.1.0 - ci-build Germany flag

Recare Search FHIR Implementation Guide - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: Recare Guardian

Official URL: http://fhir.recareai.com/StructureDefinition/recare-guardian Version: 0.1.0
Active as of 2026-04-15 Computable Name: RecareGuardian

Related person (guardian or family member) who acts as the requester for a patient in Admissions API bundles (ISiP Angehöriger). Also claims compliance with ISiKAngehoeriger in meta.profile.

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..* ISiPAngehoeriger A person that is related to a patient, but who is not a direct target of care
Constraints: relatedp-de-1
... id Σ 1..1 id Logical id of this artifact
... 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(ISiPPflegeempfaenger) The patient this person is related to
.... reference ΣC 1..1 string Literal reference, Relative, internal or absolute URL
... relationship SΣ 1..* CodeableConcept The nature of the relationship
Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person.
.... coding SΣ 1..* Coding Code defined by a terminology system
... name SΣ 1..1 HumannameDeBasis(1.6.0-ballot) A name associated with the person
.... use ?!Σ 1..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
.... family Σ 1..1 string Familienname
..... Slices for extension Content/Rules for all slices
...... extension:namenszusatz 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 Σ 1..* string Vorname
This repeating element order: Given Names appear in the correct order for presenting the name
... telecom SΣ 0..* ContactPoint A contact detail for the person
.... system SΣC 0..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
.... value SΣ 0..1 string The actual contact point details
.... 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 Address where the related person can be contacted or visited
Slice: Unordered, Open by pattern:$this
.... address:Strassenanschrift SΣ 0..* AddressDeBasis(1.6.0-ballot) Address where the related person can be contacted or visited

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 postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).
Example General: both
..... line SΣ 1..3 string Straßenname mit Hausnummer oder Postfach sowie weitere Angaben zur Zustellung
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
Example Beispiel für Adresszeile mit Extensions für Straße und Hausnummer: Musterweg 42
...... Slices for extension Content/Rules for all slices
....... extension:Strasse S 0..1 string streetName
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName
....... extension:Hausnummer S 0..1 string houseNumber
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber
....... extension:Adresszusatz S 0..1 string additionalLocator
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator
..... city SΣ 1..1 string Name of city, town etc.
Example General: Erewhon
..... postalCode SΣ 1..1 string Postleitzahl
Example General: 9132
..... country SΣC 1..1 string Staat
Constraints: address-cnt-2or3-char
Example Beispiel für textuelle Landesangabe: Deutschland
...... Slices for extension Content/Rules for all slices
....... extension:countryCode 0..1 (Complex) Länderkennzeichen nach ISO 3166-1
URL: http://hl7.org/fhir/StructureDefinition/iso21090-codedString

Example Beispiel für kodierte Landesangabe: {"system":"urn:iso:std:iso:3166","code":"DE","display":"Deutschland"}
........ extension 0..0 Additional content defined by implementations
Slice: Unordered, Open by value:url
........ url 1..1 uri "http://hl7.org/fhir/StructureDefinition/iso21090-codedString"
........ value[x] 1..1 Coding Value of extension
Binding: Iso3166-1-2 (required): A coded representation for a string. Could be codes for country in a country address part, codes for prefixes in a name part, etc.
.... address:Postfach SΣ 0..* AddressDeBasis(1.6.0-ballot) Address where the related person can be contacted or visited

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 postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).
Example General: both
..... line SΣ 1..3 string Straßenname mit Hausnummer oder Postfach sowie weitere Angaben zur Zustellung
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
Example Beispiel für Adresszeile mit Extensions für Straße und Hausnummer: Musterweg 42
...... Slices for extension Content/Rules for all slices
....... extension:Postfach S 0..1 string postBox
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox
..... city SΣ 1..1 string Name of city, town etc.
Example General: Erewhon
..... postalCode SΣ 1..1 string Postleitzahl
Example General: 9132
..... country SΣC 1..1 string Staat
Constraints: address-cnt-2or3-char
Example Beispiel für textuelle Landesangabe: Deutschland
...... Slices for extension Content/Rules for all slices
....... extension:countryCode 0..1 (Complex) Länderkennzeichen nach ISO 3166-1
URL: http://hl7.org/fhir/StructureDefinition/iso21090-codedString

Example Beispiel für kodierte Landesangabe: {"system":"urn:iso:std:iso:3166","code":"DE","display":"Deutschland"}
........ extension 0..0 Additional content defined by implementations
Slice: Unordered, Open by value:url
........ url 1..1 uri "http://hl7.org/fhir/StructureDefinition/iso21090-codedString"
........ value[x] 1..1 Coding Value of extension
Binding: Iso3166-1-2 (required): A coded representation for a string. Could be codes for country in a country address part, codes for prefixes in a name part, etc.

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.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.extension:countryCode.​value[x] Base required 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.extension:countryCode.​value[x] Base required 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.country, RelatedPerson.address:Postfach.country 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 ISiPAngehoeriger

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. RelatedPerson 0..* ISiPAngehoeriger A person that is related to a patient, but who is not a direct target of care
... id 1..1 id Logical id of this artifact
... relationship 1..* CodeableConcept The nature of the relationship
... name
.... use 1..1 code usual | official | temp | nickname | anonymous | old | maiden
.... family 1..1 string Familienname
.... given 1..* string Vorname

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. RelatedPerson C 0..* ISiPAngehoeriger A person that is related to a patient, but who is not a direct target of care
Constraints: relatedp-de-1
... id Σ 1..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... 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 ?!Σ 0..1 boolean Whether this related person's record is in active use
... patient SΣ 1..1 Reference(ISiPPflegeempfaenger) The patient this person is related to
.... 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 ΣC 1..1 string Literal reference, Relative, internal or absolute URL
.... 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Σ 1..* CodeableConcept The nature of the relationship
Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person.
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... coding SΣ 1..* Coding Code defined by a terminology system
.... text Σ 0..1 string Plain text representation of the concept
... name SΣ 1..1 HumannameDeBasis(1.6.0-ballot) A name associated with the person
.... 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 ?!Σ 1..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
.... text Σ 0..1 string Text representation of the full name
.... family Σ 1..1 string Familienname
..... 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:namenszusatz 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 Σ 1..* string Vorname
This repeating element order: Given Names appear in the correct order for presenting the name
.... prefix Σ 0..* string Namensteile vor dem Vornamen
This repeating element order: Prefixes appear in the correct order for presenting the name
..... 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: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 ΣC 0..1 Period Time period when name was/is in use
Constraints: per-1
... telecom SΣ 0..* ContactPoint A contact detail for the person
.... 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 0..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
.... value SΣ 0..1 string The actual contact point details
.... 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.
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:Geschlecht-Administrativ 0..* Coding Optional Extensions Element
URL: http://fhir.de/StructureDefinition/gender-amtlich-de
Binding: GenderOtherDE ValueSet (required)
.... value 0..1 string Primitive value for code
... birthDate Σ 0..1 date The date on which the related person was born
... Slices for address SΣ 0..* Address Address where the related person can be contacted or visited
Slice: Unordered, Open by pattern:$this
.... address:Strassenanschrift SΣ 0..* AddressDeBasis(1.6.0-ballot) Address where the related person can be contacted or visited

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 postal | physical | both
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 Straßenname mit Hausnummer oder Postfach sowie weitere Angaben zur Zustellung
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
Example Beispiel für Adresszeile mit Extensions für Straße und Hausnummer: Musterweg 42
...... 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:Strasse S 0..1 string streetName
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName
....... extension:Hausnummer S 0..1 string houseNumber
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber
....... extension:Adresszusatz S 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 Name of city, town etc.
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ΣC 1..1 string Staat
Constraints: address-cnt-2or3-char
Example Beispiel für textuelle Landesangabe: Deutschland
...... 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, value:value.ofType(Coding).system
....... extension:countryCode 0..1 (Complex) Länderkennzeichen nach ISO 3166-1
URL: http://hl7.org/fhir/StructureDefinition/iso21090-codedString

Example Beispiel für kodierte Landesangabe: {"system":"urn:iso:std:iso:3166","code":"DE","display":"Deutschland"}
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..0 Additional content defined by implementations
Slice: Unordered, Open by value:url
........ url 1..1 uri "http://hl7.org/fhir/StructureDefinition/iso21090-codedString"
........ value[x] 1..1 Coding Value of extension
Binding: Iso3166-1-2 (required): A coded representation for a string. Could be codes for country in a country address part, codes for prefixes in a name part, etc.
...... value 0..1 string Primitive value for string
Max Length:1048576
..... period ΣC 0..1 Period Time period when address was/is in use
Constraints: per-1
Example General: {"start":"2010-03-23","end":"2010-07-01"}
.... address:Postfach SΣ 0..* AddressDeBasis(1.6.0-ballot) Address where the related person can be contacted or visited

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 postal | physical | both
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 Straßenname mit Hausnummer oder Postfach sowie weitere Angaben zur Zustellung
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
Example Beispiel für Adresszeile mit Extensions für Straße und Hausnummer: Musterweg 42
...... 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:Postfach S 0..1 string postBox
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 Name of city, town etc.
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ΣC 1..1 string Staat
Constraints: address-cnt-2or3-char
Example Beispiel für textuelle Landesangabe: Deutschland
...... 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, value:value.ofType(Coding).system
....... extension:countryCode 0..1 (Complex) Länderkennzeichen nach ISO 3166-1
URL: http://hl7.org/fhir/StructureDefinition/iso21090-codedString

Example Beispiel für kodierte Landesangabe: {"system":"urn:iso:std:iso:3166","code":"DE","display":"Deutschland"}
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..0 Additional content defined by implementations
Slice: Unordered, Open by value:url
........ url 1..1 uri "http://hl7.org/fhir/StructureDefinition/iso21090-codedString"
........ value[x] 1..1 Coding Value of extension
Binding: Iso3166-1-2 (required): A coded representation for a string. Could be codes for country in a country address part, codes for prefixes in a name part, etc.
...... value 0..1 string Primitive value for string
Max Length:1048576
..... period ΣC 0..1 Period Time period when address was/is in use
Constraints: per-1
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.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.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.6.0-ballot de.basisprofil.r4 v1.6
RelatedPerson.address:Strassenanschrift.​country.extension:countryCode.​value[x] Base required 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.6.0-ballot de.basisprofil.r4 v1.6
RelatedPerson.address:Postfach.​country.extension:countryCode.​value[x] Base required 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.country, RelatedPerson.address:Postfach.country 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()
per-1 error RelatedPerson.name.period, RelatedPerson.address:Strassenanschrift.period, RelatedPerson.address:Postfach.period If present, start SHALL have a lower value than end start.hasValue().not() or end.hasValue().not() or (start <= end)
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 ISiPAngehoeriger

Summary

Mandatory: 5 elements

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. RelatedPerson C 0..* ISiPAngehoeriger A person that is related to a patient, but who is not a direct target of care
Constraints: relatedp-de-1
... id Σ 1..1 id Logical id of this artifact
... 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(ISiPPflegeempfaenger) The patient this person is related to
.... reference ΣC 1..1 string Literal reference, Relative, internal or absolute URL
... relationship SΣ 1..* CodeableConcept The nature of the relationship
Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person.
.... coding SΣ 1..* Coding Code defined by a terminology system
... name SΣ 1..1 HumannameDeBasis(1.6.0-ballot) A name associated with the person
.... use ?!Σ 1..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
.... family Σ 1..1 string Familienname
..... Slices for extension Content/Rules for all slices
...... extension:namenszusatz 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 Σ 1..* string Vorname
This repeating element order: Given Names appear in the correct order for presenting the name
... telecom SΣ 0..* ContactPoint A contact detail for the person
.... system SΣC 0..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
.... value SΣ 0..1 string The actual contact point details
.... 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 Address where the related person can be contacted or visited
Slice: Unordered, Open by pattern:$this
.... address:Strassenanschrift SΣ 0..* AddressDeBasis(1.6.0-ballot) Address where the related person can be contacted or visited

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 postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).
Example General: both
..... line SΣ 1..3 string Straßenname mit Hausnummer oder Postfach sowie weitere Angaben zur Zustellung
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
Example Beispiel für Adresszeile mit Extensions für Straße und Hausnummer: Musterweg 42
...... Slices for extension Content/Rules for all slices
....... extension:Strasse S 0..1 string streetName
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName
....... extension:Hausnummer S 0..1 string houseNumber
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber
....... extension:Adresszusatz S 0..1 string additionalLocator
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator
..... city SΣ 1..1 string Name of city, town etc.
Example General: Erewhon
..... postalCode SΣ 1..1 string Postleitzahl
Example General: 9132
..... country SΣC 1..1 string Staat
Constraints: address-cnt-2or3-char
Example Beispiel für textuelle Landesangabe: Deutschland
...... Slices for extension Content/Rules for all slices
....... extension:countryCode 0..1 (Complex) Länderkennzeichen nach ISO 3166-1
URL: http://hl7.org/fhir/StructureDefinition/iso21090-codedString

Example Beispiel für kodierte Landesangabe: {"system":"urn:iso:std:iso:3166","code":"DE","display":"Deutschland"}
........ extension 0..0 Additional content defined by implementations
Slice: Unordered, Open by value:url
........ url 1..1 uri "http://hl7.org/fhir/StructureDefinition/iso21090-codedString"
........ value[x] 1..1 Coding Value of extension
Binding: Iso3166-1-2 (required): A coded representation for a string. Could be codes for country in a country address part, codes for prefixes in a name part, etc.
.... address:Postfach SΣ 0..* AddressDeBasis(1.6.0-ballot) Address where the related person can be contacted or visited

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 postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).
Example General: both
..... line SΣ 1..3 string Straßenname mit Hausnummer oder Postfach sowie weitere Angaben zur Zustellung
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
Example Beispiel für Adresszeile mit Extensions für Straße und Hausnummer: Musterweg 42
...... Slices for extension Content/Rules for all slices
....... extension:Postfach S 0..1 string postBox
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox
..... city SΣ 1..1 string Name of city, town etc.
Example General: Erewhon
..... postalCode SΣ 1..1 string Postleitzahl
Example General: 9132
..... country SΣC 1..1 string Staat
Constraints: address-cnt-2or3-char
Example Beispiel für textuelle Landesangabe: Deutschland
...... Slices for extension Content/Rules for all slices
....... extension:countryCode 0..1 (Complex) Länderkennzeichen nach ISO 3166-1
URL: http://hl7.org/fhir/StructureDefinition/iso21090-codedString

Example Beispiel für kodierte Landesangabe: {"system":"urn:iso:std:iso:3166","code":"DE","display":"Deutschland"}
........ extension 0..0 Additional content defined by implementations
Slice: Unordered, Open by value:url
........ url 1..1 uri "http://hl7.org/fhir/StructureDefinition/iso21090-codedString"
........ value[x] 1..1 Coding Value of extension
Binding: Iso3166-1-2 (required): A coded representation for a string. Could be codes for country in a country address part, codes for prefixes in a name part, etc.

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.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.extension:countryCode.​value[x] Base required 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.extension:countryCode.​value[x] Base required 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.country, RelatedPerson.address:Postfach.country 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 ISiPAngehoeriger

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. RelatedPerson 0..* ISiPAngehoeriger A person that is related to a patient, but who is not a direct target of care
... id 1..1 id Logical id of this artifact
... relationship 1..* CodeableConcept The nature of the relationship
... name
.... use 1..1 code usual | official | temp | nickname | anonymous | old | maiden
.... family 1..1 string Familienname
.... given 1..* string Vorname

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. RelatedPerson C 0..* ISiPAngehoeriger A person that is related to a patient, but who is not a direct target of care
Constraints: relatedp-de-1
... id Σ 1..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... 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 ?!Σ 0..1 boolean Whether this related person's record is in active use
... patient SΣ 1..1 Reference(ISiPPflegeempfaenger) The patient this person is related to
.... 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 ΣC 1..1 string Literal reference, Relative, internal or absolute URL
.... 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Σ 1..* CodeableConcept The nature of the relationship
Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person.
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... coding SΣ 1..* Coding Code defined by a terminology system
.... text Σ 0..1 string Plain text representation of the concept
... name SΣ 1..1 HumannameDeBasis(1.6.0-ballot) A name associated with the person
.... 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 ?!Σ 1..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
.... text Σ 0..1 string Text representation of the full name
.... family Σ 1..1 string Familienname
..... 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:namenszusatz 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 Σ 1..* string Vorname
This repeating element order: Given Names appear in the correct order for presenting the name
.... prefix Σ 0..* string Namensteile vor dem Vornamen
This repeating element order: Prefixes appear in the correct order for presenting the name
..... 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: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 ΣC 0..1 Period Time period when name was/is in use
Constraints: per-1
... telecom SΣ 0..* ContactPoint A contact detail for the person
.... 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 0..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
.... value SΣ 0..1 string The actual contact point details
.... 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.
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:Geschlecht-Administrativ 0..* Coding Optional Extensions Element
URL: http://fhir.de/StructureDefinition/gender-amtlich-de
Binding: GenderOtherDE ValueSet (required)
.... value 0..1 string Primitive value for code
... birthDate Σ 0..1 date The date on which the related person was born
... Slices for address SΣ 0..* Address Address where the related person can be contacted or visited
Slice: Unordered, Open by pattern:$this
.... address:Strassenanschrift SΣ 0..* AddressDeBasis(1.6.0-ballot) Address where the related person can be contacted or visited

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 postal | physical | both
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 Straßenname mit Hausnummer oder Postfach sowie weitere Angaben zur Zustellung
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
Example Beispiel für Adresszeile mit Extensions für Straße und Hausnummer: Musterweg 42
...... 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:Strasse S 0..1 string streetName
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName
....... extension:Hausnummer S 0..1 string houseNumber
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber
....... extension:Adresszusatz S 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 Name of city, town etc.
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ΣC 1..1 string Staat
Constraints: address-cnt-2or3-char
Example Beispiel für textuelle Landesangabe: Deutschland
...... 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, value:value.ofType(Coding).system
....... extension:countryCode 0..1 (Complex) Länderkennzeichen nach ISO 3166-1
URL: http://hl7.org/fhir/StructureDefinition/iso21090-codedString

Example Beispiel für kodierte Landesangabe: {"system":"urn:iso:std:iso:3166","code":"DE","display":"Deutschland"}
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..0 Additional content defined by implementations
Slice: Unordered, Open by value:url
........ url 1..1 uri "http://hl7.org/fhir/StructureDefinition/iso21090-codedString"
........ value[x] 1..1 Coding Value of extension
Binding: Iso3166-1-2 (required): A coded representation for a string. Could be codes for country in a country address part, codes for prefixes in a name part, etc.
...... value 0..1 string Primitive value for string
Max Length:1048576
..... period ΣC 0..1 Period Time period when address was/is in use
Constraints: per-1
Example General: {"start":"2010-03-23","end":"2010-07-01"}
.... address:Postfach SΣ 0..* AddressDeBasis(1.6.0-ballot) Address where the related person can be contacted or visited

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 postal | physical | both
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 Straßenname mit Hausnummer oder Postfach sowie weitere Angaben zur Zustellung
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
Example Beispiel für Adresszeile mit Extensions für Straße und Hausnummer: Musterweg 42
...... 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:Postfach S 0..1 string postBox
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 Name of city, town etc.
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ΣC 1..1 string Staat
Constraints: address-cnt-2or3-char
Example Beispiel für textuelle Landesangabe: Deutschland
...... 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, value:value.ofType(Coding).system
....... extension:countryCode 0..1 (Complex) Länderkennzeichen nach ISO 3166-1
URL: http://hl7.org/fhir/StructureDefinition/iso21090-codedString

Example Beispiel für kodierte Landesangabe: {"system":"urn:iso:std:iso:3166","code":"DE","display":"Deutschland"}
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..0 Additional content defined by implementations
Slice: Unordered, Open by value:url
........ url 1..1 uri "http://hl7.org/fhir/StructureDefinition/iso21090-codedString"
........ value[x] 1..1 Coding Value of extension
Binding: Iso3166-1-2 (required): A coded representation for a string. Could be codes for country in a country address part, codes for prefixes in a name part, etc.
...... value 0..1 string Primitive value for string
Max Length:1048576
..... period ΣC 0..1 Period Time period when address was/is in use
Constraints: per-1
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.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.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.6.0-ballot de.basisprofil.r4 v1.6
RelatedPerson.address:Strassenanschrift.​country.extension:countryCode.​value[x] Base required 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.6.0-ballot de.basisprofil.r4 v1.6
RelatedPerson.address:Postfach.​country.extension:countryCode.​value[x] Base required 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.country, RelatedPerson.address:Postfach.country 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()
per-1 error RelatedPerson.name.period, RelatedPerson.address:Strassenanschrift.period, RelatedPerson.address:Postfach.period If present, start SHALL have a lower value than end start.hasValue().not() or end.hasValue().not() or (start <= end)
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 ISiPAngehoeriger

Summary

Mandatory: 5 elements

 

Other representations of profile: CSV, Excel, Schematron