EPARelatedPerson
Dieses Profil wird verwendet, um Kontakt- oder Bezugspersonen zu erfassen, die eine Beziehung zum Versicherten haben und an dessen Versorgung beteiligt sein können.
Profil für gemeinsame Datengrundlage im ePA Medication Service
EPARelatedPerson (RelatedPerson) | I | RelatedPerson | |
id | Σ | 0..1 | string |
meta | S Σ | 0..1 | Meta |
id | 0..1 | string | |
extension | I | 0..* | Extension |
versionId | S Σ | 0..1 | id |
lastUpdated | S Σ | 0..1 | instant |
source | Σ | 0..1 | uri |
profile | Σ | 0..* | canonical(StructureDefinition) |
security | Σ | 0..* | CodingBinding |
tag | Σ | 0..* | Coding |
implicitRules | Σ ?! | 0..1 | uri |
language | 0..1 | codeBinding | |
text | 0..1 | Narrative | |
id | 0..1 | string | |
extension | I | 0..* | Extension |
status | 1..1 | codeBindingPattern | |
div | I | 1..1 | xhtml |
contained | 0..* | Resource | |
extension | S I | 0..* | Extension |
additional-comment | S I | 0..1 | Extension(string) |
id | 0..1 | string | |
extension | I | 0..0 | Extension |
url | 1..1 | uriFixed Value | |
value[x] | S | 1..1 | |
valueString | string | ||
modifierExtension | ?! I | 0..* | Extension |
identifier | Σ | 0..* | Identifier |
active | Σ ?! | 0..1 | boolean |
patient | S Σ I | 1..1 | Reference(Patient) |
id | 0..1 | string | |
extension | I | 0..* | Extension |
reference | Σ I | 0..1 | string |
type | Σ | 0..1 | uriBinding |
identifier | S Σ | 1..1 | IdentifierKvid10 |
display | Σ | 0..1 | string |
relationship | S Σ | 0..* | CodeableConceptBinding |
id | 0..1 | string | |
extension | I | 0..* | Extension |
coding | S Σ | 0..* | Coding |
relationship-type | S Σ | 0..1 | CodingBinding |
id | 0..1 | string | |
extension | I | 0..* | Extension |
system | S Σ | 1..1 | uri |
version | S Σ | 1..1 | string |
code | S Σ | 1..1 | code |
display | S Σ | 1..1 | string |
userSelected | Σ | 0..1 | boolean |
text | S Σ | 0..1 | string |
name | S Σ I | 1..1 | HumannameDeBasis |
id | 0..1 | string | |
extension | I | 0..* | Extension |
use | S Σ ?! | 1..1 | codeBindingFixed Value |
text | S Σ | 0..1 | string |
family | S Σ | 1..1 | string |
id | 0..1 | string | |
extension | S I | 0..* | Extension |
namenszusatz | S I | 0..1 | Extension(string) |
id | 0..1 | string | |
extension | I | 0..0 | Extension |
url | 1..1 | uriFixed Value | |
value[x] | S | 1..1 | |
valueString | string | ||
nachname | S I | 0..1 | Extension(string) |
id | 0..1 | string | |
extension | I | 0..0 | Extension |
url | 1..1 | uriFixed Value | |
value[x] | S | 1..1 | |
valueString | string | ||
vorsatzwort | S I | 0..1 | Extension(string) |
id | 0..1 | string | |
extension | I | 0..0 | Extension |
url | 1..1 | uriFixed Value | |
value[x] | S | 1..1 | |
valueString | string | ||
value | 0..1 | System.String | |
given | S Σ | 1..* | string |
prefix | S Σ | 0..* | string |
id | 0..1 | string | |
extension | S I | 0..* | Extension |
prefix-qualifier | S I | 0..1 | Extension(code) |
id | 0..1 | string | |
extension | I | 0..0 | Extension |
url | 1..1 | uriFixed Value | |
value[x] | S | 1..1 | Binding |
valueCode | code | ||
value | 0..1 | System.String | |
suffix | Σ | 0..* | string |
period | Σ I | 0..1 | Period |
telecom | S Σ I | 0..* | ContactPoint |
id | 0..1 | string | |
extension | I | 0..* | Extension |
system | S Σ I | 1..1 | codeBinding |
value | S Σ | 1..1 | string |
use | Σ ?! | 0..1 | codeBinding |
rank | Σ | 0..1 | positiveInt |
period | Σ I | 0..1 | Period |
gender | Σ | 0..1 | codeBinding |
id | 0..1 | string | |
extension | I | 0..* | Extension |
other-amtlich | I | 0..1 | Extension(Coding) |
value | 0..1 | System.String | |
birthDate | Σ | 0..1 | date |
address | S Σ I | 0..* | AddressDeBasis |
id | 0..1 | string | |
extension | S I | 0..* | Extension |
Stadtteil | S I | 0..1 | Extension(string) |
id | 0..1 | string | |
extension | I | 0..0 | Extension |
url | 1..1 | uriFixed Value | |
value[x] | S | 1..1 | |
valueString | string | ||
use | Σ ?! | 0..1 | codeBinding |
type | S Σ | 1..1 | codeBinding |
text | Σ | 0..1 | string |
line | S Σ | 0..3 | string |
id | 0..1 | string | |
extension | S I | 0..* | Extension |
Strasse | S I | 0..1 | Extension(string) |
id | 0..1 | string | |
extension | I | 0..0 | Extension |
url | 1..1 | uriFixed Value | |
value[x] | S | 1..1 | |
valueString | string | ||
Hausnummer | S I | 0..1 | Extension(string) |
id | 0..1 | string | |
extension | I | 0..0 | Extension |
url | 1..1 | uriFixed Value | |
value[x] | S | 1..1 | |
valueString | string | ||
Adresszusatz | S I | 0..1 | Extension(string) |
id | 0..1 | string | |
extension | I | 0..0 | Extension |
url | 1..1 | uriFixed Value | |
value[x] | S | 1..1 | |
valueString | string | ||
Postfach | S I | 0..1 | Extension(string) |
id | 0..1 | string | |
extension | I | 0..0 | Extension |
url | 1..1 | uriFixed Value | |
value[x] | S | 1..1 | |
valueString | string | ||
value | 0..1 | System.String | |
city | S Σ | 1..1 | string |
district | Σ | 0..0 | string |
state | Σ | 0..1 | stringBinding |
postalCode | S Σ | 1..1 | string |
country | S Σ | 1..1 | stringBinding |
period | Σ I | 0..1 | Period |
photo | I | 0..* | Attachment |
period | I | 0..1 | Period |
communication | 0..* | BackboneElement | |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
language | 1..1 | CodeableConceptBinding | |
preferred | 0..1 | boolean |
RelatedPerson | |
Definition | Hier wird eine Kontakt- oder Bezugsperson erfasst, die eine Beziehung zur behandelten Person hat. Sie kann an der Versorgung der behandelten Person beteiligt sein. |
Cardinality | 0...* |
Invariants |
|
Mappings |
|
RelatedPerson.id | |
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation. |
RelatedPerson.meta | |
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
Cardinality | 0...1 |
Type | Meta |
Must Support | True |
Summary | True |
Invariants |
|
Mappings |
|
RelatedPerson.meta.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
RelatedPerson.meta.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
RelatedPerson.meta.versionId | |
Definition | The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted. |
Cardinality | 0...1 |
Type | id |
Must Support | True |
Summary | True |
Comments | The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes. |
Invariants |
|
Mappings |
|
RelatedPerson.meta.lastUpdated | |
Definition | When the resource last changed - e.g. when the version changed. |
Cardinality | 0...1 |
Type | instant |
Must Support | True |
Summary | True |
Comments | This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a read interaction. |
Invariants |
|
Mappings |
|
RelatedPerson.meta.source | |
Definition | A uri that identifies the source system of the resource. This provides a minimal amount of [Provenance](provenance.html#) information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc. |
Cardinality | 0...1 |
Type | uri |
Summary | True |
Comments | In the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used. This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL. |
Invariants |
|
Mappings |
|
RelatedPerson.meta.profile | |
Definition | A list of profiles (references to [StructureDefinition](structuredefinition.html#) resources) that this resource claims to conform to. The URL is a reference to [StructureDefinition.url](structuredefinition-definitions.html#StructureDefinition.url). |
Cardinality | 0...* |
Type | canonical(StructureDefinition) |
Summary | True |
Comments | It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set. |
Invariants |
|
Mappings |
|
RelatedPerson.meta.security | |
Definition | Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure. |
Cardinality | 0...* |
Type | Coding |
Binding | Security Labels from the Healthcare Privacy and Security Classification System. |
Summary | True |
Comments | The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored. |
Invariants |
|
Mappings |
|
RelatedPerson.meta.tag | |
Definition | Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource. |
Cardinality | 0...* |
Type | Coding |
Binding | Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". |
Summary | True |
Comments | The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored. |
Invariants |
|
Mappings |
|
RelatedPerson.implicitRules | |
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
Cardinality | 0...1 |
Type | uri |
Modifier | True |
Summary | True |
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. |
Invariants |
|
Mappings |
|
RelatedPerson.language | |
Definition | The base language in which the resource is written. |
Cardinality | 0...1 |
Type | code |
Binding | A human language. |
Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). |
Invariants |
|
Mappings |
|
RelatedPerson.text | |
Definition | In diesem Element können die in der Instanz enthaltenen Informationen in einer menschenlesbaren Form zusammengefasst werden. Dabei ist zu beachten, dass keine Informationen aufgenommen werden dürfen, die nicht in strukturierter Form an anderer Stelle in der Instanz enthalten sind. |
Cardinality | 0...1 |
Type | Narrative |
Alias | narrative, html, xhtml, display |
Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. |
Invariants |
|
Mappings |
|
RelatedPerson.text.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
RelatedPerson.text.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
RelatedPerson.text.status | |
Definition | The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data. |
Cardinality | 1...1 |
Type | code |
Binding | The status of a resource narrative. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Pattern | extensions |
Mappings |
|
RelatedPerson.text.div | |
Definition | The actual narrative content, a stripped down version of XHTML. |
Cardinality | 1...1 |
Type | xhtml |
Comments | The contents of the html element are an XHTML fragment containing only the basic html formatting elements described in chapters 7-11 and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained stylesheets. The XHTML content SHALL NOT contain a head, a body, external stylesheet references, scripts, forms, base/link/xlink, frames, iframes and objects. |
Invariants |
|
Mappings |
|
RelatedPerson.contained | |
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
Cardinality | 0...* |
Type | Resource |
Alias | inline resources, anonymous resources, contained resources |
Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels. |
Mappings |
|
RelatedPerson.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Must Support | True |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
RelatedPerson.extension:additional-comment | |
Definition | Hier können weitere Informationen, beispielsweise die Pflegebedürftigkeitssituation der Kontaktperson, dargestellt werden. Wenn die Kontaktperson auch gesetzlich betreuende Person ist, kann hier beschrieben werden, für welchen Bereich sie bevollmächtigt ist. |
Cardinality | 0...1 |
Type | Extension(string) |
Must Support | True |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
RelatedPerson.extension:additional-comment.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
RelatedPerson.extension:additional-comment.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...0 |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
RelatedPerson.extension:additional-comment.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Cardinality | 1...1 |
Type | uri |
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
Fixed Value | https://gematik.de/fhir/epa/StructureDefinition/epa-additional-comment-extension |
Mappings |
|
RelatedPerson.extension:additional-comment.value[x] | |
Definition | Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). |
Cardinality | 1...1 |
Type | string |
Must Support | True |
Invariants |
|
Mappings |
|
RelatedPerson.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Alias | extensions, user content |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
RelatedPerson.identifier | |
Definition | Identifier for a person within a particular scope. |
Cardinality | 0...* |
Type | Identifier |
Summary | True |
Requirements | People are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the patient. Examples are national person identifier and local identifier. |
Invariants |
|
Mappings |
|
RelatedPerson.active | |
Definition | Whether this related person record is in active use. |
Cardinality | 0...1 |
Type | boolean |
Modifier | True |
Summary | True |
Requirements | Need to be able to mark a related person record as not to be used, such as if it was created in error. |
Comments | This element is labeled as a modifier because it may be used to mark that the resource was created in error. |
Invariants |
|
Mappings |
|
RelatedPerson.patient | |
Definition | The patient this person is related to. |
Cardinality | 1...1 |
Type | Reference(Patient) |
Must Support | True |
Summary | True |
Requirements | We need to know which patient this RelatedPerson is related to. |
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
Invariants |
|
Mappings |
|
RelatedPerson.patient.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
RelatedPerson.patient.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
RelatedPerson.patient.reference | |
Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. |
Invariants |
|
Mappings |
|
RelatedPerson.patient.type | |
Definition | The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). |
Cardinality | 0...1 |
Type | uri |
Binding | Aa resource (or, for logical models, the URI of the logical model). |
Summary | True |
Comments | This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. |
Invariants |
|
Mappings |
|
RelatedPerson.patient.identifier | |
Definition | An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers. |
Cardinality | 1...1 |
Type | IdentifierKvid10 |
Must Support | True |
Summary | True |
Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). |
Invariants |
|
Mappings |
|
RelatedPerson.patient.display | |
Definition | Plain text narrative that identifies the resource in addition to the resource reference. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. |
Invariants |
|
Mappings |
|
RelatedPerson.relationship | |
Definition | Hier wird die Beziehung der Kontaktperson zur Patient:in anhand eines entsprechenden Codes oder mit einem Freitext angegeben. |
Cardinality | 0...* |
Type | CodeableConcept |
Binding | The nature of the relationship between a patient and the related person. |
Must Support | True |
Summary | True |
Requirements | We need to know the relationship with the patient since it influences the interpretation of the information attributed to this person. |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
Invariants |
|
Mappings |
|
RelatedPerson.relationship.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
RelatedPerson.relationship.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
RelatedPerson.relationship.coding | |
Definition | Hier werden Codes angegeben. |
Cardinality | 0...* |
Type | Coding |
Must Support | True |
Summary | True |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
Comments | Das MustSupport gilt nur für die vordefinierten Slices. |
Slicing | Unordered, Open, by $this(Value) |
Invariants |
|
Mappings |
|
RelatedPerson.relationship.coding:relationship-type | |
Definition | Hier wird die Beziehung der Kontaktperson zur Patient:in anhand eines Codes aus einer vorgegebenen Werteliste angegeben. |
Cardinality | 0...1 |
Type | Coding |
Binding | PatientRelationshipType (required) |
Must Support | True |
Summary | True |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. |
Invariants |
|
Mappings |
|
RelatedPerson.relationship.coding:relationship-type.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
RelatedPerson.relationship.coding:relationship-type.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
RelatedPerson.relationship.coding:relationship-type.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Cardinality | 1...1 |
Type | uri |
Must Support | True |
Summary | True |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously. |
Invariants |
|
Mappings |
|
RelatedPerson.relationship.coding:relationship-type.version | |
Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. |
Cardinality | 1...1 |
Type | string |
Must Support | True |
Summary | True |
Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. |
Invariants |
|
Mappings |
|
RelatedPerson.relationship.coding:relationship-type.code | |
Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). |
Cardinality | 1...1 |
Type | code |
Must Support | True |
Summary | True |
Requirements | Need to refer to a particular code in the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
RelatedPerson.relationship.coding:relationship-type.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Cardinality | 1...1 |
Type | string |
Must Support | True |
Summary | True |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
RelatedPerson.relationship.coding:relationship-type.userSelected | |
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). |
Cardinality | 0...1 |
Type | boolean |
Summary | True |
Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. |
Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. |
Invariants |
|
Mappings |
|
RelatedPerson.relationship.text | |
Definition | Hier wird ein Freitext eingetragen. |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. |
Comments | Very often the text is the same as a displayName of one of the codings. |
Invariants |
|
Mappings |
|
RelatedPerson.name | |
Definition | Dieses Element beschreibt diverse Namensbestandteile einer Person. |
Cardinality | 1...1 |
Type | HumannameDeBasis |
Must Support | True |
Summary | True |
Requirements | Related persons need to be identified by name, but it is uncommon to need details about multiple other names for that person. |
Comments | Names may be changed, or repudiated, or people may have different names in different contexts. Names may be divided into parts of different type that have variable significance depending on context, though the division into parts does not always matter. With personal names, the different parts may or may not be imbued with some implicit meaning; various cultures associate different importance with the name parts and the degree to which systems must care about name parts around the world varies widely. |
Invariants |
|
Mappings |
|
RelatedPerson.name.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
RelatedPerson.name.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
RelatedPerson.name.use | |
Definition | Identifies the purpose for this name. |
Cardinality | 1...1 |
Type | code |
Binding | The use of a human name. |
Must Support | True |
Modifier | True |
Summary | True |
Requirements | Allows the appropriate name for a particular context of use to be selected from among a set of names. |
Comments | Applications can assume that a name is current unless it explicitly says that it is temporary or old. |
Invariants |
|
Fixed Value | official |
Mappings |
|
RelatedPerson.name.text | |
Definition | Specifies the entire name as it should be displayed e.g. on an application UI. This may be provided instead of or as well as the specific parts. |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
Requirements | A renderable, unencoded form. |
Comments | Can provide both a text representation and parts. Applications updating a name SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part. |
Invariants |
|
Mappings |
|
RelatedPerson.name.family | |
Definition | Nachname einer Person. |
Cardinality | 1...1 |
Type | string |
Must Support | True |
Summary | True |
Alias | surname |
Comments | Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures). |
Invariants |
|
Mappings |
|
RelatedPerson.name.family.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
RelatedPerson.name.family.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Must Support | True |
Alias | extensions, user content |
Comments | Das MustSupport gilt nur für die vordefinierten Slices. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
RelatedPerson.name.family.extension:namenszusatz | |
Definition | Namenszusatz als Bestandteil das Nachnamens, wie in VSDM (Versichertenstammdatenmanagement, "eGK") definiert. Beispiele: Gräfin, Prinz oder Fürst |
Cardinality | 0...1 |
Type | Extension(string) |
Must Support | True |
Alias | extensions, user content |
Comments | Die Extension wurde erstellt aufgrund der Anforderung, die auf der eGK vorhandenen Patientenstammdaten in FHIR abbilden zu können. Auf der eGK werden die Namensbestandteile "Namenszusatz" und "Vorsatzwort" getrennt vom Nachnamen gespeichert. Anhand der Liste der zulässigen Namenszusätze ist deutlich erkennbar, dass es sich hierbei sinngemäß um Adelstitel handelt. Das Vorsatzwort kann durch die Core-Extension own-prefix (Canonical: http://hl7.org/fhir/StructureDefinition/humanname-own-prefix) abgebildet werden, für den Namenszusatz ergibt sich jedoch die Notwendikeit einer nationalen Extension, da in andern Ländern Adelstitel entweder gar nicht oder als reguläres Namenspräfix erfasst werden. |
Invariants |
|
Mappings |
|
RelatedPerson.name.family.extension:namenszusatz.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
RelatedPerson.name.family.extension:namenszusatz.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...0 |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
RelatedPerson.name.family.extension:namenszusatz.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Cardinality | 1...1 |
Type | uri |
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
Fixed Value | http://fhir.de/StructureDefinition/humanname-namenszusatz |
Mappings |
|
RelatedPerson.name.family.extension:namenszusatz.value[x] | |
Definition | Namenszusatz zum Nachnamen z.B. Gräfin, Prinz oder Fürst |
Cardinality | 1...1 |
Type | string |
Must Support | True |
Invariants |
|
Mappings |
|
RelatedPerson.name.family.extension:nachname | |
Definition | Nachname ohne Vor- und Zusätze. Dient z.B. der alphabetischen Einordnung des Namens. |
Cardinality | 0...1 |
Type | Extension(string) |
Must Support | True |
Alias | extensions, user content |
Comments | If the person's surname has legally changed to become (or incorporate) the surname of the person's partner or spouse, this is the person's surname immediately prior to such change. Often this is the person's "maiden name". |
Invariants |
|
Mappings |
|
RelatedPerson.name.family.extension:nachname.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
RelatedPerson.name.family.extension:nachname.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...0 |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
RelatedPerson.name.family.extension:nachname.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Cardinality | 1...1 |
Type | uri |
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
Fixed Value | http://hl7.org/fhir/StructureDefinition/humanname-own-name |
Mappings |
|
RelatedPerson.name.family.extension:nachname.value[x] | |
Definition | Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). |
Cardinality | 1...1 |
Type | string |
Must Support | True |
Invariants |
|
Mappings |
|
RelatedPerson.name.family.extension:vorsatzwort | |
Definition | Vorsatzwort wie z.B.: von, van, zu Vgl. auch VSDM-Spezifikation der Gematik (Versichertenstammdatenmanagement, "eGK") |
Cardinality | 0...1 |
Type | Extension(string) |
Must Support | True |
Alias | extensions, user content |
Comments | An example of a voorvoegsel is the "van" in "Ludwig van Beethoven". Since the voorvoegsel doesn't sort completely alphabetically, it is reasonable to specify it as a separate sub-component. |
Invariants |
|
Mappings |
|
RelatedPerson.name.family.extension:vorsatzwort.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
RelatedPerson.name.family.extension:vorsatzwort.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...0 |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
RelatedPerson.name.family.extension:vorsatzwort.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Cardinality | 1...1 |
Type | uri |
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
Fixed Value | http://hl7.org/fhir/StructureDefinition/humanname-own-prefix |
Mappings |
|
RelatedPerson.name.family.extension:vorsatzwort.value[x] | |
Definition | Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). |
Cardinality | 1...1 |
Type | string |
Must Support | True |
Invariants |
|
Mappings |
|
RelatedPerson.name.family.value | |
Definition | Primitive value for string |
Cardinality | 0...1 |
Type | System.String |
RelatedPerson.name.given | |
Definition | Vorname der Person |
Cardinality | 1...* |
Type | string |
Must Support | True |
Summary | True |
Alias | first name, middle name |
Comments | If only initials are recorded, they may be used in place of the full name parts. Initials may be separated into multiple given names but often aren't due to paractical limitations. This element is not called "first name" since given names do not always come first. |
Invariants |
|
Mappings |
|
RelatedPerson.name.prefix | |
Definition | Titel als akademischer Grad. Beispiele: Dr.med., Dr.rer.nat., Prof. |
Cardinality | 0...* |
Type | string |
Must Support | True |
Summary | True |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
RelatedPerson.name.prefix.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
RelatedPerson.name.prefix.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Must Support | True |
Alias | extensions, user content |
Comments | Das MustSupport gilt nur für die vordefinierten Slices. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
RelatedPerson.name.prefix.extension:prefix-qualifier | |
Definition | Spezialisierung der Art des Präfixes, z.B. "AC" für Akademische Titel |
Cardinality | 0...1 |
Type | Extension(code) |
Must Support | True |
Alias | extensions, user content |
Comments | Used to indicate additional information about the name part and how it should be used. |
Invariants |
|
Mappings |
|
RelatedPerson.name.prefix.extension:prefix-qualifier.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
RelatedPerson.name.prefix.extension:prefix-qualifier.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...0 |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
RelatedPerson.name.prefix.extension:prefix-qualifier.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Cardinality | 1...1 |
Type | uri |
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
Fixed Value | http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier |
Mappings |
|
RelatedPerson.name.prefix.extension:prefix-qualifier.value[x] | |
Definition | Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). |
Cardinality | 1...1 |
Type | code |
Binding | A set of codes each of which specifies a certain subcategory of the name part in addition to the main name part type. |
Must Support | True |
Invariants |
|
Mappings |
|
RelatedPerson.name.prefix.value | |
Definition | Primitive value for string |
Cardinality | 0...1 |
Type | System.String |
RelatedPerson.name.suffix | |
Definition | Namensteile nach dem Nachnamen |
Cardinality | 0...* |
Type | string |
Summary | True |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
RelatedPerson.name.period | |
Definition | Indicates the period of time when this name was valid for the named person. |
Cardinality | 0...1 |
Type | Period |
Summary | True |
Requirements | Allows names to be placed in historical context. |
Comments | A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. |
Invariants |
|
Mappings |
|
RelatedPerson.telecom | |
Definition | Dieses Element beschreibt die vorhandenen Kontaktmöglichkeiten. |
Cardinality | 0...* |
Type | ContactPoint |
Must Support | True |
Summary | True |
Requirements | People have (primary) ways to contact them in some way such as phone, email. |
Comments | Person may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently, and also to help with identification. |
Invariants |
|
Mappings |
|
RelatedPerson.telecom.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
RelatedPerson.telecom.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
RelatedPerson.telecom.system | |
Definition | Definition der Art des Kontaktes, z. B. Telefon (phone), E-Mail, Fax. |
Cardinality | 1...1 |
Type | code |
Binding | Telecommunications form for contact point. |
Must Support | True |
Summary | True |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
RelatedPerson.telecom.value | |
Definition | In diesem Element können Kontaktinformationen passend zum Kontaktkanal angegeben werden. Beispiele für mögliche Werte sind: "m.mustermann@mio42.de" (beim Kontaktkanal "E-mail", oder "030712345678" (beim Kontaktkanal "Telefon"). |
Cardinality | 1...1 |
Type | string |
Must Support | True |
Summary | True |
Requirements | Need to support legacy numbers that are not in a tightly controlled format. |
Comments | Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value. |
Invariants |
|
Mappings |
|
RelatedPerson.telecom.use | |
Definition | Identifies the purpose for the contact point. |
Cardinality | 0...1 |
Type | code |
Binding | Use of contact point. |
Modifier | True |
Summary | True |
Requirements | Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose. |
Comments | Applications can assume that a contact is current unless it explicitly says that it is temporary or old. |
Invariants |
|
Mappings |
|
RelatedPerson.telecom.rank | |
Definition | Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values. |
Cardinality | 0...1 |
Type | positiveInt |
Summary | True |
Comments | Note that rank does not necessarily follow the order in which the contacts are represented in the instance. |
Invariants |
|
Mappings |
|
RelatedPerson.telecom.period | |
Definition | Time period when the contact point was/is in use. |
Cardinality | 0...1 |
Type | Period |
Summary | True |
Comments | A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. |
Invariants |
|
Mappings |
|
RelatedPerson.gender | |
Definition | Geschlechtsdefinition nach den Versichertenstammdaten (VSD) |
Cardinality | 0...1 |
Type | code |
Binding | The gender of a person used for administrative purposes. |
Summary | True |
Requirements | Needed for identification of the person, in combination with (at least) name and birth date. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
RelatedPerson.gender.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
RelatedPerson.gender.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
RelatedPerson.gender.extension:other-amtlich | |
Definition | Optional Extension Element - found in all resources. |
Cardinality | 0...1 |
Type | Extension(Coding) |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
RelatedPerson.gender.value | |
Definition | Primitive value for code |
Cardinality | 0...1 |
Type | System.String |
RelatedPerson.birthDate | |
Definition | The date on which the related person was born. |
Cardinality | 0...1 |
Type | date |
Summary | True |
Invariants |
|
Mappings |
|
RelatedPerson.address | |
Definition | Hier können Angaben zur Anschrift der Kontaktperson gemacht werden. |
Cardinality | 0...* |
Type | AddressDeBasis |
Must Support | True |
Summary | True |
Requirements | Need to keep track where the related person can be contacted per postal mail or visited. |
Comments | Das MustSupport gilt nur für die vordefinierten Slices. |
Invariants |
|
Examples | Beispiel für einfache Adresse { "use": "home", "type": "postal", "line": [ "Musterweg 42" ], "city": "Musterhausen", "postalCode": "99999" } |
Mappings |
|
RelatedPerson.address.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
RelatedPerson.address.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Must Support | True |
Alias | extensions, user content |
Comments | Das MustSupport gilt nur für die vordefinierten Slices. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
RelatedPerson.address.extension:Stadtteil | |
Definition | A subsection of a municipality. |
Cardinality | 0...1 |
Type | Extension(string) |
Must Support | True |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
RelatedPerson.address.extension:Stadtteil.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
RelatedPerson.address.extension:Stadtteil.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...0 |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
RelatedPerson.address.extension:Stadtteil.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Cardinality | 1...1 |
Type | uri |
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
Fixed Value | http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-precinct |
Mappings |
|
RelatedPerson.address.extension:Stadtteil.value[x] | |
Definition | Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). |
Cardinality | 1...1 |
Type | string |
Must Support | True |
Invariants |
|
Mappings |
|
RelatedPerson.address.use | |
Definition | The purpose of this address. |
Cardinality | 0...1 |
Type | code |
Binding | The use of an address. |
Modifier | True |
Summary | True |
Requirements | Allows an appropriate address to be chosen from a list of many. |
Comments | Applications can assume that an address is current unless it explicitly says that it is temporary or old. |
Invariants |
|
Examples | General home |
Mappings |
|
RelatedPerson.address.type | |
Definition | Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both. |
Cardinality | 1...1 |
Type | code |
Binding | The type of an address (physical / postal). |
Must Support | True |
Summary | True |
Comments | The definition of Address states that "address is intended to describe postal addresses, not physical locations". However, many applications track whether an address has a dual purpose of being a location that can be visited as well as being a valid delivery destination, and Postal addresses are often used as proxies for physical locations (also see the Location resource). |
Invariants |
|
Examples | General both |
Mappings |
|
RelatedPerson.address.text | |
Definition | Specifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Requirements | A renderable, unencoded form. |
Comments | Can provide both a text representation and parts. Applications updating an address SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part. |
Invariants |
|
Examples | General 137 Nowhere Street, Erewhon 9132 |
Mappings |
|
RelatedPerson.address.line | |
Definition | Diese Komponente kann Straßennamen, Hausnummer, Appartmentnummer, Postfach, c/o sowie weitere Zustellungshinweise enthalten. Die Informationen können in mehrere line-Komponenten aufgeteilt werden. Bei Verwendung der Extensions, um Straße, Hausnnummer und Postleitzahl strukturiert zu übermitteln, müssen diese Informationen stets vollständig auch in der line-Komponente, die sie erweitern, enthalten sein, um es Systemen, die diese Extensions nicht verwenden zu ermöglichen, auf diese Informationen zugreifen zu können. |
Cardinality | 0...3 |
Type | string |
Must Support | True |
Summary | True |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Examples | General 137 Nowhere Street Beipiel für Adresszeile mit Extensions für Straße und Hausnummer Musterweg 42 |
Mappings |
|
RelatedPerson.address.line.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
RelatedPerson.address.line.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Must Support | True |
Alias | extensions, user content |
Comments | Das MustSupport gilt nur für die vordefinierten Slices. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
RelatedPerson.address.line.extension:Strasse | |
Definition | Strassenname (ohne Hausnummer) Bei Angabe einer Strasse in dieser Extension muss diese auch in Address.line angegeben werden um die Interoperabilität mit Systemen zu gewährleisten, die diese Extension nicht verwenden. |
Cardinality | 0...1 |
Type | Extension(string) |
Must Support | True |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
RelatedPerson.address.line.extension:Strasse.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
RelatedPerson.address.line.extension:Strasse.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...0 |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
RelatedPerson.address.line.extension:Strasse.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Cardinality | 1...1 |
Type | uri |
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
Fixed Value | http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName |
Mappings |
|
RelatedPerson.address.line.extension:Strasse.value[x] | |
Definition | Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). |
Cardinality | 1...1 |
Type | string |
Must Support | True |
Invariants |
|
Mappings |
|
RelatedPerson.address.line.extension:Hausnummer | |
Definition | Hausnummer, sowie Zusätze (Appartmentnummer, Etage...) Bei Angabe einer Hausnummer in dieser Extension muss diese auch in Address.line angegeben werden um die Interoperabilität mit Systemen zu gewährleisten, die diese Extension nicht verwenden. |
Cardinality | 0...1 |
Type | Extension(string) |
Must Support | True |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
RelatedPerson.address.line.extension:Hausnummer.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
RelatedPerson.address.line.extension:Hausnummer.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...0 |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
RelatedPerson.address.line.extension:Hausnummer.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Cardinality | 1...1 |
Type | uri |
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
Fixed Value | http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber |
Mappings |
|
RelatedPerson.address.line.extension:Hausnummer.value[x] | |
Definition | Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). |
Cardinality | 1...1 |
Type | string |
Must Support | True |
Invariants |
|
Mappings |
|
RelatedPerson.address.line.extension:Adresszusatz | |
Definition | Zusätzliche Informationen, wie z.B. "3. Etage", "Appartment C" Bei Angabe einer Zusatzinformation in dieser Extension muss diese auch in Address.line angegeben werden um die Interoperabilität mit Systemen zu gewährleisten, die diese Extension nicht verwenden. |
Cardinality | 0...1 |
Type | Extension(string) |
Must Support | True |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
RelatedPerson.address.line.extension:Adresszusatz.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
RelatedPerson.address.line.extension:Adresszusatz.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...0 |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
RelatedPerson.address.line.extension:Adresszusatz.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Cardinality | 1...1 |
Type | uri |
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
Fixed Value | http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator |
Mappings |
|
RelatedPerson.address.line.extension:Adresszusatz.value[x] | |
Definition | Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). |
Cardinality | 1...1 |
Type | string |
Must Support | True |
Invariants |
|
Mappings |
|
RelatedPerson.address.line.extension:Postfach | |
Definition | Postfach-Adresse. Bei Angabe eines Postfaches in dieser Extension muss das Postfach auch in Address.line angegeben werden um die Interoperabilität mit Systemen zu gewährleisten, die diese Extension nicht verwenden. Eine Postfach-Adresse darf nicht in Verbindung mit Address.type "physical" oder "both" verwendet werden. |
Cardinality | 0...1 |
Type | Extension(string) |
Must Support | True |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
RelatedPerson.address.line.extension:Postfach.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
RelatedPerson.address.line.extension:Postfach.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...0 |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
RelatedPerson.address.line.extension:Postfach.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Cardinality | 1...1 |
Type | uri |
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
Fixed Value | http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox |
Mappings |
|
RelatedPerson.address.line.extension:Postfach.value[x] | |
Definition | Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). |
Cardinality | 1...1 |
Type | string |
Must Support | True |
Invariants |
|
Mappings |
|
RelatedPerson.address.line.value | |
Definition | Primitive value for string |
Cardinality | 0...1 |
Type | System.String |
RelatedPerson.address.city | |
Definition | The name of the city, town, suburb, village or other community or delivery center. |
Cardinality | 1...1 |
Type | string |
Must Support | True |
Summary | True |
Alias | Municpality |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Examples | General Erewhon |
Mappings |
|
RelatedPerson.address.district | |
Definition | The name of the administrative area (county). |
Cardinality | 0...0 |
Type | string |
Summary | True |
Alias | County |
Comments | District is sometimes known as county, but in some regions 'county' is used in place of city (municipality), so county name should be conveyed in city instead. |
Invariants |
|
Examples | General Madison |
Mappings |
|
RelatedPerson.address.state | |
Definition | Name (oder Kürzel) des Bundeslandes. |
Cardinality | 0...1 |
Type | string |
Binding | ValueSetISO31662DE (preferred) |
Summary | True |
Alias | Province, Territory |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
RelatedPerson.address.postalCode | |
Definition | Postleitzahl gemäß der im jeweiligen Land gültigen Konventionen |
Cardinality | 1...1 |
Type | string |
Must Support | True |
Summary | True |
Alias | Zip |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Examples | General 9132 |
Mappings |
|
RelatedPerson.address.country | |
Definition | Staat (vorzugsweise als 2-Stelliger ISO-Ländercode). Es obliegt abgeleiteten Profilen, hier die Verwendung der ISO-Ländercodes verbindlich vorzuschreiben |
Cardinality | 1...1 |
Type | string |
Binding | Iso3166-1-2 (preferred) |
Must Support | True |
Summary | True |
Comments | ISO 3166 3 letter codes can be used in place of a human readable country name. |
Invariants |
|
Mappings |
|
RelatedPerson.address.period | |
Definition | Time period when address was/is in use. |
Cardinality | 0...1 |
Type | Period |
Summary | True |
Requirements | Allows addresses to be placed in historical context. |
Comments | A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. |
Invariants |
|
Examples | General { "start": "2010-03-23", "end": "2010-07-01" } |
Mappings |
|
RelatedPerson.photo | |
Definition | Image of the person. |
Cardinality | 0...* |
Type | Attachment |
Requirements | Many EHR systems have the capability to capture an image of persons. Fits with newer social media usage too. |
Comments | When providing a summary view (for example with Observation.value[x]) Attachment should be represented with a brief display text such as "Signed Procedure Consent". |
Invariants |
|
Mappings |
|
RelatedPerson.period | |
Definition | The period of time during which this relationship is or was active. If there are no dates defined, then the interval is unknown. |
Cardinality | 0...1 |
Type | Period |
Comments | A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. |
Invariants |
|
Mappings |
|
RelatedPerson.communication | |
Definition | A language which may be used to communicate with about the patient's health. |
Cardinality | 0...* |
Type | BackboneElement |
Requirements | If a related person does not speak the local language, interpreters may be required, so languages spoken and proficiency is an important things to keep track of both for patient and other persons of interest. |
Comments | If no language is specified, this implies that the default local language is spoken. If you need to convey proficiency for multiple modes, then you need multiple RelatedPerson.Communication associations. If the RelatedPerson does not speak the default local language, then the Interpreter Required Standard can be used to explicitly declare that an interpreter is required. |
Invariants |
|
Mappings |
|
RelatedPerson.communication.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
RelatedPerson.communication.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
RelatedPerson.communication.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
RelatedPerson.communication.language | |
Definition | The ISO-639-1 alpha 2 code in lower case for the language, optionally followed by a hyphen and the ISO-3166-1 alpha 2 code for the region in upper case; e.g. "en" for English, or "en-US" for American English versus "en-EN" for England English. |
Cardinality | 1...1 |
Type | CodeableConcept |
Binding | A human language. |
Requirements | Most systems in multilingual countries will want to convey language. Not all systems actually need the regional dialect. |
Comments | The structure aa-BB with this exact casing is one the most widely used notations for locale. However not all systems actually code this but instead have it as free text. Hence CodeableConcept instead of code as the data type. |
Invariants |
|
Mappings |
|
RelatedPerson.communication.preferred | |
Definition | Indicates whether or not the patient prefers this language (over other languages he masters up a certain level). |
Cardinality | 0...1 |
Type | boolean |
Requirements | People that master multiple languages up to certain level may prefer one or more, i.e. feel more confident in communicating in a particular language making other languages sort of a fall back method. |
Comments | This language is specifically identified for communicating healthcare information. |
Invariants |
|
Mappings |
|
<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="epa-related-person" /> <url value="https://gematik.de/fhir/epa/StructureDefinition/epa-related-person" /> <version value="1.1.0" /> <name value="EPARelatedPerson" /> <title value="EPA Related Person" /> <status value="active" /> <experimental value="false" /> <date value="2024-08-14" /> <publisher value="mio42 GmbH" /> <description value="Hier wird eine Kontakt- oder Bezugsperson erfasst, die eine Beziehung zur behandelten Person hat. Sie kann an der Versorgung der behandelten Person beteiligt sein." /> <fhirVersion value="4.0.1" /> <kind value="resource" /> <abstract value="false" /> <type value="RelatedPerson" /> <baseDefinition value="http://hl7.org/fhir/StructureDefinition/RelatedPerson" /> <derivation value="constraint" /> <differential> <element id="RelatedPerson"> <path value="RelatedPerson" /> <definition value="Hier wird eine Kontakt- oder Bezugsperson erfasst, die eine Beziehung zur behandelten Person hat. Sie kann an der Versorgung der behandelten Person beteiligt sein." /> </element> <element id="RelatedPerson.meta"> <path value="RelatedPerson.meta" /> <mustSupport value="true" /> </element> <element id="RelatedPerson.meta.versionId"> <path value="RelatedPerson.meta.versionId" /> <mustSupport value="true" /> </element> <element id="RelatedPerson.meta.lastUpdated"> <path value="RelatedPerson.meta.lastUpdated" /> <mustSupport value="true" /> </element> <element id="RelatedPerson.text"> <path value="RelatedPerson.text" /> <definition value="In diesem Element können die in der Instanz enthaltenen Informationen in einer menschenlesbaren Form zusammengefasst werden. Dabei ist zu beachten, dass keine Informationen aufgenommen werden dürfen, die nicht in strukturierter Form an anderer Stelle in der Instanz enthalten sind." /> </element> <element id="RelatedPerson.text.status"> <path value="RelatedPerson.text.status" /> <patternCode value="extensions" /> </element> <element id="RelatedPerson.extension"> <path value="RelatedPerson.extension" /> <mustSupport value="true" /> </element> <element id="RelatedPerson.extension:additional-comment"> <path value="RelatedPerson.extension" /> <sliceName value="additional-comment" /> <definition value="Hier können weitere Informationen, beispielsweise die Pflegebedürftigkeitssituation der Kontaktperson, dargestellt werden. Wenn die Kontaktperson auch gesetzlich betreuende Person ist, kann hier beschrieben werden, für welchen Bereich sie bevollmächtigt ist." /> <min value="0" /> <max value="1" /> <type> <code value="Extension" /> <profile value="https://gematik.de/fhir/epa/StructureDefinition/epa-additional-comment-extension" /> </type> <mustSupport value="true" /> </element> <element id="RelatedPerson.extension:additional-comment.value[x]"> <path value="RelatedPerson.extension.value[x]" /> <mustSupport value="true" /> </element> <element id="RelatedPerson.patient"> <path value="RelatedPerson.patient" /> <mustSupport value="true" /> </element> <element id="RelatedPerson.patient.identifier"> <path value="RelatedPerson.patient.identifier" /> <min value="1" /> <type> <code value="Identifier" /> <profile value="http://fhir.de/StructureDefinition/identifier-kvid-10" /> </type> <mustSupport value="true" /> </element> <element id="RelatedPerson.relationship"> <path value="RelatedPerson.relationship" /> <definition value="Hier wird die Beziehung der Kontaktperson zur Patient:in anhand eines entsprechenden Codes oder mit einem Freitext angegeben." /> <mustSupport value="true" /> </element> <element id="RelatedPerson.relationship.coding"> <path value="RelatedPerson.relationship.coding" /> <slicing> <discriminator> <type value="value" /> <path value="$this" /> </discriminator> <rules value="open" /> </slicing> <definition value="Hier werden Codes angegeben." /> <comment value="Das MustSupport gilt nur für die vordefinierten Slices." /> <mustSupport value="true" /> </element> <element id="RelatedPerson.relationship.coding:relationship-type"> <path value="RelatedPerson.relationship.coding" /> <sliceName value="relationship-type" /> <definition value="Hier wird die Beziehung der Kontaktperson zur Patient:in anhand eines Codes aus einer vorgegebenen Werteliste angegeben." /> <min value="0" /> <max value="1" /> <mustSupport value="true" /> <binding> <strength value="required" /> <valueSet value="http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype" /> </binding> </element> <element id="RelatedPerson.relationship.coding:relationship-type.system"> <path value="RelatedPerson.relationship.coding.system" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="RelatedPerson.relationship.coding:relationship-type.version"> <path value="RelatedPerson.relationship.coding.version" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="RelatedPerson.relationship.coding:relationship-type.code"> <path value="RelatedPerson.relationship.coding.code" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="RelatedPerson.relationship.coding:relationship-type.display"> <path value="RelatedPerson.relationship.coding.display" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="RelatedPerson.relationship.text"> <path value="RelatedPerson.relationship.text" /> <definition value="Hier wird ein Freitext eingetragen." /> <mustSupport value="true" /> </element> <element id="RelatedPerson.name"> <path value="RelatedPerson.name" /> <definition value="Dieses Element beschreibt diverse Namensbestandteile einer Person." /> <min value="1" /> <max value="1" /> <type> <code value="HumanName" /> <profile value="http://fhir.de/StructureDefinition/humanname-de-basis" /> </type> <mustSupport value="true" /> </element> <element id="RelatedPerson.name.use"> <path value="RelatedPerson.name.use" /> <min value="1" /> <fixedCode value="official" /> <mustSupport value="true" /> </element> <element id="RelatedPerson.name.text"> <path value="RelatedPerson.name.text" /> <mustSupport value="true" /> </element> <element id="RelatedPerson.name.family"> <path value="RelatedPerson.name.family" /> <definition value="Nachname einer Person." /> <min value="1" /> <mustSupport value="true" /> </element> <element id="RelatedPerson.name.family.extension"> <path value="RelatedPerson.name.family.extension" /> <comment value="Das MustSupport gilt nur für die vordefinierten Slices." /> <mustSupport value="true" /> </element> <element id="RelatedPerson.name.family.extension:namenszusatz"> <path value="RelatedPerson.name.family.extension" /> <sliceName value="namenszusatz" /> <mustSupport value="true" /> </element> <element id="RelatedPerson.name.family.extension:namenszusatz.value[x]"> <path value="RelatedPerson.name.family.extension.value[x]" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="RelatedPerson.name.family.extension:nachname"> <path value="RelatedPerson.name.family.extension" /> <sliceName value="nachname" /> <mustSupport value="true" /> </element> <element id="RelatedPerson.name.family.extension:nachname.value[x]"> <path value="RelatedPerson.name.family.extension.value[x]" /> <mustSupport value="true" /> </element> <element id="RelatedPerson.name.family.extension:vorsatzwort"> <path value="RelatedPerson.name.family.extension" /> <sliceName value="vorsatzwort" /> <mustSupport value="true" /> </element> <element id="RelatedPerson.name.family.extension:vorsatzwort.value[x]"> <path value="RelatedPerson.name.family.extension.value[x]" /> <mustSupport value="true" /> </element> <element id="RelatedPerson.name.given"> <path value="RelatedPerson.name.given" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="RelatedPerson.name.prefix"> <path value="RelatedPerson.name.prefix" /> <definition value="Titel als akademischer Grad. Beispiele: Dr.med., Dr.rer.nat., Prof." /> <mustSupport value="true" /> </element> <element id="RelatedPerson.name.prefix.extension"> <path value="RelatedPerson.name.prefix.extension" /> <comment value="Das MustSupport gilt nur für die vordefinierten Slices." /> <mustSupport value="true" /> </element> <element id="RelatedPerson.name.prefix.extension:prefix-qualifier"> <path value="RelatedPerson.name.prefix.extension" /> <sliceName value="prefix-qualifier" /> <mustSupport value="true" /> </element> <element id="RelatedPerson.name.prefix.extension:prefix-qualifier.value[x]"> <path value="RelatedPerson.name.prefix.extension.value[x]" /> <mustSupport value="true" /> </element> <element id="RelatedPerson.telecom"> <path value="RelatedPerson.telecom" /> <definition value="Dieses Element beschreibt die vorhandenen Kontaktmöglichkeiten." /> <mustSupport value="true" /> </element> <element id="RelatedPerson.telecom.system"> <path value="RelatedPerson.telecom.system" /> <definition value="Definition der Art des Kontaktes, z. B. Telefon (phone), E-Mail, Fax." /> <min value="1" /> <mustSupport value="true" /> </element> <element id="RelatedPerson.telecom.value"> <path value="RelatedPerson.telecom.value" /> <definition value="In diesem Element können Kontaktinformationen passend zum Kontaktkanal angegeben werden. Beispiele für mögliche Werte sind: "m.mustermann@mio42.de" (beim Kontaktkanal "E-mail", oder "030712345678" (beim Kontaktkanal "Telefon")." /> <min value="1" /> <mustSupport value="true" /> </element> <element id="RelatedPerson.gender"> <path value="RelatedPerson.gender" /> <definition value="Geschlechtsdefinition nach den Versichertenstammdaten (VSD)" /> </element> <element id="RelatedPerson.gender.extension:other-amtlich"> <path value="RelatedPerson.gender.extension" /> <sliceName value="other-amtlich" /> <min value="0" /> <max value="1" /> <type> <code value="Extension" /> <profile value="http://fhir.de/StructureDefinition/gender-amtlich-de" /> </type> </element> <element id="RelatedPerson.address"> <path value="RelatedPerson.address" /> <definition value="Hier können Angaben zur Anschrift der Kontaktperson gemacht werden." /> <comment value="Das MustSupport gilt nur für die vordefinierten Slices." /> <type> <code value="Address" /> <profile value="http://fhir.de/StructureDefinition/address-de-basis" /> </type> <mustSupport value="true" /> </element> <element id="RelatedPerson.address.extension"> <path value="RelatedPerson.address.extension" /> <comment value="Das MustSupport gilt nur für die vordefinierten Slices." /> <mustSupport value="true" /> </element> <element id="RelatedPerson.address.extension:Stadtteil"> <path value="RelatedPerson.address.extension" /> <sliceName value="Stadtteil" /> <mustSupport value="true" /> </element> <element id="RelatedPerson.address.extension:Stadtteil.value[x]"> <path value="RelatedPerson.address.extension.value[x]" /> <mustSupport value="true" /> </element> <element id="RelatedPerson.address.type"> <path value="RelatedPerson.address.type" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="RelatedPerson.address.line"> <path value="RelatedPerson.address.line" /> <mustSupport value="true" /> </element> <element id="RelatedPerson.address.line.extension"> <path value="RelatedPerson.address.line.extension" /> <comment value="Das MustSupport gilt nur für die vordefinierten Slices." /> <mustSupport value="true" /> </element> <element id="RelatedPerson.address.line.extension:Strasse"> <path value="RelatedPerson.address.line.extension" /> <sliceName value="Strasse" /> <mustSupport value="true" /> </element> <element id="RelatedPerson.address.line.extension:Strasse.value[x]"> <path value="RelatedPerson.address.line.extension.value[x]" /> <mustSupport value="true" /> </element> <element id="RelatedPerson.address.line.extension:Hausnummer"> <path value="RelatedPerson.address.line.extension" /> <sliceName value="Hausnummer" /> <mustSupport value="true" /> </element> <element id="RelatedPerson.address.line.extension:Hausnummer.value[x]"> <path value="RelatedPerson.address.line.extension.value[x]" /> <mustSupport value="true" /> </element> <element id="RelatedPerson.address.line.extension:Adresszusatz"> <path value="RelatedPerson.address.line.extension" /> <sliceName value="Adresszusatz" /> <mustSupport value="true" /> </element> <element id="RelatedPerson.address.line.extension:Adresszusatz.value[x]"> <path value="RelatedPerson.address.line.extension.value[x]" /> <mustSupport value="true" /> </element> <element id="RelatedPerson.address.line.extension:Postfach"> <path value="RelatedPerson.address.line.extension" /> <sliceName value="Postfach" /> <mustSupport value="true" /> </element> <element id="RelatedPerson.address.line.extension:Postfach.value[x]"> <path value="RelatedPerson.address.line.extension.value[x]" /> <mustSupport value="true" /> </element> <element id="RelatedPerson.address.city"> <path value="RelatedPerson.address.city" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="RelatedPerson.address.postalCode"> <path value="RelatedPerson.address.postalCode" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="RelatedPerson.address.country"> <path value="RelatedPerson.address.country" /> <min value="1" /> <mustSupport value="true" /> </element> </differential> </StructureDefinition>
{ "resourceType": "StructureDefinition", "id": "epa-related-person", "url": "https://gematik.de/fhir/epa/StructureDefinition/epa-related-person", "version": "1.1.0", "name": "EPARelatedPerson", "title": "EPA Related Person", "status": "active", "experimental": false, "date": "2024-08-14", "publisher": "mio42 GmbH", "description": "Hier wird eine Kontakt- oder Bezugsperson erfasst, die eine Beziehung zur behandelten Person hat. Sie kann an der Versorgung der behandelten Person beteiligt sein.", "fhirVersion": "4.0.1", "kind": "resource", "abstract": false, "type": "RelatedPerson", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/RelatedPerson", "derivation": "constraint", "differential": { "element": [ { "id": "RelatedPerson", "path": "RelatedPerson", "definition": "Hier wird eine Kontakt- oder Bezugsperson erfasst, die eine Beziehung zur behandelten Person hat. Sie kann an der Versorgung der behandelten Person beteiligt sein." }, { "id": "RelatedPerson.meta", "path": "RelatedPerson.meta", "mustSupport": true }, { "id": "RelatedPerson.meta.versionId", "path": "RelatedPerson.meta.versionId", "mustSupport": true }, { "id": "RelatedPerson.meta.lastUpdated", "path": "RelatedPerson.meta.lastUpdated", "mustSupport": true }, { "id": "RelatedPerson.text", "path": "RelatedPerson.text", "definition": "In diesem Element können die in der Instanz enthaltenen Informationen in einer menschenlesbaren Form zusammengefasst werden. Dabei ist zu beachten, dass keine Informationen aufgenommen werden dürfen, die nicht in strukturierter Form an anderer Stelle in der Instanz enthalten sind." }, { "id": "RelatedPerson.text.status", "path": "RelatedPerson.text.status", "patternCode": "extensions" }, { "id": "RelatedPerson.extension", "path": "RelatedPerson.extension", "mustSupport": true }, { "id": "RelatedPerson.extension:additional-comment", "path": "RelatedPerson.extension", "sliceName": "additional-comment", "definition": "Hier können weitere Informationen, beispielsweise die Pflegebedürftigkeitssituation der Kontaktperson, dargestellt werden. Wenn die Kontaktperson auch gesetzlich betreuende Person ist, kann hier beschrieben werden, für welchen Bereich sie bevollmächtigt ist.", "min": 0, "max": "1", "type": [ { "code": "Extension", "profile": [ "https://gematik.de/fhir/epa/StructureDefinition/epa-additional-comment-extension" ] } ], "mustSupport": true }, { "id": "RelatedPerson.extension:additional-comment.value[x]", "path": "RelatedPerson.extension.value[x]", "mustSupport": true }, { "id": "RelatedPerson.patient", "path": "RelatedPerson.patient", "mustSupport": true }, { "id": "RelatedPerson.patient.identifier", "path": "RelatedPerson.patient.identifier", "min": 1, "type": [ { "code": "Identifier", "profile": [ "http://fhir.de/StructureDefinition/identifier-kvid-10" ] } ], "mustSupport": true }, { "id": "RelatedPerson.relationship", "path": "RelatedPerson.relationship", "definition": "Hier wird die Beziehung der Kontaktperson zur Patient:in anhand eines entsprechenden Codes oder mit einem Freitext angegeben.", "mustSupport": true }, { "id": "RelatedPerson.relationship.coding", "path": "RelatedPerson.relationship.coding", "slicing": { "discriminator": [ { "type": "value", "path": "$this" } ], "rules": "open" }, "definition": "Hier werden Codes angegeben.", "comment": "Das MustSupport gilt nur für die vordefinierten Slices.", "mustSupport": true }, { "id": "RelatedPerson.relationship.coding:relationship-type", "path": "RelatedPerson.relationship.coding", "sliceName": "relationship-type", "definition": "Hier wird die Beziehung der Kontaktperson zur Patient:in anhand eines Codes aus einer vorgegebenen Werteliste angegeben.", "min": 0, "max": "1", "mustSupport": true, "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype" } }, { "id": "RelatedPerson.relationship.coding:relationship-type.system", "path": "RelatedPerson.relationship.coding.system", "min": 1, "mustSupport": true }, { "id": "RelatedPerson.relationship.coding:relationship-type.version", "path": "RelatedPerson.relationship.coding.version", "min": 1, "mustSupport": true }, { "id": "RelatedPerson.relationship.coding:relationship-type.code", "path": "RelatedPerson.relationship.coding.code", "min": 1, "mustSupport": true }, { "id": "RelatedPerson.relationship.coding:relationship-type.display", "path": "RelatedPerson.relationship.coding.display", "min": 1, "mustSupport": true }, { "id": "RelatedPerson.relationship.text", "path": "RelatedPerson.relationship.text", "definition": "Hier wird ein Freitext eingetragen.", "mustSupport": true }, { "id": "RelatedPerson.name", "path": "RelatedPerson.name", "definition": "Dieses Element beschreibt diverse Namensbestandteile einer Person.", "min": 1, "max": "1", "type": [ { "code": "HumanName", "profile": [ "http://fhir.de/StructureDefinition/humanname-de-basis" ] } ], "mustSupport": true }, { "id": "RelatedPerson.name.use", "path": "RelatedPerson.name.use", "min": 1, "fixedCode": "official", "mustSupport": true }, { "id": "RelatedPerson.name.text", "path": "RelatedPerson.name.text", "mustSupport": true }, { "id": "RelatedPerson.name.family", "path": "RelatedPerson.name.family", "definition": "Nachname einer Person.", "min": 1, "mustSupport": true }, { "id": "RelatedPerson.name.family.extension", "path": "RelatedPerson.name.family.extension", "comment": "Das MustSupport gilt nur für die vordefinierten Slices.", "mustSupport": true }, { "id": "RelatedPerson.name.family.extension:namenszusatz", "path": "RelatedPerson.name.family.extension", "sliceName": "namenszusatz", "mustSupport": true }, { "id": "RelatedPerson.name.family.extension:namenszusatz.value[x]", "path": "RelatedPerson.name.family.extension.value[x]", "min": 1, "mustSupport": true }, { "id": "RelatedPerson.name.family.extension:nachname", "path": "RelatedPerson.name.family.extension", "sliceName": "nachname", "mustSupport": true }, { "id": "RelatedPerson.name.family.extension:nachname.value[x]", "path": "RelatedPerson.name.family.extension.value[x]", "mustSupport": true }, { "id": "RelatedPerson.name.family.extension:vorsatzwort", "path": "RelatedPerson.name.family.extension", "sliceName": "vorsatzwort", "mustSupport": true }, { "id": "RelatedPerson.name.family.extension:vorsatzwort.value[x]", "path": "RelatedPerson.name.family.extension.value[x]", "mustSupport": true }, { "id": "RelatedPerson.name.given", "path": "RelatedPerson.name.given", "min": 1, "mustSupport": true }, { "id": "RelatedPerson.name.prefix", "path": "RelatedPerson.name.prefix", "definition": "Titel als akademischer Grad. Beispiele: Dr.med., Dr.rer.nat., Prof.", "mustSupport": true }, { "id": "RelatedPerson.name.prefix.extension", "path": "RelatedPerson.name.prefix.extension", "comment": "Das MustSupport gilt nur für die vordefinierten Slices.", "mustSupport": true }, { "id": "RelatedPerson.name.prefix.extension:prefix-qualifier", "path": "RelatedPerson.name.prefix.extension", "sliceName": "prefix-qualifier", "mustSupport": true }, { "id": "RelatedPerson.name.prefix.extension:prefix-qualifier.value[x]", "path": "RelatedPerson.name.prefix.extension.value[x]", "mustSupport": true }, { "id": "RelatedPerson.telecom", "path": "RelatedPerson.telecom", "definition": "Dieses Element beschreibt die vorhandenen Kontaktmöglichkeiten.", "mustSupport": true }, { "id": "RelatedPerson.telecom.system", "path": "RelatedPerson.telecom.system", "definition": "Definition der Art des Kontaktes, z. B. Telefon (phone), E-Mail, Fax.", "min": 1, "mustSupport": true }, { "id": "RelatedPerson.telecom.value", "path": "RelatedPerson.telecom.value", "definition": "In diesem Element können Kontaktinformationen passend zum Kontaktkanal angegeben werden. Beispiele für mögliche Werte sind: \"m.mustermann@mio42.de\" (beim Kontaktkanal \"E-mail\", oder \"030712345678\" (beim Kontaktkanal \"Telefon\").", "min": 1, "mustSupport": true }, { "id": "RelatedPerson.gender", "path": "RelatedPerson.gender", "definition": "Geschlechtsdefinition nach den Versichertenstammdaten (VSD)" }, { "id": "RelatedPerson.gender.extension:other-amtlich", "path": "RelatedPerson.gender.extension", "sliceName": "other-amtlich", "min": 0, "max": "1", "type": [ { "code": "Extension", "profile": [ "http://fhir.de/StructureDefinition/gender-amtlich-de" ] } ] }, { "id": "RelatedPerson.address", "path": "RelatedPerson.address", "definition": "Hier können Angaben zur Anschrift der Kontaktperson gemacht werden.", "comment": "Das MustSupport gilt nur für die vordefinierten Slices.", "type": [ { "code": "Address", "profile": [ "http://fhir.de/StructureDefinition/address-de-basis" ] } ], "mustSupport": true }, { "id": "RelatedPerson.address.extension", "path": "RelatedPerson.address.extension", "comment": "Das MustSupport gilt nur für die vordefinierten Slices.", "mustSupport": true }, { "id": "RelatedPerson.address.extension:Stadtteil", "path": "RelatedPerson.address.extension", "sliceName": "Stadtteil", "mustSupport": true }, { "id": "RelatedPerson.address.extension:Stadtteil.value[x]", "path": "RelatedPerson.address.extension.value[x]", "mustSupport": true }, { "id": "RelatedPerson.address.type", "path": "RelatedPerson.address.type", "min": 1, "mustSupport": true }, { "id": "RelatedPerson.address.line", "path": "RelatedPerson.address.line", "mustSupport": true }, { "id": "RelatedPerson.address.line.extension", "path": "RelatedPerson.address.line.extension", "comment": "Das MustSupport gilt nur für die vordefinierten Slices.", "mustSupport": true }, { "id": "RelatedPerson.address.line.extension:Strasse", "path": "RelatedPerson.address.line.extension", "sliceName": "Strasse", "mustSupport": true }, { "id": "RelatedPerson.address.line.extension:Strasse.value[x]", "path": "RelatedPerson.address.line.extension.value[x]", "mustSupport": true }, { "id": "RelatedPerson.address.line.extension:Hausnummer", "path": "RelatedPerson.address.line.extension", "sliceName": "Hausnummer", "mustSupport": true }, { "id": "RelatedPerson.address.line.extension:Hausnummer.value[x]", "path": "RelatedPerson.address.line.extension.value[x]", "mustSupport": true }, { "id": "RelatedPerson.address.line.extension:Adresszusatz", "path": "RelatedPerson.address.line.extension", "sliceName": "Adresszusatz", "mustSupport": true }, { "id": "RelatedPerson.address.line.extension:Adresszusatz.value[x]", "path": "RelatedPerson.address.line.extension.value[x]", "mustSupport": true }, { "id": "RelatedPerson.address.line.extension:Postfach", "path": "RelatedPerson.address.line.extension", "sliceName": "Postfach", "mustSupport": true }, { "id": "RelatedPerson.address.line.extension:Postfach.value[x]", "path": "RelatedPerson.address.line.extension.value[x]", "mustSupport": true }, { "id": "RelatedPerson.address.city", "path": "RelatedPerson.address.city", "min": 1, "mustSupport": true }, { "id": "RelatedPerson.address.postalCode", "path": "RelatedPerson.address.postalCode", "min": 1, "mustSupport": true }, { "id": "RelatedPerson.address.country", "path": "RelatedPerson.address.country", "min": 1, "mustSupport": true } ] } }
Profil für die Datenverwaltung im Kontext der Medikationsplanung
EPARelatedPersonSource (RelatedPerson) | I | EPARelatedPerson | |
id | Σ | 0..1 | string |
meta | S Σ | 0..1 | Meta |
id | 0..1 | string | |
extension | I | 0..* | Extension |
versionId | S Σ | 0..1 | id |
lastUpdated | S Σ | 0..1 | instant |
source | Σ | 0..0 | uri |
profile | Σ | 0..* | canonical(StructureDefinition) |
security | Σ | 0..0 | CodingBinding |
tag | Σ | 0..0 | Coding |
implicitRules | Σ ?! | 0..0 | uri |
language | 0..0 | codeBinding | |
text | 0..0 | Narrative | |
contained | 0..0 | Resource | |
extension | S I | 0..* | Extension |
additional-comment | S I | 0..1 | Extension(string) |
id | 0..1 | string | |
extension | I | 0..0 | Extension |
url | 1..1 | uriFixed Value | |
value[x] | S | 1..1 | |
valueString | string | ||
modifierExtension | ?! I | 0..0 | Extension |
identifier | Σ | 0..0 | Identifier |
active | Σ ?! | 0..0 | boolean |
patient | S Σ I | 1..1 | Reference(Patient) |
id | 0..1 | string | |
extension | I | 0..* | Extension |
reference | Σ I | 0..0 | string |
type | Σ | 0..0 | uriBinding |
identifier | S Σ | 1..1 | IdentifierKvid10 |
display | Σ | 0..0 | string |
relationship | S Σ | 0..* | CodeableConceptBinding |
id | 0..1 | string | |
extension | I | 0..* | Extension |
coding | S Σ | 0..1 | Coding |
relationship-type | S Σ | 0..1 | CodingBinding |
id | 0..1 | string | |
extension | I | 0..* | Extension |
system | S Σ | 1..1 | uri |
version | S Σ | 1..1 | string |
code | S Σ | 1..1 | code |
display | S Σ | 1..1 | string |
userSelected | Σ | 0..0 | boolean |
text | S Σ | 0..1 | string |
name | S Σ I | 1..1 | HumannameDeBasis |
id | 0..1 | string | |
extension | I | 0..* | Extension |
use | S Σ ?! | 1..1 | codeBindingFixed Value |
text | S Σ | 0..1 | string |
family | S Σ | 1..1 | string |
id | 0..1 | string | |
extension | S I | 0..* | Extension |
namenszusatz | S I | 0..1 | Extension(string) |
id | 0..1 | string | |
extension | I | 0..0 | Extension |
url | 1..1 | uriFixed Value | |
value[x] | S | 1..1 | |
valueString | string | ||
nachname | S I | 0..1 | Extension(string) |
id | 0..1 | string | |
extension | I | 0..0 | Extension |
url | 1..1 | uriFixed Value | |
value[x] | S | 1..1 | |
valueString | string | ||
vorsatzwort | S I | 0..1 | Extension(string) |
id | 0..1 | string | |
extension | I | 0..0 | Extension |
url | 1..1 | uriFixed Value | |
value[x] | S | 1..1 | |
valueString | string | ||
value | 0..1 | System.String | |
given | S Σ | 1..* | string |
prefix | S Σ | 0..* | string |
id | 0..1 | string | |
extension | S I | 0..* | Extension |
prefix-qualifier | S I | 0..1 | Extension(code) |
id | 0..1 | string | |
extension | I | 0..0 | Extension |
url | 1..1 | uriFixed Value | |
value[x] | S | 1..1 | Binding |
valueCode | code | ||
value | 0..1 | System.String | |
suffix | Σ | 0..* | string |
period | Σ I | 0..1 | Period |
telecom | S Σ I | 0..* | ContactPoint |
id | 0..1 | string | |
extension | I | 0..* | Extension |
system | S Σ I | 1..1 | codeBinding |
value | S Σ | 1..1 | string |
use | Σ ?! | 0..0 | codeBinding |
rank | Σ | 0..0 | positiveInt |
period | Σ I | 0..0 | Period |
gender | Σ | 0..0 | codeBinding |
birthDate | Σ | 0..0 | date |
address | S Σ I | 0..* | AddressDeBasis |
id | 0..1 | string | |
extension | S I | 0..* | Extension |
Stadtteil | S I | 0..1 | Extension(string) |
id | 0..1 | string | |
extension | I | 0..0 | Extension |
url | 1..1 | uriFixed Value | |
value[x] | S | 1..1 | |
valueString | string | ||
use | Σ ?! | 0..0 | codeBinding |
type | S Σ | 1..1 | codeBinding |
text | Σ | 0..0 | string |
line | S Σ | 0..3 | string |
id | 0..1 | string | |
extension | S I | 0..* | Extension |
Strasse | S I | 0..1 | Extension(string) |
id | 0..1 | string | |
extension | I | 0..0 | Extension |
url | 1..1 | uriFixed Value | |
value[x] | S | 1..1 | |
valueString | string | ||
Hausnummer | S I | 0..1 | Extension(string) |
id | 0..1 | string | |
extension | I | 0..0 | Extension |
url | 1..1 | uriFixed Value | |
value[x] | S | 1..1 | |
valueString | string | ||
Adresszusatz | S I | 0..1 | Extension(string) |
id | 0..1 | string | |
extension | I | 0..0 | Extension |
url | 1..1 | uriFixed Value | |
value[x] | S | 1..1 | |
valueString | string | ||
Postfach | S I | 0..1 | Extension(string) |
id | 0..1 | string | |
extension | I | 0..0 | Extension |
url | 1..1 | uriFixed Value | |
value[x] | S | 1..1 | |
valueString | string | ||
value | 0..1 | System.String | |
city | S Σ | 1..1 | string |
district | Σ | 0..0 | string |
state | Σ | 0..0 | stringBinding |
postalCode | S Σ | 1..1 | string |
country | S Σ | 1..1 | stringBinding |
period | Σ I | 0..0 | Period |
photo | I | 0..0 | Attachment |
period | I | 0..0 | Period |
communication | 0..0 | BackboneElement |
RelatedPerson | |
Definition | Hier wird eine Kontakt- oder Bezugsperson erfasst, die eine Beziehung zur behandelten Person hat. Sie kann an der Versorgung der behandelten Person beteiligt sein. |
Cardinality | 0...* |
Invariants |
|
Mappings |
|
RelatedPerson.id | |
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation. |
RelatedPerson.meta | |
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
Cardinality | 0...1 |
Type | Meta |
Must Support | True |
Summary | True |
Invariants |
|
Mappings |
|
RelatedPerson.meta.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
RelatedPerson.meta.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
RelatedPerson.meta.versionId | |
Definition | The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted. |
Cardinality | 0...1 |
Type | id |
Must Support | True |
Summary | True |
Comments | The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes. |
Invariants |
|
Mappings |
|
RelatedPerson.meta.lastUpdated | |
Definition | When the resource last changed - e.g. when the version changed. |
Cardinality | 0...1 |
Type | instant |
Must Support | True |
Summary | True |
Comments | This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a read interaction. |
Invariants |
|
Mappings |
|
RelatedPerson.meta.source | |
Definition | A uri that identifies the source system of the resource. This provides a minimal amount of [Provenance](provenance.html#) information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc. |
Cardinality | 0...0 |
Type | uri |
Summary | True |
Comments | In the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used. This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL. |
Invariants |
|
Mappings |
|
RelatedPerson.meta.profile | |
Definition | A list of profiles (references to [StructureDefinition](structuredefinition.html#) resources) that this resource claims to conform to. The URL is a reference to [StructureDefinition.url](structuredefinition-definitions.html#StructureDefinition.url). |
Cardinality | 0...* |
Type | canonical(StructureDefinition) |
Summary | True |
Comments | It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set. |
Invariants |
|
Mappings |
|
RelatedPerson.meta.security | |
Definition | Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure. |
Cardinality | 0...0 |
Type | Coding |
Binding | Security Labels from the Healthcare Privacy and Security Classification System. |
Summary | True |
Comments | The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored. |
Invariants |
|
Mappings |
|
RelatedPerson.meta.tag | |
Definition | Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource. |
Cardinality | 0...0 |
Type | Coding |
Binding | Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". |
Summary | True |
Comments | The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored. |
Invariants |
|
Mappings |
|
RelatedPerson.implicitRules | |
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
Cardinality | 0...0 |
Type | uri |
Modifier | True |
Summary | True |
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. |
Invariants |
|
Mappings |
|
RelatedPerson.language | |
Definition | The base language in which the resource is written. |
Cardinality | 0...0 |
Type | code |
Binding | A human language. |
Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). |
Invariants |
|
Mappings |
|
RelatedPerson.text | |
Definition | In diesem Element können die in der Instanz enthaltenen Informationen in einer menschenlesbaren Form zusammengefasst werden. Dabei ist zu beachten, dass keine Informationen aufgenommen werden dürfen, die nicht in strukturierter Form an anderer Stelle in der Instanz enthalten sind. |
Cardinality | 0...0 |
Type | Narrative |
Alias | narrative, html, xhtml, display |
Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. |
Invariants |
|
Mappings |
|
RelatedPerson.text.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
RelatedPerson.text.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
RelatedPerson.text.status | |
Definition | The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data. |
Cardinality | 1...1 |
Type | code |
Binding | The status of a resource narrative. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Pattern | extensions |
Mappings |
|
RelatedPerson.text.div | |
Definition | The actual narrative content, a stripped down version of XHTML. |
Cardinality | 1...1 |
Type | xhtml |
Comments | The contents of the html element are an XHTML fragment containing only the basic html formatting elements described in chapters 7-11 and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained stylesheets. The XHTML content SHALL NOT contain a head, a body, external stylesheet references, scripts, forms, base/link/xlink, frames, iframes and objects. |
Invariants |
|
Mappings |
|
RelatedPerson.contained | |
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
Cardinality | 0...0 |
Type | Resource |
Alias | inline resources, anonymous resources, contained resources |
Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels. |
Mappings |
|
RelatedPerson.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Must Support | True |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
RelatedPerson.extension:additional-comment | |
Definition | Hier können weitere Informationen, beispielsweise die Pflegebedürftigkeitssituation der Kontaktperson, dargestellt werden. Wenn die Kontaktperson auch gesetzlich betreuende Person ist, kann hier beschrieben werden, für welchen Bereich sie bevollmächtigt ist. |
Cardinality | 0...1 |
Type | Extension(string) |
Must Support | True |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
RelatedPerson.extension:additional-comment.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
RelatedPerson.extension:additional-comment.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...0 |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
RelatedPerson.extension:additional-comment.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Cardinality | 1...1 |
Type | uri |
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
Fixed Value | https://gematik.de/fhir/epa/StructureDefinition/epa-additional-comment-extension |
Mappings |
|
RelatedPerson.extension:additional-comment.value[x] | |
Definition | Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). |
Cardinality | 1...1 |
Type | string |
Must Support | True |
Invariants |
|
Mappings |
|
RelatedPerson.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Cardinality | 0...0 |
Type | Extension |
Modifier | True |
Alias | extensions, user content |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
RelatedPerson.identifier | |
Definition | Identifier for a person within a particular scope. |
Cardinality | 0...0 |
Type | Identifier |
Summary | True |
Requirements | People are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the patient. Examples are national person identifier and local identifier. |
Invariants |
|
Mappings |
|
RelatedPerson.active | |
Definition | Whether this related person record is in active use. |
Cardinality | 0...0 |
Type | boolean |
Modifier | True |
Summary | True |
Requirements | Need to be able to mark a related person record as not to be used, such as if it was created in error. |
Comments | This element is labeled as a modifier because it may be used to mark that the resource was created in error. |
Invariants |
|
Mappings |
|
RelatedPerson.patient | |
Definition | The patient this person is related to. |
Cardinality | 1...1 |
Type | Reference(Patient) |
Must Support | True |
Summary | True |
Requirements | We need to know which patient this RelatedPerson is related to. |
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
Invariants |
|
Mappings |
|
RelatedPerson.patient.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
RelatedPerson.patient.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
RelatedPerson.patient.reference | |
Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. |
Cardinality | 0...0 |
Type | string |
Summary | True |
Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. |
Invariants |
|
Mappings |
|
RelatedPerson.patient.type | |
Definition | The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). |
Cardinality | 0...0 |
Type | uri |
Binding | Aa resource (or, for logical models, the URI of the logical model). |
Summary | True |
Comments | This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. |
Invariants |
|
Mappings |
|
RelatedPerson.patient.identifier | |
Definition | An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers. |
Cardinality | 1...1 |
Type | IdentifierKvid10 |
Must Support | True |
Summary | True |
Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). |
Invariants |
|
Mappings |
|
RelatedPerson.patient.display | |
Definition | Plain text narrative that identifies the resource in addition to the resource reference. |
Cardinality | 0...0 |
Type | string |
Summary | True |
Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. |
Invariants |
|
Mappings |
|
RelatedPerson.relationship | |
Definition | Hier wird die Beziehung der Kontaktperson zur Patient:in anhand eines entsprechenden Codes oder mit einem Freitext angegeben. |
Cardinality | 0...* |
Type | CodeableConcept |
Binding | The nature of the relationship between a patient and the related person. |
Must Support | True |
Summary | True |
Requirements | We need to know the relationship with the patient since it influences the interpretation of the information attributed to this person. |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
Invariants |
|
Mappings |
|
RelatedPerson.relationship.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
RelatedPerson.relationship.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
RelatedPerson.relationship.coding | |
Definition | Hier werden Codes angegeben. |
Cardinality | 0...1 |
Type | Coding |
Must Support | True |
Summary | True |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
Comments | Das MustSupport gilt nur für die vordefinierten Slices. |
Slicing | Unordered, Closed, by $this(Value) |
Invariants |
|
Mappings |
|
RelatedPerson.relationship.coding:relationship-type | |
Definition | Hier wird die Beziehung der Kontaktperson zur Patient:in anhand eines Codes aus einer vorgegebenen Werteliste angegeben. |
Cardinality | 0...1 |
Type | Coding |
Binding | PatientRelationshipType (required) |
Must Support | True |
Summary | True |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. |
Invariants |
|
Mappings |
|
RelatedPerson.relationship.coding:relationship-type.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
RelatedPerson.relationship.coding:relationship-type.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
RelatedPerson.relationship.coding:relationship-type.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Cardinality | 1...1 |
Type | uri |
Must Support | True |
Summary | True |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously. |
Invariants |
|
Mappings |
|
RelatedPerson.relationship.coding:relationship-type.version | |
Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. |
Cardinality | 1...1 |
Type | string |
Must Support | True |
Summary | True |
Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. |
Invariants |
|
Mappings |
|
RelatedPerson.relationship.coding:relationship-type.code | |
Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). |
Cardinality | 1...1 |
Type | code |
Must Support | True |
Summary | True |
Requirements | Need to refer to a particular code in the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
RelatedPerson.relationship.coding:relationship-type.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Cardinality | 1...1 |
Type | string |
Must Support | True |
Summary | True |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
RelatedPerson.relationship.coding:relationship-type.userSelected | |
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). |
Cardinality | 0...0 |
Type | boolean |
Summary | True |
Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. |
Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. |
Invariants |
|
Mappings |
|
RelatedPerson.relationship.text | |
Definition | Hier wird ein Freitext eingetragen. |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. |
Comments | Very often the text is the same as a displayName of one of the codings. |
Invariants |
|
Mappings |
|
RelatedPerson.name | |
Definition | Dieses Element beschreibt diverse Namensbestandteile einer Person. |
Cardinality | 1...1 |
Type | HumannameDeBasis |
Must Support | True |
Summary | True |
Requirements | Related persons need to be identified by name, but it is uncommon to need details about multiple other names for that person. |
Comments | Names may be changed, or repudiated, or people may have different names in different contexts. Names may be divided into parts of different type that have variable significance depending on context, though the division into parts does not always matter. With personal names, the different parts may or may not be imbued with some implicit meaning; various cultures associate different importance with the name parts and the degree to which systems must care about name parts around the world varies widely. |
Invariants |
|
Mappings |
|
RelatedPerson.name.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
RelatedPerson.name.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
RelatedPerson.name.use | |
Definition | Identifies the purpose for this name. |
Cardinality | 1...1 |
Type | code |
Binding | The use of a human name. |
Must Support | True |
Modifier | True |
Summary | True |
Requirements | Allows the appropriate name for a particular context of use to be selected from among a set of names. |
Comments | Applications can assume that a name is current unless it explicitly says that it is temporary or old. |
Invariants |
|
Fixed Value | official |
Mappings |
|
RelatedPerson.name.text | |
Definition | Specifies the entire name as it should be displayed e.g. on an application UI. This may be provided instead of or as well as the specific parts. |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
Requirements | A renderable, unencoded form. |
Comments | Can provide both a text representation and parts. Applications updating a name SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part. |
Invariants |
|
Mappings |
|
RelatedPerson.name.family | |
Definition | Nachname einer Person. |
Cardinality | 1...1 |
Type | string |
Must Support | True |
Summary | True |
Alias | surname |
Comments | Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures). |
Invariants |
|
Mappings |
|
RelatedPerson.name.family.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
RelatedPerson.name.family.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Must Support | True |
Alias | extensions, user content |
Comments | Das MustSupport gilt nur für die vordefinierten Slices. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
RelatedPerson.name.family.extension:namenszusatz | |
Definition | Namenszusatz als Bestandteil das Nachnamens, wie in VSDM (Versichertenstammdatenmanagement, "eGK") definiert. Beispiele: Gräfin, Prinz oder Fürst |
Cardinality | 0...1 |
Type | Extension(string) |
Must Support | True |
Alias | extensions, user content |
Comments | Die Extension wurde erstellt aufgrund der Anforderung, die auf der eGK vorhandenen Patientenstammdaten in FHIR abbilden zu können. Auf der eGK werden die Namensbestandteile "Namenszusatz" und "Vorsatzwort" getrennt vom Nachnamen gespeichert. Anhand der Liste der zulässigen Namenszusätze ist deutlich erkennbar, dass es sich hierbei sinngemäß um Adelstitel handelt. Das Vorsatzwort kann durch die Core-Extension own-prefix (Canonical: http://hl7.org/fhir/StructureDefinition/humanname-own-prefix) abgebildet werden, für den Namenszusatz ergibt sich jedoch die Notwendikeit einer nationalen Extension, da in andern Ländern Adelstitel entweder gar nicht oder als reguläres Namenspräfix erfasst werden. |
Invariants |
|
Mappings |
|
RelatedPerson.name.family.extension:namenszusatz.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
RelatedPerson.name.family.extension:namenszusatz.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...0 |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
RelatedPerson.name.family.extension:namenszusatz.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Cardinality | 1...1 |
Type | uri |
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
Fixed Value | http://fhir.de/StructureDefinition/humanname-namenszusatz |
Mappings |
|
RelatedPerson.name.family.extension:namenszusatz.value[x] | |
Definition | Namenszusatz zum Nachnamen z.B. Gräfin, Prinz oder Fürst |
Cardinality | 1...1 |
Type | string |
Must Support | True |
Invariants |
|
Mappings |
|
RelatedPerson.name.family.extension:nachname | |
Definition | Nachname ohne Vor- und Zusätze. Dient z.B. der alphabetischen Einordnung des Namens. |
Cardinality | 0...1 |
Type | Extension(string) |
Must Support | True |
Alias | extensions, user content |
Comments | If the person's surname has legally changed to become (or incorporate) the surname of the person's partner or spouse, this is the person's surname immediately prior to such change. Often this is the person's "maiden name". |
Invariants |
|
Mappings |
|
RelatedPerson.name.family.extension:nachname.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
RelatedPerson.name.family.extension:nachname.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...0 |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
RelatedPerson.name.family.extension:nachname.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Cardinality | 1...1 |
Type | uri |
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
Fixed Value | http://hl7.org/fhir/StructureDefinition/humanname-own-name |
Mappings |
|
RelatedPerson.name.family.extension:nachname.value[x] | |
Definition | Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). |
Cardinality | 1...1 |
Type | string |
Must Support | True |
Invariants |
|
Mappings |
|
RelatedPerson.name.family.extension:vorsatzwort | |
Definition | Vorsatzwort wie z.B.: von, van, zu Vgl. auch VSDM-Spezifikation der Gematik (Versichertenstammdatenmanagement, "eGK") |
Cardinality | 0...1 |
Type | Extension(string) |
Must Support | True |
Alias | extensions, user content |
Comments | An example of a voorvoegsel is the "van" in "Ludwig van Beethoven". Since the voorvoegsel doesn't sort completely alphabetically, it is reasonable to specify it as a separate sub-component. |
Invariants |
|
Mappings |
|
RelatedPerson.name.family.extension:vorsatzwort.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
RelatedPerson.name.family.extension:vorsatzwort.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...0 |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
RelatedPerson.name.family.extension:vorsatzwort.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Cardinality | 1...1 |
Type | uri |
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
Fixed Value | http://hl7.org/fhir/StructureDefinition/humanname-own-prefix |
Mappings |
|
RelatedPerson.name.family.extension:vorsatzwort.value[x] | |
Definition | Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). |
Cardinality | 1...1 |
Type | string |
Must Support | True |
Invariants |
|
Mappings |
|
RelatedPerson.name.family.value | |
Definition | Primitive value for string |
Cardinality | 0...1 |
Type | System.String |
RelatedPerson.name.given | |
Definition | Vorname der Person |
Cardinality | 1...* |
Type | string |
Must Support | True |
Summary | True |
Alias | first name, middle name |
Comments | If only initials are recorded, they may be used in place of the full name parts. Initials may be separated into multiple given names but often aren't due to paractical limitations. This element is not called "first name" since given names do not always come first. |
Invariants |
|
Mappings |
|
RelatedPerson.name.prefix | |
Definition | Titel als akademischer Grad. Beispiele: Dr.med., Dr.rer.nat., Prof. |
Cardinality | 0...* |
Type | string |
Must Support | True |
Summary | True |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
RelatedPerson.name.prefix.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
RelatedPerson.name.prefix.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Must Support | True |
Alias | extensions, user content |
Comments | Das MustSupport gilt nur für die vordefinierten Slices. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
RelatedPerson.name.prefix.extension:prefix-qualifier | |
Definition | Spezialisierung der Art des Präfixes, z.B. "AC" für Akademische Titel |
Cardinality | 0...1 |
Type | Extension(code) |
Must Support | True |
Alias | extensions, user content |
Comments | Used to indicate additional information about the name part and how it should be used. |
Invariants |
|
Mappings |
|
RelatedPerson.name.prefix.extension:prefix-qualifier.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
RelatedPerson.name.prefix.extension:prefix-qualifier.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...0 |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
RelatedPerson.name.prefix.extension:prefix-qualifier.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Cardinality | 1...1 |
Type | uri |
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
Fixed Value | http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier |
Mappings |
|
RelatedPerson.name.prefix.extension:prefix-qualifier.value[x] | |
Definition | Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). |
Cardinality | 1...1 |
Type | code |
Binding | A set of codes each of which specifies a certain subcategory of the name part in addition to the main name part type. |
Must Support | True |
Invariants |
|
Mappings |
|
RelatedPerson.name.prefix.value | |
Definition | Primitive value for string |
Cardinality | 0...1 |
Type | System.String |
RelatedPerson.name.suffix | |
Definition | Namensteile nach dem Nachnamen |
Cardinality | 0...* |
Type | string |
Summary | True |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
RelatedPerson.name.period | |
Definition | Indicates the period of time when this name was valid for the named person. |
Cardinality | 0...1 |
Type | Period |
Summary | True |
Requirements | Allows names to be placed in historical context. |
Comments | A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. |
Invariants |
|
Mappings |
|
RelatedPerson.telecom | |
Definition | Dieses Element beschreibt die vorhandenen Kontaktmöglichkeiten. |
Cardinality | 0...* |
Type | ContactPoint |
Must Support | True |
Summary | True |
Requirements | People have (primary) ways to contact them in some way such as phone, email. |
Comments | Person may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently, and also to help with identification. |
Invariants |
|
Mappings |
|
RelatedPerson.telecom.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
RelatedPerson.telecom.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
RelatedPerson.telecom.system | |
Definition | Definition der Art des Kontaktes, z. B. Telefon (phone), E-Mail, Fax. |
Cardinality | 1...1 |
Type | code |
Binding | Telecommunications form for contact point. |
Must Support | True |
Summary | True |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
RelatedPerson.telecom.value | |
Definition | In diesem Element können Kontaktinformationen passend zum Kontaktkanal angegeben werden. Beispiele für mögliche Werte sind: "m.mustermann@mio42.de" (beim Kontaktkanal "E-mail", oder "030712345678" (beim Kontaktkanal "Telefon"). |
Cardinality | 1...1 |
Type | string |
Must Support | True |
Summary | True |
Requirements | Need to support legacy numbers that are not in a tightly controlled format. |
Comments | Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value. |
Invariants |
|
Mappings |
|
RelatedPerson.telecom.use | |
Definition | Identifies the purpose for the contact point. |
Cardinality | 0...0 |
Type | code |
Binding | Use of contact point. |
Modifier | True |
Summary | True |
Requirements | Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose. |
Comments | Applications can assume that a contact is current unless it explicitly says that it is temporary or old. |
Invariants |
|
Mappings |
|
RelatedPerson.telecom.rank | |
Definition | Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values. |
Cardinality | 0...0 |
Type | positiveInt |
Summary | True |
Comments | Note that rank does not necessarily follow the order in which the contacts are represented in the instance. |
Invariants |
|
Mappings |
|
RelatedPerson.telecom.period | |
Definition | Time period when the contact point was/is in use. |
Cardinality | 0...0 |
Type | Period |
Summary | True |
Comments | A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. |
Invariants |
|
Mappings |
|
RelatedPerson.gender | |
Definition | Geschlechtsdefinition nach den Versichertenstammdaten (VSD) |
Cardinality | 0...0 |
Type | code |
Binding | The gender of a person used for administrative purposes. |
Summary | True |
Requirements | Needed for identification of the person, in combination with (at least) name and birth date. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
RelatedPerson.gender.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
RelatedPerson.gender.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
RelatedPerson.gender.extension:other-amtlich | |
Definition | Optional Extension Element - found in all resources. |
Cardinality | 0...0 |
Type | Extension(Coding) |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
RelatedPerson.gender.value | |
Definition | Primitive value for code |
Cardinality | 0...1 |
Type | System.String |
RelatedPerson.birthDate | |
Definition | The date on which the related person was born. |
Cardinality | 0...0 |
Type | date |
Summary | True |
Invariants |
|
Mappings |
|
RelatedPerson.address | |
Definition | Hier können Angaben zur Anschrift der Kontaktperson gemacht werden. |
Cardinality | 0...* |
Type | AddressDeBasis |
Must Support | True |
Summary | True |
Requirements | Need to keep track where the related person can be contacted per postal mail or visited. |
Comments | Das MustSupport gilt nur für die vordefinierten Slices. |
Invariants |
|
Examples | Beispiel für einfache Adresse { "use": "home", "type": "postal", "line": [ "Musterweg 42" ], "city": "Musterhausen", "postalCode": "99999" } |
Mappings |
|
RelatedPerson.address.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
RelatedPerson.address.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Must Support | True |
Alias | extensions, user content |
Comments | Das MustSupport gilt nur für die vordefinierten Slices. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
RelatedPerson.address.extension:Stadtteil | |
Definition | A subsection of a municipality. |
Cardinality | 0...1 |
Type | Extension(string) |
Must Support | True |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
RelatedPerson.address.extension:Stadtteil.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
RelatedPerson.address.extension:Stadtteil.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...0 |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
RelatedPerson.address.extension:Stadtteil.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Cardinality | 1...1 |
Type | uri |
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
Fixed Value | http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-precinct |
Mappings |
|
RelatedPerson.address.extension:Stadtteil.value[x] | |
Definition | Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). |
Cardinality | 1...1 |
Type | string |
Must Support | True |
Invariants |
|
Mappings |
|
RelatedPerson.address.use | |
Definition | The purpose of this address. |
Cardinality | 0...0 |
Type | code |
Binding | The use of an address. |
Modifier | True |
Summary | True |
Requirements | Allows an appropriate address to be chosen from a list of many. |
Comments | Applications can assume that an address is current unless it explicitly says that it is temporary or old. |
Invariants |
|
Examples | General home |
Mappings |
|
RelatedPerson.address.type | |
Definition | Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both. |
Cardinality | 1...1 |
Type | code |
Binding | The type of an address (physical / postal). |
Must Support | True |
Summary | True |
Comments | The definition of Address states that "address is intended to describe postal addresses, not physical locations". However, many applications track whether an address has a dual purpose of being a location that can be visited as well as being a valid delivery destination, and Postal addresses are often used as proxies for physical locations (also see the Location resource). |
Invariants |
|
Examples | General both |
Mappings |
|
RelatedPerson.address.text | |
Definition | Specifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts. |
Cardinality | 0...0 |
Type | string |
Summary | True |
Requirements | A renderable, unencoded form. |
Comments | Can provide both a text representation and parts. Applications updating an address SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part. |
Invariants |
|
Examples | General 137 Nowhere Street, Erewhon 9132 |
Mappings |
|
RelatedPerson.address.line | |
Definition | Diese Komponente kann Straßennamen, Hausnummer, Appartmentnummer, Postfach, c/o sowie weitere Zustellungshinweise enthalten. Die Informationen können in mehrere line-Komponenten aufgeteilt werden. Bei Verwendung der Extensions, um Straße, Hausnnummer und Postleitzahl strukturiert zu übermitteln, müssen diese Informationen stets vollständig auch in der line-Komponente, die sie erweitern, enthalten sein, um es Systemen, die diese Extensions nicht verwenden zu ermöglichen, auf diese Informationen zugreifen zu können. |
Cardinality | 0...3 |
Type | string |
Must Support | True |
Summary | True |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Examples | General 137 Nowhere Street Beipiel für Adresszeile mit Extensions für Straße und Hausnummer Musterweg 42 |
Mappings |
|
RelatedPerson.address.line.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
RelatedPerson.address.line.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Must Support | True |
Alias | extensions, user content |
Comments | Das MustSupport gilt nur für die vordefinierten Slices. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
RelatedPerson.address.line.extension:Strasse | |
Definition | Strassenname (ohne Hausnummer) Bei Angabe einer Strasse in dieser Extension muss diese auch in Address.line angegeben werden um die Interoperabilität mit Systemen zu gewährleisten, die diese Extension nicht verwenden. |
Cardinality | 0...1 |
Type | Extension(string) |
Must Support | True |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
RelatedPerson.address.line.extension:Strasse.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
RelatedPerson.address.line.extension:Strasse.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...0 |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
RelatedPerson.address.line.extension:Strasse.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Cardinality | 1...1 |
Type | uri |
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
Fixed Value | http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName |
Mappings |
|
RelatedPerson.address.line.extension:Strasse.value[x] | |
Definition | Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). |
Cardinality | 1...1 |
Type | string |
Must Support | True |
Invariants |
|
Mappings |
|
RelatedPerson.address.line.extension:Hausnummer | |
Definition | Hausnummer, sowie Zusätze (Appartmentnummer, Etage...) Bei Angabe einer Hausnummer in dieser Extension muss diese auch in Address.line angegeben werden um die Interoperabilität mit Systemen zu gewährleisten, die diese Extension nicht verwenden. |
Cardinality | 0...1 |
Type | Extension(string) |
Must Support | True |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
RelatedPerson.address.line.extension:Hausnummer.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
RelatedPerson.address.line.extension:Hausnummer.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...0 |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
RelatedPerson.address.line.extension:Hausnummer.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Cardinality | 1...1 |
Type | uri |
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
Fixed Value | http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber |
Mappings |
|
RelatedPerson.address.line.extension:Hausnummer.value[x] | |
Definition | Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). |
Cardinality | 1...1 |
Type | string |
Must Support | True |
Invariants |
|
Mappings |
|
RelatedPerson.address.line.extension:Adresszusatz | |
Definition | Zusätzliche Informationen, wie z.B. "3. Etage", "Appartment C" Bei Angabe einer Zusatzinformation in dieser Extension muss diese auch in Address.line angegeben werden um die Interoperabilität mit Systemen zu gewährleisten, die diese Extension nicht verwenden. |
Cardinality | 0...1 |
Type | Extension(string) |
Must Support | True |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
RelatedPerson.address.line.extension:Adresszusatz.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
RelatedPerson.address.line.extension:Adresszusatz.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...0 |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
RelatedPerson.address.line.extension:Adresszusatz.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Cardinality | 1...1 |
Type | uri |
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
Fixed Value | http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator |
Mappings |
|
RelatedPerson.address.line.extension:Adresszusatz.value[x] | |
Definition | Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). |
Cardinality | 1...1 |
Type | string |
Must Support | True |
Invariants |
|
Mappings |
|
RelatedPerson.address.line.extension:Postfach | |
Definition | Postfach-Adresse. Bei Angabe eines Postfaches in dieser Extension muss das Postfach auch in Address.line angegeben werden um die Interoperabilität mit Systemen zu gewährleisten, die diese Extension nicht verwenden. Eine Postfach-Adresse darf nicht in Verbindung mit Address.type "physical" oder "both" verwendet werden. |
Cardinality | 0...1 |
Type | Extension(string) |
Must Support | True |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
RelatedPerson.address.line.extension:Postfach.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
RelatedPerson.address.line.extension:Postfach.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...0 |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
RelatedPerson.address.line.extension:Postfach.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Cardinality | 1...1 |
Type | uri |
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
Fixed Value | http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox |
Mappings |
|
RelatedPerson.address.line.extension:Postfach.value[x] | |
Definition | Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). |
Cardinality | 1...1 |
Type | string |
Must Support | True |
Invariants |
|
Mappings |
|
RelatedPerson.address.line.value | |
Definition | Primitive value for string |
Cardinality | 0...1 |
Type | System.String |
RelatedPerson.address.city | |
Definition | The name of the city, town, suburb, village or other community or delivery center. |
Cardinality | 1...1 |
Type | string |
Must Support | True |
Summary | True |
Alias | Municpality |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Examples | General Erewhon |
Mappings |
|
RelatedPerson.address.district | |
Definition | The name of the administrative area (county). |
Cardinality | 0...0 |
Type | string |
Summary | True |
Alias | County |
Comments | District is sometimes known as county, but in some regions 'county' is used in place of city (municipality), so county name should be conveyed in city instead. |
Invariants |
|
Examples | General Madison |
Mappings |
|
RelatedPerson.address.state | |
Definition | Name (oder Kürzel) des Bundeslandes. |
Cardinality | 0...0 |
Type | string |
Binding | ValueSetISO31662DE (preferred) |
Summary | True |
Alias | Province, Territory |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
RelatedPerson.address.postalCode | |
Definition | Postleitzahl gemäß der im jeweiligen Land gültigen Konventionen |
Cardinality | 1...1 |
Type | string |
Must Support | True |
Summary | True |
Alias | Zip |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Examples | General 9132 |
Mappings |
|
RelatedPerson.address.country | |
Definition | Staat (vorzugsweise als 2-Stelliger ISO-Ländercode). Es obliegt abgeleiteten Profilen, hier die Verwendung der ISO-Ländercodes verbindlich vorzuschreiben |
Cardinality | 1...1 |
Type | string |
Binding | Iso3166-1-2 (preferred) |
Must Support | True |
Summary | True |
Comments | ISO 3166 3 letter codes can be used in place of a human readable country name. |
Invariants |
|
Mappings |
|
RelatedPerson.address.period | |
Definition | Time period when address was/is in use. |
Cardinality | 0...0 |
Type | Period |
Summary | True |
Requirements | Allows addresses to be placed in historical context. |
Comments | A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. |
Invariants |
|
Examples | General { "start": "2010-03-23", "end": "2010-07-01" } |
Mappings |
|
RelatedPerson.photo | |
Definition | Image of the person. |
Cardinality | 0...0 |
Type | Attachment |
Requirements | Many EHR systems have the capability to capture an image of persons. Fits with newer social media usage too. |
Comments | When providing a summary view (for example with Observation.value[x]) Attachment should be represented with a brief display text such as "Signed Procedure Consent". |
Invariants |
|
Mappings |
|
RelatedPerson.period | |
Definition | The period of time during which this relationship is or was active. If there are no dates defined, then the interval is unknown. |
Cardinality | 0...0 |
Type | Period |
Comments | A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. |
Invariants |
|
Mappings |
|
RelatedPerson.communication | |
Definition | A language which may be used to communicate with about the patient's health. |
Cardinality | 0...0 |
Type | BackboneElement |
Requirements | If a related person does not speak the local language, interpreters may be required, so languages spoken and proficiency is an important things to keep track of both for patient and other persons of interest. |
Comments | If no language is specified, this implies that the default local language is spoken. If you need to convey proficiency for multiple modes, then you need multiple RelatedPerson.Communication associations. If the RelatedPerson does not speak the default local language, then the Interpreter Required Standard can be used to explicitly declare that an interpreter is required. |
Invariants |
|
Mappings |
|
RelatedPerson.communication.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
RelatedPerson.communication.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
RelatedPerson.communication.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
RelatedPerson.communication.language | |
Definition | The ISO-639-1 alpha 2 code in lower case for the language, optionally followed by a hyphen and the ISO-3166-1 alpha 2 code for the region in upper case; e.g. "en" for English, or "en-US" for American English versus "en-EN" for England English. |
Cardinality | 1...1 |
Type | CodeableConcept |
Binding | A human language. |
Requirements | Most systems in multilingual countries will want to convey language. Not all systems actually need the regional dialect. |
Comments | The structure aa-BB with this exact casing is one the most widely used notations for locale. However not all systems actually code this but instead have it as free text. Hence CodeableConcept instead of code as the data type. |
Invariants |
|
Mappings |
|
RelatedPerson.communication.preferred | |
Definition | Indicates whether or not the patient prefers this language (over other languages he masters up a certain level). |
Cardinality | 0...1 |
Type | boolean |
Requirements | People that master multiple languages up to certain level may prefer one or more, i.e. feel more confident in communicating in a particular language making other languages sort of a fall back method. |
Comments | This language is specifically identified for communicating healthcare information. |
Invariants |
|
Mappings |
|
<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="epa-related-person-source" /> <url value="https://gematik.de/fhir/epa-medication/StructureDefinition/epa-related-person-source" /> <version value="1.1.1" /> <name value="EPARelatedPersonSource" /> <title value="EPA Related Person Source" /> <status value="active" /> <experimental value="false" /> <date value="2024-08-14" /> <publisher value="mio42 GmbH" /> <fhirVersion value="4.0.1" /> <kind value="resource" /> <abstract value="false" /> <type value="RelatedPerson" /> <baseDefinition value="https://gematik.de/fhir/epa/StructureDefinition/epa-related-person" /> <derivation value="constraint" /> <differential> <element id="RelatedPerson.meta.source"> <path value="RelatedPerson.meta.source" /> <max value="0" /> </element> <element id="RelatedPerson.meta.security"> <path value="RelatedPerson.meta.security" /> <max value="0" /> </element> <element id="RelatedPerson.meta.tag"> <path value="RelatedPerson.meta.tag" /> <max value="0" /> </element> <element id="RelatedPerson.implicitRules"> <path value="RelatedPerson.implicitRules" /> <max value="0" /> </element> <element id="RelatedPerson.language"> <path value="RelatedPerson.language" /> <max value="0" /> </element> <element id="RelatedPerson.text"> <path value="RelatedPerson.text" /> <max value="0" /> </element> <element id="RelatedPerson.contained"> <path value="RelatedPerson.contained" /> <max value="0" /> </element> <element id="RelatedPerson.modifierExtension"> <path value="RelatedPerson.modifierExtension" /> <max value="0" /> </element> <element id="RelatedPerson.identifier"> <path value="RelatedPerson.identifier" /> <max value="0" /> </element> <element id="RelatedPerson.active"> <path value="RelatedPerson.active" /> <max value="0" /> </element> <element id="RelatedPerson.patient.reference"> <path value="RelatedPerson.patient.reference" /> <max value="0" /> </element> <element id="RelatedPerson.patient.type"> <path value="RelatedPerson.patient.type" /> <max value="0" /> </element> <element id="RelatedPerson.patient.display"> <path value="RelatedPerson.patient.display" /> <max value="0" /> </element> <element id="RelatedPerson.relationship.coding"> <path value="RelatedPerson.relationship.coding" /> <slicing> <discriminator> <type value="value" /> <path value="$this" /> </discriminator> <rules value="closed" /> </slicing> <max value="1" /> </element> <element id="RelatedPerson.relationship.coding:relationship-type"> <path value="RelatedPerson.relationship.coding" /> <sliceName value="relationship-type" /> </element> <element id="RelatedPerson.relationship.coding:relationship-type.userSelected"> <path value="RelatedPerson.relationship.coding.userSelected" /> <max value="0" /> </element> <element id="RelatedPerson.telecom.use"> <path value="RelatedPerson.telecom.use" /> <max value="0" /> </element> <element id="RelatedPerson.telecom.rank"> <path value="RelatedPerson.telecom.rank" /> <max value="0" /> </element> <element id="RelatedPerson.telecom.period"> <path value="RelatedPerson.telecom.period" /> <max value="0" /> </element> <element id="RelatedPerson.gender"> <path value="RelatedPerson.gender" /> <max value="0" /> </element> <element id="RelatedPerson.gender.extension:other-amtlich"> <path value="RelatedPerson.gender.extension" /> <sliceName value="other-amtlich" /> <max value="0" /> </element> <element id="RelatedPerson.birthDate"> <path value="RelatedPerson.birthDate" /> <max value="0" /> </element> <element id="RelatedPerson.address.use"> <path value="RelatedPerson.address.use" /> <max value="0" /> </element> <element id="RelatedPerson.address.text"> <path value="RelatedPerson.address.text" /> <max value="0" /> </element> <element id="RelatedPerson.address.state"> <path value="RelatedPerson.address.state" /> <max value="0" /> </element> <element id="RelatedPerson.address.period"> <path value="RelatedPerson.address.period" /> <max value="0" /> </element> <element id="RelatedPerson.photo"> <path value="RelatedPerson.photo" /> <max value="0" /> </element> <element id="RelatedPerson.period"> <path value="RelatedPerson.period" /> <max value="0" /> </element> <element id="RelatedPerson.communication"> <path value="RelatedPerson.communication" /> <max value="0" /> </element> </differential> </StructureDefinition>
{ "resourceType": "StructureDefinition", "id": "epa-related-person-source", "url": "https://gematik.de/fhir/epa-medication/StructureDefinition/epa-related-person-source", "version": "1.1.1", "name": "EPARelatedPersonSource", "title": "EPA Related Person Source", "status": "active", "experimental": false, "date": "2024-08-14", "publisher": "mio42 GmbH", "fhirVersion": "4.0.1", "kind": "resource", "abstract": false, "type": "RelatedPerson", "baseDefinition": "https://gematik.de/fhir/epa/StructureDefinition/epa-related-person", "derivation": "constraint", "differential": { "element": [ { "id": "RelatedPerson.meta.source", "path": "RelatedPerson.meta.source", "max": "0" }, { "id": "RelatedPerson.meta.security", "path": "RelatedPerson.meta.security", "max": "0" }, { "id": "RelatedPerson.meta.tag", "path": "RelatedPerson.meta.tag", "max": "0" }, { "id": "RelatedPerson.implicitRules", "path": "RelatedPerson.implicitRules", "max": "0" }, { "id": "RelatedPerson.language", "path": "RelatedPerson.language", "max": "0" }, { "id": "RelatedPerson.text", "path": "RelatedPerson.text", "max": "0" }, { "id": "RelatedPerson.contained", "path": "RelatedPerson.contained", "max": "0" }, { "id": "RelatedPerson.modifierExtension", "path": "RelatedPerson.modifierExtension", "max": "0" }, { "id": "RelatedPerson.identifier", "path": "RelatedPerson.identifier", "max": "0" }, { "id": "RelatedPerson.active", "path": "RelatedPerson.active", "max": "0" }, { "id": "RelatedPerson.patient.reference", "path": "RelatedPerson.patient.reference", "max": "0" }, { "id": "RelatedPerson.patient.type", "path": "RelatedPerson.patient.type", "max": "0" }, { "id": "RelatedPerson.patient.display", "path": "RelatedPerson.patient.display", "max": "0" }, { "id": "RelatedPerson.relationship.coding", "path": "RelatedPerson.relationship.coding", "slicing": { "discriminator": [ { "type": "value", "path": "$this" } ], "rules": "closed" }, "max": "1" }, { "id": "RelatedPerson.relationship.coding:relationship-type", "path": "RelatedPerson.relationship.coding", "sliceName": "relationship-type" }, { "id": "RelatedPerson.relationship.coding:relationship-type.userSelected", "path": "RelatedPerson.relationship.coding.userSelected", "max": "0" }, { "id": "RelatedPerson.telecom.use", "path": "RelatedPerson.telecom.use", "max": "0" }, { "id": "RelatedPerson.telecom.rank", "path": "RelatedPerson.telecom.rank", "max": "0" }, { "id": "RelatedPerson.telecom.period", "path": "RelatedPerson.telecom.period", "max": "0" }, { "id": "RelatedPerson.gender", "path": "RelatedPerson.gender", "max": "0" }, { "id": "RelatedPerson.gender.extension:other-amtlich", "path": "RelatedPerson.gender.extension", "sliceName": "other-amtlich", "max": "0" }, { "id": "RelatedPerson.birthDate", "path": "RelatedPerson.birthDate", "max": "0" }, { "id": "RelatedPerson.address.use", "path": "RelatedPerson.address.use", "max": "0" }, { "id": "RelatedPerson.address.text", "path": "RelatedPerson.address.text", "max": "0" }, { "id": "RelatedPerson.address.state", "path": "RelatedPerson.address.state", "max": "0" }, { "id": "RelatedPerson.address.period", "path": "RelatedPerson.address.period", "max": "0" }, { "id": "RelatedPerson.photo", "path": "RelatedPerson.photo", "max": "0" }, { "id": "RelatedPerson.period", "path": "RelatedPerson.period", "max": "0" }, { "id": "RelatedPerson.communication", "path": "RelatedPerson.communication", "max": "0" } ] } }
Informationsmodell als LogicalModel
Das Profil basiert auf folgendem Informationsmodell:
Kontaktperson (kontaktperson) | http://hl7.org/fhir/StructureDefinition/Base | ||
beziehungCodeBezeichnung | 0..* | BackboneElement | |
codeAuswahl | 0..* | BackboneElement | |
vorgegebeneWertelisteCode | 0..1 | CodingBinding | |
bezeichnung | 0..1 | string | |
name | 1..1 | BackboneElement | |
verwendungszweck | 1..1 | CodingFixed Value | |
vollstaendigerName | 0..1 | string | |
vorsatzwort | 0..1 | string | |
namenszusatz | 0..1 | string | |
titel | 0..* | string | |
nachname | 1..1 | string | |
vorname | 0..1 | string | |
anschrift | 0..* | BackboneElement | |
verwendungszweck | 1..1 | CodingBinding | |
strasse | 1..1 | string | |
hausnummer | 1..1 | string | |
anschriftenzusatz | 0..1 | string | |
stadtteil | 0..1 | string | |
postleitzahl | 1..1 | string | |
ort | 1..1 | string | |
landWohnsitzlaendercode | 1..1 | CodingBinding | |
kontaktdaten | 0..* | BackboneElement | |
kontaktkanal | 1..1 | CodingBinding | |
wert | 1..1 | string | |
hinweis | 0..1 | string |