MII Implementation Guide Core Dataset Base
2026.0.0 - Release Germany

This page is part of the MII Implementation Guide Core Dataset Base (v2026.0.0: Release) based on FHIR (HL7® FHIR® Standard) R4. The current version which supersedes this version is 2026.0.1. For a full list of available versions, see the Directory of published versions

Resource Profile: MII PR Person Patient (Pseudonymisiert)

Official URL: https://www.medizininformatik-initiative.de/fhir/core/modul-person/StructureDefinition/PatientPseudonymisiert Version: 2026.0.0
Computable Name: MII_PR_Person_PatientPseudonymisiert

Demographics and other administrative information about a patient.

Example Usage Scenarios:

  • Provide pseudonymized patient data for secondary use in research contexts while protecting patient identity
  • Support federated analyses across multiple MII sites without exposing identifying patient information
  • Enable health insurance-based analyses (e.g., NUM-CON-MON use case) using IK numbers without revealing individual insurance IDs
  • Maintain coarse demographic granularity for research cohort formation while preventing re-identification
⚠️ Important: Pseudonymization Validation Limitations

This profile does not contain rules to validate correct pseudonymization. Successful validation against this profile does not guarantee that technically or legally compliant pseudonymization has been performed.

Pseudonymization requirements vary by project context and cannot be fully represented in a single FHIR profile. For comprehensive pseudonymization guidance, consult the MII Pseudonymization Interface.

Profile Specific Implementation Guidance

This section provides detailed implementation guidance for the MII Pseudonymized Patient Profile.

Pseudonymization Identifiers

The pseudonymized patient profile uses specialized identifier types:

  • Patient.identifier:pseudonymisierterIdentifier: Pseudonymized identifier for the patient
    • MUST be appropriately typed if the identifier is a derived pseudonym
    • Use when the identifier can be linked back to the original patient data through a controlled process
    • Typically used in research scenarios where de-pseudonymization may be necessary for specific purposes
  • Patient.identifier:anonymisierterIdentifier: Anonymized identifier for the patient
    • SHOULD only be used when no inference about the original dataset is possible
    • Represents irreversible anonymization where re-identification is not feasible
  • Patient.identifier:maskierterVersichertenIdentifier: Masked health insurance identifier
Best Practice - Masked Insurance ID with IK Number

For use cases requiring health insurance analysis (e.g., NUM-CON-MON), it is necessary to include the IK number (Institutionskennzeichen) of the health insurance provider in the pseudonymized patient profile without exposing the actual insurance ID.

This is achieved by:

  1. Creating an Identifier with type KVZ10 (10-digit health insurance ID)
  2. Replacing the Identifier.value element with the [Data Absent Reason] extension using code masked
  3. Providing the IK number of the health insurance provider in Identifier.assigner.identifier

See the example resource for this modeling approach.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description Differentials, Snapshots, and other representations.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient C 0..* Patient Information about an individual or animal receiving health care services
Constraints: mii-pat-1
... id SΣ 0..1 id Logical id of this artifact
... meta SΣ 0..1 Meta Metadata about the resource
.... profile SΣ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for identifier SΣ 1..* Identifier Patienten-Identifikator
Slice: Unordered, Open by pattern:$this
.... identifier:PseudonymisierterIdentifier SΣ 0..* Identifier Pseudonymisierter Identifikator

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 1..1 CodeableConcept Description of identifier
Fixed Value: (Complex)
...... 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/v3-ObservationValue
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: PSEUDED
....... 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 0..1 uri The namespace for the identifier value
..... 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)
.... identifier:AnonymisierterIdentifier SΣ 0..* Identifier Anonymisierter Identifikator

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 1..1 CodeableConcept Description of identifier
Fixed Value: (Complex)
...... 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/v3-ObservationValue
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: ANONYED
....... 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 0..1 uri The namespace for the identifier value
..... 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)
.... identifier:MaskierterVersichertenIdentifer SΣC 0..1 IdentifierKvid10 Maskierter Identifier der Krankenversicherten-ID
Constraints: ide-masked-1

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 1..1 CodeableConcept Description of identifier
Fixed Value: (Complex)
...... 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 0..1 uri The namespace for the identifier value
..... 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 SΣC 1..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 extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:data-absent-reason S 0..1 (Complex) unknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
........ extension 0..0 Extension
Slice: Unordered, Open by value:url
........ 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
..... assigner SΣ 1..1 Reference(Organization) Organization that issued id (may be just text)
...... identifier SΣ 1..1 IdentifierIknr Logical reference, when literal reference is not known
....... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
....... type SΣ 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.
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: XX
......... 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/arge-ik/iknr
....... value SΣC 1..1 string The value that is unique
Constraints: ik-1
Example General: 123456
... active ?!SΣ 0..1 boolean Aktiv
... gender SΣ 0..1 code Administratives Geschlecht
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:other-amtlich S 0..1 Coding Extension Administratives Geschlecht
URL: http://fhir.de/StructureDefinition/gender-amtlich-de
Binding: GenderOtherDE ValueSet (required)
Constraints: ext-1
... birthDate SΣ 0..1 date Geburtsdatum
... deceased[x] ?!Σ 0..1 Indicates if the individual is deceased or not
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
... Slices for address SΣ 0..* Address Adresse
Slice: Unordered, Open by pattern:$this
.... address:Strassenanschrift SΣC 0..* AddressDeBasis Straßenanschrift
Constraints: pat-cnt-2or3-char

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 home | work | temp | old | billing - purpose of this address
..... type 1..1 code postal | physical | both
Fixed Value: both
..... text 0..1 string Text representation of the address
..... line 0..* string Street name, number, direction & P.O. Box etc.
..... city 0..1 string Name of city, town etc.
..... district 0..1 string District name (aka county)
..... state 0..1 string Sub-unit of country (abbreviations ok)
..... postalCode 0..1 string Postal code for area
..... country 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
..... period 0..1 Period Time period when address was/is in use
..... Slices for extension Content/Rules for all slices
...... extension:Stadtteil 0..1 string Stadt- oder Ortsteil
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-precinct
..... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.
Example General: home
..... type SΣ 1..1 code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).
Example General: both
..... line Σ 0..3 string Straßenname mit Hausnummer oder Postfach sowie weitere Angaben zur Zustellung
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
Example Beipiel für Adresszeile mit Extensions für Straße und Hausnummer: Musterweg 42
...... Slices for extension Content/Rules for all slices
....... extension:Strasse 0..1 string Strassenname (ohne Hausnummer)
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName
....... extension:Hausnummer 0..1 string Hausnummer
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber
....... extension:Adresszusatz 0..1 string Adresszusatz
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator
....... extension:Postfach 0..1 string Postfach
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox
..... city Σ 0..1 string Name of city, town etc.
Example General: Erewhon
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:gemeindeschluessel S 0..1 Coding Optional Extensions Element
URL: http://fhir.de/StructureDefinition/destatis/ags
Constraints: ext-1
..... postalCode SΣ 1..1 string Postleitzahl
Example General: 9132
..... country SΣ 1..1 string Staat
Binding: Iso3166-1-2 (preferred)
... 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 Σ 1..1 Reference(Patient | RelatedPerson) The other patient or related person resource that the link refers to
.... 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:MaskierterVersichertenIdentifer.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:MaskierterVersichertenIdentifer.​type Base extensible Identifier Type DeBasis ValueSet 📦1.5.4 de.basisprofil.r4 v1.5
Patient.identifier:MaskierterVersichertenIdentifer.​value.extension:data-absent-reason.​value[x] Base required DataAbsentReason 📦4.0.1 FHIR Std.
Patient.identifier:MaskierterVersichertenIdentifer.​assigner.identifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:MaskierterVersichertenIdentifer.​assigner.identifier.​type Base extensible Identifier Type DeBasis ValueSet 📦1.5.4 de.basisprofil.r4 v1.5
Patient.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
Patient.address:Strassenanschrift.​use Base required AddressUse 📍4.0.1 FHIR Std.
Patient.address:Strassenanschrift.​type Base required AddressType 📍4.0.1 FHIR Std.
Patient.address:Strassenanschrift.​country Base preferred Iso 3166 Part 1: 2 Letter Codes 📦4.0.1 FHIR Std.
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()
ik-1 warning Patient.identifier:MaskierterVersichertenIdentifer.assigner.identifier.value Eine IK muss eine numerische 9-stellige Zeichenkette (mit Prüfziffer) sein matches('^[0-9]{9}$')
ide-masked-1 warning Patient.identifier:MaskierterVersichertenIdentifer Identifier.value SOLLTE keinen Wert und SOLLTE die Extension Data Absent Reason mit Code 'masked' enthalten. value.hasValue().not() and value.extension.where(url='http://hl7.org/fhir/StructureDefinition/data-absent-reason' and value='masked').exists()
kvid-1 warning Patient.identifier:MaskierterVersichertenIdentifer.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:MaskierterVersichertenIdentifer.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()
mii-pat-1 error Patient Falls die Geschlechtsangabe 'other' gewählt wird, muss die amtliche Differenzierung per Extension angegeben werden gender.exists() and gender='other' implies gender.extension('http://fhir.de/StructureDefinition/gender-amtlich-de').exists()
pat-cnt-2or3-char warning Patient.address:Strassenanschrift The content of the country element (if present) SHALL be selected EITHER from ValueSet ISO Country Alpha-2 http://hl7.org/fhir/ValueSet/iso3166-1-2 OR MAY be selected from ISO Country Alpha-3 Value Set http://hl7.org/fhir/ValueSet/iso3166-1-3, IF the country is not specified in value Set ISO Country Alpha-2 http://hl7.org/fhir/ValueSet/iso3166-1-2. country.empty() or (country.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-2') or country.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-3'))

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient C 0..* Patient Information about an individual or animal receiving health care services
Constraints: mii-pat-1
... id S 0..1 id Logical id of this artifact
... meta S 0..1 Meta Metadata about the resource
.... profile S 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
... Slices for identifier S 1..* Identifier Patienten-Identifikator
Slice: Unordered, Open by pattern:$this
.... identifier:PseudonymisierterIdentifier S 0..* Identifier Pseudonymisierter Identifikator

Required Pattern: At least the following
..... type 1..1 CodeableConcept Description of identifier
Fixed Value: (Complex)
...... 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/v3-ObservationValue
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: PSEUDED
.... identifier:AnonymisierterIdentifier S 0..* Identifier Anonymisierter Identifikator

Required Pattern: At least the following
..... type 1..1 CodeableConcept Description of identifier
Fixed Value: (Complex)
...... 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/v3-ObservationValue
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: ANONYED
.... identifier:MaskierterVersichertenIdentifer SC 0..1 IdentifierKvid10 Maskierter Identifier der Krankenversicherten-ID
Constraints: ide-masked-1
Required Pattern: At least the following
..... type 1..1 CodeableConcept Description of identifier
Fixed Value: (Complex)
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://fhir.de/CodeSystem/identifier-type-de-basis
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: KVZ10
..... type S 1..1 CodeableConcept Description of identifier
..... system S 1..1 uri The namespace for the identifier value
..... value S 1..1 string The value that is unique
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:data-absent-reason S 0..1 (Complex) unknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
........ value[x] 1..1 code Value of extension
Required Pattern: masked
..... assigner S 1..1 Reference(Organization) Organization that issued id (may be just text)
...... identifier S 1..1 IdentifierIknr Logical reference, when literal reference is not known
....... type S 0..1 CodeableConcept Description of identifier
....... system S 1..1 uri The namespace for the identifier value
....... value S 1..1 string The value that is unique
... gender S 0..1 code Administratives Geschlecht
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:other-amtlich S 0..1 Coding Extension Administratives Geschlecht
URL: http://fhir.de/StructureDefinition/gender-amtlich-de
Binding: GenderOtherDE ValueSet (required)
... birthDate S 0..1 date Geburtsdatum
... Slices for address S 0..* Address Adresse
Slice: Unordered, Open by pattern:$this
.... address:Strassenanschrift SC 0..* AddressDeBasis Straßenanschrift
Constraints: pat-cnt-2or3-char

Required Pattern: At least the following
..... type 1..1 code postal | physical | both
Fixed Value: both
..... type S 1..1 code postal | physical | both
..... city
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:gemeindeschluessel S 0..1 Coding Optional Extensions Element
URL: http://fhir.de/StructureDefinition/destatis/ags
..... postalCode S 1..1 string Postleitzahl
..... country S 1..1 string Staat

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
ide-masked-1 warning Patient.identifier:MaskierterVersichertenIdentifer Identifier.value SOLLTE keinen Wert und SOLLTE die Extension Data Absent Reason mit Code 'masked' enthalten. value.hasValue().not() and value.extension.where(url='http://hl7.org/fhir/StructureDefinition/data-absent-reason' and value='masked').exists()
mii-pat-1 error Patient Falls die Geschlechtsangabe 'other' gewählt wird, muss die amtliche Differenzierung per Extension angegeben werden gender.exists() and gender='other' implies gender.extension('http://fhir.de/StructureDefinition/gender-amtlich-de').exists()
pat-cnt-2or3-char warning Patient.address:Strassenanschrift The content of the country element (if present) SHALL be selected EITHER from ValueSet ISO Country Alpha-2 http://hl7.org/fhir/ValueSet/iso3166-1-2 OR MAY be selected from ISO Country Alpha-3 Value Set http://hl7.org/fhir/ValueSet/iso3166-1-3, IF the country is not specified in value Set ISO Country Alpha-2 http://hl7.org/fhir/ValueSet/iso3166-1-2. country.empty() or (country.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-2') or country.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-3'))
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient C 0..* Patient Information about an individual or animal receiving health care services
Constraints: mii-pat-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 Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile SΣ 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
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier SΣ 1..* Identifier Patienten-Identifikator
Slice: Unordered, Open by pattern:$this
.... identifier:PseudonymisierterIdentifier SΣ 0..* Identifier Pseudonymisierter Identifikator

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 1..1 CodeableConcept Description of identifier
Fixed Value: (Complex)
...... 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/v3-ObservationValue
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: PSEUDED
....... 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 0..1 uri The namespace for the identifier value
..... 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)
.... identifier:AnonymisierterIdentifier SΣ 0..* Identifier Anonymisierter Identifikator

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 1..1 CodeableConcept Description of identifier
Fixed Value: (Complex)
...... 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/v3-ObservationValue
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: ANONYED
....... 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 0..1 uri The namespace for the identifier value
..... 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)
.... identifier:MaskierterVersichertenIdentifer SΣC 0..1 IdentifierKvid10 Maskierter Identifier der Krankenversicherten-ID
Constraints: ide-masked-1

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 1..1 CodeableConcept Description of identifier
Fixed Value: (Complex)
...... 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 0..1 uri The namespace for the identifier value
..... 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 SΣC 1..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
...... id 0..1 string xml:id (or equivalent in JSON)
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:data-absent-reason S 0..1 (Complex) unknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
........ id 0..1 id Unique id for inter-element referencing
........ extension 0..0 Extension
Slice: Unordered, Open by value:url
........ 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
...... value 0..1 string Primitive value for string
Max Length:1048576
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner SΣ 1..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
...... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
...... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
...... identifier SΣ 1..1 IdentifierIknr Logical reference, when literal reference is not known
....... 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 SΣ 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.
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: XX
......... 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/arge-ik/iknr
....... value SΣC 1..1 string The value that is unique
Constraints: ik-1
Example General: 123456
....... 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)
...... display Σ 0..1 string Text alternative for the resource
... active ?!SΣ 0..1 boolean Aktiv
... name Σ 0..* HumanName A name associated with the patient
... telecom Σ 0..* ContactPoint A contact detail for the individual
... gender SΣ 0..1 code Administratives Geschlecht
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 Extension
Slice: Unordered, Open by value:url
..... extension:other-amtlich S 0..1 Coding Extension Administratives Geschlecht
URL: http://fhir.de/StructureDefinition/gender-amtlich-de
Binding: GenderOtherDE ValueSet (required)
Constraints: ext-1
.... value 0..1 string Primitive value for code
... birthDate SΣ 0..1 date Geburtsdatum
... deceased[x] ?!Σ 0..1 Indicates if the individual is deceased or not
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
... Slices for address SΣ 0..* Address Adresse
Slice: Unordered, Open by pattern:$this
.... address:Strassenanschrift SΣC 0..* AddressDeBasis Straßenanschrift
Constraints: pat-cnt-2or3-char

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 home | work | temp | old | billing - purpose of this address
..... type 1..1 code postal | physical | both
Fixed Value: both
..... text 0..1 string Text representation of the address
..... line 0..* string Street name, number, direction & P.O. Box etc.
..... city 0..1 string Name of city, town etc.
..... district 0..1 string District name (aka county)
..... state 0..1 string Sub-unit of country (abbreviations ok)
..... postalCode 0..1 string Postal code for area
..... country 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
..... period 0..1 Period Time period when address was/is in use
..... 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:Stadtteil 0..1 string Stadt- oder Ortsteil
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-precinct
..... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.
Example General: home
..... type SΣ 1..1 code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).
Example General: both
..... text Σ 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
..... line Σ 0..3 string Straßenname mit Hausnummer oder Postfach sowie weitere Angaben zur Zustellung
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
Example Beipiel für Adresszeile mit Extensions für Straße und Hausnummer: Musterweg 42
...... 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:Strasse 0..1 string Strassenname (ohne Hausnummer)
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName
....... extension:Hausnummer 0..1 string Hausnummer
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber
....... extension:Adresszusatz 0..1 string Adresszusatz
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator
....... extension:Postfach 0..1 string Postfach
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox
...... value 0..1 string Primitive value for string
Max Length:1048576
..... city Σ 0..1 string Name of city, town etc.
Example General: Erewhon
...... id 0..1 string xml:id (or equivalent in JSON)
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:gemeindeschluessel S 0..1 Coding Optional Extensions Element
URL: http://fhir.de/StructureDefinition/destatis/ags
Constraints: ext-1
...... value 0..1 string Primitive value for string
Max Length:1048576
..... state Σ 0..1 string Bundesland
Binding: ISO-3166-2:de-Laendercodes (preferred)
..... postalCode SΣ 1..1 string Postleitzahl
Example General: 9132
..... country SΣ 1..1 string Staat
Binding: Iso3166-1-2 (preferred)
..... period Σ 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... 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 0..* Attachment Image of the patient
... 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
.... 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 0..* ContactPoint A contact detail for the person
.... 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
.... period 0..1 Period The period during which this contact person or organization is valid to be contacted relating to this patient
... 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
.... 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 0..* Reference(Organization | Practitioner | PractitionerRole) Patient's nominated primary care provider
... managingOrganization Σ 0..1 Reference(Organization) Organization that is the custodian of the patient record
... 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
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... other Σ 1..1 Reference(Patient | RelatedPerson) The other patient or related person resource that the link refers to
.... 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:MaskierterVersichertenIdentifer.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:MaskierterVersichertenIdentifer.​type Base extensible Identifier Type DeBasis ValueSet 📦1.5.4 de.basisprofil.r4 v1.5
Patient.identifier:MaskierterVersichertenIdentifer.​value.extension:data-absent-reason.​value[x] Base required DataAbsentReason 📦4.0.1 FHIR Std.
Patient.identifier:MaskierterVersichertenIdentifer.​assigner.type Base extensible ResourceType 📍4.0.1 FHIR Std.
Patient.identifier:MaskierterVersichertenIdentifer.​assigner.identifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:MaskierterVersichertenIdentifer.​assigner.identifier.​type Base extensible Identifier Type DeBasis ValueSet 📦1.5.4 de.basisprofil.r4 v1.5
Patient.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
Patient.address:Strassenanschrift.​use Base required AddressUse 📍4.0.1 FHIR Std.
Patient.address:Strassenanschrift.​type Base required AddressType 📍4.0.1 FHIR Std.
Patient.address:Strassenanschrift.​state Base preferred ISO-3166-2:de-Laendercodes 📦1.5.4 de.basisprofil.r4 v1.5
Patient.address:Strassenanschrift.​country Base preferred Iso 3166 Part 1: 2 Letter Codes 📦4.0.1 FHIR Std.
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
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()
ik-1 warning Patient.identifier:MaskierterVersichertenIdentifer.assigner.identifier.value Eine IK muss eine numerische 9-stellige Zeichenkette (mit Prüfziffer) sein matches('^[0-9]{9}$')
ide-masked-1 warning Patient.identifier:MaskierterVersichertenIdentifer Identifier.value SOLLTE keinen Wert und SOLLTE die Extension Data Absent Reason mit Code 'masked' enthalten. value.hasValue().not() and value.extension.where(url='http://hl7.org/fhir/StructureDefinition/data-absent-reason' and value='masked').exists()
kvid-1 warning Patient.identifier:MaskierterVersichertenIdentifer.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:MaskierterVersichertenIdentifer.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()
mii-pat-1 error Patient Falls die Geschlechtsangabe 'other' gewählt wird, muss die amtliche Differenzierung per Extension angegeben werden gender.exists() and gender='other' implies gender.extension('http://fhir.de/StructureDefinition/gender-amtlich-de').exists()
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-cnt-2or3-char warning Patient.address:Strassenanschrift The content of the country element (if present) SHALL be selected EITHER from ValueSet ISO Country Alpha-2 http://hl7.org/fhir/ValueSet/iso3166-1-2 OR MAY be selected from ISO Country Alpha-3 Value Set http://hl7.org/fhir/ValueSet/iso3166-1-3, IF the country is not specified in value Set ISO Country Alpha-2 http://hl7.org/fhir/ValueSet/iso3166-1-2. country.empty() or (country.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-2') or country.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-3'))

Summary

Mandatory: 1 element(6 nested mandatory elements)
Must-Support: 26 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Patient.identifier
  • The element 1 is sliced based on the value of Patient.address

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient C 0..* Patient Information about an individual or animal receiving health care services
Constraints: mii-pat-1
... id SΣ 0..1 id Logical id of this artifact
... meta SΣ 0..1 Meta Metadata about the resource
.... profile SΣ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for identifier SΣ 1..* Identifier Patienten-Identifikator
Slice: Unordered, Open by pattern:$this
.... identifier:PseudonymisierterIdentifier SΣ 0..* Identifier Pseudonymisierter Identifikator

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 1..1 CodeableConcept Description of identifier
Fixed Value: (Complex)
...... 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/v3-ObservationValue
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: PSEUDED
....... 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 0..1 uri The namespace for the identifier value
..... 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)
.... identifier:AnonymisierterIdentifier SΣ 0..* Identifier Anonymisierter Identifikator

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 1..1 CodeableConcept Description of identifier
Fixed Value: (Complex)
...... 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/v3-ObservationValue
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: ANONYED
....... 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 0..1 uri The namespace for the identifier value
..... 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)
.... identifier:MaskierterVersichertenIdentifer SΣC 0..1 IdentifierKvid10 Maskierter Identifier der Krankenversicherten-ID
Constraints: ide-masked-1

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 1..1 CodeableConcept Description of identifier
Fixed Value: (Complex)
...... 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 0..1 uri The namespace for the identifier value
..... 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 SΣC 1..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 extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:data-absent-reason S 0..1 (Complex) unknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
........ extension 0..0 Extension
Slice: Unordered, Open by value:url
........ 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
..... assigner SΣ 1..1 Reference(Organization) Organization that issued id (may be just text)
...... identifier SΣ 1..1 IdentifierIknr Logical reference, when literal reference is not known
....... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
....... type SΣ 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.
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: XX
......... 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/arge-ik/iknr
....... value SΣC 1..1 string The value that is unique
Constraints: ik-1
Example General: 123456
... active ?!SΣ 0..1 boolean Aktiv
... gender SΣ 0..1 code Administratives Geschlecht
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:other-amtlich S 0..1 Coding Extension Administratives Geschlecht
URL: http://fhir.de/StructureDefinition/gender-amtlich-de
Binding: GenderOtherDE ValueSet (required)
Constraints: ext-1
... birthDate SΣ 0..1 date Geburtsdatum
... deceased[x] ?!Σ 0..1 Indicates if the individual is deceased or not
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
... Slices for address SΣ 0..* Address Adresse
Slice: Unordered, Open by pattern:$this
.... address:Strassenanschrift SΣC 0..* AddressDeBasis Straßenanschrift
Constraints: pat-cnt-2or3-char

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 home | work | temp | old | billing - purpose of this address
..... type 1..1 code postal | physical | both
Fixed Value: both
..... text 0..1 string Text representation of the address
..... line 0..* string Street name, number, direction & P.O. Box etc.
..... city 0..1 string Name of city, town etc.
..... district 0..1 string District name (aka county)
..... state 0..1 string Sub-unit of country (abbreviations ok)
..... postalCode 0..1 string Postal code for area
..... country 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
..... period 0..1 Period Time period when address was/is in use
..... Slices for extension Content/Rules for all slices
...... extension:Stadtteil 0..1 string Stadt- oder Ortsteil
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-precinct
..... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.
Example General: home
..... type SΣ 1..1 code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).
Example General: both
..... line Σ 0..3 string Straßenname mit Hausnummer oder Postfach sowie weitere Angaben zur Zustellung
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
Example Beipiel für Adresszeile mit Extensions für Straße und Hausnummer: Musterweg 42
...... Slices for extension Content/Rules for all slices
....... extension:Strasse 0..1 string Strassenname (ohne Hausnummer)
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName
....... extension:Hausnummer 0..1 string Hausnummer
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber
....... extension:Adresszusatz 0..1 string Adresszusatz
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator
....... extension:Postfach 0..1 string Postfach
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox
..... city Σ 0..1 string Name of city, town etc.
Example General: Erewhon
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:gemeindeschluessel S 0..1 Coding Optional Extensions Element
URL: http://fhir.de/StructureDefinition/destatis/ags
Constraints: ext-1
..... postalCode SΣ 1..1 string Postleitzahl
Example General: 9132
..... country SΣ 1..1 string Staat
Binding: Iso3166-1-2 (preferred)
... 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 Σ 1..1 Reference(Patient | RelatedPerson) The other patient or related person resource that the link refers to
.... 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:MaskierterVersichertenIdentifer.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:MaskierterVersichertenIdentifer.​type Base extensible Identifier Type DeBasis ValueSet 📦1.5.4 de.basisprofil.r4 v1.5
Patient.identifier:MaskierterVersichertenIdentifer.​value.extension:data-absent-reason.​value[x] Base required DataAbsentReason 📦4.0.1 FHIR Std.
Patient.identifier:MaskierterVersichertenIdentifer.​assigner.identifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:MaskierterVersichertenIdentifer.​assigner.identifier.​type Base extensible Identifier Type DeBasis ValueSet 📦1.5.4 de.basisprofil.r4 v1.5
Patient.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
Patient.address:Strassenanschrift.​use Base required AddressUse 📍4.0.1 FHIR Std.
Patient.address:Strassenanschrift.​type Base required AddressType 📍4.0.1 FHIR Std.
Patient.address:Strassenanschrift.​country Base preferred Iso 3166 Part 1: 2 Letter Codes 📦4.0.1 FHIR Std.
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()
ik-1 warning Patient.identifier:MaskierterVersichertenIdentifer.assigner.identifier.value Eine IK muss eine numerische 9-stellige Zeichenkette (mit Prüfziffer) sein matches('^[0-9]{9}$')
ide-masked-1 warning Patient.identifier:MaskierterVersichertenIdentifer Identifier.value SOLLTE keinen Wert und SOLLTE die Extension Data Absent Reason mit Code 'masked' enthalten. value.hasValue().not() and value.extension.where(url='http://hl7.org/fhir/StructureDefinition/data-absent-reason' and value='masked').exists()
kvid-1 warning Patient.identifier:MaskierterVersichertenIdentifer.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:MaskierterVersichertenIdentifer.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()
mii-pat-1 error Patient Falls die Geschlechtsangabe 'other' gewählt wird, muss die amtliche Differenzierung per Extension angegeben werden gender.exists() and gender='other' implies gender.extension('http://fhir.de/StructureDefinition/gender-amtlich-de').exists()
pat-cnt-2or3-char warning Patient.address:Strassenanschrift The content of the country element (if present) SHALL be selected EITHER from ValueSet ISO Country Alpha-2 http://hl7.org/fhir/ValueSet/iso3166-1-2 OR MAY be selected from ISO Country Alpha-3 Value Set http://hl7.org/fhir/ValueSet/iso3166-1-3, IF the country is not specified in value Set ISO Country Alpha-2 http://hl7.org/fhir/ValueSet/iso3166-1-2. country.empty() or (country.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-2') or country.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-3'))

Differential View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient C 0..* Patient Information about an individual or animal receiving health care services
Constraints: mii-pat-1
... id S 0..1 id Logical id of this artifact
... meta S 0..1 Meta Metadata about the resource
.... profile S 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
... Slices for identifier S 1..* Identifier Patienten-Identifikator
Slice: Unordered, Open by pattern:$this
.... identifier:PseudonymisierterIdentifier S 0..* Identifier Pseudonymisierter Identifikator

Required Pattern: At least the following
..... type 1..1 CodeableConcept Description of identifier
Fixed Value: (Complex)
...... 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/v3-ObservationValue
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: PSEUDED
.... identifier:AnonymisierterIdentifier S 0..* Identifier Anonymisierter Identifikator

Required Pattern: At least the following
..... type 1..1 CodeableConcept Description of identifier
Fixed Value: (Complex)
...... 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/v3-ObservationValue
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: ANONYED
.... identifier:MaskierterVersichertenIdentifer SC 0..1 IdentifierKvid10 Maskierter Identifier der Krankenversicherten-ID
Constraints: ide-masked-1
Required Pattern: At least the following
..... type 1..1 CodeableConcept Description of identifier
Fixed Value: (Complex)
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://fhir.de/CodeSystem/identifier-type-de-basis
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: KVZ10
..... type S 1..1 CodeableConcept Description of identifier
..... system S 1..1 uri The namespace for the identifier value
..... value S 1..1 string The value that is unique
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:data-absent-reason S 0..1 (Complex) unknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
........ value[x] 1..1 code Value of extension
Required Pattern: masked
..... assigner S 1..1 Reference(Organization) Organization that issued id (may be just text)
...... identifier S 1..1 IdentifierIknr Logical reference, when literal reference is not known
....... type S 0..1 CodeableConcept Description of identifier
....... system S 1..1 uri The namespace for the identifier value
....... value S 1..1 string The value that is unique
... gender S 0..1 code Administratives Geschlecht
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:other-amtlich S 0..1 Coding Extension Administratives Geschlecht
URL: http://fhir.de/StructureDefinition/gender-amtlich-de
Binding: GenderOtherDE ValueSet (required)
... birthDate S 0..1 date Geburtsdatum
... Slices for address S 0..* Address Adresse
Slice: Unordered, Open by pattern:$this
.... address:Strassenanschrift SC 0..* AddressDeBasis Straßenanschrift
Constraints: pat-cnt-2or3-char

Required Pattern: At least the following
..... type 1..1 code postal | physical | both
Fixed Value: both
..... type S 1..1 code postal | physical | both
..... city
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:gemeindeschluessel S 0..1 Coding Optional Extensions Element
URL: http://fhir.de/StructureDefinition/destatis/ags
..... postalCode S 1..1 string Postleitzahl
..... country S 1..1 string Staat

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
ide-masked-1 warning Patient.identifier:MaskierterVersichertenIdentifer Identifier.value SOLLTE keinen Wert und SOLLTE die Extension Data Absent Reason mit Code 'masked' enthalten. value.hasValue().not() and value.extension.where(url='http://hl7.org/fhir/StructureDefinition/data-absent-reason' and value='masked').exists()
mii-pat-1 error Patient Falls die Geschlechtsangabe 'other' gewählt wird, muss die amtliche Differenzierung per Extension angegeben werden gender.exists() and gender='other' implies gender.extension('http://fhir.de/StructureDefinition/gender-amtlich-de').exists()
pat-cnt-2or3-char warning Patient.address:Strassenanschrift The content of the country element (if present) SHALL be selected EITHER from ValueSet ISO Country Alpha-2 http://hl7.org/fhir/ValueSet/iso3166-1-2 OR MAY be selected from ISO Country Alpha-3 Value Set http://hl7.org/fhir/ValueSet/iso3166-1-3, IF the country is not specified in value Set ISO Country Alpha-2 http://hl7.org/fhir/ValueSet/iso3166-1-2. country.empty() or (country.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-2') or country.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-3'))

Snapshot ViewView

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient C 0..* Patient Information about an individual or animal receiving health care services
Constraints: mii-pat-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 Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile SΣ 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
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier SΣ 1..* Identifier Patienten-Identifikator
Slice: Unordered, Open by pattern:$this
.... identifier:PseudonymisierterIdentifier SΣ 0..* Identifier Pseudonymisierter Identifikator

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 1..1 CodeableConcept Description of identifier
Fixed Value: (Complex)
...... 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/v3-ObservationValue
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: PSEUDED
....... 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 0..1 uri The namespace for the identifier value
..... 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)
.... identifier:AnonymisierterIdentifier SΣ 0..* Identifier Anonymisierter Identifikator

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 1..1 CodeableConcept Description of identifier
Fixed Value: (Complex)
...... 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/v3-ObservationValue
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: ANONYED
....... 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 0..1 uri The namespace for the identifier value
..... 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)
.... identifier:MaskierterVersichertenIdentifer SΣC 0..1 IdentifierKvid10 Maskierter Identifier der Krankenversicherten-ID
Constraints: ide-masked-1

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 1..1 CodeableConcept Description of identifier
Fixed Value: (Complex)
...... 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 0..1 uri The namespace for the identifier value
..... 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 SΣC 1..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
...... id 0..1 string xml:id (or equivalent in JSON)
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:data-absent-reason S 0..1 (Complex) unknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
........ id 0..1 id Unique id for inter-element referencing
........ extension 0..0 Extension
Slice: Unordered, Open by value:url
........ 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
...... value 0..1 string Primitive value for string
Max Length:1048576
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner SΣ 1..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
...... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
...... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
...... identifier SΣ 1..1 IdentifierIknr Logical reference, when literal reference is not known
....... 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 SΣ 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.
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: XX
......... 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/arge-ik/iknr
....... value SΣC 1..1 string The value that is unique
Constraints: ik-1
Example General: 123456
....... 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)
...... display Σ 0..1 string Text alternative for the resource
... active ?!SΣ 0..1 boolean Aktiv
... name Σ 0..* HumanName A name associated with the patient
... telecom Σ 0..* ContactPoint A contact detail for the individual
... gender SΣ 0..1 code Administratives Geschlecht
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 Extension
Slice: Unordered, Open by value:url
..... extension:other-amtlich S 0..1 Coding Extension Administratives Geschlecht
URL: http://fhir.de/StructureDefinition/gender-amtlich-de
Binding: GenderOtherDE ValueSet (required)
Constraints: ext-1
.... value 0..1 string Primitive value for code
... birthDate SΣ 0..1 date Geburtsdatum
... deceased[x] ?!Σ 0..1 Indicates if the individual is deceased or not
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
... Slices for address SΣ 0..* Address Adresse
Slice: Unordered, Open by pattern:$this
.... address:Strassenanschrift SΣC 0..* AddressDeBasis Straßenanschrift
Constraints: pat-cnt-2or3-char

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 home | work | temp | old | billing - purpose of this address
..... type 1..1 code postal | physical | both
Fixed Value: both
..... text 0..1 string Text representation of the address
..... line 0..* string Street name, number, direction & P.O. Box etc.
..... city 0..1 string Name of city, town etc.
..... district 0..1 string District name (aka county)
..... state 0..1 string Sub-unit of country (abbreviations ok)
..... postalCode 0..1 string Postal code for area
..... country 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
..... period 0..1 Period Time period when address was/is in use
..... 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:Stadtteil 0..1 string Stadt- oder Ortsteil
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-precinct
..... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.
Example General: home
..... type SΣ 1..1 code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).
Example General: both
..... text Σ 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
..... line Σ 0..3 string Straßenname mit Hausnummer oder Postfach sowie weitere Angaben zur Zustellung
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
Example Beipiel für Adresszeile mit Extensions für Straße und Hausnummer: Musterweg 42
...... 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:Strasse 0..1 string Strassenname (ohne Hausnummer)
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName
....... extension:Hausnummer 0..1 string Hausnummer
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber
....... extension:Adresszusatz 0..1 string Adresszusatz
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator
....... extension:Postfach 0..1 string Postfach
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox
...... value 0..1 string Primitive value for string
Max Length:1048576
..... city Σ 0..1 string Name of city, town etc.
Example General: Erewhon
...... id 0..1 string xml:id (or equivalent in JSON)
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:gemeindeschluessel S 0..1 Coding Optional Extensions Element
URL: http://fhir.de/StructureDefinition/destatis/ags
Constraints: ext-1
...... value 0..1 string Primitive value for string
Max Length:1048576
..... state Σ 0..1 string Bundesland
Binding: ISO-3166-2:de-Laendercodes (preferred)
..... postalCode SΣ 1..1 string Postleitzahl
Example General: 9132
..... country SΣ 1..1 string Staat
Binding: Iso3166-1-2 (preferred)
..... period Σ 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... 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 0..* Attachment Image of the patient
... 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
.... 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 0..* ContactPoint A contact detail for the person
.... 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
.... period 0..1 Period The period during which this contact person or organization is valid to be contacted relating to this patient
... 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
.... 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 0..* Reference(Organization | Practitioner | PractitionerRole) Patient's nominated primary care provider
... managingOrganization Σ 0..1 Reference(Organization) Organization that is the custodian of the patient record
... 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
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... other Σ 1..1 Reference(Patient | RelatedPerson) The other patient or related person resource that the link refers to
.... 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:MaskierterVersichertenIdentifer.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:MaskierterVersichertenIdentifer.​type Base extensible Identifier Type DeBasis ValueSet 📦1.5.4 de.basisprofil.r4 v1.5
Patient.identifier:MaskierterVersichertenIdentifer.​value.extension:data-absent-reason.​value[x] Base required DataAbsentReason 📦4.0.1 FHIR Std.
Patient.identifier:MaskierterVersichertenIdentifer.​assigner.type Base extensible ResourceType 📍4.0.1 FHIR Std.
Patient.identifier:MaskierterVersichertenIdentifer.​assigner.identifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:MaskierterVersichertenIdentifer.​assigner.identifier.​type Base extensible Identifier Type DeBasis ValueSet 📦1.5.4 de.basisprofil.r4 v1.5
Patient.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
Patient.address:Strassenanschrift.​use Base required AddressUse 📍4.0.1 FHIR Std.
Patient.address:Strassenanschrift.​type Base required AddressType 📍4.0.1 FHIR Std.
Patient.address:Strassenanschrift.​state Base preferred ISO-3166-2:de-Laendercodes 📦1.5.4 de.basisprofil.r4 v1.5
Patient.address:Strassenanschrift.​country Base preferred Iso 3166 Part 1: 2 Letter Codes 📦4.0.1 FHIR Std.
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
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()
ik-1 warning Patient.identifier:MaskierterVersichertenIdentifer.assigner.identifier.value Eine IK muss eine numerische 9-stellige Zeichenkette (mit Prüfziffer) sein matches('^[0-9]{9}$')
ide-masked-1 warning Patient.identifier:MaskierterVersichertenIdentifer Identifier.value SOLLTE keinen Wert und SOLLTE die Extension Data Absent Reason mit Code 'masked' enthalten. value.hasValue().not() and value.extension.where(url='http://hl7.org/fhir/StructureDefinition/data-absent-reason' and value='masked').exists()
kvid-1 warning Patient.identifier:MaskierterVersichertenIdentifer.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:MaskierterVersichertenIdentifer.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()
mii-pat-1 error Patient Falls die Geschlechtsangabe 'other' gewählt wird, muss die amtliche Differenzierung per Extension angegeben werden gender.exists() and gender='other' implies gender.extension('http://fhir.de/StructureDefinition/gender-amtlich-de').exists()
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-cnt-2or3-char warning Patient.address:Strassenanschrift The content of the country element (if present) SHALL be selected EITHER from ValueSet ISO Country Alpha-2 http://hl7.org/fhir/ValueSet/iso3166-1-2 OR MAY be selected from ISO Country Alpha-3 Value Set http://hl7.org/fhir/ValueSet/iso3166-1-3, IF the country is not specified in value Set ISO Country Alpha-2 http://hl7.org/fhir/ValueSet/iso3166-1-2. country.empty() or (country.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-2') or country.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-3'))

Summary

Mandatory: 1 element(6 nested mandatory elements)
Must-Support: 26 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Patient.identifier
  • The element 1 is sliced based on the value of Patient.address

 

Other representations of profile: CSV, Excel, Schematron