EPAPatient
Das EPAPatient
-Profil wird verwendet, um grundlegende Informationen über den Patienten, wie Name, Anrede oder Geburtsdatum zu erfassen. Ein Instanz dieses Profils kann ausschließlich durch den Kostenträger in den Patient Information Service eingestellt sowie aktualisiert werden. Es wird verwendet, um Versicherteninformationen in der Geschäftslogik zu verarbeiten und beispielsweise Medikationspläne korrekt zusammenzustellen. Wichtig dabei ist, dass die Versicherteninformationen nicht vom Medication Service selbst erhoben oder direkt abgerufen werden können. Stattdessen werden sie intern genutzt, um spezifische FHIR-Operationen auszuführen.
Im Anwendungfall des Medikationsplandokuments wird die Patient
-Ressource innerhalb des Medication Service intern in der Geschäftslogik herangezogen. Dies dient dazu, das Medikationsplan-Bundle zusammenzustellen und sicherzustellen, dass alle relevanten Informationen korrekt und vollständig in den Medikationsplan integriert werden.
Profile
EPAPatient (Patient) | I | Patient | |
id | S Σ | 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 | |
contained | 0..* | Resource | |
extension | I | 0..* | Extension |
modifierExtension | ?! I | 0..* | Extension |
identifier | S Σ | 1..* | Identifier |
KVNR | S Σ | 1..1 | IdentifierKvid10 |
active | S Σ ?! | 0..1 | boolean |
name | S Σ | 1..* | HumanName |
Name | S Σ I | 1..1 | HumannameDeBasisPattern |
id | 0..1 | string | |
extension | I | 0..* | Extension |
use | S Σ ?! | 1..1 | codeBindingPattern |
text | Σ | 0..1 | string |
family | S Σ | 1..1 | string |
id | 0..1 | string | |
extension | I | 0..* | Extension |
namenszusatz | S I | 0..1 | Extension(string) |
nachname | S I | 0..1 | Extension(string) |
vorsatzwort | S I | 0..1 | Extension(string) |
value | 0..1 | System.String | |
given | S Σ | 1..* | string |
prefix | S Σ | 0..* | string |
id | 0..1 | string | |
extension | 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] | 1..1 | BindingFixed Value | |
valueCode | code | ||
value | 0..1 | System.String | |
suffix | Σ | 0..* | string |
period | Σ I | 0..1 | Period |
Geburtsname | S Σ I | 0..1 | HumannameDeBasisPattern |
id | 0..1 | string | |
extension | I | 0..* | Extension |
use | S Σ ?! | 1..1 | codeBindingPattern |
text | Σ | 0..1 | string |
family | S Σ | 1..1 | string |
id | 0..1 | string | |
extension | I | 0..* | Extension |
namenszusatz | S I | 0..1 | Extension(string) |
nachname | S I | 0..1 | Extension(string) |
vorsatzwort | S I | 0..1 | Extension(string) |
value | 0..1 | System.String | |
given | Σ | 0..0 | string |
prefix | Σ | 0..0 | string |
suffix | Σ | 0..0 | string |
period | Σ I | 0..1 | Period |
telecom | Σ I | 0..* | ContactPoint |
gender | S Σ | 0..1 | codeBinding |
id | 0..1 | string | |
extension | I | 0..* | Extension |
other-amtlich | I | 0..1 | Extension(Coding) |
value | 0..1 | System.String | |
birthDate | S Σ | 1..1 | date |
deceased[x] | Σ ?! | 0..1 | |
deceasedBoolean | boolean | ||
deceasedDateTime | dateTime | ||
address | Σ | 0..* | Address |
maritalStatus | 0..1 | CodeableConceptBinding | |
multipleBirth[x] | 0..1 | ||
multipleBirthBoolean | boolean | ||
multipleBirthInteger | integer | ||
photo | I | 0..* | Attachment |
contact | I | 0..* | BackboneElement |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
relationship | 0..* | CodeableConceptBinding | |
name | 0..1 | HumanName | |
telecom | I | 0..* | ContactPoint |
address | 0..1 | Address | |
gender | 0..1 | codeBinding | |
organization | I | 0..1 | Reference(Organization) |
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 | |
generalPractitioner | I | 0..* | Reference(Organization | Practitioner | PractitionerRole) |
managingOrganization | Σ I | 0..1 | Reference(Organization) |
link | Σ ?! | 0..* | BackboneElement |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
other | Σ I | 1..1 | Reference(Patient | RelatedPerson) |
type | Σ | 1..1 | codeBinding |
Patient | |
Definition | Demographics and other administrative information about an individual or animal receiving care or other health-related services. |
Cardinality | 0...* |
Alias | SubjectOfCare Client Resident |
Invariants |
|
Mappings |
|
Patient.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 |
Must Support | True |
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. |
Patient.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 |
|
Patient.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 |
|
Patient.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 |
|
Patient.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 |
|
Patient.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 |
|
Patient.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 |
|
Patient.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 |
|
Patient.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 |
|
Patient.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 |
|
Patient.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 |
|
Patient.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 |
|
Patient.text | |
Definition | A 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. |
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 |
|
Patient.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 |
|
Patient.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 |
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 |
|
Patient.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 |
|
Patient.identifier | |
Definition | An identifier for this patient. |
Cardinality | 1...* |
Type | Identifier |
Must Support | True |
Summary | True |
Requirements | Patients are almost always assigned specific numerical identifiers. |
Slicing | Unordered, Open, by system(Value) |
Invariants |
|
Mappings |
|
Patient.identifier:KVNR | |
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 |
Requirements | Patients are almost always assigned specific numerical identifiers. |
Invariants |
|
Mappings |
|
Patient.active | |
Definition | Whether this patient record is in active use. Many systems use this property to mark as non-current patients, such as those that have not been seen for a period of time based on an organization's business rules. It is often used to filter patient lists to exclude inactive patients Deceased patients may also be marked as inactive for the same reasons, but may be active for some time after death. |
Cardinality | 0...1 |
Type | boolean |
Must Support | True |
Modifier | True |
Summary | True |
Requirements | Need to be able to mark a patient record as not to be used because it was created in error. |
Comments | If a record is inactive, and linked to an active record, then future patient/record updates should occur on the other patient. |
Invariants |
|
Mappings |
|
Patient.name | |
Definition | A name associated with the individual. |
Cardinality | 1...* |
Type | HumanName |
Must Support | True |
Summary | True |
Requirements | Need to be able to track the patient by multiple names. Examples are your official name and a partner name. |
Comments | In order to maintain the differentiations of name parts as given in the VSDM dataset or qualify prefixes as academic titles, vendors can opt to support the extensions specified in the German HumanName Base Profile https://simplifier.net/basisprofil-de-r4/humannamedebasis This is however not required within the scope of this specification. |
Slicing | Unordered, Open, by $this(Pattern) |
Invariants |
|
Mappings |
|
Patient.name:Name | |
Definition | Personenname mit in Deutschland üblichen Erweiterungen |
Cardinality | 1...1 |
Type | HumannameDeBasis |
Must Support | True |
Summary | True |
Requirements | Need to be able to track the patient by multiple names. Examples are your official name and a partner name. |
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 |
|
Pattern | { "use": "official" } |
Mappings |
|
Patient.name: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 |
|
Patient.name: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 |
|
Patient.name: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 |
|
Pattern | official |
Mappings |
|
Patient.name: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 |
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 |
|
Patient.name:Name.family | |
Definition | Der vollständige Familienname, einschließlich aller Vorsatz- und Zusatzwörter, mit Leerzeichen getrennt. |
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 |
|
Patient.name: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 |
|
Patient.name: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 |
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 |
|
Patient.name: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 |
|
Patient.name: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 |
|
Patient.name: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 |
|
Patient.name:Name.family.value | |
Definition | Primitive value for string |
Cardinality | 0...1 |
Type | System.String |
Patient.name: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 |
|
Patient.name:Name.prefix | |
Definition | Namensteile vor dem Vornamen, z.B. akademischer Titel. |
Cardinality | 0...* |
Type | string |
Must Support | True |
Summary | True |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Patient.name: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 |
|
Patient.name: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 |
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 |
|
Patient.name: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 |
|
Patient.name: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 |
|
Patient.name: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 |
|
Patient.name: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 |
|
Patient.name: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. |
Invariants |
|
Fixed Value | AC |
Mappings |
|
Patient.name:Name.prefix.value | |
Definition | Primitive value for string |
Cardinality | 0...1 |
Type | System.String |
Patient.name: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 |
|
Patient.name: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 |
|
Patient.name:Geburtsname | |
Definition | Personenname mit in Deutschland üblichen Erweiterungen |
Cardinality | 0...1 |
Type | HumannameDeBasis |
Must Support | True |
Summary | True |
Requirements | Need to be able to track the patient by multiple names. Examples are your official name and a partner name. |
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 |
|
Pattern | { "use": "maiden" } |
Mappings |
|
Patient.name:Geburtsname.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 |
|
Patient.name:Geburtsname.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 |
|
Patient.name:Geburtsname.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 |
|
Pattern | maiden |
Mappings |
|
Patient.name:Geburtsname.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 |
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 |
|
Patient.name:Geburtsname.family | |
Definition | Der vollständige Familienname, einschließlich aller Vorsatz- und Zusatzwörter, mit Leerzeichen getrennt. |
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 |
|
Patient.name:Geburtsname.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 |
|
Patient.name:Geburtsname.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 |
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 |
|
Patient.name:Geburtsname.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 |
|
Patient.name:Geburtsname.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 |
|
Patient.name:Geburtsname.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 |
|
Patient.name:Geburtsname.family.value | |
Definition | Primitive value for string |
Cardinality | 0...1 |
Type | System.String |
Patient.name:Geburtsname.given | |
Definition | Vorname der Person |
Cardinality | 0...0 |
Type | string |
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 |
|
Patient.name:Geburtsname.prefix | |
Definition | Namensteile vor dem Vornamen, z.B. akademischer Titel. |
Cardinality | 0...0 |
Type | string |
Summary | True |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Patient.name:Geburtsname.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 |
|
Patient.name:Geburtsname.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 |
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 |
|
Patient.name:Geburtsname.prefix.extension:prefix-qualifier | |
Definition | Spezialisierung der Art des Präfixes, z.B. "AC" für Akademische Titel |
Cardinality | 0...1 |
Type | Extension(code) |
Alias | extensions, user content |
Comments | Used to indicate additional information about the name part and how it should be used. |
Invariants |
|
Mappings |
|
Patient.name:Geburtsname.prefix.value | |
Definition | Primitive value for string |
Cardinality | 0...1 |
Type | System.String |
Patient.name:Geburtsname.suffix | |
Definition | Namensteile nach dem Nachnamen |
Cardinality | 0...0 |
Type | string |
Summary | True |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Patient.name:Geburtsname.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 |
|
Patient.telecom | |
Definition | A contact detail (e.g. a telephone number or an email address) by which the individual may be contacted. |
Cardinality | 0...* |
Type | ContactPoint |
Summary | True |
Requirements | People have (primary) ways to contact them in some way such as phone, email. |
Comments | A Patient 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. The address might not go directly to the individual, but may reach another party that is able to proxy for the patient (i.e. home phone, or pet owner's phone). |
Invariants |
|
Mappings |
|
Patient.gender | |
Definition | Administrative Gender - the gender that the patient is considered to have for administration and record keeping purposes. |
Cardinality | 0...1 |
Type | code |
Binding | The gender of a person used for administrative purposes. |
Must Support | True |
Summary | True |
Requirements | Needed for identification of the individual, in combination with (at least) name and birth date. |
Comments | The gender might not match the biological sex as determined by genetics or the individual's preferred identification. Note that for both humans and particularly animals, there are other legitimate possibilities than male and female, though the vast majority of systems and contexts only support male and female. Systems providing decision support or enforcing business rules should ideally do this on the basis of Observations dealing with the specific sex or gender aspect of interest (anatomical, chromosomal, social, etc.) However, because these observations are infrequently recorded, defaulting to the administrative gender is common practice. Where such defaulting occurs, rule enforcement should allow for the variation between administrative and biological, chromosomal and other gender aspects. For example, an alert about a hysterectomy on a male should be handled as a warning or overridable error, not a "hard" error. See the Patient Gender and Sex section for additional information about communicating patient gender and sex. |
Invariants |
|
Mappings |
|
Patient.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 |
|
Patient.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 |
|
Patient.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 |
|
Patient.gender.value | |
Definition | Primitive value for code |
Cardinality | 0...1 |
Type | System.String |
Patient.birthDate | |
Definition | The date of birth for the individual. |
Cardinality | 1...1 |
Type | date |
Must Support | True |
Summary | True |
Requirements | Age of the individual drives many clinical processes. |
Comments | At least an estimated year should be provided as a guess if the real DOB is unknown There is a standard extension "patient-birthTime" available that should be used where Time is required (such as in maternity/infant care systems). |
Invariants |
|
Mappings |
|
Patient.deceased[x] | |
Definition | Indicates if the individual is deceased or not. |
Cardinality | 0...1 |
Type | boolean |
Modifier | True |
Summary | True |
Requirements | The fact that a patient is deceased influences the clinical process. Also, in human communication and relation management it is necessary to know whether the person is alive. |
Comments | If there's no value in the instance, it means there is no statement on whether or not the individual is deceased. Most systems will interpret the absence of a value as a sign of the person being alive. |
Invariants |
|
Mappings |
|
Patient.address | |
Definition | An address for the individual. |
Cardinality | 0...* |
Type | Address |
Summary | True |
Requirements | May need to keep track of patient addresses for contacting, billing or reporting requirements and also to help with identification. |
Comments | Patient may have multiple addresses with different uses or applicable periods. |
Invariants |
|
Mappings |
|
Patient.maritalStatus | |
Definition | This field contains a patient's most recent marital (civil) status. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | The domestic partnership status of a person. |
Requirements | Most, if not all systems capture it. |
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 |
|
Patient.multipleBirth[x] | |
Definition | Indicates whether the patient is part of a multiple (boolean) or indicates the actual birth order (integer). |
Cardinality | 0...1 |
Type | boolean |
Requirements | For disambiguation of multiple-birth children, especially relevant where the care provider doesn't meet the patient, such as labs. |
Comments | Where the valueInteger is provided, the number is the birth number in the sequence. E.g. The middle birth in triplets would be valueInteger=2 and the third born would have valueInteger=3 If a boolean value was provided for this triplets example, then all 3 patient records would have valueBoolean=true (the ordering is not indicated). |
Invariants |
|
Mappings |
|
Patient.photo | |
Definition | Image of the patient. |
Cardinality | 0...* |
Type | Attachment |
Requirements | Many EHR systems have the capability to capture an image of the patient. Fits with newer social media usage too. |
Comments | Guidelines:
|
Invariants |
|
Mappings |
|
Patient.contact | |
Definition | A contact party (e.g. guardian, partner, friend) for the patient. |
Cardinality | 0...* |
Type | BackboneElement |
Requirements | Need to track people you can contact about the patient. |
Comments | Contact covers all kinds of contact parties: family members, business contacts, guardians, caregivers. Not applicable to register pedigree and family ties beyond use of having contact. |
Invariants |
|
Mappings |
|
Patient.contact.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 |
|
Patient.contact.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 |
|
Patient.contact.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 |
|
Patient.contact.relationship | |
Definition | The nature of the relationship between the patient and the contact person. |
Cardinality | 0...* |
Type | CodeableConcept |
Binding | The nature of the relationship between a patient and a contact person for that patient. |
Requirements | Used to determine which contact person is the most relevant to approach, depending on circumstances. |
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 |
|
Patient.contact.name | |
Definition | A name associated with the contact person. |
Cardinality | 0...1 |
Type | HumanName |
Requirements | Contact persons need to be identified by name, but it is uncommon to need details about multiple other names for that contact 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 might or might 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 |
|
Patient.contact.telecom | |
Definition | A contact detail for the person, e.g. a telephone number or an email address. |
Cardinality | 0...* |
Type | ContactPoint |
Requirements | People have (primary) ways to contact them in some way such as phone, email. |
Comments | Contact 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 |
|
Patient.contact.address | |
Definition | Address for the contact person. |
Cardinality | 0...1 |
Type | Address |
Requirements | Need to keep track where the contact person can be contacted per postal mail or visited. |
Comments | 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). |
Invariants |
|
Mappings |
|
Patient.contact.gender | |
Definition | Administrative Gender - the gender that the contact person is considered to have for administration and record keeping purposes. |
Cardinality | 0...1 |
Type | code |
Binding | The gender of a person used for administrative purposes. |
Requirements | Needed to address the person correctly. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Patient.contact.organization | |
Definition | Organization on behalf of which the contact is acting or for which the contact is working. |
Cardinality | 0...1 |
Type | Reference(Organization) |
Requirements | For guardians or business related contacts, the organization is relevant. |
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 |
|
Patient.contact.period | |
Definition | The period during which this contact person or organization is valid to be contacted relating to this patient. |
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 |
|
Patient.communication | |
Definition | A language which may be used to communicate with the patient about his or her health. |
Cardinality | 0...* |
Type | BackboneElement |
Requirements | If a patient does not speak the local language, interpreters may be required, so languages spoken and proficiency are 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 Patient.Communication associations. For animals, language is not a relevant field, and should be absent from the instance. If the Patient 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 |
|
Patient.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 |
|
Patient.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 |
|
Patient.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 |
|
Patient.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 |
|
Patient.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 |
|
Patient.generalPractitioner | |
Definition | Patient's nominated care provider. |
Cardinality | 0...* |
Type | Reference(Organization | Practitioner | PractitionerRole) |
Alias | careProvider |
Comments | This may be the primary care provider (in a GP context), or it may be a patient nominated care manager in a community/disability setting, or even organization that will provide people to perform the care provider roles. It is not to be used to record Care Teams, these should be in a CareTeam resource that may be linked to the CarePlan or EpisodeOfCare resources. Multiple GPs may be recorded against the patient for various reasons, such as a student that has his home GP listed along with the GP at university during the school semesters, or a "fly-in/fly-out" worker that has the onsite GP also included with his home GP to remain aware of medical issues. Jurisdictions may decide that they can profile this down to 1 if desired, or 1 per type. |
Invariants |
|
Mappings |
|
Patient.managingOrganization | |
Definition | Organization that is the custodian of the patient record. |
Cardinality | 0...1 |
Type | Reference(Organization) |
Summary | True |
Requirements | Need to know who recognizes this patient record, manages and updates it. |
Comments | There is only one managing organization for a specific patient record. Other organizations will have their own Patient record, and may use the Link property to join the records together (or a Person resource which can include confidence ratings for the association). |
Invariants |
|
Mappings |
|
Patient.link | |
Definition | Link to another patient resource that concerns the same actual patient. |
Cardinality | 0...* |
Type | BackboneElement |
Modifier | True |
Summary | True |
Requirements | There are multiple use cases:
|
Comments | There is no assumption that linked patient records have mutual links. |
Invariants |
|
Mappings |
|
Patient.link.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 |
|
Patient.link.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 |
|
Patient.link.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 |
|
Patient.link.other | |
Definition | The other patient resource that the link refers to. |
Cardinality | 1...1 |
Type | Reference(Patient | RelatedPerson) |
Summary | True |
Comments | Referencing a RelatedPerson here removes the need to use a Person record to associate a Patient and RelatedPerson as the same individual. |
Invariants |
|
Mappings |
|
Patient.link.type | |
Definition | The type of link between this patient resource and another patient resource. |
Cardinality | 1...1 |
Type | code |
Binding | The type of link between this patient resource and another patient resource. |
Summary | True |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="epa-patient" /> <url value="https://gematik.de/fhir/epa/StructureDefinition/epa-patient" /> <version value="1.1.0" /> <name value="EPAPatient" /> <title value="EPA Patient" /> <status value="active" /> <experimental value="false" /> <date value="2024-08-14" /> <publisher value="gematik GmbH" /> <description value="Defines the data structure for the patient profile in the ePA system." /> <fhirVersion value="4.0.1" /> <kind value="resource" /> <abstract value="false" /> <type value="Patient" /> <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Patient" /> <derivation value="constraint" /> <differential> <element id="Patient"> <path value="Patient" /> <constraint> <key value="pat-de-1" /> <severity value="error" /> <human value="Die amtliche Differenzierung der Geschlechtsangabe 'other' darf nur gefüllt sein, wenn das Geschlecht 'other' angegeben ist" /> <expression value="gender.exists() and gender='other' implies gender.extension('http://fhir.de/StructureDefinition/gender-amtlich-de').exists()" /> <source value="https://gematik.de/fhir/epa/StructureDefinition/epa-patient" /> </constraint> </element> <element id="Patient.id"> <path value="Patient.id" /> <mustSupport value="true" /> </element> <element id="Patient.meta"> <path value="Patient.meta" /> <mustSupport value="true" /> </element> <element id="Patient.meta.versionId"> <path value="Patient.meta.versionId" /> <mustSupport value="true" /> </element> <element id="Patient.meta.lastUpdated"> <path value="Patient.meta.lastUpdated" /> <mustSupport value="true" /> </element> <element id="Patient.identifier"> <path value="Patient.identifier" /> <slicing> <discriminator> <type value="value" /> <path value="system" /> </discriminator> <rules value="open" /> </slicing> <min value="1" /> <mustSupport value="true" /> </element> <element id="Patient.identifier:KVNR"> <path value="Patient.identifier" /> <sliceName value="KVNR" /> <min value="1" /> <max value="1" /> <type> <code value="Identifier" /> <profile value="http://fhir.de/StructureDefinition/identifier-kvid-10" /> </type> <mustSupport value="true" /> </element> <element id="Patient.active"> <path value="Patient.active" /> <mustSupport value="true" /> </element> <element id="Patient.name"> <path value="Patient.name" /> <slicing> <discriminator> <type value="pattern" /> <path value="$this" /> </discriminator> <rules value="open" /> </slicing> <comment value="In order to maintain the differentiations of name parts as given in the VSDM dataset or qualify prefixes as academic titles, vendors can opt to support the extensions specified in the German HumanName Base Profile https://simplifier.net/basisprofil-de-r4/humannamedebasis\nThis is however not required within the scope of this specification." /> <min value="1" /> <mustSupport value="true" /> </element> <element id="Patient.name:Name"> <path value="Patient.name" /> <sliceName value="Name" /> <min value="1" /> <max value="1" /> <type> <code value="HumanName" /> <profile value="http://fhir.de/StructureDefinition/humanname-de-basis" /> </type> <patternHumanName> <use value="official" /> </patternHumanName> <mustSupport value="true" /> </element> <element id="Patient.name:Name.use"> <path value="Patient.name.use" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="Patient.name:Name.family"> <path value="Patient.name.family" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="Patient.name:Name.family.extension:namenszusatz"> <path value="Patient.name.family.extension" /> <sliceName value="namenszusatz" /> <mustSupport value="true" /> </element> <element id="Patient.name:Name.family.extension:nachname"> <path value="Patient.name.family.extension" /> <sliceName value="nachname" /> <mustSupport value="true" /> </element> <element id="Patient.name:Name.family.extension:vorsatzwort"> <path value="Patient.name.family.extension" /> <sliceName value="vorsatzwort" /> <mustSupport value="true" /> </element> <element id="Patient.name:Name.given"> <path value="Patient.name.given" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="Patient.name:Name.prefix"> <path value="Patient.name.prefix" /> <mustSupport value="true" /> </element> <element id="Patient.name:Name.prefix.extension:prefix-qualifier"> <path value="Patient.name.prefix.extension" /> <sliceName value="prefix-qualifier" /> <mustSupport value="true" /> </element> <element id="Patient.name:Name.prefix.extension:prefix-qualifier.value[x]"> <path value="Patient.name.prefix.extension.value[x]" /> <fixedCode value="AC" /> </element> <element id="Patient.name:Geburtsname"> <path value="Patient.name" /> <sliceName value="Geburtsname" /> <min value="0" /> <max value="1" /> <type> <code value="HumanName" /> <profile value="http://fhir.de/StructureDefinition/humanname-de-basis" /> </type> <patternHumanName> <use value="maiden" /> </patternHumanName> <mustSupport value="true" /> </element> <element id="Patient.name:Geburtsname.use"> <path value="Patient.name.use" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="Patient.name:Geburtsname.family"> <path value="Patient.name.family" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="Patient.name:Geburtsname.family.extension:namenszusatz"> <path value="Patient.name.family.extension" /> <sliceName value="namenszusatz" /> <mustSupport value="true" /> </element> <element id="Patient.name:Geburtsname.family.extension:nachname"> <path value="Patient.name.family.extension" /> <sliceName value="nachname" /> <mustSupport value="true" /> </element> <element id="Patient.name:Geburtsname.family.extension:vorsatzwort"> <path value="Patient.name.family.extension" /> <sliceName value="vorsatzwort" /> <mustSupport value="true" /> </element> <element id="Patient.name:Geburtsname.given"> <path value="Patient.name.given" /> <max value="0" /> </element> <element id="Patient.name:Geburtsname.prefix"> <path value="Patient.name.prefix" /> <max value="0" /> </element> <element id="Patient.name:Geburtsname.suffix"> <path value="Patient.name.suffix" /> <max value="0" /> </element> <element id="Patient.gender"> <path value="Patient.gender" /> <mustSupport value="true" /> </element> <element id="Patient.gender.extension:other-amtlich"> <path value="Patient.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="Patient.birthDate"> <path value="Patient.birthDate" /> <min value="1" /> <mustSupport value="true" /> </element> </differential> </StructureDefinition>
{ "resourceType": "StructureDefinition", "id": "epa-patient", "url": "https://gematik.de/fhir/epa/StructureDefinition/epa-patient", "version": "1.1.0", "name": "EPAPatient", "title": "EPA Patient", "status": "active", "experimental": false, "date": "2024-08-14", "publisher": "gematik GmbH", "description": "Defines the data structure for the patient profile in the ePA system.", "fhirVersion": "4.0.1", "kind": "resource", "abstract": false, "type": "Patient", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Patient", "derivation": "constraint", "differential": { "element": [ { "id": "Patient", "path": "Patient", "constraint": [ { "key": "pat-de-1", "human": "Die amtliche Differenzierung der Geschlechtsangabe 'other' darf nur gefüllt sein, wenn das Geschlecht 'other' angegeben ist", "source": "https://gematik.de/fhir/epa/StructureDefinition/epa-patient", "severity": "error", "expression": "gender.exists() and gender='other' implies gender.extension('http://fhir.de/StructureDefinition/gender-amtlich-de').exists()" } ] }, { "id": "Patient.id", "path": "Patient.id", "mustSupport": true }, { "id": "Patient.meta", "path": "Patient.meta", "mustSupport": true }, { "id": "Patient.meta.versionId", "path": "Patient.meta.versionId", "mustSupport": true }, { "id": "Patient.meta.lastUpdated", "path": "Patient.meta.lastUpdated", "mustSupport": true }, { "id": "Patient.identifier", "path": "Patient.identifier", "slicing": { "discriminator": [ { "type": "value", "path": "system" } ], "rules": "open" }, "min": 1, "mustSupport": true }, { "id": "Patient.identifier:KVNR", "path": "Patient.identifier", "sliceName": "KVNR", "min": 1, "max": "1", "type": [ { "code": "Identifier", "profile": [ "http://fhir.de/StructureDefinition/identifier-kvid-10" ] } ], "mustSupport": true }, { "id": "Patient.active", "path": "Patient.active", "mustSupport": true }, { "id": "Patient.name", "path": "Patient.name", "slicing": { "discriminator": [ { "type": "pattern", "path": "$this" } ], "rules": "open" }, "comment": "In order to maintain the differentiations of name parts as given in the VSDM dataset or qualify prefixes as academic titles, vendors can opt to support the extensions specified in the German HumanName Base Profile https://simplifier.net/basisprofil-de-r4/humannamedebasis\nThis is however not required within the scope of this specification.", "min": 1, "mustSupport": true }, { "id": "Patient.name:Name", "path": "Patient.name", "sliceName": "Name", "min": 1, "max": "1", "type": [ { "code": "HumanName", "profile": [ "http://fhir.de/StructureDefinition/humanname-de-basis" ] } ], "patternHumanName": { "use": "official" }, "mustSupport": true }, { "id": "Patient.name:Name.use", "path": "Patient.name.use", "min": 1, "mustSupport": true }, { "id": "Patient.name:Name.family", "path": "Patient.name.family", "min": 1, "mustSupport": true }, { "id": "Patient.name:Name.family.extension:namenszusatz", "path": "Patient.name.family.extension", "sliceName": "namenszusatz", "mustSupport": true }, { "id": "Patient.name:Name.family.extension:nachname", "path": "Patient.name.family.extension", "sliceName": "nachname", "mustSupport": true }, { "id": "Patient.name:Name.family.extension:vorsatzwort", "path": "Patient.name.family.extension", "sliceName": "vorsatzwort", "mustSupport": true }, { "id": "Patient.name:Name.given", "path": "Patient.name.given", "min": 1, "mustSupport": true }, { "id": "Patient.name:Name.prefix", "path": "Patient.name.prefix", "mustSupport": true }, { "id": "Patient.name:Name.prefix.extension:prefix-qualifier", "path": "Patient.name.prefix.extension", "sliceName": "prefix-qualifier", "mustSupport": true }, { "id": "Patient.name:Name.prefix.extension:prefix-qualifier.value[x]", "path": "Patient.name.prefix.extension.value[x]", "fixedCode": "AC" }, { "id": "Patient.name:Geburtsname", "path": "Patient.name", "sliceName": "Geburtsname", "min": 0, "max": "1", "type": [ { "code": "HumanName", "profile": [ "http://fhir.de/StructureDefinition/humanname-de-basis" ] } ], "patternHumanName": { "use": "maiden" }, "mustSupport": true }, { "id": "Patient.name:Geburtsname.use", "path": "Patient.name.use", "min": 1, "mustSupport": true }, { "id": "Patient.name:Geburtsname.family", "path": "Patient.name.family", "min": 1, "mustSupport": true }, { "id": "Patient.name:Geburtsname.family.extension:namenszusatz", "path": "Patient.name.family.extension", "sliceName": "namenszusatz", "mustSupport": true }, { "id": "Patient.name:Geburtsname.family.extension:nachname", "path": "Patient.name.family.extension", "sliceName": "nachname", "mustSupport": true }, { "id": "Patient.name:Geburtsname.family.extension:vorsatzwort", "path": "Patient.name.family.extension", "sliceName": "vorsatzwort", "mustSupport": true }, { "id": "Patient.name:Geburtsname.given", "path": "Patient.name.given", "max": "0" }, { "id": "Patient.name:Geburtsname.prefix", "path": "Patient.name.prefix", "max": "0" }, { "id": "Patient.name:Geburtsname.suffix", "path": "Patient.name.suffix", "max": "0" }, { "id": "Patient.gender", "path": "Patient.gender", "mustSupport": true }, { "id": "Patient.gender.extension:other-amtlich", "path": "Patient.gender.extension", "sliceName": "other-amtlich", "min": 0, "max": "1", "type": [ { "code": "Extension", "profile": [ "http://fhir.de/StructureDefinition/gender-amtlich-de" ] } ] }, { "id": "Patient.birthDate", "path": "Patient.birthDate", "min": 1, "mustSupport": true } ] } }