Implementation Guide
ePA Basisfunktionalitäten
Version 1.3.1 - release

Resource Profile: EPA Patient

Official URL: https://gematik.de/fhir/epa/StructureDefinition/epa-patient Version: 1.3.0
Active as of 2025-12-15 Computable Name: EPAPatient

Copyright/Legal: gematik GmbH / Dieses Artefakt ist lizenziert unter Apache License, Version 2.0.

Das Patient-Profil für die ePA

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient C 0..* TIPatient Information about an individual or animal receiving health care services
Constraints: dom-2, dom-3, dom-4, dom-5, dom-6, pat-de-1
... id SΣ 0..1 id Logical id of this artifact
... meta SΣ 0..1 Meta Metadata about the resource
.... versionId SΣ 0..1 id Version specific identifier
.... lastUpdated SΣ 0..1 instant When the resource version last changed
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for identifier SΣ 1..* Identifier An identifier for this patient
Slice: Unordered, Open by pattern:$this
.... identifier:KVNR SΣ 1..1 IdentifierKvid10 An identifier intended for computation

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... use 0..1 code usual | official | temp | secondary | old (If known)
..... type 0..1 CodeableConcept Description of identifier
..... system 1..1 uri The namespace for the identifier value
Fixed Value: http://fhir.de/sid/gkv/kvid-10
..... value 0..1 string The value that is unique
..... period 0..1 Period Time period when id is/was valid for use
..... assigner 0..1 Reference(Organization) Organization that issued id (may be just text)
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type ΣC 0..1 CodeableConcept Description of identifier
Binding: Identifier Type DeBasis ValueSet (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Constraints: kvid-2
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://fhir.de/CodeSystem/identifier-type-de-basis
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: KVZ10
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... system SΣ 1..1 uri The namespace for the identifier value
Fixed Value: http://fhir.de/sid/gkv/kvid-10
..... value SΣC 1..1 string The value that is unique
Constraints: kvid-1
Example General: 123456
... Slices for name SΣ 1..* HumanName A name associated with the patient
Slice: Unordered, Open by value:$this
.... name:Name SΣC 1..1 HumannameDeBasis Personenname
Constraints: hum-1, hum-2, hum-3, hum-4

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... use 1..1 code usual | official | temp | nickname | anonymous | old | maiden
Fixed Value: official
..... text 0..1 string Text representation of the full name
..... family 0..1 string Family name (often called 'Surname')
..... given 0..* string Given names (not always 'first'). Includes middle names
..... prefix 0..* string Parts that come before the name
..... suffix 0..* string Parts that come after the name
..... period 0..1 Period Time period when name was/is in use
..... use ?!SΣ 1..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
..... family SΣ 1..1 string Familienname
...... Slices for extension Content/Rules for all slices
....... extension:namenszusatz SN 0..1 string Namenszusatz gemäß VSDM (Versichertenstammdatenmanagement, "eGK")
URL: http://fhir.de/StructureDefinition/humanname-namenszusatz
....... extension:nachname S 0..1 string Nachname ohne Vor- und Zusätze
URL: http://hl7.org/fhir/StructureDefinition/humanname-own-name
....... extension:vorsatzwort S 0..1 string Vorsatzwort
URL: http://hl7.org/fhir/StructureDefinition/humanname-own-prefix
..... given SΣ 1..* string Vorname
This repeating element order: Given Names appear in the correct order for presenting the name
..... prefix SΣ 0..* string Namensteile vor dem Vornamen
This repeating element order: Prefixes appear in the correct order for presenting the name
...... Slices for extension Content/Rules for all slices
....... extension:prefix-qualifier S 0..1 (Complex) LS | AC | NB | PR | HON | BR | AD | SP | MID | CL | IN | VV
URL: http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier
........ extension 0..0 Additional content defined by implementations
Slice: Unordered, Open by value:url
........ url S 1..1 uri "http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier"
........ value[x] S 1..1 code Value of extension
Binding: EntityNamePartQualifier (required): A set of codes each of which specifies a certain subcategory of the name part in addition to the main name part type.
Fixed Value: AC
.... name:Geburtsname SΣC 0..1 HumannameDeBasis Personenname
Constraints: hum-1, hum-2, hum-3, hum-4

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... use 1..1 code usual | official | temp | nickname | anonymous | old | maiden
Fixed Value: maiden
..... text 0..1 string Text representation of the full name
..... family 0..1 string Family name (often called 'Surname')
..... given 0..* string Given names (not always 'first'). Includes middle names
..... prefix 0..* string Parts that come before the name
..... suffix 0..* string Parts that come after the name
..... period 0..1 Period Time period when name was/is in use
..... use ?!SΣ 1..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
..... family SΣ 1..1 string Familienname
...... Slices for extension Content/Rules for all slices
....... extension:namenszusatz S 0..1 (Complex) Namenszusatz gemäß VSDM (Versichertenstammdatenmanagement, "eGK")
URL: http://fhir.de/StructureDefinition/humanname-namenszusatz
........ extension 0..0 Additional content defined by implementations
Slice: Unordered, Open by value:url
........ url S 1..1 uri "http://fhir.de/StructureDefinition/humanname-namenszusatz"
........ value[x] S 0..1 string Namenszusatz
....... extension:nachname S 0..1 (Complex) Portion derived from person's own surname
URL: http://hl7.org/fhir/StructureDefinition/humanname-own-name
........ extension 0..0 Additional content defined by implementations
Slice: Unordered, Open by value:url
........ url S 1..1 uri "http://hl7.org/fhir/StructureDefinition/humanname-own-name"
........ value[x] S 1..1 string Value of extension
....... extension:vorsatzwort S 0..1 (Complex) Voorvoegsel derived from person's own surname
URL: http://hl7.org/fhir/StructureDefinition/humanname-own-prefix
........ extension 0..0 Additional content defined by implementations
Slice: Unordered, Open by value:url
........ url S 1..1 uri "http://hl7.org/fhir/StructureDefinition/humanname-own-prefix"
........ value[x] S 1..1 string Value of extension
... gender SΣ 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
.... Slices for extension Content/Rules for all slices
..... extension:other-amtlich 0..1 (Complex) Optional Extensions Element
URL: http://fhir.de/StructureDefinition/gender-amtlich-de
...... extension 0..0 Additional content defined by implementations
Slice: Unordered, Open by value:url
...... url S 1..1 uri "http://fhir.de/StructureDefinition/gender-amtlich-de"
...... value[x] SC 1..1 Coding Value of extension
Binding: GenderOtherDE ValueSet (required)
Constraints: gender-amtlich-1
....... system SΣ 0..1 uri Identity of the terminology system
....... version SΣ 0..1 string Version of the system - if relevant
....... code SΣ 0..1 code Symbol in syntax defined by the system
....... display SΣ 0..1 string Representation defined by the system
... birthDate SΣ 1..1 date Geburtsdatum
... deceased[x] ?!Σ 0..1 Indicates if the individual is deceased or not
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
... link ?!Σ 0..* BackboneElement Link to another patient resource that concerns the same actual person
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... other ΣC 1..1 Reference(Patient | RelatedPerson) The other patient or related person resource that the link refers to
Constraints: ref-1
.... type Σ 1..1 code replaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Patient.identifier:KVNR.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:KVNR.​type Base extensible Identifier Type DeBasis ValueSet 📦1.5.4 de.basisprofil.r4 v1.5
Patient.name:Name.use Base required NameUse 📍4.0.1 FHIR Std.
Patient.name:Name.prefix.​extension:prefix-qualifier.​value[x] Base required EntityNamePartQualifier 📍4.0.1 FHIR Std.
Patient.name:Geburtsname.​use Base required NameUse 📍4.0.1 FHIR Std.
Patient.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
Patient.gender.extension:other-amtlich.​value[x] Base required GenderOtherDE ValueSet 📦1.5.4 de.basisprofil.r4 v1.5
Patient.link.type Base required LinkType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Patient If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Patient If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Patient If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Patient If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Patient A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
gender-amtlich-1 error Patient.gender.extension:other-amtlich.value[x] Die amtliche Differenzierung der Geschlechtsangabe 'other' darf nur gefüllt sein, wenn das Geschlecht 'other' angegeben ist %resource.where(gender='other').exists()
hum-1 error Patient.name:Name, Patient.name:Geburtsname Wenn die Extension 'namenszusatz' verwendet wird, dann muss der vollständige Name im Attribut 'family' angegeben werden family.extension('http://fhir.de/StructureDefinition/humanname-namenszusatz').empty() or family.hasValue()
hum-2 error Patient.name:Name, Patient.name:Geburtsname Wenn die Extension 'nachname' verwendet wird, dann muss der vollständige Name im Attribut 'family' angegeben werden family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-name').empty() or family.hasValue()
hum-3 error Patient.name:Name, Patient.name:Geburtsname Wenn die Extension 'vorsatzwort' verwendet wird, dann muss der vollständige Name im Attribut 'family' angegeben werden family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-prefix').empty() or family.hasValue()
hum-4 error Patient.name:Name, Patient.name:Geburtsname Wenn die Extension 'prefix-qualifier' verwendet wird, dann muss ein Namenspräfix im Attribut 'prefix' angegeben werden prefix.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier').empty() or $this.hasValue())
kvid-1 warning Patient.identifier:KVNR.value Der unveränderliche Teil der KVID muss 10-stellig sein und mit einem Großbuchstaben anfangen matches('^[A-Z][0-9]{9}$')
kvid-2 warning Patient.identifier:KVNR.type 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()
pat-de-1 error Patient Die amtliche Differenzierung der Geschlechtsangabe 'other' darf nur gefüllt sein, wenn das Geschlecht 'other' angegeben ist gender.exists() and gender='other' implies gender.extension('http://fhir.de/StructureDefinition/gender-amtlich-de').exists()
ref-1 error Patient.link.other SHALL have a contained resource if a local reference is provided reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

This structure is derived from TIPatient

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient 0..* TIPatient Information about an individual or animal receiving health care services
... id S 0..1 id Logical id of this artifact
... meta S 0..1 Meta Metadata about the resource
.... versionId S 0..1 id Version specific identifier
.... lastUpdated S 0..1 instant When the resource version last changed
... identifier 1..* Identifier An identifier for this patient
.... identifier:KVNR 1..1 IdentifierKvid10 An identifier intended for computation
..... system S 1..1 uri The namespace for the identifier value
..... value S 1..1 string The value that is unique
... active 0..0 Whether this patient's record is in active use
... Slices for name Content/Rules for all slices
.... name:Name 1..1 HumannameDeBasis Personenname
..... prefix
...... Slices for extension Content/Rules for all slices
....... extension:prefix-qualifier 0..1 ENQualifier(5.2.0) LS | AC | NB | PR | HON | BR | AD | SP | MID | CL | IN | VV
........ url S 1..1 uri identifies the meaning of the extension
........ value[x] S 1..1 code Value of extension
.... name:Geburtsname 0..1 HumannameDeBasis Personenname
..... family
...... Slices for extension Content/Rules for all slices
....... extension:namenszusatz 0..1 HumannameNamenszusatz Namenszusatz gemäß VSDM (Versichertenstammdatenmanagement, "eGK")
........ url S 1..1 uri identifies the meaning of the extension
........ value[x] S 0..1 string Namenszusatz
....... extension:nachname 0..1 OwnName(5.2.0) Portion derived from person's own surname
........ url S 1..1 uri identifies the meaning of the extension
........ value[x] S 1..1 string Value of extension
....... extension:vorsatzwort 0..1 OwnPrefix(5.2.0) Voorvoegsel derived from person's own surname
........ url S 1..1 uri identifies the meaning of the extension
........ value[x] S 1..1 string Value of extension
... gender
.... Slices for extension Content/Rules for all slices
..... extension:other-amtlich 0..1 GenderOtherDE Optional Extensions Element
...... url S 1..1 uri identifies the meaning of the extension
...... value[x] S 1..1 Coding Value of extension
....... system S 0..1 uri Identity of the terminology system
....... version S 0..1 string Version of the system - if relevant
....... code S 0..1 code Symbol in syntax defined by the system
....... display S 0..1 string Representation defined by the system

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient C 0..* TIPatient Information about an individual or animal receiving health care services
Constraints: dom-2, dom-3, dom-4, dom-5, dom-6, pat-de-1
... id SΣ 0..1 id Logical id of this artifact
... meta SΣ 0..1 Meta Metadata about the resource
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId SΣ 0..1 id Version specific identifier
.... lastUpdated SΣ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile Σ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Slice: Unordered, Open by value:url
... Slices for identifier SΣ 1..* Identifier An identifier for this patient
Slice: Unordered, Open by pattern:$this
.... identifier:KVNR SΣ 1..1 IdentifierKvid10 An identifier intended for computation

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... use 0..1 code usual | official | temp | secondary | old (If known)
..... type 0..1 CodeableConcept Description of identifier
..... system 1..1 uri The namespace for the identifier value
Fixed Value: http://fhir.de/sid/gkv/kvid-10
..... value 0..1 string The value that is unique
..... period 0..1 Period Time period when id is/was valid for use
..... assigner 0..1 Reference(Organization) Organization that issued id (may be just text)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type ΣC 0..1 CodeableConcept Description of identifier
Binding: Identifier Type DeBasis ValueSet (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Constraints: kvid-2
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://fhir.de/CodeSystem/identifier-type-de-basis
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: KVZ10
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... system SΣ 1..1 uri The namespace for the identifier value
Fixed Value: http://fhir.de/sid/gkv/kvid-10
..... value SΣC 1..1 string The value that is unique
Constraints: kvid-1
Example General: 123456
..... period ΣC 0..1 Period Time period when id is/was valid for use
Constraints: per-1
..... assigner ΣC 0..1 Reference(Organization) Organization that issued id (may be just text)
Constraints: ref-1
... Slices for name SΣ 1..* HumanName A name associated with the patient
Slice: Unordered, Open by value:$this
.... name:Name SΣC 1..1 HumannameDeBasis Personenname
Constraints: hum-1, hum-2, hum-3, hum-4

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... use 1..1 code usual | official | temp | nickname | anonymous | old | maiden
Fixed Value: official
..... text 0..1 string Text representation of the full name
..... family 0..1 string Family name (often called 'Surname')
..... given 0..* string Given names (not always 'first'). Includes middle names
..... prefix 0..* string Parts that come before the name
..... suffix 0..* string Parts that come after the name
..... period 0..1 Period Time period when name was/is in use
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!SΣ 1..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
..... text Σ 0..1 string Text representation of the full name
..... family SΣ 1..1 string Familienname
...... id 0..1 string Unique id for inter-element referencing
...... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... extension:namenszusatz SN 0..1 string Namenszusatz gemäß VSDM (Versichertenstammdatenmanagement, "eGK")
URL: http://fhir.de/StructureDefinition/humanname-namenszusatz
....... extension:nachname S 0..1 string Nachname ohne Vor- und Zusätze
URL: http://hl7.org/fhir/StructureDefinition/humanname-own-name
....... extension:vorsatzwort S 0..1 string Vorsatzwort
URL: http://hl7.org/fhir/StructureDefinition/humanname-own-prefix
...... value 0..1 string Primitive value for string
Max Length:1048576
..... given SΣ 1..* string Vorname
This repeating element order: Given Names appear in the correct order for presenting the name
..... prefix SΣ 0..* string Namensteile vor dem Vornamen
This repeating element order: Prefixes appear in the correct order for presenting the name
...... id 0..1 string Unique id for inter-element referencing
...... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... extension:prefix-qualifier S 0..1 (Complex) LS | AC | NB | PR | HON | BR | AD | SP | MID | CL | IN | VV
URL: http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..0 Additional content defined by implementations
Slice: Unordered, Open by value:url
........ url S 1..1 uri "http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier"
........ value[x] S 1..1 code Value of extension
Binding: EntityNamePartQualifier (required): A set of codes each of which specifies a certain subcategory of the name part in addition to the main name part type.
Fixed Value: AC
...... value 0..1 string Primitive value for string
Max Length:1048576
..... suffix Σ 0..* string Namensteile nach dem Nachnamen
This repeating element order: Suffixes appear in the correct order for presenting the name
..... period ΣC 0..1 Period Time period when name was/is in use
Constraints: per-1
.... name:Geburtsname SΣC 0..1 HumannameDeBasis Personenname
Constraints: hum-1, hum-2, hum-3, hum-4

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... use 1..1 code usual | official | temp | nickname | anonymous | old | maiden
Fixed Value: maiden
..... text 0..1 string Text representation of the full name
..... family 0..1 string Family name (often called 'Surname')
..... given 0..* string Given names (not always 'first'). Includes middle names
..... prefix 0..* string Parts that come before the name
..... suffix 0..* string Parts that come after the name
..... period 0..1 Period Time period when name was/is in use
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!SΣ 1..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
..... text Σ 0..1 string Text representation of the full name
..... family SΣ 1..1 string Familienname
...... id 0..1 string Unique id for inter-element referencing
...... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... extension:namenszusatz S 0..1 (Complex) Namenszusatz gemäß VSDM (Versichertenstammdatenmanagement, "eGK")
URL: http://fhir.de/StructureDefinition/humanname-namenszusatz
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..0 Additional content defined by implementations
Slice: Unordered, Open by value:url
........ url S 1..1 uri "http://fhir.de/StructureDefinition/humanname-namenszusatz"
........ value[x] S 0..1 string Namenszusatz
....... extension:nachname S 0..1 (Complex) Portion derived from person's own surname
URL: http://hl7.org/fhir/StructureDefinition/humanname-own-name
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..0 Additional content defined by implementations
Slice: Unordered, Open by value:url
........ url S 1..1 uri "http://hl7.org/fhir/StructureDefinition/humanname-own-name"
........ value[x] S 1..1 string Value of extension
....... extension:vorsatzwort S 0..1 (Complex) Voorvoegsel derived from person's own surname
URL: http://hl7.org/fhir/StructureDefinition/humanname-own-prefix
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..0 Additional content defined by implementations
Slice: Unordered, Open by value:url
........ url S 1..1 uri "http://hl7.org/fhir/StructureDefinition/humanname-own-prefix"
........ value[x] S 1..1 string Value of extension
...... value 0..1 string Primitive value for string
Max Length:1048576
..... period ΣC 0..1 Period Time period when name was/is in use
Constraints: per-1
... telecom ΣC 0..* ContactPoint A contact detail for the individual
Constraints: cpt-2
... gender SΣ 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... extension:other-amtlich 0..1 (Complex) Optional Extensions Element
URL: http://fhir.de/StructureDefinition/gender-amtlich-de
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..0 Additional content defined by implementations
Slice: Unordered, Open by value:url
...... url S 1..1 uri "http://fhir.de/StructureDefinition/gender-amtlich-de"
...... value[x] SC 1..1 Coding Value of extension
Binding: GenderOtherDE ValueSet (required)
Constraints: gender-amtlich-1
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... system SΣ 0..1 uri Identity of the terminology system
....... version SΣ 0..1 string Version of the system - if relevant
....... code SΣ 0..1 code Symbol in syntax defined by the system
....... display SΣ 0..1 string Representation defined by the system
....... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... value 0..1 code Primitive value for code
Max Length:1048576
... birthDate SΣ 1..1 date Geburtsdatum
... deceased[x] ?!Σ 0..1 Indicates if the individual is deceased or not
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
... address Σ 0..* Address An address for the individual
... maritalStatus 0..1 CodeableConcept Marital (civil) status of a patient
Binding: Marital Status Codes (extensible): The domestic partnership status of a person.
... multipleBirth[x] 0..1 Whether patient is part of a multiple birth
.... multipleBirthBoolean boolean
.... multipleBirthInteger integer
... photo C 0..* Attachment Image of the patient
Constraints: att-1
... contact C 0..* BackboneElement A contact party (e.g. guardian, partner, friend) for the patient
Constraints: pat-1
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... relationship 0..* CodeableConcept The kind of relationship
Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.
.... name 0..1 HumanName A name associated with the contact person
.... telecom C 0..* ContactPoint A contact detail for the person
Constraints: cpt-2
.... address 0..1 Address Address for the contact person
.... gender 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
.... organization C 0..1 Reference(Organization) Organization that is associated with the contact
Constraints: ref-1
.... period C 0..1 Period The period during which this contact person or organization is valid to be contacted relating to this patient
Constraints: per-1
... communication 0..* BackboneElement A language which may be used to communicate with the patient about his or her health
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... language 1..1 CodeableConcept The language which can be used to communicate with the patient about his or her health
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
.... preferred 0..1 boolean Language preference indicator
... generalPractitioner C 0..* Reference(Organization | Practitioner | PractitionerRole) Patient's nominated primary care provider
Constraints: ref-1
... managingOrganization ΣC 0..1 Reference(Organization) Organization that is the custodian of the patient record
Constraints: ref-1
... link ?!Σ 0..* BackboneElement Link to another patient resource that concerns the same actual person
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... other ΣC 1..1 Reference(Patient | RelatedPerson) The other patient or related person resource that the link refers to
Constraints: ref-1
.... type Σ 1..1 code replaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Patient.meta.security Base extensible SecurityLabels 📍4.0.1 FHIR Std.
Patient.meta.tag Base example Common Tags 📍4.0.1 FHIR Std.
Patient.language Base preferred Common Languages 📦4.0.1 FHIR Std.
Patient.identifier:KVNR.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:KVNR.​type Base extensible Identifier Type DeBasis ValueSet 📦1.5.4 de.basisprofil.r4 v1.5
Patient.name:Name.use Base required NameUse 📍4.0.1 FHIR Std.
Patient.name:Name.prefix.​extension:prefix-qualifier.​value[x] Base required EntityNamePartQualifier 📍4.0.1 FHIR Std.
Patient.name:Geburtsname.​use Base required NameUse 📍4.0.1 FHIR Std.
Patient.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
Patient.gender.extension:other-amtlich.​value[x] Base required GenderOtherDE ValueSet 📦1.5.4 de.basisprofil.r4 v1.5
Patient.maritalStatus Base extensible MaritalStatus 📦4.0.1 FHIR Std.
Patient.contact.relationship Base extensible Patient Contact Relationship 📦4.0.1 FHIR Std.
Patient.contact.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
Patient.communication.​language Base preferred Common Languages 📦4.0.1 FHIR Std.
Patient.link.type Base required LinkType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
att-1 error Patient.photo If the Attachment has data, it SHALL have a contentType data.empty() or contentType.exists()
cpt-2 error Patient.telecom, Patient.contact.telecom A system is required if a value is provided. value.empty() or system.exists()
dom-2 error Patient If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Patient If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Patient If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Patient If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Patient A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
gender-amtlich-1 error Patient.gender.extension:other-amtlich.value[x] Die amtliche Differenzierung der Geschlechtsangabe 'other' darf nur gefüllt sein, wenn das Geschlecht 'other' angegeben ist %resource.where(gender='other').exists()
hum-1 error Patient.name:Name, Patient.name:Geburtsname Wenn die Extension 'namenszusatz' verwendet wird, dann muss der vollständige Name im Attribut 'family' angegeben werden family.extension('http://fhir.de/StructureDefinition/humanname-namenszusatz').empty() or family.hasValue()
hum-2 error Patient.name:Name, Patient.name:Geburtsname Wenn die Extension 'nachname' verwendet wird, dann muss der vollständige Name im Attribut 'family' angegeben werden family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-name').empty() or family.hasValue()
hum-3 error Patient.name:Name, Patient.name:Geburtsname Wenn die Extension 'vorsatzwort' verwendet wird, dann muss der vollständige Name im Attribut 'family' angegeben werden family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-prefix').empty() or family.hasValue()
hum-4 error Patient.name:Name, Patient.name:Geburtsname Wenn die Extension 'prefix-qualifier' verwendet wird, dann muss ein Namenspräfix im Attribut 'prefix' angegeben werden prefix.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier').empty() or $this.hasValue())
kvid-1 warning Patient.identifier:KVNR.value Der unveränderliche Teil der KVID muss 10-stellig sein und mit einem Großbuchstaben anfangen matches('^[A-Z][0-9]{9}$')
kvid-2 warning Patient.identifier:KVNR.type 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()
pat-1 error Patient.contact 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()
pat-de-1 error Patient Die amtliche Differenzierung der Geschlechtsangabe 'other' darf nur gefüllt sein, wenn das Geschlecht 'other' angegeben ist gender.exists() and gender='other' implies gender.extension('http://fhir.de/StructureDefinition/gender-amtlich-de').exists()
per-1 error Patient.identifier:KVNR.period, Patient.name:Name.period, Patient.name:Geburtsname.period, Patient.contact.period If present, start SHALL have a lower value than end start.hasValue().not() or end.hasValue().not() or (start <= end)
ref-1 error Patient.identifier:KVNR.assigner, Patient.contact.organization, Patient.generalPractitioner, Patient.managingOrganization, Patient.link.other SHALL have a contained resource if a local reference is provided reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

This structure is derived from TIPatient

Summary

Mandatory: 2 elements
Must-Support: 20 elements
Prohibited: 1 element

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient C 0..* TIPatient Information about an individual or animal receiving health care services
Constraints: dom-2, dom-3, dom-4, dom-5, dom-6, pat-de-1
... id SΣ 0..1 id Logical id of this artifact
... meta SΣ 0..1 Meta Metadata about the resource
.... versionId SΣ 0..1 id Version specific identifier
.... lastUpdated SΣ 0..1 instant When the resource version last changed
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for identifier SΣ 1..* Identifier An identifier for this patient
Slice: Unordered, Open by pattern:$this
.... identifier:KVNR SΣ 1..1 IdentifierKvid10 An identifier intended for computation

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... use 0..1 code usual | official | temp | secondary | old (If known)
..... type 0..1 CodeableConcept Description of identifier
..... system 1..1 uri The namespace for the identifier value
Fixed Value: http://fhir.de/sid/gkv/kvid-10
..... value 0..1 string The value that is unique
..... period 0..1 Period Time period when id is/was valid for use
..... assigner 0..1 Reference(Organization) Organization that issued id (may be just text)
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type ΣC 0..1 CodeableConcept Description of identifier
Binding: Identifier Type DeBasis ValueSet (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Constraints: kvid-2
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://fhir.de/CodeSystem/identifier-type-de-basis
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: KVZ10
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... system SΣ 1..1 uri The namespace for the identifier value
Fixed Value: http://fhir.de/sid/gkv/kvid-10
..... value SΣC 1..1 string The value that is unique
Constraints: kvid-1
Example General: 123456
... Slices for name SΣ 1..* HumanName A name associated with the patient
Slice: Unordered, Open by value:$this
.... name:Name SΣC 1..1 HumannameDeBasis Personenname
Constraints: hum-1, hum-2, hum-3, hum-4

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... use 1..1 code usual | official | temp | nickname | anonymous | old | maiden
Fixed Value: official
..... text 0..1 string Text representation of the full name
..... family 0..1 string Family name (often called 'Surname')
..... given 0..* string Given names (not always 'first'). Includes middle names
..... prefix 0..* string Parts that come before the name
..... suffix 0..* string Parts that come after the name
..... period 0..1 Period Time period when name was/is in use
..... use ?!SΣ 1..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
..... family SΣ 1..1 string Familienname
...... Slices for extension Content/Rules for all slices
....... extension:namenszusatz SN 0..1 string Namenszusatz gemäß VSDM (Versichertenstammdatenmanagement, "eGK")
URL: http://fhir.de/StructureDefinition/humanname-namenszusatz
....... extension:nachname S 0..1 string Nachname ohne Vor- und Zusätze
URL: http://hl7.org/fhir/StructureDefinition/humanname-own-name
....... extension:vorsatzwort S 0..1 string Vorsatzwort
URL: http://hl7.org/fhir/StructureDefinition/humanname-own-prefix
..... given SΣ 1..* string Vorname
This repeating element order: Given Names appear in the correct order for presenting the name
..... prefix SΣ 0..* string Namensteile vor dem Vornamen
This repeating element order: Prefixes appear in the correct order for presenting the name
...... Slices for extension Content/Rules for all slices
....... extension:prefix-qualifier S 0..1 (Complex) LS | AC | NB | PR | HON | BR | AD | SP | MID | CL | IN | VV
URL: http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier
........ extension 0..0 Additional content defined by implementations
Slice: Unordered, Open by value:url
........ url S 1..1 uri "http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier"
........ value[x] S 1..1 code Value of extension
Binding: EntityNamePartQualifier (required): A set of codes each of which specifies a certain subcategory of the name part in addition to the main name part type.
Fixed Value: AC
.... name:Geburtsname SΣC 0..1 HumannameDeBasis Personenname
Constraints: hum-1, hum-2, hum-3, hum-4

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... use 1..1 code usual | official | temp | nickname | anonymous | old | maiden
Fixed Value: maiden
..... text 0..1 string Text representation of the full name
..... family 0..1 string Family name (often called 'Surname')
..... given 0..* string Given names (not always 'first'). Includes middle names
..... prefix 0..* string Parts that come before the name
..... suffix 0..* string Parts that come after the name
..... period 0..1 Period Time period when name was/is in use
..... use ?!SΣ 1..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
..... family SΣ 1..1 string Familienname
...... Slices for extension Content/Rules for all slices
....... extension:namenszusatz S 0..1 (Complex) Namenszusatz gemäß VSDM (Versichertenstammdatenmanagement, "eGK")
URL: http://fhir.de/StructureDefinition/humanname-namenszusatz
........ extension 0..0 Additional content defined by implementations
Slice: Unordered, Open by value:url
........ url S 1..1 uri "http://fhir.de/StructureDefinition/humanname-namenszusatz"
........ value[x] S 0..1 string Namenszusatz
....... extension:nachname S 0..1 (Complex) Portion derived from person's own surname
URL: http://hl7.org/fhir/StructureDefinition/humanname-own-name
........ extension 0..0 Additional content defined by implementations
Slice: Unordered, Open by value:url
........ url S 1..1 uri "http://hl7.org/fhir/StructureDefinition/humanname-own-name"
........ value[x] S 1..1 string Value of extension
....... extension:vorsatzwort S 0..1 (Complex) Voorvoegsel derived from person's own surname
URL: http://hl7.org/fhir/StructureDefinition/humanname-own-prefix
........ extension 0..0 Additional content defined by implementations
Slice: Unordered, Open by value:url
........ url S 1..1 uri "http://hl7.org/fhir/StructureDefinition/humanname-own-prefix"
........ value[x] S 1..1 string Value of extension
... gender SΣ 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
.... Slices for extension Content/Rules for all slices
..... extension:other-amtlich 0..1 (Complex) Optional Extensions Element
URL: http://fhir.de/StructureDefinition/gender-amtlich-de
...... extension 0..0 Additional content defined by implementations
Slice: Unordered, Open by value:url
...... url S 1..1 uri "http://fhir.de/StructureDefinition/gender-amtlich-de"
...... value[x] SC 1..1 Coding Value of extension
Binding: GenderOtherDE ValueSet (required)
Constraints: gender-amtlich-1
....... system SΣ 0..1 uri Identity of the terminology system
....... version SΣ 0..1 string Version of the system - if relevant
....... code SΣ 0..1 code Symbol in syntax defined by the system
....... display SΣ 0..1 string Representation defined by the system
... birthDate SΣ 1..1 date Geburtsdatum
... deceased[x] ?!Σ 0..1 Indicates if the individual is deceased or not
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
... link ?!Σ 0..* BackboneElement Link to another patient resource that concerns the same actual person
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... other ΣC 1..1 Reference(Patient | RelatedPerson) The other patient or related person resource that the link refers to
Constraints: ref-1
.... type Σ 1..1 code replaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Patient.identifier:KVNR.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:KVNR.​type Base extensible Identifier Type DeBasis ValueSet 📦1.5.4 de.basisprofil.r4 v1.5
Patient.name:Name.use Base required NameUse 📍4.0.1 FHIR Std.
Patient.name:Name.prefix.​extension:prefix-qualifier.​value[x] Base required EntityNamePartQualifier 📍4.0.1 FHIR Std.
Patient.name:Geburtsname.​use Base required NameUse 📍4.0.1 FHIR Std.
Patient.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
Patient.gender.extension:other-amtlich.​value[x] Base required GenderOtherDE ValueSet 📦1.5.4 de.basisprofil.r4 v1.5
Patient.link.type Base required LinkType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Patient If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Patient If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Patient If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Patient If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Patient A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
gender-amtlich-1 error Patient.gender.extension:other-amtlich.value[x] Die amtliche Differenzierung der Geschlechtsangabe 'other' darf nur gefüllt sein, wenn das Geschlecht 'other' angegeben ist %resource.where(gender='other').exists()
hum-1 error Patient.name:Name, Patient.name:Geburtsname Wenn die Extension 'namenszusatz' verwendet wird, dann muss der vollständige Name im Attribut 'family' angegeben werden family.extension('http://fhir.de/StructureDefinition/humanname-namenszusatz').empty() or family.hasValue()
hum-2 error Patient.name:Name, Patient.name:Geburtsname Wenn die Extension 'nachname' verwendet wird, dann muss der vollständige Name im Attribut 'family' angegeben werden family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-name').empty() or family.hasValue()
hum-3 error Patient.name:Name, Patient.name:Geburtsname Wenn die Extension 'vorsatzwort' verwendet wird, dann muss der vollständige Name im Attribut 'family' angegeben werden family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-prefix').empty() or family.hasValue()
hum-4 error Patient.name:Name, Patient.name:Geburtsname Wenn die Extension 'prefix-qualifier' verwendet wird, dann muss ein Namenspräfix im Attribut 'prefix' angegeben werden prefix.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier').empty() or $this.hasValue())
kvid-1 warning Patient.identifier:KVNR.value Der unveränderliche Teil der KVID muss 10-stellig sein und mit einem Großbuchstaben anfangen matches('^[A-Z][0-9]{9}$')
kvid-2 warning Patient.identifier:KVNR.type 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()
pat-de-1 error Patient Die amtliche Differenzierung der Geschlechtsangabe 'other' darf nur gefüllt sein, wenn das Geschlecht 'other' angegeben ist gender.exists() and gender='other' implies gender.extension('http://fhir.de/StructureDefinition/gender-amtlich-de').exists()
ref-1 error Patient.link.other SHALL have a contained resource if a local reference is provided reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Differential View

This structure is derived from TIPatient

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient 0..* TIPatient Information about an individual or animal receiving health care services
... id S 0..1 id Logical id of this artifact
... meta S 0..1 Meta Metadata about the resource
.... versionId S 0..1 id Version specific identifier
.... lastUpdated S 0..1 instant When the resource version last changed
... identifier 1..* Identifier An identifier for this patient
.... identifier:KVNR 1..1 IdentifierKvid10 An identifier intended for computation
..... system S 1..1 uri The namespace for the identifier value
..... value S 1..1 string The value that is unique
... active 0..0 Whether this patient's record is in active use
... Slices for name Content/Rules for all slices
.... name:Name 1..1 HumannameDeBasis Personenname
..... prefix
...... Slices for extension Content/Rules for all slices
....... extension:prefix-qualifier 0..1 ENQualifier(5.2.0) LS | AC | NB | PR | HON | BR | AD | SP | MID | CL | IN | VV
........ url S 1..1 uri identifies the meaning of the extension
........ value[x] S 1..1 code Value of extension
.... name:Geburtsname 0..1 HumannameDeBasis Personenname
..... family
...... Slices for extension Content/Rules for all slices
....... extension:namenszusatz 0..1 HumannameNamenszusatz Namenszusatz gemäß VSDM (Versichertenstammdatenmanagement, "eGK")
........ url S 1..1 uri identifies the meaning of the extension
........ value[x] S 0..1 string Namenszusatz
....... extension:nachname 0..1 OwnName(5.2.0) Portion derived from person's own surname
........ url S 1..1 uri identifies the meaning of the extension
........ value[x] S 1..1 string Value of extension
....... extension:vorsatzwort 0..1 OwnPrefix(5.2.0) Voorvoegsel derived from person's own surname
........ url S 1..1 uri identifies the meaning of the extension
........ value[x] S 1..1 string Value of extension
... gender
.... Slices for extension Content/Rules for all slices
..... extension:other-amtlich 0..1 GenderOtherDE Optional Extensions Element
...... url S 1..1 uri identifies the meaning of the extension
...... value[x] S 1..1 Coding Value of extension
....... system S 0..1 uri Identity of the terminology system
....... version S 0..1 string Version of the system - if relevant
....... code S 0..1 code Symbol in syntax defined by the system
....... display S 0..1 string Representation defined by the system

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient C 0..* TIPatient Information about an individual or animal receiving health care services
Constraints: dom-2, dom-3, dom-4, dom-5, dom-6, pat-de-1
... id SΣ 0..1 id Logical id of this artifact
... meta SΣ 0..1 Meta Metadata about the resource
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId SΣ 0..1 id Version specific identifier
.... lastUpdated SΣ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile Σ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Slice: Unordered, Open by value:url
... Slices for identifier SΣ 1..* Identifier An identifier for this patient
Slice: Unordered, Open by pattern:$this
.... identifier:KVNR SΣ 1..1 IdentifierKvid10 An identifier intended for computation

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... use 0..1 code usual | official | temp | secondary | old (If known)
..... type 0..1 CodeableConcept Description of identifier
..... system 1..1 uri The namespace for the identifier value
Fixed Value: http://fhir.de/sid/gkv/kvid-10
..... value 0..1 string The value that is unique
..... period 0..1 Period Time period when id is/was valid for use
..... assigner 0..1 Reference(Organization) Organization that issued id (may be just text)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type ΣC 0..1 CodeableConcept Description of identifier
Binding: Identifier Type DeBasis ValueSet (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Constraints: kvid-2
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://fhir.de/CodeSystem/identifier-type-de-basis
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: KVZ10
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... system SΣ 1..1 uri The namespace for the identifier value
Fixed Value: http://fhir.de/sid/gkv/kvid-10
..... value SΣC 1..1 string The value that is unique
Constraints: kvid-1
Example General: 123456
..... period ΣC 0..1 Period Time period when id is/was valid for use
Constraints: per-1
..... assigner ΣC 0..1 Reference(Organization) Organization that issued id (may be just text)
Constraints: ref-1
... Slices for name SΣ 1..* HumanName A name associated with the patient
Slice: Unordered, Open by value:$this
.... name:Name SΣC 1..1 HumannameDeBasis Personenname
Constraints: hum-1, hum-2, hum-3, hum-4

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... use 1..1 code usual | official | temp | nickname | anonymous | old | maiden
Fixed Value: official
..... text 0..1 string Text representation of the full name
..... family 0..1 string Family name (often called 'Surname')
..... given 0..* string Given names (not always 'first'). Includes middle names
..... prefix 0..* string Parts that come before the name
..... suffix 0..* string Parts that come after the name
..... period 0..1 Period Time period when name was/is in use
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!SΣ 1..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
..... text Σ 0..1 string Text representation of the full name
..... family SΣ 1..1 string Familienname
...... id 0..1 string Unique id for inter-element referencing
...... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... extension:namenszusatz SN 0..1 string Namenszusatz gemäß VSDM (Versichertenstammdatenmanagement, "eGK")
URL: http://fhir.de/StructureDefinition/humanname-namenszusatz
....... extension:nachname S 0..1 string Nachname ohne Vor- und Zusätze
URL: http://hl7.org/fhir/StructureDefinition/humanname-own-name
....... extension:vorsatzwort S 0..1 string Vorsatzwort
URL: http://hl7.org/fhir/StructureDefinition/humanname-own-prefix
...... value 0..1 string Primitive value for string
Max Length:1048576
..... given SΣ 1..* string Vorname
This repeating element order: Given Names appear in the correct order for presenting the name
..... prefix SΣ 0..* string Namensteile vor dem Vornamen
This repeating element order: Prefixes appear in the correct order for presenting the name
...... id 0..1 string Unique id for inter-element referencing
...... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... extension:prefix-qualifier S 0..1 (Complex) LS | AC | NB | PR | HON | BR | AD | SP | MID | CL | IN | VV
URL: http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..0 Additional content defined by implementations
Slice: Unordered, Open by value:url
........ url S 1..1 uri "http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier"
........ value[x] S 1..1 code Value of extension
Binding: EntityNamePartQualifier (required): A set of codes each of which specifies a certain subcategory of the name part in addition to the main name part type.
Fixed Value: AC
...... value 0..1 string Primitive value for string
Max Length:1048576
..... suffix Σ 0..* string Namensteile nach dem Nachnamen
This repeating element order: Suffixes appear in the correct order for presenting the name
..... period ΣC 0..1 Period Time period when name was/is in use
Constraints: per-1
.... name:Geburtsname SΣC 0..1 HumannameDeBasis Personenname
Constraints: hum-1, hum-2, hum-3, hum-4

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... use 1..1 code usual | official | temp | nickname | anonymous | old | maiden
Fixed Value: maiden
..... text 0..1 string Text representation of the full name
..... family 0..1 string Family name (often called 'Surname')
..... given 0..* string Given names (not always 'first'). Includes middle names
..... prefix 0..* string Parts that come before the name
..... suffix 0..* string Parts that come after the name
..... period 0..1 Period Time period when name was/is in use
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!SΣ 1..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
..... text Σ 0..1 string Text representation of the full name
..... family SΣ 1..1 string Familienname
...... id 0..1 string Unique id for inter-element referencing
...... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... extension:namenszusatz S 0..1 (Complex) Namenszusatz gemäß VSDM (Versichertenstammdatenmanagement, "eGK")
URL: http://fhir.de/StructureDefinition/humanname-namenszusatz
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..0 Additional content defined by implementations
Slice: Unordered, Open by value:url
........ url S 1..1 uri "http://fhir.de/StructureDefinition/humanname-namenszusatz"
........ value[x] S 0..1 string Namenszusatz
....... extension:nachname S 0..1 (Complex) Portion derived from person's own surname
URL: http://hl7.org/fhir/StructureDefinition/humanname-own-name
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..0 Additional content defined by implementations
Slice: Unordered, Open by value:url
........ url S 1..1 uri "http://hl7.org/fhir/StructureDefinition/humanname-own-name"
........ value[x] S 1..1 string Value of extension
....... extension:vorsatzwort S 0..1 (Complex) Voorvoegsel derived from person's own surname
URL: http://hl7.org/fhir/StructureDefinition/humanname-own-prefix
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..0 Additional content defined by implementations
Slice: Unordered, Open by value:url
........ url S 1..1 uri "http://hl7.org/fhir/StructureDefinition/humanname-own-prefix"
........ value[x] S 1..1 string Value of extension
...... value 0..1 string Primitive value for string
Max Length:1048576
..... period ΣC 0..1 Period Time period when name was/is in use
Constraints: per-1
... telecom ΣC 0..* ContactPoint A contact detail for the individual
Constraints: cpt-2
... gender SΣ 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... extension:other-amtlich 0..1 (Complex) Optional Extensions Element
URL: http://fhir.de/StructureDefinition/gender-amtlich-de
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..0 Additional content defined by implementations
Slice: Unordered, Open by value:url
...... url S 1..1 uri "http://fhir.de/StructureDefinition/gender-amtlich-de"
...... value[x] SC 1..1 Coding Value of extension
Binding: GenderOtherDE ValueSet (required)
Constraints: gender-amtlich-1
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... system SΣ 0..1 uri Identity of the terminology system
....... version SΣ 0..1 string Version of the system - if relevant
....... code SΣ 0..1 code Symbol in syntax defined by the system
....... display SΣ 0..1 string Representation defined by the system
....... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... value 0..1 code Primitive value for code
Max Length:1048576
... birthDate SΣ 1..1 date Geburtsdatum
... deceased[x] ?!Σ 0..1 Indicates if the individual is deceased or not
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
... address Σ 0..* Address An address for the individual
... maritalStatus 0..1 CodeableConcept Marital (civil) status of a patient
Binding: Marital Status Codes (extensible): The domestic partnership status of a person.
... multipleBirth[x] 0..1 Whether patient is part of a multiple birth
.... multipleBirthBoolean boolean
.... multipleBirthInteger integer
... photo C 0..* Attachment Image of the patient
Constraints: att-1
... contact C 0..* BackboneElement A contact party (e.g. guardian, partner, friend) for the patient
Constraints: pat-1
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... relationship 0..* CodeableConcept The kind of relationship
Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.
.... name 0..1 HumanName A name associated with the contact person
.... telecom C 0..* ContactPoint A contact detail for the person
Constraints: cpt-2
.... address 0..1 Address Address for the contact person
.... gender 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
.... organization C 0..1 Reference(Organization) Organization that is associated with the contact
Constraints: ref-1
.... period C 0..1 Period The period during which this contact person or organization is valid to be contacted relating to this patient
Constraints: per-1
... communication 0..* BackboneElement A language which may be used to communicate with the patient about his or her health
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... language 1..1 CodeableConcept The language which can be used to communicate with the patient about his or her health
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
.... preferred 0..1 boolean Language preference indicator
... generalPractitioner C 0..* Reference(Organization | Practitioner | PractitionerRole) Patient's nominated primary care provider
Constraints: ref-1
... managingOrganization ΣC 0..1 Reference(Organization) Organization that is the custodian of the patient record
Constraints: ref-1
... link ?!Σ 0..* BackboneElement Link to another patient resource that concerns the same actual person
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... other ΣC 1..1 Reference(Patient | RelatedPerson) The other patient or related person resource that the link refers to
Constraints: ref-1
.... type Σ 1..1 code replaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Patient.meta.security Base extensible SecurityLabels 📍4.0.1 FHIR Std.
Patient.meta.tag Base example Common Tags 📍4.0.1 FHIR Std.
Patient.language Base preferred Common Languages 📦4.0.1 FHIR Std.
Patient.identifier:KVNR.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:KVNR.​type Base extensible Identifier Type DeBasis ValueSet 📦1.5.4 de.basisprofil.r4 v1.5
Patient.name:Name.use Base required NameUse 📍4.0.1 FHIR Std.
Patient.name:Name.prefix.​extension:prefix-qualifier.​value[x] Base required EntityNamePartQualifier 📍4.0.1 FHIR Std.
Patient.name:Geburtsname.​use Base required NameUse 📍4.0.1 FHIR Std.
Patient.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
Patient.gender.extension:other-amtlich.​value[x] Base required GenderOtherDE ValueSet 📦1.5.4 de.basisprofil.r4 v1.5
Patient.maritalStatus Base extensible MaritalStatus 📦4.0.1 FHIR Std.
Patient.contact.relationship Base extensible Patient Contact Relationship 📦4.0.1 FHIR Std.
Patient.contact.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
Patient.communication.​language Base preferred Common Languages 📦4.0.1 FHIR Std.
Patient.link.type Base required LinkType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
att-1 error Patient.photo If the Attachment has data, it SHALL have a contentType data.empty() or contentType.exists()
cpt-2 error Patient.telecom, Patient.contact.telecom A system is required if a value is provided. value.empty() or system.exists()
dom-2 error Patient If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Patient If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Patient If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Patient If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Patient A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
gender-amtlich-1 error Patient.gender.extension:other-amtlich.value[x] Die amtliche Differenzierung der Geschlechtsangabe 'other' darf nur gefüllt sein, wenn das Geschlecht 'other' angegeben ist %resource.where(gender='other').exists()
hum-1 error Patient.name:Name, Patient.name:Geburtsname Wenn die Extension 'namenszusatz' verwendet wird, dann muss der vollständige Name im Attribut 'family' angegeben werden family.extension('http://fhir.de/StructureDefinition/humanname-namenszusatz').empty() or family.hasValue()
hum-2 error Patient.name:Name, Patient.name:Geburtsname Wenn die Extension 'nachname' verwendet wird, dann muss der vollständige Name im Attribut 'family' angegeben werden family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-name').empty() or family.hasValue()
hum-3 error Patient.name:Name, Patient.name:Geburtsname Wenn die Extension 'vorsatzwort' verwendet wird, dann muss der vollständige Name im Attribut 'family' angegeben werden family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-prefix').empty() or family.hasValue()
hum-4 error Patient.name:Name, Patient.name:Geburtsname Wenn die Extension 'prefix-qualifier' verwendet wird, dann muss ein Namenspräfix im Attribut 'prefix' angegeben werden prefix.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier').empty() or $this.hasValue())
kvid-1 warning Patient.identifier:KVNR.value Der unveränderliche Teil der KVID muss 10-stellig sein und mit einem Großbuchstaben anfangen matches('^[A-Z][0-9]{9}$')
kvid-2 warning Patient.identifier:KVNR.type 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()
pat-1 error Patient.contact 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()
pat-de-1 error Patient Die amtliche Differenzierung der Geschlechtsangabe 'other' darf nur gefüllt sein, wenn das Geschlecht 'other' angegeben ist gender.exists() and gender='other' implies gender.extension('http://fhir.de/StructureDefinition/gender-amtlich-de').exists()
per-1 error Patient.identifier:KVNR.period, Patient.name:Name.period, Patient.name:Geburtsname.period, Patient.contact.period If present, start SHALL have a lower value than end start.hasValue().not() or end.hasValue().not() or (start <= end)
ref-1 error Patient.identifier:KVNR.assigner, Patient.contact.organization, Patient.generalPractitioner, Patient.managingOrganization, Patient.link.other SHALL have a contained resource if a local reference is provided reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

This structure is derived from TIPatient

Summary

Mandatory: 2 elements
Must-Support: 20 elements
Prohibited: 1 element

 

Other representations of profile: CSV, Excel, Schematron