PFLIP HL7 FHIR Implementation Guide
0.1.0 - ci-build

PFLIP HL7 FHIR Implementation Guide - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: PFLIP_Patient

Official URL: http://pflipdemo.com/fhir/StructureDefinition/pflip-patient Version: 0.1.0
Draft as of 2024-07-30 Computable Name: PFLIP_Patient

Patient profile derived from KBV_PR_MIO_ULB_Patient to ensure pseudonymized implementation

Usage:

Formal Views of Profile Content

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

This structure is derived from KBV_PR_MIO_ULB_Patient

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..* KBV_PR_MIO_ULB_Patient Information about an individual or animal receiving health care services
... Slices for extension Content/Rules for all slices
.... extension:konfession_religion 0..0
.... extension:dolmetscher_erforderlich 0..0
.... extension:weitere_hinweise_zur_kommunikation 0..0
... Slices for identifier Content/Rules for all slices
.... identifier:versichertenId_GKV 0..0
.... identifier:versichertennummer_pkv 0..0
.... identifier:versichertennummer_kvk 0..0
.... identifier:versichertenId_PKV 0..0
... name 1..1 HumanName A name associated with the patient
.... name:name 0..1 KBV_PR_Base_Datatype_Name(1.3.0) Personenname
..... text 0..0
..... family 1..1 string Familienname
...... extension 1..* Extension Extension
...... Slices for extension Content/Rules for all slices
....... extension:namenszusatz 0..0
...... Slices for extension Content/Rules for all slices
....... extension:nachname 0..0
...... Slices for extension Content/Rules for all slices
....... extension:vorsatzwort 0..0
...... Slices for extension Content/Rules for all slices
....... data-absent-reason S 1..1 (Complex) masked for pseudonymization
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
........ value[x] 1..1 code Value of extension
Required Pattern: masked
...... value 0..0
..... given 0..0
..... prefix 0..0
... Slices for name Content/Rules for all slices
.... name:geburtsname 0..0
... telecom 0..0
... birthDate
.... Slices for extension 1..* Extension Extension
Slice: Unordered, Closed by value:url
..... birth-date-mm-yyyy S 1..1 string BirthDate (MM-YYYY)
URL: http://pflipdemo.com/fhir/StructureDefinition/birthDate-mm-yyyy
... address 0..0
... Slices for address Content/Rules for all slices
.... address:Strassenanschrift 0..0
... Slices for address Content/Rules for all slices
.... address:Postfach 0..0
... maritalStatus 0..0
... communication 0..0

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient C 0..* KBV_PR_MIO_ULB_Patient Information about an individual or animal receiving health care services
pat-de-1: Die amtliche Differenzierung der Geschlechtsangabe 'other' darf nur gefüllt sein, wenn das Geschlecht 'other' angegeben ist
... meta Σ 1..1 Meta Metadata about the resource
.... profile Σ 1..1 canonical(StructureDefinition) Profiles this resource claims to conform to

Required Pattern: https://fhir.kbv.de/StructureDefinition/KBV_PR_MIO_ULB_Patient|1.0.0
... Slices for extension Content/Rules for all slices
... modifierExtension ?!N 0..* Extension Extensions that cannot be ignored
Slice: Unordered, Open by value:url
.... identifier:pid SΣN 0..* IdentifierPid(1.3.2) An identifier intended for computation
..... use ?!ΣN 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type ΣN 1..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.


Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: MR
...... coding ΣN 1..1 Coding Code defined by a terminology system
....... system ΣN 1..1 uri Identity of the terminology system
....... code ΣN 1..1 code Symbol in syntax defined by the system
....... display ΣN 1..1 string Representation defined by the system
Required Pattern: Medical record number
..... system SΣN 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value SΣN 1..1 string The value that is unique
Example General: 123456
... Slices for name SΣ 1..1 HumanName A name associated with the patient
Slice: Unordered, Closed by value:use
.... name:name SΣC 0..1 KBV_PR_Base_Datatype_Name(1.3.0) Personenname
hum-1: Wenn die Extension 'namenszusatz' verwendet wird, dann muss der vollständige Name im Attribut 'family' angegeben werden
hum-2: Wenn die Extension 'nachname' verwendet wird, dann muss der vollständige Name im Attribut 'family' angegeben werden
hum-3: Wenn die Extension 'vorsatzwort' verwendet wird, dann muss der vollständige Name im Attribut 'family' angegeben werden
hum-4: Wenn die Extension 'prefix-qualifier' verwendet wird, dann muss ein Namenspräfix im Attribut 'prefix' angegeben werden
..... use ?!Σ 1..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.


Required Pattern: official
..... family SΣ 1..1 string Familienname
...... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
....... data-absent-reason S 1..1 (Complex) masked for pseudonymization
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
........ extension 0..0
........ url 1..1 uri "http://hl7.org/fhir/StructureDefinition/data-absent-reason"
........ value[x] 1..1 code Value of extension
Binding: DataAbsentReason (required)
Required Pattern: masked
... 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
..... other-amtlich SN 0..1 (Complex) Optional Extensions Element
URL: http://fhir.de/StructureDefinition/gender-amtlich-de
...... url 1..1 uri "http://fhir.de/StructureDefinition/gender-amtlich-de"
...... Slices for value[x] SCN 1..1 Coding Value of extension
Slice: Unordered, Closed by type:$this
Binding: GenderOtherDE (required)
gender-amtlich-1: Die amtliche Differenzierung der Geschlechtsangabe 'other' darf nur gefüllt sein, wenn das Geschlecht 'other' angegeben ist
....... value[x]:valueCoding SCN 1..1 Coding Value of extension
Binding: GenderOtherDE (required)
gender-amtlich-1: Die amtliche Differenzierung der Geschlechtsangabe 'other' darf nur gefüllt sein, wenn das Geschlecht 'other' angegeben ist
... birthDate SΣ 1..1 date The date of birth for the individual
.... Slices for extension 1..* Extension Extension
Slice: Unordered, Closed by value:url
..... data-absent-reason SN 0..1 (Complex) unknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
...... extension N 0..0
...... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/data-absent-reason"
...... Slices for value[x] SN 1..1 code Value of extension
Slice: Unordered, Closed by type:$this
Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.

....... value[x]:valueCode SN 1..1 code Value of extension
Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.


Fixed Value: unknown
..... birth-date-mm-yyyy S 1..1 string BirthDate (MM-YYYY)
URL: http://pflipdemo.com/fhir/StructureDefinition/birthDate-mm-yyyy

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Patient.identifier:pid.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Patient.identifier:pid.typeextensiblePattern: MR
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Patient.identifier:versichertenId_GKV.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Patient.identifier:versichertenId_GKV.typeextensiblePattern: GKV
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Patient.identifier:versichertennummer_pkv.userequiredFixed Value: secondary
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Patient.identifier:versichertennummer_pkv.typeextensiblePattern: PKV
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Patient.identifier:reisepassnummer.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Patient.identifier:reisepassnummer.typeextensiblePattern: PPN
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Patient.identifier:versichertennummer_kvk.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Patient.identifier:versichertennummer_kvk.typeextensiblePattern: kvk
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Patient.identifier:versichertenId_PKV.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Patient.identifier:versichertenId_PKV.typeextensiblePattern: PKV
http://fhir.de/ValueSet/identifier-type-de-basis
Patient.name:name.userequiredPattern: official
http://hl7.org/fhir/ValueSet/name-use|4.0.1
from the FHIR Standard
Patient.name:name.family.extension:data-absent-reason.value[x]requiredPattern: masked
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard
Patient.name:name.prefix.extension:prefix-qualifier.value[x]requiredEntityNamePartQualifier
http://hl7.org/fhir/ValueSet/name-part-qualifier|4.0.1
from the FHIR Standard
Patient.name:name.prefix.extension:prefix-qualifier.value[x]:valueCoderequiredFixed Value: AC
http://hl7.org/fhir/ValueSet/name-part-qualifier|4.0.1
from the FHIR Standard
Patient.name:geburtsname.userequiredPattern: maiden
http://hl7.org/fhir/ValueSet/name-use|4.0.1
from the FHIR Standard
Patient.name:geburtsname.prefix.extension:prefix-qualifier.value[x]requiredEntityNamePartQualifier
http://hl7.org/fhir/ValueSet/name-part-qualifier|4.0.1
from the FHIR Standard
Patient.name:geburtsname.prefix.extension:prefix-qualifier.value[x]:valueCoderequiredFixed Value: AC
http://hl7.org/fhir/ValueSet/name-part-qualifier|4.0.1
from the FHIR Standard
Patient.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
Patient.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
from the FHIR Standard
Patient.gender.extension:other-amtlich.value[x]requiredGenderOtherDE
http://fhir.de/ValueSet/gender-other-de
Patient.gender.extension:other-amtlich.value[x]:valueCodingrequiredGenderOtherDE
http://fhir.de/ValueSet/gender-other-de
Patient.birthDate.extension:data-absent-reason.value[x]requiredDataAbsentReason
http://hl7.org/fhir/ValueSet/data-absent-reason|4.0.1
from the FHIR Standard
Patient.birthDate.extension:data-absent-reason.value[x]:valueCoderequiredFixed Value: unknown
http://hl7.org/fhir/ValueSet/data-absent-reason|4.0.1
from the FHIR Standard
Patient.address:Strassenanschrift.typerequiredPattern: both
http://hl7.org/fhir/ValueSet/address-type|4.0.1
from the FHIR Standard
Patient.address:Postfach.typerequiredPattern: postal
http://hl7.org/fhir/ValueSet/address-type|4.0.1
from the FHIR Standard
Patient.communication.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Patient.link.typerequiredLinkType
http://hl7.org/fhir/ValueSet/link-type|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorPatientIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorPatientIf 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-4errorPatientIf 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-5errorPatientIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practicePatientA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** elementsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
gender-amtlich-1errorPatient.gender.extension:other-amtlich.value[x], Patient.gender.extension:other-amtlich.value[x]:valueCodingDie amtliche Differenzierung der Geschlechtsangabe 'other' darf nur gefüllt sein, wenn das Geschlecht 'other' angegeben ist
: %resource.where(gender='other').exists()
hum-1errorPatient.name:nameWenn 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-2errorPatient.name:nameWenn 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-3errorPatient.name:nameWenn 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-4errorPatient.name:nameWenn 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())
kvk-1errorPatient.identifier:versichertennummer_kvk.valueDie Krankenversichertenkartenummer muss numerisch und 6- bis 12-stellig sein.
: matches('^[0-9]{6,12}$')
kvid-1warningPatient.identifier:versichertenId_GKV.valueDer unveränderliche Teil der KVID muss 10-stellig sein und mit einem Großbuchstaben anfangen
: matches('^[A-Z][0-9]{9}$')
pat-de-1errorPatientDie 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()
pkvid-1warningPatient.identifier:versichertenId_PKV.valueDer unveränderliche Teil der PKVID muss 10-stellig sein und mit einem Großbuchstaben anfangen
: matches('^[A-Z][0-9]{9}$')
ref-1errorPatient.identifier:versichertennummer_pkv.assigner, Patient.contact.organization, Patient.link.otherSHALL 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'))
NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient C 0..* KBV_PR_MIO_ULB_Patient Information about an individual or animal receiving health care services
pat-de-1: Die amtliche Differenzierung der Geschlechtsangabe 'other' darf nur gefüllt sein, wenn das Geschlecht 'other' angegeben ist
... id Σ 0..1 id Logical id of this artifact
... meta Σ 1..1 Meta Metadata about the resource
.... id 0..1 string Unique id for inter-element referencing
.... extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... profile Σ 1..1 canonical(StructureDefinition) Profiles this resource claims to conform to

Required Pattern: https://fhir.kbv.de/StructureDefinition/KBV_PR_MIO_ULB_Patient|1.0.0
... text 0..1 Narrative Text summary of the resource, for human interpretation
.... id 0..1 string Unique id for inter-element referencing
.... extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... status 1..1 code generated | extensions | additional | empty
Binding: NarrativeStatus (required): The status of a resource narrative.


Required Pattern: extensions
.... div C 1..1 xhtml Limited xhtml content
txt-1: The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes
txt-2: The narrative SHALL have some non-whitespace content
... modifierExtension ?!N 0..* Extension Extensions that cannot be ignored
Slice: Unordered, Open by value:url
... Slices for identifier SΣN 0..* Identifier An identifier for this patient
Slice: Unordered, Closed by pattern:type, exists:assigner
.... identifier:pid SΣN 0..* IdentifierPid(1.3.2) An identifier intended for computation
..... id 0..1 string Unique id for inter-element referencing
..... extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!ΣN 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type ΣN 1..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.


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://terminology.hl7.org/CodeSystem/v2-0203
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: MR
....... 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
...... id 0..1 string Unique id for inter-element referencing
...... extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... coding ΣN 1..1 Coding Code defined by a terminology system
....... id 0..1 string Unique id for inter-element referencing
....... extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... system ΣN 1..1 uri Identity of the terminology system
....... version ΣN 0..1 string Version of the system - if relevant
....... code ΣN 1..1 code Symbol in syntax defined by the system
....... display ΣN 1..1 string Representation defined by the system
Required Pattern: Medical record number
..... system SΣN 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value SΣN 1..1 string The value that is unique
Example General: 123456
... Slices for name SΣ 1..1 HumanName A name associated with the patient
Slice: Unordered, Closed by value:use
.... name:name SΣC 0..1 KBV_PR_Base_Datatype_Name(1.3.0) Personenname
hum-1: Wenn die Extension 'namenszusatz' verwendet wird, dann muss der vollständige Name im Attribut 'family' angegeben werden
hum-2: Wenn die Extension 'nachname' verwendet wird, dann muss der vollständige Name im Attribut 'family' angegeben werden
hum-3: Wenn die Extension 'vorsatzwort' verwendet wird, dann muss der vollständige Name im Attribut 'family' angegeben werden
hum-4: Wenn die Extension 'prefix-qualifier' verwendet wird, dann muss ein Namenspräfix im Attribut 'prefix' angegeben werden
..... id 0..1 string Unique id for inter-element referencing
..... extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 1..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.


Required Pattern: official
..... family SΣ 1..1 string Familienname
...... id 0..1 string Unique id for inter-element referencing
...... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
....... data-absent-reason S 1..1 (Complex) masked for pseudonymization
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
........ id 0..1 id Unique id for inter-element referencing
........ extension 0..0
........ url 1..1 uri "http://hl7.org/fhir/StructureDefinition/data-absent-reason"
........ value[x] 1..1 code Value of extension
Binding: DataAbsentReason (required)
Required Pattern: masked
... 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 Unique id for inter-element referencing
.... Slices for extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... other-amtlich SN 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 N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... url 1..1 uri "http://fhir.de/StructureDefinition/gender-amtlich-de"
...... Slices for value[x] SCN 1..1 Coding Value of extension
Slice: Unordered, Closed by type:$this
Binding: GenderOtherDE (required)
gender-amtlich-1: Die amtliche Differenzierung der Geschlechtsangabe 'other' darf nur gefüllt sein, wenn das Geschlecht 'other' angegeben ist
....... value[x]:valueCoding SCN 1..1 Coding Value of extension
Binding: GenderOtherDE (required)
gender-amtlich-1: Die amtliche Differenzierung der Geschlechtsangabe 'other' darf nur gefüllt sein, wenn das Geschlecht 'other' angegeben ist
........ id 0..1 string Unique id for inter-element referencing
........ extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ system ΣN 0..1 uri Identity of the terminology system
........ version ΣN 0..1 string Version of the system - if relevant
........ code ΣN 0..1 code Symbol in syntax defined by the system
........ display ΣN 0..1 string Representation defined by the system
.... value 0..1 code Primitive value for code
Max Length: 1048576
... birthDate SΣ 1..1 date The date of birth for the individual
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 1..* Extension Extension
Slice: Unordered, Closed by value:url
..... data-absent-reason SN 0..1 (Complex) unknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
...... id 0..1 string Unique id for inter-element referencing
...... extension N 0..0
...... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/data-absent-reason"
...... Slices for value[x] SN 1..1 code Value of extension
Slice: Unordered, Closed by type:$this
Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.

....... value[x]:valueCode SN 1..1 code Value of extension
Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.


Fixed Value: unknown
..... birth-date-mm-yyyy S 1..1 string BirthDate (MM-YYYY)
URL: http://pflipdemo.com/fhir/StructureDefinition/birthDate-mm-yyyy
.... value 0..1 date Primitive value for date

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Patient.text.statusrequiredPattern: extensions
http://hl7.org/fhir/ValueSet/narrative-status|4.0.1
from the FHIR Standard
Patient.identifier:pid.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Patient.identifier:pid.typeextensiblePattern: MR
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Patient.identifier:versichertenId_GKV.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Patient.identifier:versichertenId_GKV.typeextensiblePattern: GKV
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Patient.identifier:versichertennummer_pkv.userequiredFixed Value: secondary
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Patient.identifier:versichertennummer_pkv.typeextensiblePattern: PKV
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Patient.identifier:versichertennummer_pkv.assigner.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
Patient.identifier:reisepassnummer.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Patient.identifier:reisepassnummer.typeextensiblePattern: PPN
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Patient.identifier:versichertennummer_kvk.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Patient.identifier:versichertennummer_kvk.typeextensiblePattern: kvk
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Patient.identifier:versichertenId_PKV.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Patient.identifier:versichertenId_PKV.typeextensiblePattern: PKV
http://fhir.de/ValueSet/identifier-type-de-basis
Patient.name:name.userequiredPattern: official
http://hl7.org/fhir/ValueSet/name-use|4.0.1
from the FHIR Standard
Patient.name:name.family.extension:data-absent-reason.value[x]requiredPattern: masked
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard
Patient.name:name.prefix.extension:prefix-qualifier.value[x]requiredEntityNamePartQualifier
http://hl7.org/fhir/ValueSet/name-part-qualifier|4.0.1
from the FHIR Standard
Patient.name:name.prefix.extension:prefix-qualifier.value[x]:valueCoderequiredFixed Value: AC
http://hl7.org/fhir/ValueSet/name-part-qualifier|4.0.1
from the FHIR Standard
Patient.name:geburtsname.userequiredPattern: maiden
http://hl7.org/fhir/ValueSet/name-use|4.0.1
from the FHIR Standard
Patient.name:geburtsname.prefix.extension:prefix-qualifier.value[x]requiredEntityNamePartQualifier
http://hl7.org/fhir/ValueSet/name-part-qualifier|4.0.1
from the FHIR Standard
Patient.name:geburtsname.prefix.extension:prefix-qualifier.value[x]:valueCoderequiredFixed Value: AC
http://hl7.org/fhir/ValueSet/name-part-qualifier|4.0.1
from the FHIR Standard
Patient.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
Patient.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
from the FHIR Standard
Patient.gender.extension:other-amtlich.value[x]requiredGenderOtherDE
http://fhir.de/ValueSet/gender-other-de
Patient.gender.extension:other-amtlich.value[x]:valueCodingrequiredGenderOtherDE
http://fhir.de/ValueSet/gender-other-de
Patient.birthDate.extension:data-absent-reason.value[x]requiredDataAbsentReason
http://hl7.org/fhir/ValueSet/data-absent-reason|4.0.1
from the FHIR Standard
Patient.birthDate.extension:data-absent-reason.value[x]:valueCoderequiredFixed Value: unknown
http://hl7.org/fhir/ValueSet/data-absent-reason|4.0.1
from the FHIR Standard
Patient.address:Strassenanschrift.typerequiredPattern: both
http://hl7.org/fhir/ValueSet/address-type|4.0.1
from the FHIR Standard
Patient.address:Postfach.typerequiredPattern: postal
http://hl7.org/fhir/ValueSet/address-type|4.0.1
from the FHIR Standard
Patient.contact.relationshipextensiblePatientContactRelationship
http://hl7.org/fhir/ValueSet/patient-contactrelationship
from the FHIR Standard
Patient.contact.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
Patient.contact.address.typerequiredAddressType
http://hl7.org/fhir/ValueSet/address-type|4.0.1
from the FHIR Standard
Patient.contact.address.countryextensibleKBV_VS_Base_Deuev_Anlage_8
https://fhir.kbv.de/ValueSet/KBV_VS_Base_Deuev_Anlage_8
Patient.contact.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
from the FHIR Standard
Patient.communication.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Patient.link.typerequiredLinkType
http://hl7.org/fhir/ValueSet/link-type|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
cpt-2errorPatient.contact.telecomA system is required if a value is provided.
: value.empty() or system.exists()
dom-2errorPatientIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorPatientIf 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-4errorPatientIf 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-5errorPatientIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practicePatientA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** elementsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
gender-amtlich-1errorPatient.gender.extension:other-amtlich.value[x], Patient.gender.extension:other-amtlich.value[x]:valueCodingDie amtliche Differenzierung der Geschlechtsangabe 'other' darf nur gefüllt sein, wenn das Geschlecht 'other' angegeben ist
: %resource.where(gender='other').exists()
hum-1errorPatient.name:nameWenn 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-2errorPatient.name:nameWenn 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-3errorPatient.name:nameWenn 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-4errorPatient.name:nameWenn 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())
kvk-1errorPatient.identifier:versichertennummer_kvk.valueDie Krankenversichertenkartenummer muss numerisch und 6- bis 12-stellig sein.
: matches('^[0-9]{6,12}$')
kvid-1warningPatient.identifier:versichertenId_GKV.valueDer unveränderliche Teil der KVID muss 10-stellig sein und mit einem Großbuchstaben anfangen
: matches('^[A-Z][0-9]{9}$')
pat-de-1errorPatientDie 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-1errorPatient.identifier:reisepassnummer.period, Patient.contact.address.period, Patient.contact.periodIf present, start SHALL have a lower value than end
: start.hasValue().not() or end.hasValue().not() or (start <= end)
pkvid-1warningPatient.identifier:versichertenId_PKV.valueDer unveränderliche Teil der PKVID muss 10-stellig sein und mit einem Großbuchstaben anfangen
: matches('^[A-Z][0-9]{9}$')
ref-1errorPatient.identifier:versichertennummer_pkv.assigner, Patient.contact.organization, Patient.link.otherSHALL 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'))
txt-1errorPatient.text.divThe narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes
: htmlChecks()
txt-2errorPatient.text.divThe narrative SHALL have some non-whitespace content
: htmlChecks()

This structure is derived from KBV_PR_MIO_ULB_Patient

Summary

Mandatory: 2 elements(2 nested mandatory elements)
Must-Support: 2 elements
Prohibited: 32 elements

Extensions

This structure refers to these extensions:

Differential View

This structure is derived from KBV_PR_MIO_ULB_Patient

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..* KBV_PR_MIO_ULB_Patient Information about an individual or animal receiving health care services
... Slices for extension Content/Rules for all slices
.... extension:konfession_religion 0..0
.... extension:dolmetscher_erforderlich 0..0
.... extension:weitere_hinweise_zur_kommunikation 0..0
... Slices for identifier Content/Rules for all slices
.... identifier:versichertenId_GKV 0..0
.... identifier:versichertennummer_pkv 0..0
.... identifier:versichertennummer_kvk 0..0
.... identifier:versichertenId_PKV 0..0
... name 1..1 HumanName A name associated with the patient
.... name:name 0..1 KBV_PR_Base_Datatype_Name(1.3.0) Personenname
..... text 0..0
..... family 1..1 string Familienname
...... extension 1..* Extension Extension
...... Slices for extension Content/Rules for all slices
....... extension:namenszusatz 0..0
...... Slices for extension Content/Rules for all slices
....... extension:nachname 0..0
...... Slices for extension Content/Rules for all slices
....... extension:vorsatzwort 0..0
...... Slices for extension Content/Rules for all slices
....... data-absent-reason S 1..1 (Complex) masked for pseudonymization
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
........ value[x] 1..1 code Value of extension
Required Pattern: masked
...... value 0..0
..... given 0..0
..... prefix 0..0
... Slices for name Content/Rules for all slices
.... name:geburtsname 0..0
... telecom 0..0
... birthDate
.... Slices for extension 1..* Extension Extension
Slice: Unordered, Closed by value:url
..... birth-date-mm-yyyy S 1..1 string BirthDate (MM-YYYY)
URL: http://pflipdemo.com/fhir/StructureDefinition/birthDate-mm-yyyy
... address 0..0
... Slices for address Content/Rules for all slices
.... address:Strassenanschrift 0..0
... Slices for address Content/Rules for all slices
.... address:Postfach 0..0
... maritalStatus 0..0
... communication 0..0

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient C 0..* KBV_PR_MIO_ULB_Patient Information about an individual or animal receiving health care services
pat-de-1: Die amtliche Differenzierung der Geschlechtsangabe 'other' darf nur gefüllt sein, wenn das Geschlecht 'other' angegeben ist
... meta Σ 1..1 Meta Metadata about the resource
.... profile Σ 1..1 canonical(StructureDefinition) Profiles this resource claims to conform to

Required Pattern: https://fhir.kbv.de/StructureDefinition/KBV_PR_MIO_ULB_Patient|1.0.0
... Slices for extension Content/Rules for all slices
... modifierExtension ?!N 0..* Extension Extensions that cannot be ignored
Slice: Unordered, Open by value:url
.... identifier:pid SΣN 0..* IdentifierPid(1.3.2) An identifier intended for computation
..... use ?!ΣN 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type ΣN 1..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.


Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: MR
...... coding ΣN 1..1 Coding Code defined by a terminology system
....... system ΣN 1..1 uri Identity of the terminology system
....... code ΣN 1..1 code Symbol in syntax defined by the system
....... display ΣN 1..1 string Representation defined by the system
Required Pattern: Medical record number
..... system SΣN 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value SΣN 1..1 string The value that is unique
Example General: 123456
... Slices for name SΣ 1..1 HumanName A name associated with the patient
Slice: Unordered, Closed by value:use
.... name:name SΣC 0..1 KBV_PR_Base_Datatype_Name(1.3.0) Personenname
hum-1: Wenn die Extension 'namenszusatz' verwendet wird, dann muss der vollständige Name im Attribut 'family' angegeben werden
hum-2: Wenn die Extension 'nachname' verwendet wird, dann muss der vollständige Name im Attribut 'family' angegeben werden
hum-3: Wenn die Extension 'vorsatzwort' verwendet wird, dann muss der vollständige Name im Attribut 'family' angegeben werden
hum-4: Wenn die Extension 'prefix-qualifier' verwendet wird, dann muss ein Namenspräfix im Attribut 'prefix' angegeben werden
..... use ?!Σ 1..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.


Required Pattern: official
..... family SΣ 1..1 string Familienname
...... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
....... data-absent-reason S 1..1 (Complex) masked for pseudonymization
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
........ extension 0..0
........ url 1..1 uri "http://hl7.org/fhir/StructureDefinition/data-absent-reason"
........ value[x] 1..1 code Value of extension
Binding: DataAbsentReason (required)
Required Pattern: masked
... 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
..... other-amtlich SN 0..1 (Complex) Optional Extensions Element
URL: http://fhir.de/StructureDefinition/gender-amtlich-de
...... url 1..1 uri "http://fhir.de/StructureDefinition/gender-amtlich-de"
...... Slices for value[x] SCN 1..1 Coding Value of extension
Slice: Unordered, Closed by type:$this
Binding: GenderOtherDE (required)
gender-amtlich-1: Die amtliche Differenzierung der Geschlechtsangabe 'other' darf nur gefüllt sein, wenn das Geschlecht 'other' angegeben ist
....... value[x]:valueCoding SCN 1..1 Coding Value of extension
Binding: GenderOtherDE (required)
gender-amtlich-1: Die amtliche Differenzierung der Geschlechtsangabe 'other' darf nur gefüllt sein, wenn das Geschlecht 'other' angegeben ist
... birthDate SΣ 1..1 date The date of birth for the individual
.... Slices for extension 1..* Extension Extension
Slice: Unordered, Closed by value:url
..... data-absent-reason SN 0..1 (Complex) unknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
...... extension N 0..0
...... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/data-absent-reason"
...... Slices for value[x] SN 1..1 code Value of extension
Slice: Unordered, Closed by type:$this
Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.

....... value[x]:valueCode SN 1..1 code Value of extension
Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.


Fixed Value: unknown
..... birth-date-mm-yyyy S 1..1 string BirthDate (MM-YYYY)
URL: http://pflipdemo.com/fhir/StructureDefinition/birthDate-mm-yyyy

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Patient.identifier:pid.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Patient.identifier:pid.typeextensiblePattern: MR
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Patient.identifier:versichertenId_GKV.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Patient.identifier:versichertenId_GKV.typeextensiblePattern: GKV
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Patient.identifier:versichertennummer_pkv.userequiredFixed Value: secondary
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Patient.identifier:versichertennummer_pkv.typeextensiblePattern: PKV
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Patient.identifier:reisepassnummer.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Patient.identifier:reisepassnummer.typeextensiblePattern: PPN
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Patient.identifier:versichertennummer_kvk.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Patient.identifier:versichertennummer_kvk.typeextensiblePattern: kvk
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Patient.identifier:versichertenId_PKV.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Patient.identifier:versichertenId_PKV.typeextensiblePattern: PKV
http://fhir.de/ValueSet/identifier-type-de-basis
Patient.name:name.userequiredPattern: official
http://hl7.org/fhir/ValueSet/name-use|4.0.1
from the FHIR Standard
Patient.name:name.family.extension:data-absent-reason.value[x]requiredPattern: masked
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard
Patient.name:name.prefix.extension:prefix-qualifier.value[x]requiredEntityNamePartQualifier
http://hl7.org/fhir/ValueSet/name-part-qualifier|4.0.1
from the FHIR Standard
Patient.name:name.prefix.extension:prefix-qualifier.value[x]:valueCoderequiredFixed Value: AC
http://hl7.org/fhir/ValueSet/name-part-qualifier|4.0.1
from the FHIR Standard
Patient.name:geburtsname.userequiredPattern: maiden
http://hl7.org/fhir/ValueSet/name-use|4.0.1
from the FHIR Standard
Patient.name:geburtsname.prefix.extension:prefix-qualifier.value[x]requiredEntityNamePartQualifier
http://hl7.org/fhir/ValueSet/name-part-qualifier|4.0.1
from the FHIR Standard
Patient.name:geburtsname.prefix.extension:prefix-qualifier.value[x]:valueCoderequiredFixed Value: AC
http://hl7.org/fhir/ValueSet/name-part-qualifier|4.0.1
from the FHIR Standard
Patient.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
Patient.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
from the FHIR Standard
Patient.gender.extension:other-amtlich.value[x]requiredGenderOtherDE
http://fhir.de/ValueSet/gender-other-de
Patient.gender.extension:other-amtlich.value[x]:valueCodingrequiredGenderOtherDE
http://fhir.de/ValueSet/gender-other-de
Patient.birthDate.extension:data-absent-reason.value[x]requiredDataAbsentReason
http://hl7.org/fhir/ValueSet/data-absent-reason|4.0.1
from the FHIR Standard
Patient.birthDate.extension:data-absent-reason.value[x]:valueCoderequiredFixed Value: unknown
http://hl7.org/fhir/ValueSet/data-absent-reason|4.0.1
from the FHIR Standard
Patient.address:Strassenanschrift.typerequiredPattern: both
http://hl7.org/fhir/ValueSet/address-type|4.0.1
from the FHIR Standard
Patient.address:Postfach.typerequiredPattern: postal
http://hl7.org/fhir/ValueSet/address-type|4.0.1
from the FHIR Standard
Patient.communication.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Patient.link.typerequiredLinkType
http://hl7.org/fhir/ValueSet/link-type|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorPatientIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorPatientIf 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-4errorPatientIf 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-5errorPatientIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practicePatientA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** elementsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
gender-amtlich-1errorPatient.gender.extension:other-amtlich.value[x], Patient.gender.extension:other-amtlich.value[x]:valueCodingDie amtliche Differenzierung der Geschlechtsangabe 'other' darf nur gefüllt sein, wenn das Geschlecht 'other' angegeben ist
: %resource.where(gender='other').exists()
hum-1errorPatient.name:nameWenn 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-2errorPatient.name:nameWenn 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-3errorPatient.name:nameWenn 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-4errorPatient.name:nameWenn 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())
kvk-1errorPatient.identifier:versichertennummer_kvk.valueDie Krankenversichertenkartenummer muss numerisch und 6- bis 12-stellig sein.
: matches('^[0-9]{6,12}$')
kvid-1warningPatient.identifier:versichertenId_GKV.valueDer unveränderliche Teil der KVID muss 10-stellig sein und mit einem Großbuchstaben anfangen
: matches('^[A-Z][0-9]{9}$')
pat-de-1errorPatientDie 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()
pkvid-1warningPatient.identifier:versichertenId_PKV.valueDer unveränderliche Teil der PKVID muss 10-stellig sein und mit einem Großbuchstaben anfangen
: matches('^[A-Z][0-9]{9}$')
ref-1errorPatient.identifier:versichertennummer_pkv.assigner, Patient.contact.organization, Patient.link.otherSHALL 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'))

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient C 0..* KBV_PR_MIO_ULB_Patient Information about an individual or animal receiving health care services
pat-de-1: Die amtliche Differenzierung der Geschlechtsangabe 'other' darf nur gefüllt sein, wenn das Geschlecht 'other' angegeben ist
... id Σ 0..1 id Logical id of this artifact
... meta Σ 1..1 Meta Metadata about the resource
.... id 0..1 string Unique id for inter-element referencing
.... extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... profile Σ 1..1 canonical(StructureDefinition) Profiles this resource claims to conform to

Required Pattern: https://fhir.kbv.de/StructureDefinition/KBV_PR_MIO_ULB_Patient|1.0.0
... text 0..1 Narrative Text summary of the resource, for human interpretation
.... id 0..1 string Unique id for inter-element referencing
.... extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... status 1..1 code generated | extensions | additional | empty
Binding: NarrativeStatus (required): The status of a resource narrative.


Required Pattern: extensions
.... div C 1..1 xhtml Limited xhtml content
txt-1: The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes
txt-2: The narrative SHALL have some non-whitespace content
... modifierExtension ?!N 0..* Extension Extensions that cannot be ignored
Slice: Unordered, Open by value:url
... Slices for identifier SΣN 0..* Identifier An identifier for this patient
Slice: Unordered, Closed by pattern:type, exists:assigner
.... identifier:pid SΣN 0..* IdentifierPid(1.3.2) An identifier intended for computation
..... id 0..1 string Unique id for inter-element referencing
..... extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!ΣN 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type ΣN 1..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.


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://terminology.hl7.org/CodeSystem/v2-0203
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: MR
....... 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
...... id 0..1 string Unique id for inter-element referencing
...... extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... coding ΣN 1..1 Coding Code defined by a terminology system
....... id 0..1 string Unique id for inter-element referencing
....... extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... system ΣN 1..1 uri Identity of the terminology system
....... version ΣN 0..1 string Version of the system - if relevant
....... code ΣN 1..1 code Symbol in syntax defined by the system
....... display ΣN 1..1 string Representation defined by the system
Required Pattern: Medical record number
..... system SΣN 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value SΣN 1..1 string The value that is unique
Example General: 123456
... Slices for name SΣ 1..1 HumanName A name associated with the patient
Slice: Unordered, Closed by value:use
.... name:name SΣC 0..1 KBV_PR_Base_Datatype_Name(1.3.0) Personenname
hum-1: Wenn die Extension 'namenszusatz' verwendet wird, dann muss der vollständige Name im Attribut 'family' angegeben werden
hum-2: Wenn die Extension 'nachname' verwendet wird, dann muss der vollständige Name im Attribut 'family' angegeben werden
hum-3: Wenn die Extension 'vorsatzwort' verwendet wird, dann muss der vollständige Name im Attribut 'family' angegeben werden
hum-4: Wenn die Extension 'prefix-qualifier' verwendet wird, dann muss ein Namenspräfix im Attribut 'prefix' angegeben werden
..... id 0..1 string Unique id for inter-element referencing
..... extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 1..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.


Required Pattern: official
..... family SΣ 1..1 string Familienname
...... id 0..1 string Unique id for inter-element referencing
...... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
....... data-absent-reason S 1..1 (Complex) masked for pseudonymization
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
........ id 0..1 id Unique id for inter-element referencing
........ extension 0..0
........ url 1..1 uri "http://hl7.org/fhir/StructureDefinition/data-absent-reason"
........ value[x] 1..1 code Value of extension
Binding: DataAbsentReason (required)
Required Pattern: masked
... 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 Unique id for inter-element referencing
.... Slices for extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... other-amtlich SN 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 N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... url 1..1 uri "http://fhir.de/StructureDefinition/gender-amtlich-de"
...... Slices for value[x] SCN 1..1 Coding Value of extension
Slice: Unordered, Closed by type:$this
Binding: GenderOtherDE (required)
gender-amtlich-1: Die amtliche Differenzierung der Geschlechtsangabe 'other' darf nur gefüllt sein, wenn das Geschlecht 'other' angegeben ist
....... value[x]:valueCoding SCN 1..1 Coding Value of extension
Binding: GenderOtherDE (required)
gender-amtlich-1: Die amtliche Differenzierung der Geschlechtsangabe 'other' darf nur gefüllt sein, wenn das Geschlecht 'other' angegeben ist
........ id 0..1 string Unique id for inter-element referencing
........ extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ system ΣN 0..1 uri Identity of the terminology system
........ version ΣN 0..1 string Version of the system - if relevant
........ code ΣN 0..1 code Symbol in syntax defined by the system
........ display ΣN 0..1 string Representation defined by the system
.... value 0..1 code Primitive value for code
Max Length: 1048576
... birthDate SΣ 1..1 date The date of birth for the individual
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 1..* Extension Extension
Slice: Unordered, Closed by value:url
..... data-absent-reason SN 0..1 (Complex) unknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
...... id 0..1 string Unique id for inter-element referencing
...... extension N 0..0
...... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/data-absent-reason"
...... Slices for value[x] SN 1..1 code Value of extension
Slice: Unordered, Closed by type:$this
Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.

....... value[x]:valueCode SN 1..1 code Value of extension
Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.


Fixed Value: unknown
..... birth-date-mm-yyyy S 1..1 string BirthDate (MM-YYYY)
URL: http://pflipdemo.com/fhir/StructureDefinition/birthDate-mm-yyyy
.... value 0..1 date Primitive value for date

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Patient.text.statusrequiredPattern: extensions
http://hl7.org/fhir/ValueSet/narrative-status|4.0.1
from the FHIR Standard
Patient.identifier:pid.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Patient.identifier:pid.typeextensiblePattern: MR
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Patient.identifier:versichertenId_GKV.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Patient.identifier:versichertenId_GKV.typeextensiblePattern: GKV
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Patient.identifier:versichertennummer_pkv.userequiredFixed Value: secondary
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Patient.identifier:versichertennummer_pkv.typeextensiblePattern: PKV
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Patient.identifier:versichertennummer_pkv.assigner.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
Patient.identifier:reisepassnummer.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Patient.identifier:reisepassnummer.typeextensiblePattern: PPN
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Patient.identifier:versichertennummer_kvk.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Patient.identifier:versichertennummer_kvk.typeextensiblePattern: kvk
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Patient.identifier:versichertenId_PKV.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Patient.identifier:versichertenId_PKV.typeextensiblePattern: PKV
http://fhir.de/ValueSet/identifier-type-de-basis
Patient.name:name.userequiredPattern: official
http://hl7.org/fhir/ValueSet/name-use|4.0.1
from the FHIR Standard
Patient.name:name.family.extension:data-absent-reason.value[x]requiredPattern: masked
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard
Patient.name:name.prefix.extension:prefix-qualifier.value[x]requiredEntityNamePartQualifier
http://hl7.org/fhir/ValueSet/name-part-qualifier|4.0.1
from the FHIR Standard
Patient.name:name.prefix.extension:prefix-qualifier.value[x]:valueCoderequiredFixed Value: AC
http://hl7.org/fhir/ValueSet/name-part-qualifier|4.0.1
from the FHIR Standard
Patient.name:geburtsname.userequiredPattern: maiden
http://hl7.org/fhir/ValueSet/name-use|4.0.1
from the FHIR Standard
Patient.name:geburtsname.prefix.extension:prefix-qualifier.value[x]requiredEntityNamePartQualifier
http://hl7.org/fhir/ValueSet/name-part-qualifier|4.0.1
from the FHIR Standard
Patient.name:geburtsname.prefix.extension:prefix-qualifier.value[x]:valueCoderequiredFixed Value: AC
http://hl7.org/fhir/ValueSet/name-part-qualifier|4.0.1
from the FHIR Standard
Patient.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
Patient.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
from the FHIR Standard
Patient.gender.extension:other-amtlich.value[x]requiredGenderOtherDE
http://fhir.de/ValueSet/gender-other-de
Patient.gender.extension:other-amtlich.value[x]:valueCodingrequiredGenderOtherDE
http://fhir.de/ValueSet/gender-other-de
Patient.birthDate.extension:data-absent-reason.value[x]requiredDataAbsentReason
http://hl7.org/fhir/ValueSet/data-absent-reason|4.0.1
from the FHIR Standard
Patient.birthDate.extension:data-absent-reason.value[x]:valueCoderequiredFixed Value: unknown
http://hl7.org/fhir/ValueSet/data-absent-reason|4.0.1
from the FHIR Standard
Patient.address:Strassenanschrift.typerequiredPattern: both
http://hl7.org/fhir/ValueSet/address-type|4.0.1
from the FHIR Standard
Patient.address:Postfach.typerequiredPattern: postal
http://hl7.org/fhir/ValueSet/address-type|4.0.1
from the FHIR Standard
Patient.contact.relationshipextensiblePatientContactRelationship
http://hl7.org/fhir/ValueSet/patient-contactrelationship
from the FHIR Standard
Patient.contact.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
Patient.contact.address.typerequiredAddressType
http://hl7.org/fhir/ValueSet/address-type|4.0.1
from the FHIR Standard
Patient.contact.address.countryextensibleKBV_VS_Base_Deuev_Anlage_8
https://fhir.kbv.de/ValueSet/KBV_VS_Base_Deuev_Anlage_8
Patient.contact.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
from the FHIR Standard
Patient.communication.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Patient.link.typerequiredLinkType
http://hl7.org/fhir/ValueSet/link-type|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
cpt-2errorPatient.contact.telecomA system is required if a value is provided.
: value.empty() or system.exists()
dom-2errorPatientIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorPatientIf 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-4errorPatientIf 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-5errorPatientIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practicePatientA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** elementsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
gender-amtlich-1errorPatient.gender.extension:other-amtlich.value[x], Patient.gender.extension:other-amtlich.value[x]:valueCodingDie amtliche Differenzierung der Geschlechtsangabe 'other' darf nur gefüllt sein, wenn das Geschlecht 'other' angegeben ist
: %resource.where(gender='other').exists()
hum-1errorPatient.name:nameWenn 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-2errorPatient.name:nameWenn 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-3errorPatient.name:nameWenn 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-4errorPatient.name:nameWenn 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())
kvk-1errorPatient.identifier:versichertennummer_kvk.valueDie Krankenversichertenkartenummer muss numerisch und 6- bis 12-stellig sein.
: matches('^[0-9]{6,12}$')
kvid-1warningPatient.identifier:versichertenId_GKV.valueDer unveränderliche Teil der KVID muss 10-stellig sein und mit einem Großbuchstaben anfangen
: matches('^[A-Z][0-9]{9}$')
pat-de-1errorPatientDie 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-1errorPatient.identifier:reisepassnummer.period, Patient.contact.address.period, Patient.contact.periodIf present, start SHALL have a lower value than end
: start.hasValue().not() or end.hasValue().not() or (start <= end)
pkvid-1warningPatient.identifier:versichertenId_PKV.valueDer unveränderliche Teil der PKVID muss 10-stellig sein und mit einem Großbuchstaben anfangen
: matches('^[A-Z][0-9]{9}$')
ref-1errorPatient.identifier:versichertennummer_pkv.assigner, Patient.contact.organization, Patient.link.otherSHALL 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'))
txt-1errorPatient.text.divThe narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes
: htmlChecks()
txt-2errorPatient.text.divThe narrative SHALL have some non-whitespace content
: htmlChecks()

This structure is derived from KBV_PR_MIO_ULB_Patient

Summary

Mandatory: 2 elements(2 nested mandatory elements)
Must-Support: 2 elements
Prohibited: 32 elements

Extensions

This structure refers to these extensions:

 

Other representations of profile: CSV, Excel, Schematron