| Offizielle URL: https://gematik.de/fhir/ti/StructureDefinition/ti-related-person | Version: 1.5.0 | |||
| Active Stand: 2026-11-16 | Maschinenlesbarer Name: TIRelatedPerson | |||
Copyright/Rechtliches: gematik GmbH / Dieses Artefakt ist lizenziert unter Apache License, Version 2.0. |
||||
Dieses Profil bildet eine Kontakt- oder Bezugsperson ab.
Usages:
You can also check for usages in the FHIR IG Statistics
Beschreibung von Profilen, Differentials, Snapshots und deren Repräsentationen.
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | RelatedPerson | A person that is related to a patient, but who is not a direct target of care Constraints: dom-2, dom-3, dom-4, dom-5, dom-6, pat-de-1 |
![]() ![]() |
SΣ | 0..1 | Meta | Metadata about the resource |
![]() ![]() ![]() |
SΣ | 0..1 | id | Version specific identifier |
![]() ![]() ![]() |
SΣ | 0..1 | instant | When the resource version last changed |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
S | 0..* | Extension | Extension Slice: Unordered, Open by value:url |
![]() ![]() ![]() |
S | 0..1 | (Complex) | Additional notes that apply to this resource or element. URL: http://hl7.org/fhir/StructureDefinition/note |
![]() ![]() ![]() ![]() |
0..0 | Additional content defined by implementations Slice: Unordered, Open by value:url | ||
![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/note" | |
![]() ![]() ![]() ![]() |
S | 1..1 | Annotation | Notes for this resource/element |
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | dateTime | When the annotation was made |
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | markdown | The annotation - text content (as markdown) |
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url |
![]() ![]() |
?!Σ | 0..1 | boolean | Whether this related person's record is in active use |
![]() ![]() |
SΣC | 1..1 | Reference(TI Patient) | The patient this person is related to Constraints: ref-1 |
![]() ![]() ![]() |
SΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL |
![]() ![]() ![]() |
SΣ | 0..1 | Identifier | Logical reference, when literal reference is not known |
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | The value that is unique Example General: 123456 |
![]() ![]() ![]() |
SΣ | 0..1 | string | Text alternative for the resource |
![]() ![]() |
SΣ | 0..* | CodeableConcept | The nature of the relationship Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person. |
![]() ![]() ![]() |
SΣ | 0..* | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | uri | Identity of the terminology system |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Version of the system - if relevant |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | code | Symbol in syntax defined by the system |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Representation defined by the system |
![]() ![]() |
SΣ | 0..* | HumanName | A name associated with the person Slice: Unordered, Open by value:$this |
![]() ![]() ![]() |
SΣ | 0..1 | TIHumanName | A name associated with the person Required Pattern: At least the following |
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() |
1..1 | code | usual | official | temp | nickname | anonymous | old | maiden Fixed Value: official | |
![]() ![]() ![]() ![]() |
0..1 | string | Text representation of the full name | |
![]() ![]() ![]() ![]() |
0..1 | string | Family name (often called 'Surname') | |
![]() ![]() ![]() ![]() |
0..* | string | Given names (not always 'first'). Includes middle names | |
![]() ![]() ![]() ![]() |
0..* | string | Parts that come before the name | |
![]() ![]() ![]() ![]() |
0..* | string | Parts that come after the name | |
![]() ![]() ![]() ![]() |
0..1 | Period | Time period when name was/is in use | |
![]() ![]() ![]() |
SΣ | 0..1 | TIBirthName | A name associated with the person Required Pattern: At least the following |
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() |
1..1 | code | usual | official | temp | nickname | anonymous | old | maiden Fixed Value: maiden | |
![]() ![]() ![]() ![]() |
0..1 | string | Text representation of the full name | |
![]() ![]() ![]() ![]() |
0..1 | string | Family name (often called 'Surname') | |
![]() ![]() ![]() ![]() |
0..* | string | Given names (not always 'first'). Includes middle names | |
![]() ![]() ![]() ![]() |
0..* | string | Parts that come before the name | |
![]() ![]() ![]() ![]() |
0..* | string | Parts that come after the name | |
![]() ![]() ![]() ![]() |
0..1 | Period | Time period when name was/is in use | |
![]() ![]() |
SΣC | 0..* | ContactPoint | A contact detail for the person Constraints: cpt-2 |
![]() ![]() ![]() |
SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. |
![]() ![]() ![]() |
SΣ | 1..1 | string | The actual contact point details |
![]() ![]() ![]() |
?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. |
![]() ![]() |
SΣ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. |
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
0..1 | Coding | Optional Extensions Element URL: http://fhir.de/StructureDefinition/gender-amtlich-de Binding: GenderOtherDE ValueSet (required) | |
![]() ![]() |
SΣ | 0..* | Address | Address where the related person can be contacted or visited |
![]() ![]() ![]() |
?!SΣ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home |
![]() ![]() ![]() |
SΣ | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 |
![]() ![]() ![]() |
SΣ | 0..* | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street |
![]() ![]() ![]() |
SΣ | 0..1 | string | Name of city, town etc. Example General: Erewhon |
![]() ![]() ![]() |
SΣ | 0..1 | string | Sub-unit of country (abbreviations ok) |
![]() ![]() ![]() |
SΣ | 0..1 | string | Postal code for area Example General: 9132 |
![]() ![]() ![]() |
SΣ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| RelatedPerson.patient.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| RelatedPerson.relationship | Base | preferred | Patient relationship type | 📍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.use | Base | required | AddressUse | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| cpt-2 | error | RelatedPerson.telecom | A system is required if a value is provided. |
value.empty() or system.exists()
|
| 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()
|
| pat-de-1 | error | RelatedPerson | Die amtliche Differenzierung der Geschlechtsangabe 'other' darf nur gefüllt sein, wenn das Geschlecht 'other' angegeben ist |
gender.exists() and gender='other' implies gender.extension('http://fhir.de/StructureDefinition/gender-amtlich-de').exists()
|
| ref-1 | error | RelatedPerson.patient | SHALL have a contained resource if a local reference is provided |
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
|
Diese Struktur ist abgeleitet von RelatedPerson
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | RelatedPerson | A person that is related to a patient, but who is not a direct target of care Constraints: pat-de-1 |
![]() ![]() |
S | 0..1 | Meta | Metadata about the resource |
![]() ![]() ![]() |
S | 0..1 | id | Version specific identifier |
![]() ![]() ![]() |
S | 0..1 | instant | When the resource version last changed |
![]() ![]() |
S | 0..* | Extension | Extension |
![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() |
S | 0..1 | (Complex) | Additional notes that apply to this resource or element. URL: http://hl7.org/fhir/StructureDefinition/note |
![]() ![]() ![]() ![]() |
S | 1..1 | Annotation | Notes for this resource/element |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | dateTime | When the annotation was made |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | markdown | The annotation - text content (as markdown) |
![]() ![]() |
S | 1..1 | Reference(TI Patient) | The patient this person is related to |
![]() ![]() ![]() |
S | 0..1 | string | Literal reference, Relative, internal or absolute URL |
![]() ![]() ![]() |
S | 0..1 | Identifier | Logical reference, when literal reference is not known |
![]() ![]() ![]() ![]() |
S | 0..1 | uri | The namespace for the identifier value |
![]() ![]() ![]() ![]() |
S | 0..1 | string | The value that is unique |
![]() ![]() ![]() |
S | 0..1 | string | Text alternative for the resource |
![]() ![]() |
S | 0..* | CodeableConcept | The nature of the relationship |
![]() ![]() ![]() |
S | 0..* | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() |
S | 0..1 | uri | Identity of the terminology system |
![]() ![]() ![]() ![]() |
S | 0..1 | string | Version of the system - if relevant |
![]() ![]() ![]() ![]() |
S | 0..1 | code | Symbol in syntax defined by the system |
![]() ![]() ![]() ![]() |
S | 0..1 | string | Representation defined by the system |
![]() ![]() |
S | 0..* | HumanName | A name associated with the person Slice: Unordered, Open by value:$this |
![]() ![]() ![]() |
S | 0..1 | TIHumanName | A name associated with the person Required Pattern: At least the following |
![]() ![]() ![]() ![]() |
1..1 | code | usual | official | temp | nickname | anonymous | old | maiden Fixed Value: official | |
![]() ![]() ![]() |
S | 0..1 | TIBirthName | A name associated with the person Required Pattern: At least the following |
![]() ![]() ![]() ![]() |
1..1 | code | usual | official | temp | nickname | anonymous | old | maiden Fixed Value: maiden | |
![]() ![]() |
S | 0..* | ContactPoint | A contact detail for the person |
![]() ![]() ![]() |
S | 1..1 | code | phone | fax | email | pager | url | sms | other |
![]() ![]() ![]() |
S | 1..1 | string | The actual contact point details |
![]() ![]() |
S | 0..1 | code | male | female | other | unknown |
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
0..1 | Coding | Optional Extensions Element URL: http://fhir.de/StructureDefinition/gender-amtlich-de Binding: GenderOtherDE ValueSet (required) | |
![]() ![]() |
S | 0..* | Address | Address where the related person can be contacted or visited |
![]() ![]() ![]() |
S | 0..1 | code | home | work | temp | old | billing - purpose of this address |
![]() ![]() ![]() |
S | 0..1 | string | Text representation of the address |
![]() ![]() ![]() |
S | 0..* | string | Street name, number, direction & P.O. Box etc. |
![]() ![]() ![]() |
S | 0..1 | string | Name of city, town etc. |
![]() ![]() ![]() |
S | 0..1 | string | Sub-unit of country (abbreviations ok) |
![]() ![]() ![]() |
S | 0..1 | string | Postal code for area |
![]() ![]() ![]() |
S | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) |
Documentation for this format | ||||
| Id | Grade | Path(s) | Description | Expression |
| pat-de-1 | error | RelatedPerson | Die amtliche Differenzierung der Geschlechtsangabe 'other' darf nur gefüllt sein, wenn das Geschlecht 'other' angegeben ist |
gender.exists() and gender='other' implies gender.extension('http://fhir.de/StructureDefinition/gender-amtlich-de').exists()
|
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
C | 0..* | RelatedPerson | A person that is related to a patient, but who is not a direct target of care Constraints: dom-2, dom-3, dom-4, dom-5, dom-6, pat-de-1 | ||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
SΣ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
SΣ | 0..1 | id | Version specific identifier | ||||
![]() ![]() ![]() |
SΣ | 0..1 | instant | When the resource version last changed | ||||
![]() ![]() ![]() |
Σ | 0..1 | uri | Identifies where the resource comes from | ||||
![]() ![]() ![]() |
Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
![]() ![]() ![]() |
Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
![]() ![]() ![]() |
Σ | 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". | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() |
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 | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
S | 0..* | Extension | Extension Slice: Unordered, Open by value:url | ||||
![]() ![]() ![]() |
S | 0..1 | (Complex) | Additional notes that apply to this resource or element. URL: http://hl7.org/fhir/StructureDefinition/note | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..0 | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||||
![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/note" | |||||
![]() ![]() ![]() ![]() |
S | 1..1 | Annotation | Notes for this resource/element | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Individual responsible for the annotation | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
Reference(Practitioner | Patient | RelatedPerson | Organization) | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
string | |||||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | dateTime | When the annotation was made | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | markdown | The annotation - text content (as markdown) | ||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url | ||||
![]() ![]() |
Σ | 0..* | Identifier | A human identifier for this person | ||||
![]() ![]() |
?!Σ | 0..1 | boolean | Whether this related person's record is in active use | ||||
![]() ![]() |
SΣC | 1..1 | Reference(TI Patient) | The patient this person is related to Constraints: ref-1 | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
SΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() |
Σ | 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). | ||||
![]() ![]() ![]() |
SΣ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | The value that is unique Example General: 123456 | ||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | Period | Time period when id is/was valid for use Constraints: per-1 | ||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | Reference(Organization) | Organization that issued id (may be just text) Constraints: ref-1 | ||||
![]() ![]() ![]() |
SΣ | 0..1 | string | Text alternative for the resource | ||||
![]() ![]() |
SΣ | 0..* | CodeableConcept | The nature of the relationship Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person. | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
SΣ | 0..* | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | uri | Identity of the terminology system | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | code | Symbol in syntax defined by the system | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() |
SΣ | 0..* | HumanName | A name associated with the person Slice: Unordered, Open by value:$this | ||||
![]() ![]() ![]() |
SΣ | 0..1 | TIHumanName | A name associated with the person Required Pattern: At least the following | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
1..1 | code | usual | official | temp | nickname | anonymous | old | maiden Fixed Value: official | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Text representation of the full name | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Family name (often called 'Surname') | |||||
![]() ![]() ![]() ![]() |
0..* | string | Given names (not always 'first'). Includes middle names | |||||
![]() ![]() ![]() ![]() |
0..* | string | Parts that come before the name | |||||
![]() ![]() ![]() ![]() |
0..* | string | Parts that come after the name | |||||
![]() ![]() ![]() ![]() |
0..1 | Period | Time period when name was/is in use | |||||
![]() ![]() ![]() |
SΣ | 0..1 | TIBirthName | A name associated with the person Required Pattern: At least the following | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
1..1 | code | usual | official | temp | nickname | anonymous | old | maiden Fixed Value: maiden | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Text representation of the full name | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Family name (often called 'Surname') | |||||
![]() ![]() ![]() ![]() |
0..* | string | Given names (not always 'first'). Includes middle names | |||||
![]() ![]() ![]() ![]() |
0..* | string | Parts that come before the name | |||||
![]() ![]() ![]() ![]() |
0..* | string | Parts that come after the name | |||||
![]() ![]() ![]() ![]() |
0..1 | Period | Time period when name was/is in use | |||||
![]() ![]() |
SΣC | 0..* | ContactPoint | A contact detail for the person Constraints: cpt-2 | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. | ||||
![]() ![]() ![]() |
SΣ | 1..1 | string | The actual contact point details | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||
![]() ![]() ![]() |
Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
![]() ![]() ![]() |
ΣC | 0..1 | Period | Time period when the contact point was/is in use Constraints: per-1 | ||||
![]() ![]() |
SΣ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | ||||
![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
0..1 | Coding | Optional Extensions Element URL: http://fhir.de/StructureDefinition/gender-amtlich-de Binding: GenderOtherDE ValueSet (required) | |||||
![]() ![]() ![]() |
0..1 | code | Primitive value for code Max Length:1048576 | |||||
![]() ![]() |
Σ | 0..1 | date | The date on which the related person was born | ||||
![]() ![]() |
SΣ | 0..* | Address | Address where the related person can be contacted or visited | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
?!SΣ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home | ||||
![]() ![]() ![]() |
Σ | 0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both | ||||
![]() ![]() ![]() |
SΣ | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 | ||||
![]() ![]() ![]() |
SΣ | 0..* | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street | ||||
![]() ![]() ![]() |
SΣ | 0..1 | string | Name of city, town etc. Example General: Erewhon | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | District name (aka county) Example General: Madison | ||||
![]() ![]() ![]() |
SΣ | 0..1 | string | Sub-unit of country (abbreviations ok) | ||||
![]() ![]() ![]() |
SΣ | 0..1 | string | Postal code for area Example General: 9132 | ||||
![]() ![]() ![]() |
SΣ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) | ||||
![]() ![]() ![]() |
Σ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"} | ||||
![]() ![]() |
C | 0..* | Attachment | Image of the person Constraints: att-1 | ||||
![]() ![]() |
C | 0..1 | Period | Period of time that this relationship is considered valid Constraints: per-1 | ||||
![]() ![]() |
0..* | BackboneElement | A language which may be used to communicate with about the patient's health | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
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.
| |||||
![]() ![]() ![]() |
0..1 | boolean | Language preference indicator | |||||
Documentation for this format | ||||||||
| 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.patient.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| RelatedPerson.patient.identifier.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| RelatedPerson.relationship | Base | preferred | Patient relationship type | 📍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.use | Base | required | AddressUse | 📍4.0.1 | FHIR Std. |
| RelatedPerson.address.type | Base | required | AddressType | 📍4.0.1 | FHIR Std. |
| RelatedPerson.communication.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| att-1 | error | RelatedPerson.photo | If the Attachment has data, it SHALL have a contentType |
data.empty() or contentType.exists()
|
| cpt-2 | error | RelatedPerson.telecom | A system is required if a value is provided. |
value.empty() or system.exists()
|
| 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()
|
| pat-de-1 | error | RelatedPerson | Die amtliche Differenzierung der Geschlechtsangabe 'other' darf nur gefüllt sein, wenn das Geschlecht 'other' angegeben ist |
gender.exists() and gender='other' implies gender.extension('http://fhir.de/StructureDefinition/gender-amtlich-de').exists()
|
| per-1 | error | RelatedPerson.patient.identifier.period, RelatedPerson.telecom.period, RelatedPerson.address.period, RelatedPerson.period | If present, start SHALL have a lower value than end |
start.hasValue().not() or end.hasValue().not() or (start <= end)
|
| ref-1 | error | RelatedPerson.patient, RelatedPerson.patient.identifier.assigner | SHALL have a contained resource if a local reference is provided |
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
|
Diese Struktur ist abgeleitet von RelatedPerson
Summary
Mandatory: 0 element(2 nested mandatory elements)
Must-Support: 35 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Schlüsselelemente-Ansicht
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | RelatedPerson | A person that is related to a patient, but who is not a direct target of care Constraints: dom-2, dom-3, dom-4, dom-5, dom-6, pat-de-1 |
![]() ![]() |
SΣ | 0..1 | Meta | Metadata about the resource |
![]() ![]() ![]() |
SΣ | 0..1 | id | Version specific identifier |
![]() ![]() ![]() |
SΣ | 0..1 | instant | When the resource version last changed |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
S | 0..* | Extension | Extension Slice: Unordered, Open by value:url |
![]() ![]() ![]() |
S | 0..1 | (Complex) | Additional notes that apply to this resource or element. URL: http://hl7.org/fhir/StructureDefinition/note |
![]() ![]() ![]() ![]() |
0..0 | Additional content defined by implementations Slice: Unordered, Open by value:url | ||
![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/note" | |
![]() ![]() ![]() ![]() |
S | 1..1 | Annotation | Notes for this resource/element |
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | dateTime | When the annotation was made |
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | markdown | The annotation - text content (as markdown) |
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url |
![]() ![]() |
?!Σ | 0..1 | boolean | Whether this related person's record is in active use |
![]() ![]() |
SΣC | 1..1 | Reference(TI Patient) | The patient this person is related to Constraints: ref-1 |
![]() ![]() ![]() |
SΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL |
![]() ![]() ![]() |
SΣ | 0..1 | Identifier | Logical reference, when literal reference is not known |
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | The value that is unique Example General: 123456 |
![]() ![]() ![]() |
SΣ | 0..1 | string | Text alternative for the resource |
![]() ![]() |
SΣ | 0..* | CodeableConcept | The nature of the relationship Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person. |
![]() ![]() ![]() |
SΣ | 0..* | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | uri | Identity of the terminology system |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Version of the system - if relevant |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | code | Symbol in syntax defined by the system |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Representation defined by the system |
![]() ![]() |
SΣ | 0..* | HumanName | A name associated with the person Slice: Unordered, Open by value:$this |
![]() ![]() ![]() |
SΣ | 0..1 | TIHumanName | A name associated with the person Required Pattern: At least the following |
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() |
1..1 | code | usual | official | temp | nickname | anonymous | old | maiden Fixed Value: official | |
![]() ![]() ![]() ![]() |
0..1 | string | Text representation of the full name | |
![]() ![]() ![]() ![]() |
0..1 | string | Family name (often called 'Surname') | |
![]() ![]() ![]() ![]() |
0..* | string | Given names (not always 'first'). Includes middle names | |
![]() ![]() ![]() ![]() |
0..* | string | Parts that come before the name | |
![]() ![]() ![]() ![]() |
0..* | string | Parts that come after the name | |
![]() ![]() ![]() ![]() |
0..1 | Period | Time period when name was/is in use | |
![]() ![]() ![]() |
SΣ | 0..1 | TIBirthName | A name associated with the person Required Pattern: At least the following |
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() |
1..1 | code | usual | official | temp | nickname | anonymous | old | maiden Fixed Value: maiden | |
![]() ![]() ![]() ![]() |
0..1 | string | Text representation of the full name | |
![]() ![]() ![]() ![]() |
0..1 | string | Family name (often called 'Surname') | |
![]() ![]() ![]() ![]() |
0..* | string | Given names (not always 'first'). Includes middle names | |
![]() ![]() ![]() ![]() |
0..* | string | Parts that come before the name | |
![]() ![]() ![]() ![]() |
0..* | string | Parts that come after the name | |
![]() ![]() ![]() ![]() |
0..1 | Period | Time period when name was/is in use | |
![]() ![]() |
SΣC | 0..* | ContactPoint | A contact detail for the person Constraints: cpt-2 |
![]() ![]() ![]() |
SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. |
![]() ![]() ![]() |
SΣ | 1..1 | string | The actual contact point details |
![]() ![]() ![]() |
?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. |
![]() ![]() |
SΣ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. |
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
0..1 | Coding | Optional Extensions Element URL: http://fhir.de/StructureDefinition/gender-amtlich-de Binding: GenderOtherDE ValueSet (required) | |
![]() ![]() |
SΣ | 0..* | Address | Address where the related person can be contacted or visited |
![]() ![]() ![]() |
?!SΣ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home |
![]() ![]() ![]() |
SΣ | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 |
![]() ![]() ![]() |
SΣ | 0..* | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street |
![]() ![]() ![]() |
SΣ | 0..1 | string | Name of city, town etc. Example General: Erewhon |
![]() ![]() ![]() |
SΣ | 0..1 | string | Sub-unit of country (abbreviations ok) |
![]() ![]() ![]() |
SΣ | 0..1 | string | Postal code for area Example General: 9132 |
![]() ![]() ![]() |
SΣ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| RelatedPerson.patient.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| RelatedPerson.relationship | Base | preferred | Patient relationship type | 📍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.use | Base | required | AddressUse | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| cpt-2 | error | RelatedPerson.telecom | A system is required if a value is provided. |
value.empty() or system.exists()
|
| 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()
|
| pat-de-1 | error | RelatedPerson | Die amtliche Differenzierung der Geschlechtsangabe 'other' darf nur gefüllt sein, wenn das Geschlecht 'other' angegeben ist |
gender.exists() and gender='other' implies gender.extension('http://fhir.de/StructureDefinition/gender-amtlich-de').exists()
|
| ref-1 | error | RelatedPerson.patient | SHALL have a contained resource if a local reference is provided |
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
|
Differential-Ansicht
Diese Struktur ist abgeleitet von RelatedPerson
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | RelatedPerson | A person that is related to a patient, but who is not a direct target of care Constraints: pat-de-1 |
![]() ![]() |
S | 0..1 | Meta | Metadata about the resource |
![]() ![]() ![]() |
S | 0..1 | id | Version specific identifier |
![]() ![]() ![]() |
S | 0..1 | instant | When the resource version last changed |
![]() ![]() |
S | 0..* | Extension | Extension |
![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() |
S | 0..1 | (Complex) | Additional notes that apply to this resource or element. URL: http://hl7.org/fhir/StructureDefinition/note |
![]() ![]() ![]() ![]() |
S | 1..1 | Annotation | Notes for this resource/element |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | dateTime | When the annotation was made |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | markdown | The annotation - text content (as markdown) |
![]() ![]() |
S | 1..1 | Reference(TI Patient) | The patient this person is related to |
![]() ![]() ![]() |
S | 0..1 | string | Literal reference, Relative, internal or absolute URL |
![]() ![]() ![]() |
S | 0..1 | Identifier | Logical reference, when literal reference is not known |
![]() ![]() ![]() ![]() |
S | 0..1 | uri | The namespace for the identifier value |
![]() ![]() ![]() ![]() |
S | 0..1 | string | The value that is unique |
![]() ![]() ![]() |
S | 0..1 | string | Text alternative for the resource |
![]() ![]() |
S | 0..* | CodeableConcept | The nature of the relationship |
![]() ![]() ![]() |
S | 0..* | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() |
S | 0..1 | uri | Identity of the terminology system |
![]() ![]() ![]() ![]() |
S | 0..1 | string | Version of the system - if relevant |
![]() ![]() ![]() ![]() |
S | 0..1 | code | Symbol in syntax defined by the system |
![]() ![]() ![]() ![]() |
S | 0..1 | string | Representation defined by the system |
![]() ![]() |
S | 0..* | HumanName | A name associated with the person Slice: Unordered, Open by value:$this |
![]() ![]() ![]() |
S | 0..1 | TIHumanName | A name associated with the person Required Pattern: At least the following |
![]() ![]() ![]() ![]() |
1..1 | code | usual | official | temp | nickname | anonymous | old | maiden Fixed Value: official | |
![]() ![]() ![]() |
S | 0..1 | TIBirthName | A name associated with the person Required Pattern: At least the following |
![]() ![]() ![]() ![]() |
1..1 | code | usual | official | temp | nickname | anonymous | old | maiden Fixed Value: maiden | |
![]() ![]() |
S | 0..* | ContactPoint | A contact detail for the person |
![]() ![]() ![]() |
S | 1..1 | code | phone | fax | email | pager | url | sms | other |
![]() ![]() ![]() |
S | 1..1 | string | The actual contact point details |
![]() ![]() |
S | 0..1 | code | male | female | other | unknown |
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
0..1 | Coding | Optional Extensions Element URL: http://fhir.de/StructureDefinition/gender-amtlich-de Binding: GenderOtherDE ValueSet (required) | |
![]() ![]() |
S | 0..* | Address | Address where the related person can be contacted or visited |
![]() ![]() ![]() |
S | 0..1 | code | home | work | temp | old | billing - purpose of this address |
![]() ![]() ![]() |
S | 0..1 | string | Text representation of the address |
![]() ![]() ![]() |
S | 0..* | string | Street name, number, direction & P.O. Box etc. |
![]() ![]() ![]() |
S | 0..1 | string | Name of city, town etc. |
![]() ![]() ![]() |
S | 0..1 | string | Sub-unit of country (abbreviations ok) |
![]() ![]() ![]() |
S | 0..1 | string | Postal code for area |
![]() ![]() ![]() |
S | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) |
Documentation for this format | ||||
| Id | Grade | Path(s) | Description | Expression |
| pat-de-1 | error | RelatedPerson | Die amtliche Differenzierung der Geschlechtsangabe 'other' darf nur gefüllt sein, wenn das Geschlecht 'other' angegeben ist |
gender.exists() and gender='other' implies gender.extension('http://fhir.de/StructureDefinition/gender-amtlich-de').exists()
|
Snapshot-AnsichtView
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
C | 0..* | RelatedPerson | A person that is related to a patient, but who is not a direct target of care Constraints: dom-2, dom-3, dom-4, dom-5, dom-6, pat-de-1 | ||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
SΣ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
SΣ | 0..1 | id | Version specific identifier | ||||
![]() ![]() ![]() |
SΣ | 0..1 | instant | When the resource version last changed | ||||
![]() ![]() ![]() |
Σ | 0..1 | uri | Identifies where the resource comes from | ||||
![]() ![]() ![]() |
Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
![]() ![]() ![]() |
Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
![]() ![]() ![]() |
Σ | 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". | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() |
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 | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
S | 0..* | Extension | Extension Slice: Unordered, Open by value:url | ||||
![]() ![]() ![]() |
S | 0..1 | (Complex) | Additional notes that apply to this resource or element. URL: http://hl7.org/fhir/StructureDefinition/note | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..0 | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||||
![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/note" | |||||
![]() ![]() ![]() ![]() |
S | 1..1 | Annotation | Notes for this resource/element | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Individual responsible for the annotation | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
Reference(Practitioner | Patient | RelatedPerson | Organization) | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
string | |||||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | dateTime | When the annotation was made | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | markdown | The annotation - text content (as markdown) | ||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url | ||||
![]() ![]() |
Σ | 0..* | Identifier | A human identifier for this person | ||||
![]() ![]() |
?!Σ | 0..1 | boolean | Whether this related person's record is in active use | ||||
![]() ![]() |
SΣC | 1..1 | Reference(TI Patient) | The patient this person is related to Constraints: ref-1 | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
SΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() |
Σ | 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). | ||||
![]() ![]() ![]() |
SΣ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | The value that is unique Example General: 123456 | ||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | Period | Time period when id is/was valid for use Constraints: per-1 | ||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | Reference(Organization) | Organization that issued id (may be just text) Constraints: ref-1 | ||||
![]() ![]() ![]() |
SΣ | 0..1 | string | Text alternative for the resource | ||||
![]() ![]() |
SΣ | 0..* | CodeableConcept | The nature of the relationship Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person. | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
SΣ | 0..* | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | uri | Identity of the terminology system | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | code | Symbol in syntax defined by the system | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() |
SΣ | 0..* | HumanName | A name associated with the person Slice: Unordered, Open by value:$this | ||||
![]() ![]() ![]() |
SΣ | 0..1 | TIHumanName | A name associated with the person Required Pattern: At least the following | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
1..1 | code | usual | official | temp | nickname | anonymous | old | maiden Fixed Value: official | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Text representation of the full name | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Family name (often called 'Surname') | |||||
![]() ![]() ![]() ![]() |
0..* | string | Given names (not always 'first'). Includes middle names | |||||
![]() ![]() ![]() ![]() |
0..* | string | Parts that come before the name | |||||
![]() ![]() ![]() ![]() |
0..* | string | Parts that come after the name | |||||
![]() ![]() ![]() ![]() |
0..1 | Period | Time period when name was/is in use | |||||
![]() ![]() ![]() |
SΣ | 0..1 | TIBirthName | A name associated with the person Required Pattern: At least the following | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
1..1 | code | usual | official | temp | nickname | anonymous | old | maiden Fixed Value: maiden | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Text representation of the full name | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Family name (often called 'Surname') | |||||
![]() ![]() ![]() ![]() |
0..* | string | Given names (not always 'first'). Includes middle names | |||||
![]() ![]() ![]() ![]() |
0..* | string | Parts that come before the name | |||||
![]() ![]() ![]() ![]() |
0..* | string | Parts that come after the name | |||||
![]() ![]() ![]() ![]() |
0..1 | Period | Time period when name was/is in use | |||||
![]() ![]() |
SΣC | 0..* | ContactPoint | A contact detail for the person Constraints: cpt-2 | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. | ||||
![]() ![]() ![]() |
SΣ | 1..1 | string | The actual contact point details | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||
![]() ![]() ![]() |
Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
![]() ![]() ![]() |
ΣC | 0..1 | Period | Time period when the contact point was/is in use Constraints: per-1 | ||||
![]() ![]() |
SΣ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | ||||
![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
0..1 | Coding | Optional Extensions Element URL: http://fhir.de/StructureDefinition/gender-amtlich-de Binding: GenderOtherDE ValueSet (required) | |||||
![]() ![]() ![]() |
0..1 | code | Primitive value for code Max Length:1048576 | |||||
![]() ![]() |
Σ | 0..1 | date | The date on which the related person was born | ||||
![]() ![]() |
SΣ | 0..* | Address | Address where the related person can be contacted or visited | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
?!SΣ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home | ||||
![]() ![]() ![]() |
Σ | 0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both | ||||
![]() ![]() ![]() |
SΣ | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 | ||||
![]() ![]() ![]() |
SΣ | 0..* | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street | ||||
![]() ![]() ![]() |
SΣ | 0..1 | string | Name of city, town etc. Example General: Erewhon | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | District name (aka county) Example General: Madison | ||||
![]() ![]() ![]() |
SΣ | 0..1 | string | Sub-unit of country (abbreviations ok) | ||||
![]() ![]() ![]() |
SΣ | 0..1 | string | Postal code for area Example General: 9132 | ||||
![]() ![]() ![]() |
SΣ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) | ||||
![]() ![]() ![]() |
Σ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"} | ||||
![]() ![]() |
C | 0..* | Attachment | Image of the person Constraints: att-1 | ||||
![]() ![]() |
C | 0..1 | Period | Period of time that this relationship is considered valid Constraints: per-1 | ||||
![]() ![]() |
0..* | BackboneElement | A language which may be used to communicate with about the patient's health | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
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.
| |||||
![]() ![]() ![]() |
0..1 | boolean | Language preference indicator | |||||
Documentation for this format | ||||||||
| 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.patient.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| RelatedPerson.patient.identifier.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| RelatedPerson.relationship | Base | preferred | Patient relationship type | 📍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.use | Base | required | AddressUse | 📍4.0.1 | FHIR Std. |
| RelatedPerson.address.type | Base | required | AddressType | 📍4.0.1 | FHIR Std. |
| RelatedPerson.communication.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| att-1 | error | RelatedPerson.photo | If the Attachment has data, it SHALL have a contentType |
data.empty() or contentType.exists()
|
| cpt-2 | error | RelatedPerson.telecom | A system is required if a value is provided. |
value.empty() or system.exists()
|
| 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()
|
| pat-de-1 | error | RelatedPerson | Die amtliche Differenzierung der Geschlechtsangabe 'other' darf nur gefüllt sein, wenn das Geschlecht 'other' angegeben ist |
gender.exists() and gender='other' implies gender.extension('http://fhir.de/StructureDefinition/gender-amtlich-de').exists()
|
| per-1 | error | RelatedPerson.patient.identifier.period, RelatedPerson.telecom.period, RelatedPerson.address.period, RelatedPerson.period | If present, start SHALL have a lower value than end |
start.hasValue().not() or end.hasValue().not() or (start <= end)
|
| ref-1 | error | RelatedPerson.patient, RelatedPerson.patient.identifier.assigner | SHALL have a contained resource if a local reference is provided |
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
|
Diese Struktur ist abgeleitet von RelatedPerson
Summary
Mandatory: 0 element(2 nested mandatory elements)
Must-Support: 35 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Weitere Repräsentationen des Profils: CSV, Excel, Schematron