ISiKPatient - Definitions - ISiK Basis Implementierungsleitfaden v6.0.0-rc

Is Modifier false

Must Support true

Summary true

4. 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.

Short Metadata about the resource

Control 0..1

Meta

Is Modifier false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

6. 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.

Short Unique id for inter-element referencing

Control 0..1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

8. 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.

Short Additional content defined by implementations

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.

Control 0..*

Is Modifier false

Summary false

Alternate Names extensions, user content

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())

This element introduces a set of slices on Patient.meta.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

10. 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.

Short Eindeutiger Name der serverseitigen Version des Datensatzes

Comments

Alle von einem Server bereitgestellten Ressourcen SOLLEN über eine versionID verfügen. Von Clients erzeugte Ressourcen, die im Kontext einer CREATE-Interaktion übermittelt werden, MÜSSEN NICHT über eine versionIDverfügen.

Control 0..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

12. Patient.meta.lastUpdated

Definition

When the resource last changed - e.g. when the version changed.

Short Zeitpunkt der letzten Änderung

Comments

Alle von einem Server bereitgestellten Ressourcen SOLLEN über ein lastUpdate verfügen. Von Clients erzeugte Ressourcen, die im Kontext einer CREATE-Interaktion übermittelt werden, MÜSSEN NICHT über ein lastUpdateverfügen.

Control 0..1

instant

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

14. Patient.meta.source

Definition

A uri that identifies the source system of the resource. This provides a minimal amount of Provenance 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.

Short Identifies where the resource comes from

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.

Control 0..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

16. Patient.meta.profile

Definition

A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url.

Short Profiles this resource claims to conform to

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.

Control 0..*

Type canonical(StructureDefinition)

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

18. Patient.meta.security

Definition

Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.

Short Security Labels applied to this resource

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.

Control 0..*

Unless not suitable, these codes SHALL be taken from All Security Labels
(extensible to http://hl7.org/fhir/ValueSet/security-labels|4.0.1)

Security Labels from the Healthcare Privacy and Security Classification System.

Coding

Is Modifier false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

20. 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.

Short Tags applied to this resource

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.

Control 0..*

For example codes, see CommonTags
(example to http://hl7.org/fhir/ValueSet/common-tags|4.0.1)

Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".

Coding

Is Modifier false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

22. 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.

Short A set of rules under which this content was created

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.

Control 0..1

Is Modifier true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

24. Patient.language

Definition

The base language in which the resource is written.

Short Language of the resource content

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).

Control 0..1

The codes SHOULD be taken from CommonLanguages
(preferred to http://hl7.org/fhir/ValueSet/languages|4.0.1)

A human language.

Additional Bindings

Purpose

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

26. 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.

Short Text summary of the resource, for human interpretation

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.

Control 0..1

Narrative

Is Modifier false

Summary false

Alternate Names narrative, html, xhtml, display

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

28. 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.

Short Contained, inline 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.

Control 0..*

Resource

Is Modifier false

Summary false

Alternate Names inline resources, anonymous resources, contained resources

30. 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.

Short Additional content defined by implementations

Comments

Control 0..*

Is Modifier false

Summary false

Alternate Names extensions, user content

32. 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).

Short Extensions that cannot be ignored

Comments

Control 0..*

Is Modifier true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them

Summary false

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.

Alternate Names extensions, user content

34. Patient.identifier

Definition

An identifier for this patient.

Short An identifier for this patient

Comments

Eindeutiger Identifier des Patienten

Note This is a business identifier, not a resource identifier (see discussion)

Control 1..*

Identifier

Is Modifier false

Must Support true

Summary true

Requirements

Patients are almost always assigned specific numerical identifiers.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

This element introduces a set of slices on Patient.identifier. The slices areUnordered and Open, and can be differentiated using the following discriminators:

pattern @ $this

36. Patient.identifier:VersichertenId

Slice Name VersichertenId

Definition

An identifier for this patient.

Short Lebenslange Krankenversichertennummer

Comments

Die als 'KVZ10' kodierte Versichertennummer ist der 10-stellige, unveränderbare Teil der Versichertennummer, der lesbar auf die Elektronische Gesundheitskarte aufgedruckt ist. Er gilt für alle Krankenversichertennummern, unabhängig davon, ob es sich um GKV, PKV oder Sonderkostenträger handelt. Für eine Weiterverarbeitung einer Patient-Ressource in der ePA ist dieser Identifier im EPAPatient-Profil ein Pflichtfeld.
Weitere Hinweise: siehe Deutschen Basisprofile

Note This is a business identifier, not a resource identifier (see discussion)

Control 0..1

Type Identifier(Identifier-Profil für die 10-stellige Krankenversichertennummer)

Is Modifier false

Must Support true

Summary true

Requirements

Patients are almost always assigned specific numerical identifiers.

Pattern Value { "type" : { "coding" : [{ "system" : "http://fhir.de/CodeSystem/identifier-type-de-basis", "code" : "KVZ10" }] } }

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

38. Patient.identifier:VersichertenId.id

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Short Unique id for inter-element referencing

Control 0..1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

40. Patient.identifier:VersichertenId.extension

Definition

Short Additional content defined by implementations

Comments

Control 0..*

Is Modifier false

Summary false

Alternate Names extensions, user content

This element introduces a set of slices on Patient.identifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

42. Patient.identifier:VersichertenId.use

Definition

The purpose of this identifier.

Short usual | official | temp | secondary | old (If known)

Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Control 0..1

The codes SHALL be taken from IdentifierUse
(required to http://hl7.org/fhir/ValueSet/identifier-use|4.0.1)

Identifies the purpose for this identifier, if known .

Is Modifier true because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

44. Patient.identifier:VersichertenId.type

Definition

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

Short Art des Identifiers

Comments

Hier ist stets der Code KVZ10 aus dem CodeSystem http://fhir.de/CodeSystem/identifier-type-de-basis anzugeben.
Begründung Pflichtfeld: type dient der Unterscheidung verschiedener Identifier-Typen

Control 1..1

Unless not suitable, these codes SHALL be taken from Identifier Type DeBasis ValueSet
(extensible to http://fhir.de/ValueSet/identifier-type-de-basis)

A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

Is Modifier false

Must Support true

Summary true

Requirements

Allows users to make use of identifiers when the identifier system is not known.

Pattern Value { "coding" : [{ "system" : "http://fhir.de/CodeSystem/identifier-type-de-basis", "code" : "KVZ10" }] }

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
kvid-2: Die type Codes 'GKV' und 'PKV' haben den Status 'retired', daher sollen diese nicht mehr verwendet werden (($this.coding.exists(system='http://fhir.de/CodeSystem/identifier-type-de-basis' and code='GKV') or $this.coding.exists(system='http://fhir.de/CodeSystem/identifier-type-de-basis' and code='PKV')).not())

46. Patient.identifier:VersichertenId.system

Definition

Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

Short Namensraum der Versichertennummer

Comments

Hier ist stets der Wert http://fhir.de/sid/gkv/kvid-10 anzugeben.
Begründung Pflichtfeld: system stellt in Kombination mit value die Eindeutigkeit eines Identifiers sicher.

Control 1..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support true

Summary true

Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Fixed Value http://fhir.de/sid/gkv/kvid-10

Example General: http://www.acme.com/identifiers/patient

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

48. Patient.identifier:VersichertenId.value

Definition

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

Short Lebenslange Krankenversichertennummer

Comments

Der 10-stellige, unveränderbare Teil der Versichertennummer.

Control 1..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support true

Summary true

Example General: 123456

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
kvid-1: Der unveränderliche Teil der KVID muss 10-stellig sein und mit einem Großbuchstaben anfangen (matches('^[A-Z][0-9]{9}$'))

50. Patient.identifier:VersichertenId.period

Definition

Time period during which identifier is/was valid for use.

Short Time period when id is/was valid for use

Control 0..1

Is Modifier false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

52. Patient.identifier:VersichertenId.assigner

Definition

Organization that issued/manages the identifier.

Short Organization that issued id (may be just text)

Comments

The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

Control 0..1

Type Reference(Organization)

Is Modifier false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

54. Patient.identifier:VersichertenId-GKV

Slice Name VersichertenId-GKV

Definition

An identifier for this patient.

Short Gesetzliche Krankenversichertennummer

Comments

WARNUNG: Die Verwendung der 'GKV'-Kodierung einer Versichertennummer ist abgekündigt, da die lebenslangen Versichertennummer ab 2024 auch für PKV oder Sonderkostenträger eingeführt wird. Bitte statt dessen künftig den 'VersichertenId'-Slice verwenden.

Note This is a business identifier, not a resource identifier (see discussion)

Control 0..1

Type Identifier(Identifier-Profil für die 10-stellige Krankenversichertennummer)

Is Modifier false

Must Support true

Summary true

Requirements

Patients are almost always assigned specific numerical identifiers.

Pattern Value { "type" : { "coding" : [{ "system" : "http://fhir.de/CodeSystem/identifier-type-de-basis", "code" : "GKV" }] } }

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

56. Patient.identifier:VersichertenId-GKV.id

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Short Unique id for inter-element referencing

Control 0..1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

58. Patient.identifier:VersichertenId-GKV.extension

Definition

Short Additional content defined by implementations

Comments

Control 0..*

Is Modifier false

Summary false

Alternate Names extensions, user content

This element introduces a set of slices on Patient.identifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

60. Patient.identifier:VersichertenId-GKV.use

Definition

The purpose of this identifier.

Short usual | official | temp | secondary | old (If known)

Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Control 0..1

The codes SHALL be taken from IdentifierUse
(required to http://hl7.org/fhir/ValueSet/identifier-use|4.0.1)

Identifies the purpose for this identifier, if known .

Is Modifier true because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

62. Patient.identifier:VersichertenId-GKV.type

Definition

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

Short Art des Identifiers

Comments

Hier ist stets der Code GKV aus dem CodeSystem http://fhir.de/CodeSystem/identifier-type-de-basis anzugeben.
Begründung Pflichtfeld: type dient der Unterscheidung verschiedener Identifier-Typen

Control 1..1

Unless not suitable, these codes SHALL be taken from Identifier Type DeBasis ValueSet
(extensible to http://fhir.de/ValueSet/identifier-type-de-basis)

A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

Is Modifier false

Must Support true

Summary true

Requirements

Allows users to make use of identifiers when the identifier system is not known.

Pattern Value { "coding" : [{ "system" : "http://fhir.de/CodeSystem/identifier-type-de-basis", "code" : "KVZ10" }] }

64. Patient.identifier:VersichertenId-GKV.system

Definition

Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

Short Namensraum der Versichertennummer

Comments

Hier ist stets der Wert http://fhir.de/sid/gkv/kvid-10 anzugeben.
Begründung Pflichtfeld: system stellt in Kombination mit value die Eindeutigkeit eines Identifiers sicher.

Control 1..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support true

Summary true

Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Fixed Value http://fhir.de/sid/gkv/kvid-10

Example General: http://www.acme.com/identifiers/patient

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

66. Patient.identifier:VersichertenId-GKV.value

Definition

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

Short The value that is unique

Comments

Enthält den eigentlichen Wert des Identifiers.
Begründung Pflichtfeld: Ist der Wert nicht bekannt, sollte der gesamte Slice weggelassen werden.

Control 1..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support true

Summary true

Example General: 123456

68. Patient.identifier:VersichertenId-GKV.period

Definition

Time period during which identifier is/was valid for use.

Short Time period when id is/was valid for use

Control 0..1

Is Modifier false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

70. Patient.identifier:VersichertenId-GKV.assigner

Definition

Organization that issued/manages the identifier.

Short Organization that issued id (may be just text)

Comments

The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

Control 0..1

Type Reference(Organization)

Is Modifier false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

72. Patient.identifier:Patientennummer

Slice Name Patientennummer

Definition

An identifier for this patient.

Short Organisationsinterner Patienten-Identifier (PID)

Comments

Organisationsintere Patienten-Identifier werden von z.B. von KIS-Systemen vergeben und dienen innerhalb einer Einreichtung meist als primäres Identifikationsmerkmal für Patienten, u.A. in der HL7 V2-Kommunikation.
Weitere Hinweise: siehe Deutschen Basisprofile

Note This is a business identifier, not a resource identifier (see discussion)

Control 1..*

Type Identifier(Identifier-Profil für die Abbildung einer Patienten-ID)

Is Modifier false

Must Support true

Summary true

Requirements

Patients are almost always assigned specific numerical identifiers.

Pattern Value { "type" : { "coding" : [{ "system" : "http://terminology.hl7.org/CodeSystem/v2-0203", "code" : "MR" }] } }

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

74. Patient.identifier:Patientennummer.id

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Short Unique id for inter-element referencing

Control 0..1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

76. Patient.identifier:Patientennummer.extension

Definition

Short Additional content defined by implementations

Comments

Control 0..*

Is Modifier false

Summary false

Alternate Names extensions, user content

This element introduces a set of slices on Patient.identifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

78. Patient.identifier:Patientennummer.use

Definition

The purpose of this identifier.

Short usual | official | temp | secondary | old (If known)

Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Control 0..1

The codes SHALL be taken from IdentifierUse
(required to http://hl7.org/fhir/ValueSet/identifier-use|4.0.1)

Identifies the purpose for this identifier, if known .

Is Modifier true because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

80. Patient.identifier:Patientennummer.type

Definition

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

Short Art des Identifiers

Comments

Hier ist stets der Code MR aus dem CodeSystem http://terminology.hl7.org/CodeSystem/v2-0203 anzugeben.
Begründung Pflichtfeld: type dient der Unterscheidung verschiedener Identifier-Typen

Control 1..1

Unless not suitable, these codes SHALL be taken from Identifier Type DeBasis ValueSet
(extensible to http://fhir.de/ValueSet/identifier-type-de-basis)

A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

Is Modifier false

Must Support true

Summary true

Requirements

Allows users to make use of identifiers when the identifier system is not known.

Pattern Value { "coding" : [{ "system" : "http://terminology.hl7.org/CodeSystem/v2-0203", "code" : "MR" }] }

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

82. Patient.identifier:Patientennummer.system

Definition

Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

Short Namensraum des Identifiers

Comments

Hier ist stets der eindeutige Name (URL) des Namensraums anzugeben, aus dem der Identifier stammt. Hinweise zur Festlegung der URLs für lokale Namensräume sind in den Deutschen Basisprofilen beschrieben.
Begründung Pflichtfeld: system stellt in Kombination mit value die Eindeutigkeit eines Identifiers sicher.

Control 1..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support true

Summary true

Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Example General: http://www.acme.com/identifiers/patient

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

84. Patient.identifier:Patientennummer.value

Definition

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

Short The value that is unique

Comments

Enthält den eigentlichen Wert des Identifiers.
Begründung Pflichtfeld: Ist der Wert nicht bekannt, sollte der gesamte Slice weggelassen werden.

Control 1..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support true

Summary true

Example General: 123456

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

86. Patient.identifier:Patientennummer.period

Definition

Time period during which identifier is/was valid for use.

Short Time period when id is/was valid for use

Control 0..1

Is Modifier false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

88. Patient.identifier:Patientennummer.assigner

Definition

Organization that issued/manages the identifier.

Short Organization that issued id (may be just text)

Comments

The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

Control 0..1

Type Reference(Organization)

Is Modifier false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

90. Patient.identifier:Versichertennummer_PKV

Slice Name Versichertennummer_PKV

Definition

An identifier for this patient.

Short Private Krankenversichertennummer

Comments

Für Privatpatienten, die noch nicht über eine lebenslange, unveränderliche Krankenversichertennummer (KVNR) verfügen, können bis auf weiteres noch die versicherungsspezifischen PKV-Nummern angegeben werden. Da bei diesen der Bezeichner des vom Kostenträger verwendeten Namensraums meist nicht ermittelt werden kann, ist statt dessen der Name des Kostenträgers in assigner anzugeben. Achtung: Dieser Slice dient NICHT zur Abbildung einer 10-stelligen PKV-VersichertenId nach § 362 SGB V. Diese sind durch den Slice 'VersichertenId' abzubilden, da die Nummernkreise dieser Identifier identisch sind. Weitere Hinweise: siehe Deutsche Basisprofile Der Identifier kann jedoch zusätzlich zur KVNR verwendet werden, wenn für eine Zusatzversicherung eine separate, versicherungsspezifische PKV-Nummer vorliegt.

Note This is a business identifier, not a resource identifier (see discussion)

Control 0..1

Type Identifier(Identifier-Profil für die Abbildung einer Privatversichertennummer)

Is Modifier false

Must Support false

Summary true

Requirements

Patients are almost always assigned specific numerical identifiers.

Pattern Value { "type" : { "coding" : [{ "system" : "http://fhir.de/CodeSystem/identifier-type-de-basis", "code" : "PKV" }] } }

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

92. Patient.identifier:Versichertennummer_PKV.id

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Short Unique id for inter-element referencing

Control 0..1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

94. Patient.identifier:Versichertennummer_PKV.extension

Definition

Short Additional content defined by implementations

Comments

Control 0..*

Is Modifier false

Summary false

Alternate Names extensions, user content

This element introduces a set of slices on Patient.identifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

96. Patient.identifier:Versichertennummer_PKV.use

Definition

The purpose of this identifier.

Short Verwendungszeck des Identifiers

Comments

Hier ist stets der Wert secondary anzugeben.

Control 0..1

The codes SHALL be taken from IdentifierUse
(required to http://hl7.org/fhir/ValueSet/identifier-use|4.0.1)

Identifies the purpose for this identifier, if known .

Is Modifier true because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support true

Summary true

Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Fixed Value secondary

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

98. Patient.identifier:Versichertennummer_PKV.type

Definition

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

Short Art des Identifiers

Comments

Hier ist stets der Code PKV aus dem CodeSystem http://fhir.de/CodeSystem/identifier-type-de-basis anzugeben.
Begründung Pflichtfeld: type dient der Unterscheidung verschiedener Identifier-Typen

Control 1..1

Unless not suitable, these codes SHALL be taken from Identifier Type DeBasis ValueSet
(extensible to http://fhir.de/ValueSet/identifier-type-de-basis)

A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

Is Modifier false

Must Support true

Summary true

Requirements

Allows users to make use of identifiers when the identifier system is not known.

Pattern Value { "coding" : [{ "system" : "http://fhir.de/CodeSystem/identifier-type-de-basis", "code" : "PKV" }] }

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

100. Patient.identifier:Versichertennummer_PKV.system

Definition

Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

Short The namespace for the identifier value

Comments

Identifier.system is always case sensitive.

Control 0..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Example General: http://www.acme.com/identifiers/patient

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

102. Patient.identifier:Versichertennummer_PKV.value

Definition

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

Short Private Krankenversichertennummer

Comments

Enthält den eigentlichen Wert des Identifiers.
Begründung Pflichtfeld: Ist der Wert nicht bekannt, sollte der gesamte Slice weggelassen werden.

Control 1..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support true

Summary true

Example General: 123456

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

104. Patient.identifier:Versichertennummer_PKV.period

Definition

Time period during which identifier is/was valid for use.

Short Time period when id is/was valid for use

Control 0..1

Is Modifier false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

106. Patient.identifier:Versichertennummer_PKV.assigner

Definition

Organization that issued/manages the identifier.

Short Organization that issued id (may be just text)

Comments

The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

Control 1..1

Type Reference(Organization)

Is Modifier false

Must Support true

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

108. Patient.identifier:Versichertennummer_PKV.assigner.id

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Short Unique id for inter-element referencing

Control 0..1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

110. Patient.identifier:Versichertennummer_PKV.assigner.extension

Definition

Short Additional content defined by implementations

Comments

Control 0..*

Is Modifier false

Summary false

Alternate Names extensions, user content

This element introduces a set of slices on Patient.identifier.assigner.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

112. Patient.identifier:Versichertennummer_PKV.assigner.reference

Definition

A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

Short Literal reference, Relative, internal or absolute URL

Comments

Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

Control 0..1
This element is affected by the following invariants: ref-1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

114. Patient.identifier:Versichertennummer_PKV.assigner.type

Definition

The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).

Short Type the reference refers to (e.g. "Patient")

Comments

This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.

Control 0..1

Unless not suitable, these codes SHALL be taken from ResourceType
(extensible to http://hl7.org/fhir/ValueSet/resource-types)

Aa resource (or, for logical models, the URI of the logical model).

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

116. Patient.identifier:Versichertennummer_PKV.assigner.identifier

Definition

An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.

Short An identifier intended for computation

Comments

When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).

Note This is a business identifier, not a resource identifier (see discussion)

Control 0..1
This element is affected by the following invariants: ele-1

Type Identifier(Identifier-Profil für die Abbildung eines Institutionskennzeichens (IKNR))

Is Modifier false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

118. Patient.identifier:Versichertennummer_PKV.assigner.identifier.id

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Short Unique id for inter-element referencing

Control 0..1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

120. Patient.identifier:Versichertennummer_PKV.assigner.identifier.extension

Definition

Short Additional content defined by implementations

Comments

Control 0..*

Is Modifier false

Summary false

Alternate Names extensions, user content

This element introduces a set of slices on Patient.identifier.assigner.identifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

122. Patient.identifier:Versichertennummer_PKV.assigner.identifier.use

Definition

The purpose of this identifier.

Short usual | official | temp | secondary | old (If known)

Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Control 0..1

The codes SHALL be taken from IdentifierUse
(required to http://hl7.org/fhir/ValueSet/identifier-use|4.0.1)

Identifies the purpose for this identifier, if known .

Is Modifier true because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

124. Patient.identifier:Versichertennummer_PKV.assigner.identifier.type

Definition

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

Short Description of identifier

Comments

This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

Control 0..1

Unless not suitable, these codes SHALL be taken from Identifier Type DeBasis ValueSet
(extensible to http://fhir.de/ValueSet/identifier-type-de-basis)

A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

Is Modifier false

Summary true

Requirements

Allows users to make use of identifiers when the identifier system is not known.

Pattern Value { "coding" : [{ "system" : "http://terminology.hl7.org/CodeSystem/v2-0203", "code" : "XX" }] }

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

126. Patient.identifier:Versichertennummer_PKV.assigner.identifier.system

Definition

Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

Short Namensraum des Identifiers

Comments

Hier ist stets der Wert http://fhir.de/sid/arge-ik/iknr anzugeben.

Control 1..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support true

Summary true

Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Fixed Value http://fhir.de/sid/arge-ik/iknr

Example General: http://www.acme.com/identifiers/patient

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

128. Patient.identifier:Versichertennummer_PKV.assigner.identifier.value

Definition

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

Short IK-Nummer des Kostenträgers

Comments

IK-Nummer des Kostenträgers, aus dessen Nummernkreis die PKV-Nummer stammt.

Control 1..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support true

Summary true

Example General: 123456

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ik-1: Eine IK muss eine numerische 9-stellige Zeichenkette (mit Prüfziffer) sein (matches('^[0-9]{9}$'))

130. Patient.identifier:Versichertennummer_PKV.assigner.identifier.period

Definition

Time period during which identifier is/was valid for use.

Short Time period when id is/was valid for use

Control 0..1

Is Modifier false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

132. Patient.identifier:Versichertennummer_PKV.assigner.identifier.assigner

Definition

Organization that issued/manages the identifier.

Short Organization that issued id (may be just text)

Comments

The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

Control 0..1

Type Reference(Organization)

Is Modifier false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

134. Patient.identifier:Versichertennummer_PKV.assigner.display

Definition

Plain text narrative that identifies the resource in addition to the resource reference.

Short Name des Kostenträgers

Comments

Name des Kostenträgers, aus dessen Nummernkreis die PKV-Nummer stammt.

Control 1..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support true

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

136. 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.

Short Status des Datensatzes

Comments

true = Der Datensatz befindet sich in Verwendung/kann verwendet werden
false= Der Datensatz wurde storniert (z.B. bei Dubletten, Merge) oder archiviert
Einschränkung der übergreifenden MS-Definition:
Verfügt ein bestätigungsrelevantes System nicht über die Datenstruktur zur Hinterlegung des Aktivitätsstatus einer Patienten-Ressource, so MUSS dieses System die Information NICHT abbilden. Das System SOLL jedoch den Aktivitätsstatus hart kodieren in der Patienteninstanz (Patient.active auf 'true'), sodass Clients nicht missverständlich mit einer inaktiven Patient-Ressource interagieren.

Control 0..1

boolean

Is Modifier true because This element is labelled as a modifier because it is a status element that can indicate that a record should not be treated as valid

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support true

Summary true

Requirements

Need to be able to mark a patient record as not to be used because it was created in error.

Meaning if Missing This resource is generally assumed to be active if no value is provided for the active element

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

138. Patient.name

Definition

A name associated with the individual.

Short A name associated with the patient

Comments

Angabe der Namen

Control 1..*

HumanName

Is Modifier false

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.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

This element introduces a set of slices on Patient.name. The slices areUnordered and Open, and can be differentiated using the following discriminators:

pattern @ $this

140. Patient.name:Name

Slice Name Name

Definition

A name associated with the individual.

Short Offizieller Name

Comments

Offizieller Name des Patienten, wie er z.B. in Ausweis oder Versicherungsdokumenten erscheint. Begründung Pflichtfeld: Der offizielle Name des Patienten ist unerlässlich, um Verwechlungen zu vermeiden und den Patienten im Versorgungskontext korrekt anzusprechen. Wenn kein Name vorliegt, MUSS die data-absent-reason-Extension eingesetzt werden.
Weitere Hinweise: siehe Deutsche Basisprofile

Control 1..1

Type HumanName(HumanName, deutsches Basisprofil)

Is Modifier false

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.

Pattern Value { "use" : "official" }

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

142. 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.

Short Unique id for inter-element referencing

Control 0..1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

144. Patient.name:Name.extension

Definition

Short Additional content defined by implementations

Comments

Control 0..*

Is Modifier false

Summary false

Alternate Names extensions, user content

This element introduces a set of slices on Patient.name.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

146. Patient.name:Name.use

Definition

Identifies the purpose for this name.

Short Verwendungszweck

Comments

Hier ist stets der Wert official anzugeben.
Begründung Pflichtfeld: Dient als Unterscheidungs- und Auswahlkriterium

Control 1..1

The codes SHALL be taken from NameUse
(required to http://hl7.org/fhir/ValueSet/name-use|4.0.1)

The use of a human name.

Is Modifier true because This is labeled as "Is Modifier" because applications should not mistake a temporary or old name etc.for a current/permanent one

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support true

Summary true

Requirements

Allows the appropriate name for a particular context of use to be selected from among a set of names.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

148. 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.

Short Text representation of the full name

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.

Control 0..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Requirements

A renderable, unencoded form.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

150. Patient.name:Name.family

Definition

Der vollständige Familienname, einschließlich aller Vorsatz- und Zusatzwörter, mit Leerzeichen getrennt.

Short Nachname

Comments

Vollständiger Nachname bzw. Familienname der Person, einschließlich Vor- und Zusätze.
Begründung Pflichtfeld: Ein offizieller Name ist nur zulässig, wenn der Nachname und mindestens ein Vorname angegeben sind.

Control 1..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support true

Summary true

Alternate Names surname

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

152. Patient.name:Name.family.id

Definition

unique id for the element within a resource (for internal references)

Short xml:id (or equivalent in JSON)

Control 0..1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

154. Patient.name:Name.family.extension

Definition

Short Additional content defined by implementations

Comments

Control 0..*

Is Modifier false

Summary false

Alternate Names extensions, user content

This element introduces a set of slices on Patient.name.family.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

156. Patient.name:Name.family.extension:namenszusatz

Slice Name namenszusatz

Definition

Namenszusatz als Bestandteil das Nachnamens, wie in VSDM (Versichertenstammdatenmanagement, "eGK") definiert. Beispiele: Gräfin, Prinz oder Fürst

Short Namenszusatz

Comments

Enthält ehem. Adelstitel wie z.B. 'Graf', 'Baronesse', 'Freiherr'...
Begründung MS: Erforderlich für die verlustfreie Kommunikation von VSDM-Daten.

Control 0..1
This element is affected by the following invariants: ele-1

Type Extension(Extension zur Erfassung der VSDM Namensbestandteile) (Extension Type: string)

Is Modifier false

Must Support true

Summary false

158. Patient.name:Name.family.extension:nachname

Slice Name nachname

Definition

The portion of the family name that is derived from the person's own surname, as distinguished from any portion that is derived from the surname of the person's partner or spouse.

Short Nachname

Comments

Nachname ohne Vor- und Zusätze.
Begründung MS: Erforderlich für die verlustfreie Kommunikation von VSDM-Daten.

Control 0..1
This element is affected by the following invariants: ele-1

Type Extension(Own Name) (Extension Type: string)

Is Modifier false

Must Support true

Summary false

160. Patient.name:Name.family.extension:vorsatzwort

Slice Name vorsatzwort

Definition

The prefix portion (e.g. voorvoegsel) of the family name that is derived from the person's own surname, as distinguished from any portion that is derived from the surname of the person's partner or spouse.

Short Voorvoegsel derived from person's own surname

Comments

Enthält Vorsätze, die vor dem Nachnamen stehen, z.B. 'von', 'van', 'zu'...
Begründung MS: Erforderlich für die verlustfreie Kommunikation von VSDM-Daten.

Control 0..1
This element is affected by the following invariants: ele-1

Type Extension(Own Prefix) (Extension Type: string)

Is Modifier false

Must Support true

Summary false

162. Patient.name:Name.family.value

Definition

The actual value

Short Primitive value for string

Control 0..1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

Max Length: 1048576

164. Patient.name:Name.given

Definition

Vorname der Person

Short Vorname

Comments

Kann mehrfach verwendet werden, um den Rufnamen sowie weitere Vornamen, Mittelnamen oder Mittel-Initialen abzubilden. Begründung Pflichtfeld: Ein offizieller Name ist nur zulässig, wenn der Nachname und mindestens ein Vorname angegeben sind.

Control 1..*

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support true

Summary true

Alternate Names first name, middle name

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

166. Patient.name:Name.prefix

Definition

Namensteile vor dem Vornamen, z.B. akademischer Titel.

Short Präfix

Comments

Präfix, z.B. akademischer Titel od. militärischer Rang

Control 0..*

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support true

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

168. Patient.name:Name.prefix.id

Definition

unique id for the element within a resource (for internal references)

Short xml:id (or equivalent in JSON)

Control 0..1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

170. Patient.name:Name.prefix.extension

Definition

Short Additional content defined by implementations

Comments

Control 0..*

Is Modifier false

Summary false

Alternate Names extensions, user content

This element introduces a set of slices on Patient.name.prefix.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

172. Patient.name:Name.prefix.extension:prefix-qualifier

Slice Name prefix-qualifier

Definition

A set of codes each of which specifies a certain subcategory of the name part in addition to the main name part type.

Short Extension, um das Präfix als akademischen Titel zu qualifizieren

Comments

Hier ist stets der Wert AC anzugeben.
Begründung MS: Erforderlich für die verlustfreie Kommunikation von VSDM-Daten.

Control 0..1
This element is affected by the following invariants: ele-1

Type Extension(EN Qualifier) (Extension Type: code)

Is Modifier false

Must Support true

Summary false

174. 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.

Short Unique id for inter-element referencing

Control 0..1
This element is affected by the following invariants: ele-1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

176. Patient.name:Name.prefix.extension:prefix-qualifier.extension

Definition

An Extension

Short Extension

Control 0..0

Is Modifier false

Summary false

This element introduces a set of slices on Patient.name.prefix.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

178. Patient.name:Name.prefix.extension:prefix-qualifier.url

Definition

Source of the definition for the extension code - a logical name or a URL.

Short identifies the meaning of the extension

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.

Control 1..1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

Fixed Value http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier

180. 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 for a list).

Short Value of extension

Control 1..1
This element is affected by the following invariants: ext-1

Binding The codes SHALL be taken from EntityNamePartQualifier
(required to http://hl7.org/fhir/ValueSet/name-part-qualifier)

[x] Note SeeChoice of Data Typesfor further information about how to use [x]

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary false

Fixed Value AC

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

182. Patient.name:Name.prefix.value

Definition

The actual value

Short Primitive value for string

Control 0..1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

Max Length: 1048576

184. Patient.name:Name.suffix

Definition

Namensteile nach dem Nachnamen

Short Namensteile nach dem Nachnamen

Control 0..*

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

186. Patient.name:Name.period

Definition

Indicates the period of time when this name was valid for the named person.

Short Time period when name was/is in use

Control 0..1

Is Modifier false

Summary true

Requirements

Allows names to be placed in historical context.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

188. Patient.name:Geburtsname

Slice Name Geburtsname

Definition

A name associated with the individual.

Short Geburtsname

Comments

Familienname zum Zeitpunkt der Geburt, sofern abweichend vom offiziellen Namen.

Control 0..1

Type HumanName(HumanName, deutsches Basisprofil)

Is Modifier false

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.

Pattern Value { "use" : "maiden" }

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

190. 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.

Short Unique id for inter-element referencing

Control 0..1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

192. Patient.name:Geburtsname.extension

Definition

Short Additional content defined by implementations

Comments

Control 0..*

Is Modifier false

Summary false

Alternate Names extensions, user content

This element introduces a set of slices on Patient.name.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

194. Patient.name:Geburtsname.use

Definition

Identifies the purpose for this name.

Short Verwendungszweck

Comments

Hier ist stets der Wert maiden anzugeben.
Begründung Pflichtfeld: Dient als Unterscheidungs- und Auswahlkriterium

Control 1..1

The codes SHALL be taken from NameUse
(required to http://hl7.org/fhir/ValueSet/name-use|4.0.1)

The use of a human name.

Is Modifier true because This is labeled as "Is Modifier" because applications should not mistake a temporary or old name etc.for a current/permanent one

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support true

Summary true

Requirements

Allows the appropriate name for a particular context of use to be selected from among a set of names.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

196. 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.

Short Text representation of the full name

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.

Control 0..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Requirements

A renderable, unencoded form.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

198. Patient.name:Geburtsname.family

Definition

Der vollständige Familienname, einschließlich aller Vorsatz- und Zusatzwörter, mit Leerzeichen getrennt.

Short Nachname

Comments

Vollständiger Nachname bzw. Familienname des Patienten, einschließlich Vor- und Zusätze.
Begründung Pflichtfeld: Ist der Nachname zum Zeitpunkt der Geburt nicht bekannt, sollte der gesamte Slice weggelassen werden.

Control 1..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support true

Summary true

Alternate Names surname

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

200. Patient.name:Geburtsname.family.id

Definition

unique id for the element within a resource (for internal references)

Short xml:id (or equivalent in JSON)

Control 0..1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

202. Patient.name:Geburtsname.family.extension

Definition

Short Additional content defined by implementations

Comments

Control 0..*

Is Modifier false

Summary false

Alternate Names extensions, user content

This element introduces a set of slices on Patient.name.family.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

204. Patient.name:Geburtsname.family.extension:namenszusatz

Slice Name namenszusatz

Definition

Namenszusatz als Bestandteil das Nachnamens, wie in VSDM (Versichertenstammdatenmanagement, "eGK") definiert. Beispiele: Gräfin, Prinz oder Fürst

Short Namenszusatz

Comments

Enthält ehem. Adelstitel wie z.B. 'Graf', 'Baronesse', 'Freiherr'...
Begründung MS: Erforderlich für die verlustfreie Kommunikation von VSDM-Daten.

Control 0..1
This element is affected by the following invariants: ele-1

Type Extension(Extension zur Erfassung der VSDM Namensbestandteile) (Extension Type: string)

Is Modifier false

Must Support true

Summary false

206. Patient.name:Geburtsname.family.extension:nachname

Slice Name nachname

Definition

The portion of the family name that is derived from the person's own surname, as distinguished from any portion that is derived from the surname of the person's partner or spouse.

Short Nachname

Comments

Nachname ohne Vor- und Zusätze.
Begründung MS: Erforderlich für die verlustfreie Kommunikation von VSDM-Daten.

Control 0..1
This element is affected by the following invariants: ele-1

Type Extension(Own Name) (Extension Type: string)

Is Modifier false

Must Support true

Summary false

208. Patient.name:Geburtsname.family.extension:vorsatzwort

Slice Name vorsatzwort

Definition

Short Voorvoegsel derived from person's own surname

Comments

Enthält Vorsätze, die vor dem Nachnamen stehen, z.B. 'von', 'van', 'zu'...
Begründung MS: Erforderlich für die verlustfreie Kommunikation von VSDM-Daten.

Control 0..1
This element is affected by the following invariants: ele-1

Type Extension(Own Prefix) (Extension Type: string)

Is Modifier false

Must Support true

Summary false

210. Patient.name:Geburtsname.family.value

Definition

The actual value

Short Primitive value for string

Control 0..1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

Max Length: 1048576

212. Patient.name:Geburtsname.given

Definition

Vorname der Person

Short Vorname

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.

Control 0..0

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Alternate Names first name, middle name

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

214. Patient.name:Geburtsname.prefix

Definition

Namensteile vor dem Vornamen, z.B. akademischer Titel.

Short Namensteile vor dem Vornamen

Control 0..0

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

220. Patient.name:Geburtsname.suffix

Definition

Namensteile nach dem Nachnamen

Short Namensteile nach dem Nachnamen

Control 0..*

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

222. Patient.name:Geburtsname.period

Definition

Indicates the period of time when this name was valid for the named person.

Short Time period when name was/is in use

Control 0..1

Is Modifier false

Summary true

Requirements

Allows names to be placed in historical context.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

224. Patient.telecom

Definition

A contact detail (e.g. a telephone number or an email address) by which the individual may be contacted.

Short Angabe der Kontaktdaten

Comments

Angabe der Kontaktdaten des Patienten, z.B. Telefonnummer oder E-Mail-Adresse. Bedingtes MS: Kontaktdaten sind im Kontext der Terminplanung unerlässlich, z.B. für Terminvereinbarungen oder Rückfragen. Das Must-Support gilt ausschließlich für Systeme, die Kontaktdaten persistieren.

Control 0..*

ContactPoint

Is Modifier false

Must Support true

Summary true

Requirements

People have (primary) ways to contact them in some way such as phone, email.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

226. Patient.telecom.id

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Short Unique id for inter-element referencing

Control 0..1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

228. Patient.telecom.extension

Definition

Short Additional content defined by implementations

Comments

Control 0..*

Is Modifier false

Summary false

Alternate Names extensions, user content

This element introduces a set of slices on Patient.telecom.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

230. Patient.telecom.system

Definition

Telecommunications form for contact point - what communications system is required to make use of the contact.

Short Art der Kontaktdaten

Comments

Hier ist der Art der Kontaktdaten anzugeben, z.B. phone für Telefonnummer oder email für E-Mail-Adresse.
Begründung Pflichtfeld: Dient der Unterscheidung verschiedener Kontaktarten

Control 1..1
This element is affected by the following invariants: cpt-2

The codes SHALL be taken from ContactPointSystem
(required to http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1)

Telecommunications form for contact point.

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support true

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

232. Patient.telecom.value

Definition

The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).

Short Wert der Kontaktdaten

Comments

Enthält den eigentlichen Wert der Kontaktdaten, z.B. die Telefonnummer oder E-Mail-Adresse.
Begründung Pflichtfeld: Ohne diese Angabe sind die Kontaktdaten nicht nutzbar.

Control 1..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support true

Summary true

Requirements

Need to support legacy numbers that are not in a tightly controlled format.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

234. Patient.telecom.use

Definition

Identifies the purpose for the contact point.

Short home | work | temp | old | mobile - purpose of this contact point

Comments

Applications can assume that a contact is current unless it explicitly says that it is temporary or old.

Control 0..1

The codes SHALL be taken from ContactPointUse
(required to http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1)

Use of contact point.

Is Modifier true because This is labeled as "Is Modifier" because applications should not mistake a temporary or old contact etc.for a current/permanent one

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Requirements

Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

236. Patient.telecom.rank

Definition

Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values.

Short Specify preferred order of use (1 = highest)

Comments

Note that rank does not necessarily follow the order in which the contacts are represented in the instance.

Control 0..1

positiveInt

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

238. Patient.telecom.period

Definition

Time period when the contact point was/is in use.

Short Time period when the contact point was/is in use

Control 0..1

Is Modifier false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

240. Patient.gender

Definition

Administrative Gender - the gender that the patient is considered to have for administration and record keeping purposes.

Short Administratives Geschlecht

Comments

Für die Geschlechtskennzeichen 'unbestimmt' und 'divers' ist der international vereinbarte code other zu verwenden. Zur weiteren Differenzierung kann dann die Extension Geschlecht-Admnistrativ verwendet werden. Begründung Pflichtfeld: Die Geschlechtsangabe ist für viele Versorgungsprozesse unerlässlich, z.B.

Bettendisposition
Ermittlung von Referenzwerten
korrekte Anrede des Patienten
Weitere Hinweise: siehe Deutsche Basisprofile

Control 1..1

The codes SHALL be taken from AdministrativeGender
(required to http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1)

The gender of a person used for administrative purposes.

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support true

Summary true

Requirements

Needed for identification of the individual, in combination with (at least) name and birth date.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

242. Patient.gender.id

Definition

unique id for the element within a resource (for internal references)

Short xml:id (or equivalent in JSON)

Control 0..1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

244. Patient.gender.extension

Definition

An Extension

Short Extension

Control 0..*

Is Modifier false

Summary false

This element introduces a set of slices on Patient.gender.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

246. Patient.gender.extension:Geschlecht-Administrativ

Slice Name Geschlecht-Administrativ

Definition

Optional Extension Element - found in all resources.

Short Extension zur Differenzierung des Geschlechtskennzeichens

Comments

Diese Extension darf nur in Verbindung mit dem Geschlechtskennzeichen other verwendet werden und dient der Differenzierung zwischen den in Deutschland möglichen Geschlechtskennzeichen D (divers) und X(unbestimmt)

Control 0..1
This element is affected by the following invariants: ele-1

Type Extension(Differenzierung des administrativen Geschlechts 'other') (Extension Type: Coding)

Is Modifier false

Must Support true

Summary false

248. Patient.gender.value

Definition

Primitive value for code

Short Primitive value for code

Control 0..1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

250. Patient.birthDate

Definition

The date of birth for the individual.

Short Geburtsdatum

Comments

Tages-, monats- oder jahresgenaues Geburtsdatum.
Begründung Pflichtfeld: Das Geburstdatum dient - in Verbindung mit dem Namen - als wichtiges Such- und Unterscheidungskriterium.
Weitere Hinweise: siehe Deutsche Basisprofile

Control 1..1

date

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support true

Summary true

Requirements

Age of the individual drives many clinical processes.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

LOINC Code 21112-8

252. Patient.birthDate.id

Definition

unique id for the element within a resource (for internal references)

Short xml:id (or equivalent in JSON)

Control 0..1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

254. Patient.birthDate.extension

Definition

An Extension

Short Extension

Control 0..*

Is Modifier false

Summary false

This element introduces a set of slices on Patient.birthDate.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

256. Patient.birthDate.extension:Data-Absent-Reason

Slice Name Data-Absent-Reason

Definition

Provides a reason why the expected value or elements in the element that is extended are missing.

Short Begründung für fehlende Information

Comments

ToDo

Control 0..1

Type Extension(Data Absent Reason) (Extension Type: code)

Is Modifier false

Must Support true

Summary false

258. Patient.birthDate.extension:Data-Absent-Reason.id

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Short Unique id for inter-element referencing

Control 0..1
This element is affected by the following invariants: ele-1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

260. Patient.birthDate.extension:Data-Absent-Reason.extension

Definition

An Extension

Short Extension

Control 0..0

Is Modifier false

Summary false

This element introduces a set of slices on Patient.birthDate.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

262. Patient.birthDate.extension:Data-Absent-Reason.url

Definition

Source of the definition for the extension code - a logical name or a URL.

Short identifies the meaning of the extension

Comments

Control 1..1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

Fixed Value http://hl7.org/fhir/StructureDefinition/data-absent-reason

264. Patient.birthDate.extension:Data-Absent-Reason.value[x]

Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Short Value of extension

Control 1..1
This element is affected by the following invariants: ext-1

Binding The codes SHALL be taken from DataAbsentReason
(required to http://hl7.org/fhir/ValueSet/data-absent-reason)

[x] Note SeeChoice of Data Typesfor further information about how to use [x]

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support true

Summary false

Fixed Value unknown

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

266. Patient.birthDate.value

Definition

The actual value

Short Primitive value for date

Control 0..1

date

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

268. Patient.deceased[x]

Definition

Indicates if the individual is deceased or not.

Short Indicates if the individual is deceased or not

Comments

Einschränkung der übergreifenden MS-Definition: Die Implementierung dieses Elements ist für Server optional. Die Kennzeichnung als Must-Support erfolgt, da es sich um ein als Modifier-Element markiertes Feld in der Kernspezifikation handelt.

**WICHTIGER Hinweis für Implementierer:**

Alle server-seitigen Implementierungen SOLLEN in der Lage sein, die systemintern möglichen Statuswerte korrekt in FHIR abzubilden.
Alle client-seitigen Implementierungen SOLLEN in der Lage sein, sämtliche Status-Codes zu interpretieren und dem Anwender in angemessener Form darstellen zu können.

Control 0..1

Type Choice of: boolean, dateTime

[x] Note SeeChoice of Data Typesfor further information about how to use [x]

Is Modifier true because This element is labeled as a modifier because once a patient is marked as deceased, the actions that are appropriate to perform on the patient may be significantly different.

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support true

Must Support Types No must-support rules about the choice of types/profiles

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.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

270. Patient.address

Definition

An address for the individual.

Short An address for the individual

Comments

Angabe der Adressen

Control 0..*

Address

Is Modifier false

Must Support true

Summary true

Requirements

May need to keep track of patient addresses for contacting, billing or reporting requirements and also to help with identification.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

This element introduces a set of slices on Patient.address. The slices areUnordered and Open, and can be differentiated using the following discriminators:

pattern @ $this

272. Patient.address:Strassenanschrift

Slice Name Strassenanschrift

Definition

An address for the individual.

Short Straßenanschrift

Comments

Wohn- oder Aufenthaltsort des Patienten

Control 0..*

Type Address(Adresse, deutsches Basisprofil)

Is Modifier false

Must Support true

Summary true

Requirements

May need to keep track of patient addresses for contacting, billing or reporting requirements and also to help with identification.

Pattern Value { "type" : "both" }

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
address-cnt-2or3-char: 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')))

274. Patient.address:Strassenanschrift.id

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Short Unique id for inter-element referencing

Control 0..1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

276. Patient.address:Strassenanschrift.extension

Definition

Short Additional content defined by implementations

Comments

Control 0..*

Is Modifier false

Summary false

Alternate Names extensions, user content

This element introduces a set of slices on Patient.address.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

278. Patient.address:Strassenanschrift.extension:Stadtteil

Slice Name Stadtteil

Definition

A subsection of a municipality.

Short precinct

Control 0..1
This element is affected by the following invariants: ele-1

Type Extension(ADXP Precinct) (Extension Type: string)

Is Modifier false

Must Support true

Summary false

280. Patient.address:Strassenanschrift.use

Definition

The purpose of this address.

Short home | work | temp | old | billing - purpose of this address

Comments

Applications can assume that an address is current unless it explicitly says that it is temporary or old.

Control 0..1

The codes SHALL be taken from AddressUse
(required to http://hl7.org/fhir/ValueSet/address-use|4.0.1)

The use of an address.

Is Modifier true because This is labeled as "Is Modifier" because applications should not mistake a temporary or old address etc.for a current/permanent one

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Requirements

Allows an appropriate address to be chosen from a list of many.

Example General: home

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

282. Patient.address:Strassenanschrift.type

Definition

Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both.

Short Adresstyp

Comments

Hier ist stets der Wert both anzugeben.
Begründung Pflichtfeld: Dient als Unterscheidungs- und Auswahlkriterium

Control 1..1

The codes SHALL be taken from AddressType
(required to http://hl7.org/fhir/ValueSet/address-type|4.0.1)

The type of an address (physical / postal).

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support true

Summary true

Example General: both

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

284. Patient.address:Strassenanschrift.text

Definition

Specifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts.

Short Text representation of the address

Comments

Can provide both a text representation and parts. Applications updating an address SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part.

Control 0..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Requirements

A renderable, unencoded form.

Example General: 137 Nowhere Street, Erewhon 9132

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

286. Patient.address:Strassenanschrift.line

Definition

Diese Komponente kann Straßennamen, Hausnummer, Appartmentnummer, Postfach, c/o sowie weitere Zustellungshinweise enthalten. Die Informationen können in mehrere line-Komponenten aufgeteilt werden. Bei Verwendung der Extensions, um Straße, Hausnnummer und Postleitzahl strukturiert zu übermitteln, müssen diese Informationen stets vollständig auch in der line-Komponente, die sie erweitern, enthalten sein, um es Systemen, die diese Extensions nicht verwenden zu ermöglichen, auf diese Informationen zugreifen zu können.

Short Adresszeile

Comments

Diese Komponente kann Straßennamen, Hausnummer, Appartmentnummer, 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.
Begründung Pflichtfeld: Ohne diese Angabe ist die Adresse nicht zustellbar.
Begründung für Reduktion der max. Kardinalität: Die maximale Kardinalität wurde in Übereinstimmung mit der DIN-Norm 5008 (Schreib- und Gestaltungsregeln für die Text- und Informationsverarbeitung) auf 3 beschränkt.

Control 1..3

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support true

Summary true

Example General: 137 Nowhere Street
Beipiel für Adresszeile mit Extensions für Straße und Hausnummer: Musterweg 42

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

288. Patient.address:Strassenanschrift.line.id

Definition

unique id for the element within a resource (for internal references)

Short xml:id (or equivalent in JSON)

Control 0..1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

290. Patient.address:Strassenanschrift.line.extension

Definition

Short Additional content defined by implementations

Comments

Control 0..*

Is Modifier false

Summary false

Alternate Names extensions, user content

This element introduces a set of slices on Patient.address.line.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

292. Patient.address:Strassenanschrift.line.extension:Strasse

Slice Name Strasse

Definition

streetName.

Short Strassenname

Comments

Strassenname (ohne Hausnummer). Bei Angabe einer Strasse in dieser Extension muss diese auch in Address.line angegeben werden, um die Interoperabilität mit Systemen zu gewährleisten, die diese Extension nicht verwenden.
Begründung MS: Erforderlich für die verlustfreie Kommunikation von VSDM-Daten.

Control 0..1
This element is affected by the following invariants: ele-1

Type Extension(ADXP Street Name) (Extension Type: string)

Is Modifier false

Must Support true

Summary false

294. Patient.address:Strassenanschrift.line.extension:Hausnummer

Slice Name Hausnummer

Definition

The number of a building, house or lot alongside the street. Also known as "primary street number". This does not number the street but rather the building.

Short houseNumber

Comments

Hausnummer, sowie Zusätze (Appartmentnummer, Etage...). Bei Angabe einer Hausnummer in dieser Extension muss diese auch in Address.line angegeben werden, um die Interoperabilität mit Systemen zu gewährleisten, die diese Extension nicht verwenden.
Begründung MS: Erforderlich für die verlustfreie Kommunikation von VSDM-Daten.

Control 0..1
This element is affected by the following invariants: ele-1

Type Extension(ADXP House Number) (Extension Type: string)

Is Modifier false

Must Support true

Summary false

296. Patient.address:Strassenanschrift.line.extension:Adresszusatz

Slice Name Adresszusatz

Definition

This can be a unit designator, such as apartment number, suite number, or floor. There may be several unit designators in an address (e.g., "3rd floor, Appt. 342"). This can also be a designator pointing away from the location, rather than specifying a smaller location within some larger one (e.g., Dutch "t.o." means "opposite to" for house boats located across the street facing houses).

Short additionalLocator

Comments

Zusätzliche Informationen, wie z.B. '3. Etage', 'Appartment C'. Bei Angabe einer Zusatzinformation in dieser Extension muss diese auch in Address.line angegeben werden, um die Interoperabilität mit Systemen zu gewährleisten, die diese Extension nicht verwenden.
Begründung MS: Erforderlich für die verlustfreie Kommunikation von VSDM-Daten.

Control 0..1
This element is affected by the following invariants: ele-1

Type Extension(ADXP Additional Locator) (Extension Type: string)

Is Modifier false

Must Support true

Summary false

298. Patient.address:Strassenanschrift.line.extension:Postfach

Slice Name Postfach

Definition

A numbered box located in a post station.

Short Postfachnummer

Comments

Postfach-Adresse. Bei Angabe eines Postfaches in dieser Extension muss das Postfach auch in Address.line angegeben werden, um die Interoperabilität mit Systemen zu gewährleisten, die diese Extension nicht verwenden. Eine Postfach-Adresse darf nicht in Verbindung mit Address.type physical oder both verwendet werden.
Begründung MS: Erforderlich für die verlustfreie Kommunikation von VSDM-Daten.

Control 0..0
This element is affected by the following invariants: ele-1

Type Extension(ADXP Post Box) (Extension Type: string)

Is Modifier false

Summary false

300. Patient.address:Strassenanschrift.line.value

Definition

The actual value

Short Primitive value for string

Control 0..1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

Max Length: 1048576

302. Patient.address:Strassenanschrift.city

Definition

The name of the city, town, suburb, village or other community or delivery center.

Short Stadt

Comments

Begründung Pflichtfeld: Ohne diese Angabe ist die Adresse nicht zustellbar.

Control 1..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support true

Summary true

Alternate Names Municpality

Example General: Erewhon

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

304. Patient.address:Strassenanschrift.district

Definition

The name of the administrative area (county).

Short District name (aka county)

Comments

District is sometimes known as county, but in some regions 'county' is used in place of city (municipality), so county name should be conveyed in city instead.

Control 0..0

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Alternate Names County

Example General: Madison

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

306. Patient.address:Strassenanschrift.state

Definition

Name (oder Kürzel) des Bundeslandes.

Short Bundesland

Control 0..1

Binding The codes SHOULD be taken from ISO-3166-2:de-Laendercodes
(preferred to http://fhir.de/ValueSet/iso/bundeslaender)

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Alternate Names Province, Territory

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

308. Patient.address:Strassenanschrift.postalCode

Definition

Postleitzahl gemäß der im jeweiligen Land gültigen Konventionen

Short Postleitzahl

Comments

Begründung Pflichtfeld: Ohne diese Angabe ist die Adresse nicht zustellbar.

Control 1..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support true

Summary true

Alternate Names Zip

Example General: 9132

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

310. Patient.address:Strassenanschrift.country

Definition

Staat (vorzugsweise als 2-Stelliger ISO-Ländercode). Es obliegt abgeleiteten Profilen, hier die Verwendung der ISO-Ländercodes verbindlich vorzuschreiben

Short Land

Comments

Begründung Pflichtfeld: Ohne diese Angabe ist die Adresse nicht zustellbar.

Control 1..1

Binding The codes SHOULD be taken from Iso3166-1-2
(preferred to http://hl7.org/fhir/ValueSet/iso3166-1-2)

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support true

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

312. Patient.address:Strassenanschrift.period

Definition

Time period when address was/is in use.

Short Time period when address was/is in use

Control 0..1

Is Modifier false

Summary true

Requirements

Allows addresses to be placed in historical context.

Example General: { "start" : "2010-03-23", "end" : "2010-07-01" }

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

314. Patient.address:Postfach

Slice Name Postfach

Definition

An address for the individual.

Short Postfachadresse

Comments

Adresse, die nur für postalische Zustellung genutzt werden kann.

Control 0..*

Type Address(Adresse, deutsches Basisprofil)

Is Modifier false

Must Support true

Summary true

Requirements

May need to keep track of patient addresses for contacting, billing or reporting requirements and also to help with identification.

Pattern Value { "type" : "postal" }

316. Patient.address:Postfach.id

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Short Unique id for inter-element referencing

Control 0..1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

318. Patient.address:Postfach.extension

Definition

Short Additional content defined by implementations

Comments

Control 0..*

Is Modifier false

Summary false

Alternate Names extensions, user content

This element introduces a set of slices on Patient.address.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

320. Patient.address:Postfach.extension:Stadtteil

Slice Name Stadtteil

Definition

A subsection of a municipality.

Short Stadt- oder Ortsteil

Comments

Control 0..1
This element is affected by the following invariants: ele-1

Type Extension(ADXP Precinct) (Extension Type: string)

Is Modifier false

Summary false

Alternate Names extensions, user content

322. Patient.address:Postfach.use

Definition

The purpose of this address.

Short home | work | temp | old | billing - purpose of this address

Comments

Applications can assume that an address is current unless it explicitly says that it is temporary or old.

Control 0..1

The codes SHALL be taken from AddressUse
(required to http://hl7.org/fhir/ValueSet/address-use|4.0.1)

The use of an address.

Is Modifier true because This is labeled as "Is Modifier" because applications should not mistake a temporary or old address etc.for a current/permanent one

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Requirements

Allows an appropriate address to be chosen from a list of many.

Example General: home

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

324. Patient.address:Postfach.type

Definition

Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both.

Short Adresstyp

Comments

Hier ist stets der Wert postal anzugeben.
Begründung Pflichtfeld: Dient als Unterscheidungs- und Auswahlkriterium

Control 1..1

The codes SHALL be taken from AddressType
(required to http://hl7.org/fhir/ValueSet/address-type|4.0.1)

The type of an address (physical / postal).

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support true

Summary true

Example General: both

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

326. Patient.address:Postfach.text

Definition

Specifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts.

Short Text representation of the address

Comments

Control 0..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Requirements

A renderable, unencoded form.

Example General: 137 Nowhere Street, Erewhon 9132

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

328. Patient.address:Postfach.line

Definition

Short Adresszeile

Comments

Diese Komponente enthält die Postfachadresse als String der Form 'Postfach: 12345'. Bei Verwendung der Postfach-Extension, um die Postfachnummer 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.
Begründung Pflichtfeld: Ohne diese Angabe ist die Adresse nicht zustellbar.
Begründung für Reduktion der max. Kardinalität: Die maximale Kardinalität wurde in Übereinstimmung mit der DIN-Norm 5008 (Schreib- und Gestaltungsregeln für die Text- und Informationsverarbeitung) auf 3 beschränkt.

Control 1..3

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support true

Summary true

Example General: 137 Nowhere Street
Beipiel für Adresszeile mit Extensions für Straße und Hausnummer: Musterweg 42

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

330. Patient.address:Postfach.line.id

Definition

unique id for the element within a resource (for internal references)

Short xml:id (or equivalent in JSON)

Control 0..1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

332. Patient.address:Postfach.line.extension

Definition

Short Additional content defined by implementations

Comments

Control 0..*

Is Modifier false

Summary false

Alternate Names extensions, user content

This element introduces a set of slices on Patient.address.line.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

334. Patient.address:Postfach.line.extension:Strasse

Slice Name Strasse

Definition

streetName.

Short streetName

Control 0..0
This element is affected by the following invariants: ele-1

Type Extension(ADXP Street Name) (Extension Type: string)

Is Modifier false

Summary false

336. Patient.address:Postfach.line.extension:Hausnummer

Slice Name Hausnummer

Definition

The number of a building, house or lot alongside the street. Also known as "primary street number". This does not number the street but rather the building.

Short houseNumber

Control 0..0
This element is affected by the following invariants: ele-1

Type Extension(ADXP House Number) (Extension Type: string)

Is Modifier false

Summary false

338. Patient.address:Postfach.line.extension:Adresszusatz

Slice Name Adresszusatz

Definition

Short additionalLocator

Control 0..0
This element is affected by the following invariants: ele-1

Type Extension(ADXP Additional Locator) (Extension Type: string)

Is Modifier false

Summary false

340. Patient.address:Postfach.line.extension:Postfach

Slice Name Postfach

Definition

A numbered box located in a post station.

Short Postfachnummer

Comments

Control 0..1
This element is affected by the following invariants: ele-1

Type Extension(ADXP Post Box) (Extension Type: string)

Is Modifier false

Must Support true

Summary false

342. Patient.address:Postfach.line.value

Definition

The actual value

Short Primitive value for string

Control 0..1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

Max Length: 1048576

344. Patient.address:Postfach.city

Definition

The name of the city, town, suburb, village or other community or delivery center.

Short Stadt

Comments

Begründung Pflichtfeld: Ohne diese Angabe ist die Adresse nicht zustellbar.

Control 1..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support true

Summary true

Alternate Names Municpality

Example General: Erewhon

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

346. Patient.address:Postfach.district

Definition

The name of the administrative area (county).

Short District name (aka county)

Comments

District is sometimes known as county, but in some regions 'county' is used in place of city (municipality), so county name should be conveyed in city instead.

Control 0..0

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Alternate Names County

Example General: Madison

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

348. Patient.address:Postfach.state

Definition

Name (oder Kürzel) des Bundeslandes.

Short Bundesland

Control 0..1

Binding The codes SHOULD be taken from ISO-3166-2:de-Laendercodes
(preferred to http://fhir.de/ValueSet/iso/bundeslaender)

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Alternate Names Province, Territory

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

350. Patient.address:Postfach.postalCode

Definition

Postleitzahl gemäß der im jeweiligen Land gültigen Konventionen

Short Postleitzahl

Comments

Begründung Pflichtfeld: Ohne diese Angabe ist die Adresse nicht zustellbar.

Control 1..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support true

Summary true

Alternate Names Zip

Example General: 9132

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

352. Patient.address:Postfach.country

Definition

Staat (vorzugsweise als 2-Stelliger ISO-Ländercode). Es obliegt abgeleiteten Profilen, hier die Verwendung der ISO-Ländercodes verbindlich vorzuschreiben

Short Land

Comments

Begründung Pflichtfeld: Ohne diese Angabe ist die Adresse nicht zustellbar.

Control 1..1

Binding The codes SHOULD be taken from Iso3166-1-2
(preferred to http://hl7.org/fhir/ValueSet/iso3166-1-2)

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support true

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

354. Patient.address:Postfach.period

Definition

Time period when address was/is in use.

Short Time period when address was/is in use

Control 0..1

Is Modifier false

Summary true

Requirements

Allows addresses to be placed in historical context.

Example General: { "start" : "2010-03-23", "end" : "2010-07-01" }

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

356. Patient.maritalStatus

Definition

This field contains a patient's most recent marital (civil) status.

Short Marital (civil) status of a patient

Control 0..1

Unless not suitable, these codes SHALL be taken from Marital Status Codes
(extensible to http://hl7.org/fhir/ValueSet/marital-status|4.0.1)

The domestic partnership status of a person.

Is Modifier false

Summary false

Requirements

Most, if not all systems capture it.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

358. Patient.multipleBirth[x]

Definition

Indicates whether the patient is part of a multiple (boolean) or indicates the actual birth order (integer).

Short Whether patient is part of a multiple birth

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).

Control 0..1

Type Choice of: boolean, integer

[x] Note SeeChoice of Data Typesfor further information about how to use [x]

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary false

Requirements

For disambiguation of multiple-birth children, especially relevant where the care provider doesn't meet the patient, such as labs.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

360. Patient.photo

Definition

Image of the patient.

Short Image of the patient

Comments

Guidelines:

Use id photos, not clinical photos.
Limit dimensions to thumbnail.
Keep byte count low to ease resource updates.

Control 0..*

Attachment

Is Modifier false

Summary false

Requirements

Many EHR systems have the capability to capture an image of the patient. Fits with newer social media usage too.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

362. Patient.contact

Definition

A contact party (e.g. guardian, partner, friend) for the patient.

Short A contact party (e.g. guardian, partner, friend) for 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.

Control 0..*

BackboneElement

Is Modifier false

Summary false

Requirements

Need to track people you can contact about the patient.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
pat-1: SHALL at least contain a contact's details or a reference to an organization (name.exists() or telecom.exists() or address.exists() or organization.exists())

364. 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.

Short Unique id for inter-element referencing

Control 0..1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

366. Patient.contact.extension

Definition

Short Additional content defined by implementations

Comments

Control 0..*

Is Modifier false

Summary false

Alternate Names extensions, user content

368. 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).

Short Extensions that cannot be ignored even if unrecognized

Comments

Control 0..*

Is Modifier true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them

Summary true

Requirements

Alternate Names extensions, user content, modifiers

370. Patient.contact.relationship

Definition

The nature of the relationship between the patient and the contact person.

Short The kind of relationship

Control 0..*

Unless not suitable, these codes SHALL be taken from PatientContactRelationship
(extensible to http://hl7.org/fhir/ValueSet/patient-contactrelationship|4.0.1)

The nature of the relationship between a patient and a contact person for that patient.

Is Modifier false

Summary false

Requirements

Used to determine which contact person is the most relevant to approach, depending on circumstances.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

372. Patient.contact.name

Definition

A name associated with the contact person.

Short A name associated with the contact person

Control 0..1

HumanName

Is Modifier false

Summary false

Requirements

Contact persons need to be identified by name, but it is uncommon to need details about multiple other names for that contact person.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

374. Patient.contact.telecom

Definition

A contact detail for the person, e.g. a telephone number or an email address.

Short A contact detail for the person

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.

Control 0..*

ContactPoint

Is Modifier false

Summary false

Requirements

People have (primary) ways to contact them in some way such as phone, email.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

376. Patient.contact.address

Definition

Address for the contact person.

Short Address for the contact person

Control 0..1

Address

Is Modifier false

Summary false

Requirements

Need to keep track where the contact person can be contacted per postal mail or visited.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

378. Patient.contact.gender

Definition

Administrative Gender - the gender that the contact person is considered to have for administration and record keeping purposes.

Short male | female | other | unknown

Control 0..1

The codes SHALL be taken from AdministrativeGender
(required to http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1)

The gender of a person used for administrative purposes.

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary false

Requirements

Needed to address the person correctly.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

380. Patient.contact.organization

Definition

Organization on behalf of which the contact is acting or for which the contact is working.

Short Organization that is associated with the contact

Control 0..1
This element is affected by the following invariants: pat-1

Type Reference(Organization)

Is Modifier false

Summary false

Requirements

For guardians or business related contacts, the organization is relevant.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

382. Patient.contact.period

Definition

The period during which this contact person or organization is valid to be contacted relating to this patient.

Short The period during which this contact person or organization is valid to be contacted relating to this patient

Control 0..1

Is Modifier false

Summary false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

384. Patient.communication

Definition

A language which may be used to communicate with the patient about his or her health.

Short A language which may be used to communicate with the patient about his or her health

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.

Control 0..*

BackboneElement

Is Modifier false

Summary false

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.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

386. 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.

Short Unique id for inter-element referencing

Control 0..1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

388. Patient.communication.extension

Definition

Short Additional content defined by implementations

Comments

Control 0..*

Is Modifier false

Summary false

Alternate Names extensions, user content

390. Patient.communication.modifierExtension

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Short Extensions that cannot be ignored even if unrecognized

Comments

Control 0..*

Is Modifier true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them

Summary true

Requirements

Alternate Names extensions, user content, modifiers

392. 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.

Short The language which can be used to communicate with the patient about his or her health

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.

Control 1..1

The codes SHOULD be taken from CommonLanguages
(preferred to http://hl7.org/fhir/ValueSet/languages|4.0.1)

A human language.

Additional Bindings

Purpose

Is Modifier false

Summary false

Requirements

Most systems in multilingual countries will want to convey language. Not all systems actually need the regional dialect.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

394. Patient.communication.preferred

Definition

Indicates whether or not the patient prefers this language (over other languages he masters up a certain level).

Short Language preference indicator

Comments

This language is specifically identified for communicating healthcare information.

Control 0..1

boolean

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary false

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.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

396. Patient.generalPractitioner

Definition

Patient's nominated care provider.

Short Patient's nominated primary care provider

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.

Control 0..*

Type Reference(Organization, Practitioner, PractitionerRole)

Is Modifier false

Summary false

Alternate Names careProvider

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

398. Patient.managingOrganization

Definition

Organization that is the custodian of the patient record.

Short Organization that is the custodian of the patient record

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).

Control 0..1

Type Reference(Organization)

Is Modifier false

Summary true

Requirements

Need to know who recognizes this patient record, manages and updates it.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

400. Patient.link

Definition

Link to another patient resource that concerns the same actual patient.

Short Link

Comments

Dieses und untergeordnete Elemente KÖNNEN bei einem erfolgten Patient merge entsprechend der Festlegungen unter {{pagelink:Patient-merge}} befüllt werden. Da das Element der Unterstützung der Patient merge Notification dient, MUSS es im Rahmen des Bestätigungsverfahrens NICHT unterstützt werden (Stand: Stufe 4).

Control 0..*

BackboneElement

Is Modifier true because This element is labeled as a modifier because it might not be the main Patient resource, and the referenced patient should be used instead of this Patient record. This is when the link.type value is 'replaced-by'

Must Support true

Summary true

Requirements

There are multiple use cases:

Duplicate patient records due to the clerical errors associated with the difficulties of identifying humans consistently, and
Distribution of patient information across multiple servers.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

402. 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.

Short Unique id for inter-element referencing

Control 0..1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

404. Patient.link.extension

Definition

Short Additional content defined by implementations

Comments

Control 0..*

Is Modifier false

Summary false

Alternate Names extensions, user content

406. Patient.link.modifierExtension

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Short Extensions that cannot be ignored even if unrecognized

Comments

Control 0..*

Is Modifier true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them

Summary true

Requirements

Alternate Names extensions, user content, modifiers

408. Patient.link.other

Definition

The other patient resource that the link refers to.

Short The other patient or related person resource that the link refers to

Comments

Referencing a RelatedPerson here removes the need to use a Person record to associate a Patient and RelatedPerson as the same individual.

Control 1..1

Type Reference(Patient, RelatedPerson)

Is Modifier false

Must Support true

Must Support Types No must-support rules about the choice of types/profiles

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

410. Patient.link.other.id

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Short Unique id for inter-element referencing

Control 0..1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

412. Patient.link.other.extension

Definition

Short Additional content defined by implementations

Comments

Control 0..*

Is Modifier false

Summary false

Alternate Names extensions, user content

This element introduces a set of slices on Patient.link.other.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

414. Patient.link.other.reference

Definition

Short Literal reference, Relative, internal or absolute URL

Comments

Control 0..1
This element is affected by the following invariants: ref-1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

416. Patient.link.other.type

Definition

The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

Short Type the reference refers to (e.g. "Patient")

Comments

Control 0..1

Unless not suitable, these codes SHALL be taken from ResourceType
(extensible to http://hl7.org/fhir/ValueSet/resource-types|4.0.1)

Aa resource (or, for logical models, the URI of the logical model).

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

418. Patient.link.other.identifier

Definition

An 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.

Short Logical reference, when literal reference is not known

Comments

Logischer Verweis auf Identifier[Patientennummer]

Note This is a business identifier, not a resource identifier (see discussion)

Control 0..1

Identifier

Is Modifier false

Must Support true

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

420. Patient.link.other.display

Definition

Plain text narrative that identifies the resource in addition to the resource reference.

Short Text alternative for the resource

Comments

This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

Control 0..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

422. Patient.link.type

Definition

The type of link between this patient resource and another patient resource.

Short replaced-by | replaces | refer | seealso

Control 1..1

The codes SHALL be taken from LinkType
(required to http://hl7.org/fhir/ValueSet/link-type|4.0.1)

The type of link between this patient resource and another patient resource.