Angehöriger (RelatedPerson)
Motivation
Der Angehörige wird vor allem im Zusammenhang mit Anwendungsszenarien verwendet, in denen das Versicherungsverhältnis eine Rolle spielt. Hier können Angehörige, bspw. der hauptversicherte Elternteil eines minderjährigen Kindes, in der Familienversicherung sein. In Selbstzahler-Szenarien können Angehörige die Zahler für eine im Krankenhaus erbrachte Leistung sein.
Kompatibilität
Für das Profil ISiKAngehoeriger wurde bis zum Zeitpunkt der Veröffentlichung kein Abgleich der Kompatibilität zu anderen Profilen (der KBV und der Medizininformatik-Initiative) durchgeführt.
Profil
| Name | Canonical |
|---|---|
| ISiKAngehoeriger | https://gematik.de/fhir/isik/StructureDefinition/ISiKAngehoeriger |
| RelatedPerson | I | RelatedPerson | Element idRelatedPerson A person that is related to a patient, but who is not a direct target of care DefinitionInformation about a person that is involved in the care for a patient, but who is not the target of healthcare, nor has a formal responsibility in the care process.
| |
| id | Σ | 0..1 | string | There are no (further) constraints on this element Element idRelatedPerson.id Logical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation. |
| meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idRelatedPerson.meta Metadata about the resource DefinitionThe 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.
|
| implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idRelatedPerson.implicitRules A set of rules under which this content was created DefinitionA 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. 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.
|
| language | 0..1 | codeBinding | There are no (further) constraints on this element Element idRelatedPerson.language Language of the resource content DefinitionThe base language in which the resource is written. 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). A human language.
| |
| text | 0..1 | Narrative | There are no (further) constraints on this element Element idRelatedPerson.text Text summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. 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.
| |
| contained | 0..* | Resource | There are no (further) constraints on this element Element idRelatedPerson.contained Contained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese 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. 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.
| |
| extension | I | 0..* | Extension | There are no (further) constraints on this element Element idRelatedPerson.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| modifierExtension | ?! I | 0..* | Extension | There are no (further) constraints on this element Element idRelatedPerson.modifierExtension Extensions that cannot be ignored Alternate namesextensions, user content DefinitionMay 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). 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| identifier | Σ | 0..* | Identifier | There are no (further) constraints on this element Element idRelatedPerson.identifier A human identifier for this person DefinitionIdentifier for a person within a particular scope. 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.
|
| active | Σ ?! | 0..1 | boolean | There are no (further) constraints on this element Element idRelatedPerson.active Whether this related person's record is in active use DefinitionWhether this related person record is in active use. Need to be able to mark a related person record as not to be used, such as if it was created in error. This element is labeled as a modifier because it may be used to mark that the resource was created in error. This resource is generally assumed to be active if no value is provided for the active element
|
| patient | S Σ I | 1..1 | Reference(Patient) | There are no (further) constraints on this element Element idRelatedPerson.patient The patient this person is related to DefinitionThe patient this person is related to. We need to know which patient this RelatedPerson is related to. 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.
|
| id | 0..1 | string | There are no (further) constraints on this element Element idRelatedPerson.patient.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
| extension | I | 0..* | Extension | There are no (further) constraints on this element Element idRelatedPerson.patient.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| reference | Σ I | 1..1 | string | There are no (further) constraints on this element Element idRelatedPerson.patient.reference Literal reference, Relative, internal or absolute URL DefinitionA 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. 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.
|
| type | Σ | 0..1 | uriBinding | There are no (further) constraints on this element Element idRelatedPerson.patient.type Type the reference refers to (e.g. "Patient") DefinitionThe 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). 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. Aa resource (or, for logical models, the URI of the logical model).
|
| identifier | Σ | 0..1 | Identifier | There are no (further) constraints on this element Element idRelatedPerson.patient.identifier Logical reference, when literal reference is not known DefinitionAn identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. 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).
|
| display | Σ | 0..1 | string | There are no (further) constraints on this element Element idRelatedPerson.patient.display Text alternative for the resource DefinitionPlain text narrative that identifies the resource in addition to the resource reference. 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.
|
| relationship | S Σ | 0..* | CodeableConceptBinding | Element idRelatedPerson.relationship The nature of the relationship DefinitionThe nature of the relationship between a patient and the related person. We need to know the relationship with the patient since it influences the interpretation of the information attributed to this person. Motivation: Harmonisierung mit KBV (KBV_PR_Base_RelatedPerson) The nature of the relationship between a patient and the related person.
|
| name | S Σ I | 1..1 | HumanName, deutsches Basisprofil | Element idRelatedPerson.name Personenname DefinitionPersonenname mit in Deutschland üblichen Erweiterungen Related persons need to be identified by name, but it is uncommon to need details about multiple other names for that person. 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. HumanName, deutsches Basisprofil Constraints
|
| telecom | S Σ I | 0..* | ContactPoint | Element idRelatedPerson.telecom A contact detail for the person DefinitionA contact detail for the person, e.g. a telephone number or an email address. People have (primary) ways to contact them in some way such as phone, email. Motivation: Harmonisierung mit KBV (KBV_PR_Base_RelatedPerson)
|
| gender | Σ | 0..1 | codeBinding | There are no (further) constraints on this element Element idRelatedPerson.gender male | female | other | unknown DefinitionAdministrative Gender - the gender that the person is considered to have for administration and record keeping purposes. Needed for identification of the person, in combination with (at least) name and birth date. Note that FHIR strings SHALL NOT exceed 1MB in size The gender of a person used for administrative purposes.
|
| birthDate | Σ | 0..1 | date | There are no (further) constraints on this element Element idRelatedPerson.birthDate The date on which the related person was born DefinitionThe date on which the related person was born.
|
| address | S Σ | 0..* | Address | Element idRelatedPerson.address Address where the related person can be contacted or visited DefinitionAddress where the related person can be contacted or visited. Need to keep track where the related person can be contacted per postal mail or visited. In order to differentiate between post box addresses and physical addresses, street names and house numbers, and to add city district names, vendors can opt to support the extensions as suggested in the German Address Base Profile http://fhir.de/StructureDefinition/address-de-basis. Such differentiations are however not required within the scope of this specification. Unordered, Open, by $this(Pattern) Constraints
|
| Strassenanschrift | S Σ I | 0..* | Adresse, deutsches BasisprofilPattern | Element idRelatedPerson.address:Strassenanschrift Eine Adresse gemäß postalischer Konventionen DefinitionEine Adresse gemäß postalischer Konventionen (im Gegensatz zu bspw. GPS-Koordinaten). Die Adresse kann sowohl zur Zustellung von Postsendungen oder zum Aufsuchen von Orten, die keine gültige Postadresse haben, verwendet werden. Die verwendeten Extensions in diesem Profil bilden die Struktur der Adresse ab, wie sie im VSDM-Format der elektronischen Versichertenkarte verwendet wird. Insbesondere bei ausländischen Adresse oder Adressen, die nicht durch Einlesen einer elektronischen Versichertenkarte erfasst wurden, sind abweichende Strukturen möglich. Die Verwendung der Extensions ist nicht verpflichtend. Need to keep track where the related person can be contacted per postal mail or visited. Note: address is intended to describe postal addresses for administrative purposes, not to describe absolute geographical coordinates. Postal addresses are often used as proxies for physical locations (also see the Location resource). Adresse, deutsches Basisprofil Constraints
{
"type": "both"
}
|
| id | 0..1 | string | There are no (further) constraints on this element Element idRelatedPerson.address:Strassenanschrift.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
| extension | I | 0..* | Extension | There are no (further) constraints on this element Element idRelatedPerson.address:Strassenanschrift.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| Stadtteil | S I | 0..1 | Extension(string) | Element idRelatedPerson.address:Strassenanschrift.extension:Stadtteil Stadt- oder Ortsteil Alternate namesextensions, user content DefinitionA subsection of a municipality. 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. http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-precinct Constraints
|
| use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idRelatedPerson.address:Strassenanschrift.use home | work | temp | old | billing - purpose of this address DefinitionThe purpose of this address. Allows an appropriate address to be chosen from a list of many. Applications can assume that an address is current unless it explicitly says that it is temporary or old. The use of an address.
General home Mappings
|
| type | S Σ | 1..1 | codeBindingPattern | There are no (further) constraints on this element Element idRelatedPerson.address:Strassenanschrift.type postal | physical | both DefinitionDistinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both. 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). The type of an address (physical / postal).
both
|
| text | Σ | 0..1 | string | There are no (further) constraints on this element Element idRelatedPerson.address:Strassenanschrift.text Text representation of the address DefinitionSpecifies 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. A renderable, unencoded form. 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.
General 137 Nowhere Street, Erewhon 9132 Mappings
|
| line | S Σ | 1..3 | string | There are no (further) constraints on this element Element idRelatedPerson.address:Strassenanschrift.line Straßenname mit Hausnummer oder Postfach sowie weitere Angaben zur Zustellung DefinitionDiese 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. Note that FHIR strings SHALL NOT exceed 1MB in size
General 137 Nowhere Street Beipiel für Adresszeile mit Extensions für Straße und Hausnummer Musterweg 42 Mappings
|
| id | 0..1 | string | There are no (further) constraints on this element Element idRelatedPerson.address:Strassenanschrift.line.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
| extension | I | 0..* | Extension | There are no (further) constraints on this element Element idRelatedPerson.address:Strassenanschrift.line.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| Strasse | S I | 0..1 | Extension(string) | Element idRelatedPerson.address:Strassenanschrift.line.extension:Strasse Strassenname (ohne Hausnummer) Alternate namesextensions, user content DefinitionStrassenname (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. 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. http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName Constraints
|
| Hausnummer | S I | 0..1 | Extension(string) | Element idRelatedPerson.address:Strassenanschrift.line.extension:Hausnummer Hausnummer Alternate namesextensions, user content DefinitionHausnummer, 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. 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. http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber Constraints
|
| Adresszusatz | S I | 0..1 | Extension(string) | Element idRelatedPerson.address:Strassenanschrift.line.extension:Adresszusatz Adresszusatz Alternate namesextensions, user content DefinitionZusä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. 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. http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator Constraints
|
| Postfach | I | 0..0 | Extension(string) | Element idRelatedPerson.address:Strassenanschrift.line.extension:Postfach Postfach Alternate namesextensions, user content DefinitionPostfach-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. 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. http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox Constraints
|
| value | 0..1 | System.String | There are no (further) constraints on this element Element idRelatedPerson.address:Strassenanschrift.line.value Primitive value for string DefinitionPrimitive value for string System.String Maximum string length1048576 | |
| city | S Σ | 1..1 | string | There are no (further) constraints on this element Element idRelatedPerson.address:Strassenanschrift.city Name of city, town etc. Alternate namesMunicpality DefinitionThe name of the city, town, suburb, village or other community or delivery center. Note that FHIR strings SHALL NOT exceed 1MB in size
General Erewhon Mappings
|
| district | Σ | 0..0 | string | There are no (further) constraints on this element Element idRelatedPerson.address:Strassenanschrift.district District name (aka county) Alternate namesCounty DefinitionThe name of the administrative area (county). 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.
General Madison Mappings
|
| state | Σ | 0..1 | stringBinding | There are no (further) constraints on this element Element idRelatedPerson.address:Strassenanschrift.state Bundesland Alternate namesProvince, Territory DefinitionName (oder Kürzel) des Bundeslandes. Note that FHIR strings SHALL NOT exceed 1MB in size ValueSetISO31662DE (preferred) Constraints
|
| postalCode | S Σ | 1..1 | string | There are no (further) constraints on this element Element idRelatedPerson.address:Strassenanschrift.postalCode Postleitzahl Alternate namesZip DefinitionPostleitzahl gemäß der im jeweiligen Land gültigen Konventionen Note that FHIR strings SHALL NOT exceed 1MB in size
General 9132 Mappings
|
| country | S Σ | 1..1 | stringBinding | There are no (further) constraints on this element Element idRelatedPerson.address:Strassenanschrift.country Staat DefinitionStaat (vorzugsweise als 2-Stelliger ISO-Ländercode). Es obliegt abgeleiteten Profilen, hier die Verwendung der ISO-Ländercodes verbindlich vorzuschreiben ISO 3166 3 letter codes can be used in place of a human readable country name.
|
| period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element idRelatedPerson.address:Strassenanschrift.period Time period when address was/is in use DefinitionTime period when address was/is in use. Allows addresses to be placed in historical context. 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.
General {
"start": "2010-03-23",
"end": "2010-07-01"
}Mappings
|
| Postfach | S Σ I | 0..* | Adresse, deutsches BasisprofilPattern | Element idRelatedPerson.address:Postfach Eine Adresse gemäß postalischer Konventionen DefinitionEine Adresse gemäß postalischer Konventionen (im Gegensatz zu bspw. GPS-Koordinaten). Die Adresse kann sowohl zur Zustellung von Postsendungen oder zum Aufsuchen von Orten, die keine gültige Postadresse haben, verwendet werden. Die verwendeten Extensions in diesem Profil bilden die Struktur der Adresse ab, wie sie im VSDM-Format der elektronischen Versichertenkarte verwendet wird. Insbesondere bei ausländischen Adresse oder Adressen, die nicht durch Einlesen einer elektronischen Versichertenkarte erfasst wurden, sind abweichende Strukturen möglich. Die Verwendung der Extensions ist nicht verpflichtend. Need to keep track where the related person can be contacted per postal mail or visited. Note: address is intended to describe postal addresses for administrative purposes, not to describe absolute geographical coordinates. Postal addresses are often used as proxies for physical locations (also see the Location resource). Adresse, deutsches Basisprofil Constraints
{
"type": "postal"
}
|
| id | 0..1 | string | There are no (further) constraints on this element Element idRelatedPerson.address:Postfach.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
| extension | I | 0..* | Extension | There are no (further) constraints on this element Element idRelatedPerson.address:Postfach.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| Stadtteil | I | 0..1 | Extension(string) | There are no (further) constraints on this element Element idRelatedPerson.address:Postfach.extension:Stadtteil Stadt- oder Ortsteil Alternate namesextensions, user content DefinitionA subsection of a municipality. 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. http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-precinct Constraints
|
| use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idRelatedPerson.address:Postfach.use home | work | temp | old | billing - purpose of this address DefinitionThe purpose of this address. Allows an appropriate address to be chosen from a list of many. Applications can assume that an address is current unless it explicitly says that it is temporary or old. The use of an address.
General home Mappings
|
| type | S Σ | 1..1 | codeBindingPattern | There are no (further) constraints on this element Element idRelatedPerson.address:Postfach.type postal | physical | both DefinitionDistinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both. 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). The type of an address (physical / postal).
postal
|
| text | Σ | 0..1 | string | There are no (further) constraints on this element Element idRelatedPerson.address:Postfach.text Text representation of the address DefinitionSpecifies 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. A renderable, unencoded form. 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.
General 137 Nowhere Street, Erewhon 9132 Mappings
|
| line | S Σ | 1..3 | string | There are no (further) constraints on this element Element idRelatedPerson.address:Postfach.line Straßenname mit Hausnummer oder Postfach sowie weitere Angaben zur Zustellung DefinitionDiese 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. Note that FHIR strings SHALL NOT exceed 1MB in size
General 137 Nowhere Street Beipiel für Adresszeile mit Extensions für Straße und Hausnummer Musterweg 42 Mappings
|
| id | 0..1 | string | There are no (further) constraints on this element Element idRelatedPerson.address:Postfach.line.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
| extension | I | 0..* | Extension | There are no (further) constraints on this element Element idRelatedPerson.address:Postfach.line.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| Strasse | I | 0..0 | Extension(string) | Element idRelatedPerson.address:Postfach.line.extension:Strasse Strassenname (ohne Hausnummer) Alternate namesextensions, user content DefinitionStrassenname (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. 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. http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName Constraints
|
| Hausnummer | I | 0..0 | Extension(string) | Element idRelatedPerson.address:Postfach.line.extension:Hausnummer Hausnummer Alternate namesextensions, user content DefinitionHausnummer, 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. 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. http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber Constraints
|
| Adresszusatz | I | 0..0 | Extension(string) | Element idRelatedPerson.address:Postfach.line.extension:Adresszusatz Adresszusatz Alternate namesextensions, user content DefinitionZusä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. 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. http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator Constraints
|
| Postfach | S I | 0..1 | Extension(string) | Element idRelatedPerson.address:Postfach.line.extension:Postfach Postfach Alternate namesextensions, user content DefinitionPostfach-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. 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. http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox Constraints
|
| value | 0..1 | System.String | There are no (further) constraints on this element Element idRelatedPerson.address:Postfach.line.value Primitive value for string DefinitionPrimitive value for string System.String Maximum string length1048576 | |
| city | S Σ | 1..1 | string | There are no (further) constraints on this element Element idRelatedPerson.address:Postfach.city Name of city, town etc. Alternate namesMunicpality DefinitionThe name of the city, town, suburb, village or other community or delivery center. Note that FHIR strings SHALL NOT exceed 1MB in size
General Erewhon Mappings
|
| district | Σ | 0..0 | string | There are no (further) constraints on this element Element idRelatedPerson.address:Postfach.district District name (aka county) Alternate namesCounty DefinitionThe name of the administrative area (county). 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.
General Madison Mappings
|
| state | Σ | 0..1 | stringBinding | There are no (further) constraints on this element Element idRelatedPerson.address:Postfach.state Bundesland Alternate namesProvince, Territory DefinitionName (oder Kürzel) des Bundeslandes. Note that FHIR strings SHALL NOT exceed 1MB in size ValueSetISO31662DE (preferred) Constraints
|
| postalCode | S Σ | 1..1 | string | There are no (further) constraints on this element Element idRelatedPerson.address:Postfach.postalCode Postleitzahl Alternate namesZip DefinitionPostleitzahl gemäß der im jeweiligen Land gültigen Konventionen Note that FHIR strings SHALL NOT exceed 1MB in size
General 9132 Mappings
|
| country | S Σ | 1..1 | stringBinding | There are no (further) constraints on this element Element idRelatedPerson.address:Postfach.country Staat DefinitionStaat (vorzugsweise als 2-Stelliger ISO-Ländercode). Es obliegt abgeleiteten Profilen, hier die Verwendung der ISO-Ländercodes verbindlich vorzuschreiben ISO 3166 3 letter codes can be used in place of a human readable country name.
|
| period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element idRelatedPerson.address:Postfach.period Time period when address was/is in use DefinitionTime period when address was/is in use. Allows addresses to be placed in historical context. 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.
General {
"start": "2010-03-23",
"end": "2010-07-01"
}Mappings
|
| photo | I | 0..* | Attachment | There are no (further) constraints on this element Element idRelatedPerson.photo Image of the person DefinitionImage of the person. Many EHR systems have the capability to capture an image of persons. Fits with newer social media usage too. 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".
|
| period | I | 0..1 | Period | There are no (further) constraints on this element Element idRelatedPerson.period Period of time that this relationship is considered valid DefinitionThe period of time during which this relationship is or was active. If there are no dates defined, then the interval is unknown. 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.
|
| communication | 0..* | BackboneElement | There are no (further) constraints on this element Element idRelatedPerson.communication A language which may be used to communicate with about the patient's health DefinitionA language which may be used to communicate with about the patient's health. 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. 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.
| |
| id | 0..1 | string | There are no (further) constraints on this element Element idRelatedPerson.communication.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
| extension | I | 0..* | Extension | There are no (further) constraints on this element Element idRelatedPerson.communication.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idRelatedPerson.communication.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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). 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. 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.
|
| language | 1..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idRelatedPerson.communication.language The language which can be used to communicate with the patient about his or her health DefinitionThe 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. Most systems in multilingual countries will want to convey language. Not all systems actually need the regional dialect. 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. A human language.
| |
| preferred | 0..1 | boolean | There are no (further) constraints on this element Element idRelatedPerson.communication.preferred Language preference indicator DefinitionIndicates whether or not the patient prefers this language (over other languages he masters up a certain level). 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. This language is specifically identified for communicating healthcare information.
|
| key | severity | human | expression |
|---|---|---|---|
| relatedp-de-1 | error | Falls die Geschlechtsangabe 'other' gewählt wird, muss die amtliche Differenzierung per Extension angegeben werden | gender.exists() and gender='other' implies gender.extension('http://fhir.de/StructureDefinition/gender-amtlich-de').exists() |
| address-cnt-2or3-char | warning | The content of the country element (if present) SHALL be selected EITHER from ValueSet ISO Country Alpha-2 http://hl7.org/fhir/ValueSet/iso3166-1-2 OR MAY be selected from ISO Country Alpha-3 Value Set http://hl7.org/fhir/ValueSet/iso3166-1-3, IF the country is not specified in value Set ISO Country Alpha-2 http://hl7.org/fhir/ValueSet/iso3166-1-2. | country.empty() or (country.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-2') or country.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-3')) |
| address-cnt-2or3-char | warning | The content of the country element (if present) SHALL be selected EITHER from ValueSet ISO Country Alpha-2 http://hl7.org/fhir/ValueSet/iso3166-1-2 OR MAY be selected from ISO Country Alpha-3 Value Set http://hl7.org/fhir/ValueSet/iso3166-1-3, IF the country is not specified in value Set ISO Country Alpha-2 http://hl7.org/fhir/ValueSet/iso3166-1-2. | country.empty() or (country.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-2') or country.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-3')) |
Anmerkungen zu den Must-Support-Feldern
RelatedPerson.name
Bedeutung: Name der angehörigen Person
Hinweise: Siehe Beschreibung der Deutschen Basisprofile
RelatedPerson.patient
Bedeutung: Referenz zum verwandten Patienten
RelatedPerson.address.type
Bedeutung: Die Art der Adresse (physisch / postalisch)
Hinweise: Siehe Beschreibung der Deutschen Basisprofile
RelatedPerson.address.line
Bedeutung: Enthält Straßenname, Hausnummer, Richtung, Postfach und ähnliche Adressinformationen
Hinweise: Siehe Beschreibung der Deutschen Basisprofile
RelatedPerson.address.city
Bedeutung: Enthält Name der Stadt oder des Ortes
Hinweise: Siehe Beschreibung der Deutschen Basisprofile
RelatedPerson.address.postalCode
Bedeutung: Postleitzahl für das Gebiet
Hinweise: Siehe Beschreibung der Deutschen Basisprofile
RelatedPerson.address.country
Bedeutung: Land (kann z. B. ein ISO 3166-Code mit 2 oder 3 Buchstaben sein)
Hinweise: Siehe Beschreibung der Deutschen Basisprofile
Interaktionen
Für die Ressource RelatedPerson MUSS die REST-Interaktion "READ" implementiert werden.
Folgende Suchparameter sind für das Bestätigungsverfahren relevant, auch in Kombination:
Der Suchparameter "_id" MUSS unterstützt werden:
Beispiele:
GET [base]/RelatedPerson?_id=103270Anwendungshinweise: Weitere Informationen zur Suche nach "_id" finden sich in der FHIR-Basisspezifikation - Abschnitt "Parameters for all resources".
Der Suchparameter "patient" MUSS unterstützt werden:
Beispiele:
GET [base]/RelatedPerson?patient=Patient/123Anwendungshinweise: Weitere Informationen zur Suche nach "RelatedPerson.patient" finden sich in der FHIR-Basisspezifikation - Abschnitt "Reference Search".
Die Suche nach einem beliebigen Bestandteil des Namens KANN unterstützt werden:
Beispiele:
GET [base]/RelatedPerson?name=HeidiGET [base]/RelatedPerson?name=AlpenzauberAnwendungshinweise: Weitere Informationen zur Suche nach "RelatedPerson.name" finden sich in der FHIR-Basisspezifikation - Abschnitt "String Search".
Der Suchparameter "address" KANN unterstützt werden:
Beispiele
GET [base]/RelatedPerson?address=BerlinAnwendungshinweise: Weitere Informationen zur Suche nach "RelatedPerson.address" finden sich in der FHIR-Basisspezifikation - Abschnitt "String Search".
- Der Suchparameter "address-city" KANN unterstützt werden:
Beispiele:
GET [base]/RelatedPerson?address-city=BerlinAnwendungshinweise: Weitere Informationen zur Suche nach "RelatedPerson.address.city" finden sich in der FHIR-Basisspezifikation - Abschnitt "String Search".
Der Suchparameter "address-country" KANN unterstützt werden:
Beispiele:
GET [base]/RelatedPerson?address-country=DEAnwendungshinweise: Weitere Informationen zur Suche nach "RelatedPerson.address.country" finden sich in der FHIR-Basisspezifikation - Abschnitt "String Search".
Der Suchparameter "address-postalcode" KANN unterstützt werden:
Beispiele:
GET [base]/RelatedPerson?address-postalcode=10117Anwendungshinweise: Weitere Informationen zur Suche nach "RelatedPerson.address.postalCode" finden sich in der FHIR-Basisspezifikation - Abschnitt "String Search".
Beispiele
Valides Minimalbeispiel für das Profil ISiKAngehoeriger:
{ "resourceType": "RelatedPerson", "id": "ISiKAngehoerigerMustermann", "meta": { "profile": [ "https://gematik.de/fhir/isik/StructureDefinition/ISiKAngehoeriger" ] }, "patient": { "reference": "Patient/PatientinMusterfrau" }, "name": [ { "family": "Mustermann", "given": [ "Maxine" ] } ], "address": [ { "type": "both", "line": [ "Milchstr. 42" ], "city": "Beispielstadt", "postalCode": "78143", "country": "DE" } ], "relationship": [ { "coding": [ { "code": "DAUC", "system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode" } ] } ] }