0.4.0 - ci-build

ONCOnnectTumorboardIG - Local Development build (v0.4.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: Patient (Profile)

Official URL: https://tumorboards-ig.app.ccc-onconnect.de/StructureDefinition/onconnect-pr-tb-patient Version: 0.4.0
Draft as of 2026-05-28 Computable Name: ONCOnnect_PR_TB_Patient

Captures the basic information about a patient.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient C 0..* MII_PR_Person_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Σ 2..* Identifier Identifier
Slice: Unordered, Open by pattern:$this
.... identifier:versichertenId SΣ 1..1 IdentifierKvid10 Health insurance number

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... period 0..1 Period Time period when id is/was valid for use
..... 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
..... assigner SΣC 1..1 Reference(Organization) Organization that issued id (may be just text)
Constraints: ref-1
...... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
...... identifier SΣ 1..1 IdentifierIknr An identifier intended for computation
....... 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
.... identifier:pid SΣ 1..* IdentifierPid Organization-internal patient identifier

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... period 0..1 Period Time period when id is/was valid for use
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type SΣ 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.
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: MR
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... system SΣ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value SΣ 1..1 string The value that is unique
Example General: 123456
..... assigner SΣC 0..1 Reference(Organization) Organization that issued id (may be just text)
Constraints: ref-1
...... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
...... identifier Σ 0..1 Identifier 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 Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Required Pattern: At least the following
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
........ coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
......... id 0..1 string Unique id for inter-element referencing
......... extension 0..* Extension Additional content defined by implementations
......... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
......... version 0..1 string Version of the system - if relevant
......... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 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
... active ?!Σ 0..1 boolean Whether this patient's record is in active use
... Slices for name SΣ 1..* HumanName Name
Slice: Unordered, Open by pattern:$this
.... name:name SΣC 1..1 HumannameDeBasis Person's name
Constraints: hum-1, hum-2, hum-3, hum-4

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... text 0..1 string Text representation of the full name
..... suffix 0..* string Parts that come after the name
..... period 0..1 Period Time period when name was/is in use
..... use ?!SΣ 1..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
Fixed Value: official
..... family SΣ 1..1 string Familienname
...... Slices for extension Content/Rules for all slices
....... extension:namenszusatz S 0..1 string Namenszusatz gemäß VSDM (Versichertenstammdatenmanagement, "eGK")
URL: http://fhir.de/StructureDefinition/humanname-namenszusatz
....... extension:nachname S 0..1 string Nachname ohne Vor- und Zusätze
URL: http://hl7.org/fhir/StructureDefinition/humanname-own-name
....... extension:vorsatzwort S 0..1 string Vorsatzwort
URL: http://hl7.org/fhir/StructureDefinition/humanname-own-prefix
..... given SΣ 1..* string Vorname
This repeating element order: Given Names appear in the correct order for presenting the name
..... prefix SΣ 0..* string Namensteile vor dem Vornamen
This repeating element order: Prefixes appear in the correct order for presenting the name
...... Slices for extension Content/Rules for all slices
....... extension:prefix-qualifier S 0..1 code LS | AC | NB | PR | HON | BR | AD | SP | MID | CL | IN | VV
URL: http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier
Binding: EntityNamePartQualifier (required)
.... name:geburtsname SΣC 0..1 HumannameDeBasis Maiden name
Constraints: hum-1, hum-2, hum-3, hum-4

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... text 0..1 string Text representation of the full name
..... suffix 0..* string Parts that come after the name
..... period 0..1 Period Time period when name was/is in use
..... use ?!SΣ 1..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
Fixed Value: maiden
..... family SΣ 1..1 string Familienname
...... Slices for extension Content/Rules for all slices
....... extension:namenszusatz S 0..1 string Namenszusatz gemäß VSDM (Versichertenstammdatenmanagement, "eGK")
URL: http://fhir.de/StructureDefinition/humanname-namenszusatz
....... extension:nachname S 0..1 string Nachname ohne Vor- und Zusätze
URL: http://hl7.org/fhir/StructureDefinition/humanname-own-name
....... extension:vorsatzwort S 0..1 string Vorsatzwort
URL: http://hl7.org/fhir/StructureDefinition/humanname-own-prefix
... gender SΣ 0..1 code Administrative gender
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
.... Slices for extension Content/Rules for all slices
..... extension:other-amtlich S 0..1 Coding Extension administrative gender
URL: http://fhir.de/StructureDefinition/gender-amtlich-de
Binding: GenderOtherDE ValueSet (required)
... birthDate SΣ 1..1 date Date of birth
.... Slices for extension Content/Rules for all slices
..... extension:data-absent-reason S 0..1 code unknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
... deceased[x] ?!SΣ 0..1 Deceased
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
... Slices for address SΣ 0..* Address Address
Slice: Unordered, Open by pattern:$this
.... address:Strassenanschrift SΣC 0..* AddressDeBasis Street address
Constraints: add-1, add-2, add-3, add-4, add-5, add-6, add-7, 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
..... text 0..1 string Text representation of the address
..... state 0..1 string Sub-unit of country (abbreviations ok)
..... period 0..1 Period Time period when address was/is in use
..... Slices for extension Content/Rules for all slices
...... extension:Stadtteil S 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).
Fixed Value: both
..... line SΣ 1..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 S 0..1 string Strassenname (ohne Hausnummer)
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName
....... extension:Hausnummer S 0..1 string Hausnummer
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber
....... extension:Adresszusatz S 0..1 string Adresszusatz
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator
..... city SΣ 1..1 string Name of city, town etc.
Example General: Erewhon
...... Slices for extension Content/Rules for all slices
....... extension:gemeindeschluessel S 0..1 Coding Optional Extensions Element
URL: http://fhir.de/StructureDefinition/destatis/ags
..... postalCode SΣ 1..1 string Postleitzahl
Example General: 9132
..... country SΣ 1..1 string Staat
Binding: Iso3166-1-2 (preferred)
.... address:Postfach SΣC 0..* AddressDeBasis Postbox
Constraints: add-1, add-2, add-3, add-4, add-5, add-6, add-7, 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
..... text 0..1 string Text representation of the address
..... state 0..1 string Sub-unit of country (abbreviations ok)
..... period 0..1 Period Time period when address was/is in use
..... Slices for extension Content/Rules for all slices
...... extension:Stadtteil S 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).
Fixed Value: postal
..... line SΣ 1..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:Postfach S 0..1 string Postfach
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox
..... city SΣ 1..1 string Name of city, town etc.
Example General: Erewhon
...... Slices for extension Content/Rules for all slices
....... extension:gemeindeschluessel S 0..1 Coding Optional Extensions Element
URL: http://fhir.de/StructureDefinition/destatis/ags
..... postalCode SΣ 1..1 string Postleitzahl
Example General: 9132
..... country SΣ 1..1 string Staat
Binding: Iso3166-1-2 (preferred)
... link ?!SΣ 0..* BackboneElement Link
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... other SΣC 1..1 Reference(Patient | RelatedPerson) The other patient or related person resource that the link refers to
Constraints: ref-1
.... type SΣ 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:versichertenId.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:versichertenId.​type Base extensible Identifier Type DeBasis ValueSet 📦1.5.4 de.basisprofil.r4 v1.5
Patient.identifier:versichertenId.​assigner.identifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:versichertenId.​assigner.identifier.​type Base extensible Identifier Type DeBasis ValueSet 📦1.5.4 de.basisprofil.r4 v1.5
Patient.identifier:pid.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:pid.​type Base extensible Identifier Type DeBasis ValueSet 📦1.5.4 de.basisprofil.r4 v1.5
Patient.identifier:pid.​assigner.identifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:pid.​assigner.identifier.​type Base extensible IdentifierType 📦4.0.1 FHIR Std.
Patient.name:name.use Base required NameUse 📍4.0.1 FHIR Std.
Patient.name:geburtsname.​use Base required NameUse 📍4.0.1 FHIR Std.
Patient.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
Patient.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.address:Postfach.​use Base required AddressUse 📍4.0.1 FHIR Std.
Patient.address:Postfach.​type Base required AddressType 📍4.0.1 FHIR Std.
Patient.address:Postfach.​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
add-1 error Patient.address:Strassenanschrift, Patient.address:Postfach Wenn die Extension 'Hausnummer' verwendet wird, muss auch Address.line gefüllt werden line.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber').empty() or $this.hasValue())
add-2 error Patient.address:Strassenanschrift, Patient.address:Postfach Wenn die Extension 'Strasse' verwendet wird, muss auch Address.line gefüllt werden line.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName').empty() or $this.hasValue())
add-3 error Patient.address:Strassenanschrift, Patient.address:Postfach Wenn die Extension 'Postfach' verwendet wird, muss auch Address.line gefüllt werden line.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox').empty() or $this.hasValue())
add-4 warning Patient.address:Strassenanschrift, Patient.address:Postfach Eine Postfach-Adresse darf nicht vom Type "physical" oder "both" sein. line.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox').empty() or $this.hasValue()) or type='postal' or type.empty()
add-5 error Patient.address:Strassenanschrift, Patient.address:Postfach Wenn die Extension 'Adresszusatz' verwendet wird, muss auch Address.line gefüllt werden line.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator').empty() or $this.hasValue())
add-6 warning Patient.address:Strassenanschrift, Patient.address:Postfach Wenn die Extension 'Postfach' verwendet wird, dürfen die Extensions 'Strasse' und 'Hausnummer' nicht verwendet werden line.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox').empty() or ($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName').empty() and $this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber').empty()))
add-7 warning Patient.address:Strassenanschrift, Patient.address:Postfach Wenn die Extension 'Precinct' (Stadtteil) verwendet wird, dann muss diese Information auch als separates line-item abgebildet sein. extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-precinct').empty() or all(line contains extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-precinct').value.ofType(string))
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()
hum-1 error Patient.name:name, Patient.name:geburtsname Wenn die Extension 'namenszusatz' verwendet wird, dann muss der vollständige Name im Attribut 'family' angegeben werden family.extension('http://fhir.de/StructureDefinition/humanname-namenszusatz').empty() or family.hasValue()
hum-2 error Patient.name:name, Patient.name:geburtsname Wenn die Extension 'nachname' verwendet wird, dann muss der vollständige Name im Attribut 'family' angegeben werden family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-name').empty() or family.hasValue()
hum-3 error Patient.name:name, Patient.name:geburtsname Wenn die Extension 'vorsatzwort' verwendet wird, dann muss der vollständige Name im Attribut 'family' angegeben werden family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-prefix').empty() or family.hasValue()
hum-4 error Patient.name:name, Patient.name:geburtsname Wenn die Extension 'prefix-qualifier' verwendet wird, dann muss ein Namenspräfix im Attribut 'prefix' angegeben werden prefix.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier').empty() or $this.hasValue())
ik-1 warning Patient.identifier:versichertenId.assigner.identifier.value Eine IK muss eine numerische 9-stellige Zeichenkette (mit Prüfziffer) sein matches('^[0-9]{9}$')
kvid-1 warning Patient.identifier:versichertenId.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:versichertenId.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, Patient.address:Postfach 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'))
ref-1 error Patient.identifier:versichertenId.assigner, Patient.identifier:pid.assigner, Patient.link.other SHALL have a contained resource if a local reference is provided reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

This structure is derived from MII_PR_Person_Patient

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient 0..* MII_PR_Person_Patient Information about an individual or animal receiving health care services
... identifier 2..* Identifier Identifier
... Slices for identifier Content/Rules for all slices
.... identifier:versichertenId 1..1 IdentifierKvid10 Health insurance number
.... identifier:pid 1..* IdentifierPid Organization-internal patient identifier
... name 1..* HumanName Name
.... name:name 1..1 HumannameDeBasis Person's name
... birthDate 1..1 date Date of birth

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient C 0..* MII_PR_Person_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
Slice: Unordered, Open by value:url
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Slice: Unordered, Open by value:url
... Slices for identifier SΣ 2..* Identifier Identifier
Slice: Unordered, Open by pattern:$this
.... identifier:versichertenId SΣ 1..1 IdentifierKvid10 Health insurance number

Required Pattern: At least the following
..... 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
..... period ΣC 0..1 Period Time period when id is/was valid for use
Constraints: per-1
..... assigner SΣC 1..1 Reference(Organization) Organization that issued id (may be just text)
Constraints: ref-1
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... 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 An identifier intended for computation
....... 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 ΣC 0..1 Period Time period when id is/was valid for use
Constraints: per-1
....... assigner ΣC 0..1 Reference(Organization) Organization that issued id (may be just text)
Constraints: ref-1
...... display Σ 0..1 string Text alternative for the resource
.... identifier:pid SΣ 1..* IdentifierPid Organization-internal patient identifier

Required Pattern: At least the following
..... 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Σ 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.
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: MR
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... system SΣ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value SΣ 1..1 string The value that is unique
Example General: 123456
..... period ΣC 0..1 Period Time period when id is/was valid for use
Constraints: per-1
..... assigner SΣC 0..1 Reference(Organization) Organization that issued id (may be just text)
Constraints: ref-1
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... 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 Σ 0..1 Identifier 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 Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Required Pattern: At least the following
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
........ coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
......... id 0..1 string Unique id for inter-element referencing
......... extension 0..* Extension Additional content defined by implementations
......... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
......... version 0..1 string Version of the system - if relevant
......... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 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 ΣC 0..1 uri The namespace for the identifier value
Constraints: mii-pat-2
Example General: http://www.acme.com/identifiers/patient
....... value Σ 0..1 string The value that is unique
Example General: 123456
....... period ΣC 0..1 Period Time period when id is/was valid for use
Constraints: per-1
....... assigner ΣC 0..1 Reference(Organization) Organization that issued id (may be just text)
Constraints: ref-1
...... display Σ 0..1 string Text alternative for the resource
... active ?!Σ 0..1 boolean Whether this patient's record is in active use
... Slices for name SΣ 1..* HumanName Name
Slice: Unordered, Open by pattern:$this
.... name:name SΣC 1..1 HumannameDeBasis Person's name
Constraints: hum-1, hum-2, hum-3, hum-4

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!SΣ 1..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
Fixed Value: official
..... text Σ 0..1 string Text representation of the full name
..... family SΣ 1..1 string Familienname
...... id 0..1 string Unique id for inter-element referencing
...... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... extension:namenszusatz S 0..1 string Namenszusatz gemäß VSDM (Versichertenstammdatenmanagement, "eGK")
URL: http://fhir.de/StructureDefinition/humanname-namenszusatz
....... extension:nachname S 0..1 string Nachname ohne Vor- und Zusätze
URL: http://hl7.org/fhir/StructureDefinition/humanname-own-name
....... extension:vorsatzwort S 0..1 string Vorsatzwort
URL: http://hl7.org/fhir/StructureDefinition/humanname-own-prefix
...... value 0..1 string Primitive value for string
Max Length:1048576
..... given SΣ 1..* string Vorname
This repeating element order: Given Names appear in the correct order for presenting the name
..... prefix SΣ 0..* string Namensteile vor dem Vornamen
This repeating element order: Prefixes appear in the correct order for presenting the name
...... id 0..1 string Unique id for inter-element referencing
...... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... extension:prefix-qualifier S 0..1 code LS | AC | NB | PR | HON | BR | AD | SP | MID | CL | IN | VV
URL: http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier
Binding: EntityNamePartQualifier (required)
...... value 0..1 string Primitive value for string
Max Length:1048576
..... suffix Σ 0..* string Namensteile nach dem Nachnamen
This repeating element order: Suffixes appear in the correct order for presenting the name
..... period ΣC 0..1 Period Time period when name was/is in use
Constraints: per-1
.... name:geburtsname SΣC 0..1 HumannameDeBasis Maiden name
Constraints: hum-1, hum-2, hum-3, hum-4

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!SΣ 1..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
Fixed Value: maiden
..... text Σ 0..1 string Text representation of the full name
..... family SΣ 1..1 string Familienname
...... id 0..1 string Unique id for inter-element referencing
...... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... extension:namenszusatz S 0..1 string Namenszusatz gemäß VSDM (Versichertenstammdatenmanagement, "eGK")
URL: http://fhir.de/StructureDefinition/humanname-namenszusatz
....... extension:nachname S 0..1 string Nachname ohne Vor- und Zusätze
URL: http://hl7.org/fhir/StructureDefinition/humanname-own-name
....... extension:vorsatzwort S 0..1 string Vorsatzwort
URL: http://hl7.org/fhir/StructureDefinition/humanname-own-prefix
...... value 0..1 string Primitive value for string
Max Length:1048576
..... suffix Σ 0..* string Namensteile nach dem Nachnamen
This repeating element order: Suffixes appear in the correct order for presenting the name
..... period ΣC 0..1 Period Time period when name was/is in use
Constraints: per-1
... telecom ΣC 0..* ContactPoint A contact detail for the individual
Constraints: cpt-2
... gender SΣ 0..1 code Administrative gender
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... extension:other-amtlich S 0..1 Coding Extension administrative gender
URL: http://fhir.de/StructureDefinition/gender-amtlich-de
Binding: GenderOtherDE ValueSet (required)
.... value 0..1 code Primitive value for code
Max Length:1048576
... birthDate SΣ 1..1 date Date of birth
.... 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:data-absent-reason S 0..1 code unknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
.... value 0..1 date Primitive value for date
... deceased[x] ?!SΣ 0..1 Deceased
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
... Slices for address SΣ 0..* Address Address
Slice: Unordered, Open by pattern:$this
.... address:Strassenanschrift SΣC 0..* AddressDeBasis Street address
Constraints: add-1, add-2, add-3, add-4, add-5, add-6, add-7, pat-cnt-2or3-char

Required Pattern: At least the following
..... 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 S 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).
Fixed Value: both
..... text Σ 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
..... line SΣ 1..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 Unique id for inter-element referencing
...... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... extension:Strasse S 0..1 string Strassenname (ohne Hausnummer)
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName
....... extension:Hausnummer S 0..1 string Hausnummer
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber
....... extension:Adresszusatz S 0..1 string Adresszusatz
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator
...... value 0..1 string Primitive value for string
Max Length:1048576
..... city SΣ 1..1 string Name of city, town etc.
Example General: Erewhon
...... 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:gemeindeschluessel S 0..1 Coding Optional Extensions Element
URL: http://fhir.de/StructureDefinition/destatis/ags
...... 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 ΣC 0..1 Period Time period when address was/is in use
Constraints: per-1
Example General: {"start":"2010-03-23","end":"2010-07-01"}
.... address:Postfach SΣC 0..* AddressDeBasis Postbox
Constraints: add-1, add-2, add-3, add-4, add-5, add-6, add-7, pat-cnt-2or3-char

Required Pattern: At least the following
..... 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 S 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).
Fixed Value: postal
..... text Σ 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
..... line SΣ 1..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 Unique id for inter-element referencing
...... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... extension:Postfach S 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 SΣ 1..1 string Name of city, town etc.
Example General: Erewhon
...... 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:gemeindeschluessel S 0..1 Coding Optional Extensions Element
URL: http://fhir.de/StructureDefinition/destatis/ags
...... 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 ΣC 0..1 Period Time period when address was/is in use
Constraints: per-1
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 C 0..* Attachment Image of the patient
Constraints: att-1
... contact C 0..* BackboneElement A contact party (e.g. guardian, partner, friend) for the patient
Constraints: pat-1
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... relationship 0..* CodeableConcept The kind of relationship
Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.
.... name 0..1 HumanName A name associated with the contact person
.... telecom C 0..* ContactPoint A contact detail for the person
Constraints: cpt-2
.... address 0..1 Address Address for the contact person
.... gender 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
.... organization C 0..1 Reference(Organization) Organization that is associated with the contact
Constraints: ref-1
.... period C 0..1 Period The period during which this contact person or organization is valid to be contacted relating to this patient
Constraints: per-1
... communication 0..* BackboneElement A language which may be used to communicate with the patient about his or her health
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... language 1..1 CodeableConcept The language which can be used to communicate with the patient about his or her health
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
.... preferred 0..1 boolean Language preference indicator
... generalPractitioner C 0..* Reference(Organization | Practitioner | PractitionerRole) Patient's nominated primary care provider
Constraints: ref-1
... managingOrganization ΣC 0..1 Reference(Organization) Organization that is the custodian of the patient record
Constraints: ref-1
... link ?!SΣ 0..* BackboneElement Link
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... other SΣC 1..1 Reference(Patient | RelatedPerson) The other patient or related person resource that the link refers to
Constraints: ref-1
.... type SΣ 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:versichertenId.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:versichertenId.​type Base extensible Identifier Type DeBasis ValueSet 📦1.5.4 de.basisprofil.r4 v1.5
Patient.identifier:versichertenId.​assigner.type Base extensible ResourceType 📦4.0.1 FHIR Std.
Patient.identifier:versichertenId.​assigner.identifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:versichertenId.​assigner.identifier.​type Base extensible Identifier Type DeBasis ValueSet 📦1.5.4 de.basisprofil.r4 v1.5
Patient.identifier:pid.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:pid.​type Base extensible Identifier Type DeBasis ValueSet 📦1.5.4 de.basisprofil.r4 v1.5
Patient.identifier:pid.​assigner.type Base extensible ResourceType 📦4.0.1 FHIR Std.
Patient.identifier:pid.​assigner.identifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:pid.​assigner.identifier.​type Base extensible IdentifierType 📦4.0.1 FHIR Std.
Patient.name:name.use Base required NameUse 📍4.0.1 FHIR Std.
Patient.name:geburtsname.​use Base required NameUse 📍4.0.1 FHIR Std.
Patient.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
Patient.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.address:Postfach.​use Base required AddressUse 📍4.0.1 FHIR Std.
Patient.address:Postfach.​type Base required AddressType 📍4.0.1 FHIR Std.
Patient.address:Postfach.​state Base preferred ISO-3166-2:de-Laendercodes 📦1.5.4 de.basisprofil.r4 v1.5
Patient.address:Postfach.​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
add-1 error Patient.address:Strassenanschrift, Patient.address:Postfach Wenn die Extension 'Hausnummer' verwendet wird, muss auch Address.line gefüllt werden line.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber').empty() or $this.hasValue())
add-2 error Patient.address:Strassenanschrift, Patient.address:Postfach Wenn die Extension 'Strasse' verwendet wird, muss auch Address.line gefüllt werden line.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName').empty() or $this.hasValue())
add-3 error Patient.address:Strassenanschrift, Patient.address:Postfach Wenn die Extension 'Postfach' verwendet wird, muss auch Address.line gefüllt werden line.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox').empty() or $this.hasValue())
add-4 warning Patient.address:Strassenanschrift, Patient.address:Postfach Eine Postfach-Adresse darf nicht vom Type "physical" oder "both" sein. line.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox').empty() or $this.hasValue()) or type='postal' or type.empty()
add-5 error Patient.address:Strassenanschrift, Patient.address:Postfach Wenn die Extension 'Adresszusatz' verwendet wird, muss auch Address.line gefüllt werden line.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator').empty() or $this.hasValue())
add-6 warning Patient.address:Strassenanschrift, Patient.address:Postfach Wenn die Extension 'Postfach' verwendet wird, dürfen die Extensions 'Strasse' und 'Hausnummer' nicht verwendet werden line.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox').empty() or ($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName').empty() and $this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber').empty()))
add-7 warning Patient.address:Strassenanschrift, Patient.address:Postfach Wenn die Extension 'Precinct' (Stadtteil) verwendet wird, dann muss diese Information auch als separates line-item abgebildet sein. extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-precinct').empty() or all(line contains extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-precinct').value.ofType(string))
att-1 error Patient.photo If the Attachment has data, it SHALL have a contentType data.empty() or contentType.exists()
cpt-2 error Patient.telecom, Patient.contact.telecom A system is required if a value is provided. value.empty() or system.exists()
dom-2 error Patient If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Patient If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Patient If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Patient If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Patient A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
hum-1 error Patient.name:name, Patient.name:geburtsname Wenn die Extension 'namenszusatz' verwendet wird, dann muss der vollständige Name im Attribut 'family' angegeben werden family.extension('http://fhir.de/StructureDefinition/humanname-namenszusatz').empty() or family.hasValue()
hum-2 error Patient.name:name, Patient.name:geburtsname Wenn die Extension 'nachname' verwendet wird, dann muss der vollständige Name im Attribut 'family' angegeben werden family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-name').empty() or family.hasValue()
hum-3 error Patient.name:name, Patient.name:geburtsname Wenn die Extension 'vorsatzwort' verwendet wird, dann muss der vollständige Name im Attribut 'family' angegeben werden family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-prefix').empty() or family.hasValue()
hum-4 error Patient.name:name, Patient.name:geburtsname Wenn die Extension 'prefix-qualifier' verwendet wird, dann muss ein Namenspräfix im Attribut 'prefix' angegeben werden prefix.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier').empty() or $this.hasValue())
ik-1 warning Patient.identifier:versichertenId.assigner.identifier.value Eine IK muss eine numerische 9-stellige Zeichenkette (mit Prüfziffer) sein matches('^[0-9]{9}$')
kvid-1 warning Patient.identifier:versichertenId.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:versichertenId.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()
mii-pat-2 error Patient.identifier:pid.assigner.identifier.system Entweder IKNR oder MII Core Location Identifier muss verwendet werden $this = 'http://fhir.de/sid/arge-ik/iknr' or $this = 'https://www.medizininformatik-initiative.de/fhir/core/CodeSystem/core-location-identifier'
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, Patient.address:Postfach 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'))
per-1 error Patient.identifier:versichertenId.period, Patient.identifier:versichertenId.assigner.identifier.period, Patient.identifier:pid.period, Patient.identifier:pid.assigner.identifier.period, Patient.name:name.period, Patient.name:geburtsname.period, Patient.address:Strassenanschrift.period, Patient.address:Postfach.period, Patient.contact.period If present, start SHALL have a lower value than end start.hasValue().not() or end.hasValue().not() or (start <= end)
ref-1 error Patient.identifier:versichertenId.assigner, Patient.identifier:versichertenId.assigner.identifier.assigner, Patient.identifier:pid.assigner, Patient.identifier:pid.assigner.identifier.assigner, Patient.contact.organization, Patient.generalPractitioner, Patient.managingOrganization, Patient.link.other SHALL have a contained resource if a local reference is provided reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

This structure is derived from MII_PR_Person_Patient

Summary

Mandatory: 5 elements

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient C 0..* MII_PR_Person_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Σ 2..* Identifier Identifier
Slice: Unordered, Open by pattern:$this
.... identifier:versichertenId SΣ 1..1 IdentifierKvid10 Health insurance number

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... period 0..1 Period Time period when id is/was valid for use
..... 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
..... assigner SΣC 1..1 Reference(Organization) Organization that issued id (may be just text)
Constraints: ref-1
...... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
...... identifier SΣ 1..1 IdentifierIknr An identifier intended for computation
....... 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
.... identifier:pid SΣ 1..* IdentifierPid Organization-internal patient identifier

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... period 0..1 Period Time period when id is/was valid for use
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type SΣ 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.
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: MR
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... system SΣ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value SΣ 1..1 string The value that is unique
Example General: 123456
..... assigner SΣC 0..1 Reference(Organization) Organization that issued id (may be just text)
Constraints: ref-1
...... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
...... identifier Σ 0..1 Identifier 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 Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Required Pattern: At least the following
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
........ coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
......... id 0..1 string Unique id for inter-element referencing
......... extension 0..* Extension Additional content defined by implementations
......... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
......... version 0..1 string Version of the system - if relevant
......... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 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
... active ?!Σ 0..1 boolean Whether this patient's record is in active use
... Slices for name SΣ 1..* HumanName Name
Slice: Unordered, Open by pattern:$this
.... name:name SΣC 1..1 HumannameDeBasis Person's name
Constraints: hum-1, hum-2, hum-3, hum-4

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... text 0..1 string Text representation of the full name
..... suffix 0..* string Parts that come after the name
..... period 0..1 Period Time period when name was/is in use
..... use ?!SΣ 1..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
Fixed Value: official
..... family SΣ 1..1 string Familienname
...... Slices for extension Content/Rules for all slices
....... extension:namenszusatz S 0..1 string Namenszusatz gemäß VSDM (Versichertenstammdatenmanagement, "eGK")
URL: http://fhir.de/StructureDefinition/humanname-namenszusatz
....... extension:nachname S 0..1 string Nachname ohne Vor- und Zusätze
URL: http://hl7.org/fhir/StructureDefinition/humanname-own-name
....... extension:vorsatzwort S 0..1 string Vorsatzwort
URL: http://hl7.org/fhir/StructureDefinition/humanname-own-prefix
..... given SΣ 1..* string Vorname
This repeating element order: Given Names appear in the correct order for presenting the name
..... prefix SΣ 0..* string Namensteile vor dem Vornamen
This repeating element order: Prefixes appear in the correct order for presenting the name
...... Slices for extension Content/Rules for all slices
....... extension:prefix-qualifier S 0..1 code LS | AC | NB | PR | HON | BR | AD | SP | MID | CL | IN | VV
URL: http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier
Binding: EntityNamePartQualifier (required)
.... name:geburtsname SΣC 0..1 HumannameDeBasis Maiden name
Constraints: hum-1, hum-2, hum-3, hum-4

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... text 0..1 string Text representation of the full name
..... suffix 0..* string Parts that come after the name
..... period 0..1 Period Time period when name was/is in use
..... use ?!SΣ 1..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
Fixed Value: maiden
..... family SΣ 1..1 string Familienname
...... Slices for extension Content/Rules for all slices
....... extension:namenszusatz S 0..1 string Namenszusatz gemäß VSDM (Versichertenstammdatenmanagement, "eGK")
URL: http://fhir.de/StructureDefinition/humanname-namenszusatz
....... extension:nachname S 0..1 string Nachname ohne Vor- und Zusätze
URL: http://hl7.org/fhir/StructureDefinition/humanname-own-name
....... extension:vorsatzwort S 0..1 string Vorsatzwort
URL: http://hl7.org/fhir/StructureDefinition/humanname-own-prefix
... gender SΣ 0..1 code Administrative gender
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
.... Slices for extension Content/Rules for all slices
..... extension:other-amtlich S 0..1 Coding Extension administrative gender
URL: http://fhir.de/StructureDefinition/gender-amtlich-de
Binding: GenderOtherDE ValueSet (required)
... birthDate SΣ 1..1 date Date of birth
.... Slices for extension Content/Rules for all slices
..... extension:data-absent-reason S 0..1 code unknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
... deceased[x] ?!SΣ 0..1 Deceased
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
... Slices for address SΣ 0..* Address Address
Slice: Unordered, Open by pattern:$this
.... address:Strassenanschrift SΣC 0..* AddressDeBasis Street address
Constraints: add-1, add-2, add-3, add-4, add-5, add-6, add-7, 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
..... text 0..1 string Text representation of the address
..... state 0..1 string Sub-unit of country (abbreviations ok)
..... period 0..1 Period Time period when address was/is in use
..... Slices for extension Content/Rules for all slices
...... extension:Stadtteil S 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).
Fixed Value: both
..... line SΣ 1..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 S 0..1 string Strassenname (ohne Hausnummer)
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName
....... extension:Hausnummer S 0..1 string Hausnummer
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber
....... extension:Adresszusatz S 0..1 string Adresszusatz
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator
..... city SΣ 1..1 string Name of city, town etc.
Example General: Erewhon
...... Slices for extension Content/Rules for all slices
....... extension:gemeindeschluessel S 0..1 Coding Optional Extensions Element
URL: http://fhir.de/StructureDefinition/destatis/ags
..... postalCode SΣ 1..1 string Postleitzahl
Example General: 9132
..... country SΣ 1..1 string Staat
Binding: Iso3166-1-2 (preferred)
.... address:Postfach SΣC 0..* AddressDeBasis Postbox
Constraints: add-1, add-2, add-3, add-4, add-5, add-6, add-7, 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
..... text 0..1 string Text representation of the address
..... state 0..1 string Sub-unit of country (abbreviations ok)
..... period 0..1 Period Time period when address was/is in use
..... Slices for extension Content/Rules for all slices
...... extension:Stadtteil S 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).
Fixed Value: postal
..... line SΣ 1..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:Postfach S 0..1 string Postfach
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox
..... city SΣ 1..1 string Name of city, town etc.
Example General: Erewhon
...... Slices for extension Content/Rules for all slices
....... extension:gemeindeschluessel S 0..1 Coding Optional Extensions Element
URL: http://fhir.de/StructureDefinition/destatis/ags
..... postalCode SΣ 1..1 string Postleitzahl
Example General: 9132
..... country SΣ 1..1 string Staat
Binding: Iso3166-1-2 (preferred)
... link ?!SΣ 0..* BackboneElement Link
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... other SΣC 1..1 Reference(Patient | RelatedPerson) The other patient or related person resource that the link refers to
Constraints: ref-1
.... type SΣ 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:versichertenId.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:versichertenId.​type Base extensible Identifier Type DeBasis ValueSet 📦1.5.4 de.basisprofil.r4 v1.5
Patient.identifier:versichertenId.​assigner.identifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:versichertenId.​assigner.identifier.​type Base extensible Identifier Type DeBasis ValueSet 📦1.5.4 de.basisprofil.r4 v1.5
Patient.identifier:pid.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:pid.​type Base extensible Identifier Type DeBasis ValueSet 📦1.5.4 de.basisprofil.r4 v1.5
Patient.identifier:pid.​assigner.identifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:pid.​assigner.identifier.​type Base extensible IdentifierType 📦4.0.1 FHIR Std.
Patient.name:name.use Base required NameUse 📍4.0.1 FHIR Std.
Patient.name:geburtsname.​use Base required NameUse 📍4.0.1 FHIR Std.
Patient.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
Patient.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.address:Postfach.​use Base required AddressUse 📍4.0.1 FHIR Std.
Patient.address:Postfach.​type Base required AddressType 📍4.0.1 FHIR Std.
Patient.address:Postfach.​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
add-1 error Patient.address:Strassenanschrift, Patient.address:Postfach Wenn die Extension 'Hausnummer' verwendet wird, muss auch Address.line gefüllt werden line.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber').empty() or $this.hasValue())
add-2 error Patient.address:Strassenanschrift, Patient.address:Postfach Wenn die Extension 'Strasse' verwendet wird, muss auch Address.line gefüllt werden line.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName').empty() or $this.hasValue())
add-3 error Patient.address:Strassenanschrift, Patient.address:Postfach Wenn die Extension 'Postfach' verwendet wird, muss auch Address.line gefüllt werden line.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox').empty() or $this.hasValue())
add-4 warning Patient.address:Strassenanschrift, Patient.address:Postfach Eine Postfach-Adresse darf nicht vom Type "physical" oder "both" sein. line.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox').empty() or $this.hasValue()) or type='postal' or type.empty()
add-5 error Patient.address:Strassenanschrift, Patient.address:Postfach Wenn die Extension 'Adresszusatz' verwendet wird, muss auch Address.line gefüllt werden line.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator').empty() or $this.hasValue())
add-6 warning Patient.address:Strassenanschrift, Patient.address:Postfach Wenn die Extension 'Postfach' verwendet wird, dürfen die Extensions 'Strasse' und 'Hausnummer' nicht verwendet werden line.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox').empty() or ($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName').empty() and $this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber').empty()))
add-7 warning Patient.address:Strassenanschrift, Patient.address:Postfach Wenn die Extension 'Precinct' (Stadtteil) verwendet wird, dann muss diese Information auch als separates line-item abgebildet sein. extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-precinct').empty() or all(line contains extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-precinct').value.ofType(string))
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()
hum-1 error Patient.name:name, Patient.name:geburtsname Wenn die Extension 'namenszusatz' verwendet wird, dann muss der vollständige Name im Attribut 'family' angegeben werden family.extension('http://fhir.de/StructureDefinition/humanname-namenszusatz').empty() or family.hasValue()
hum-2 error Patient.name:name, Patient.name:geburtsname Wenn die Extension 'nachname' verwendet wird, dann muss der vollständige Name im Attribut 'family' angegeben werden family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-name').empty() or family.hasValue()
hum-3 error Patient.name:name, Patient.name:geburtsname Wenn die Extension 'vorsatzwort' verwendet wird, dann muss der vollständige Name im Attribut 'family' angegeben werden family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-prefix').empty() or family.hasValue()
hum-4 error Patient.name:name, Patient.name:geburtsname Wenn die Extension 'prefix-qualifier' verwendet wird, dann muss ein Namenspräfix im Attribut 'prefix' angegeben werden prefix.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier').empty() or $this.hasValue())
ik-1 warning Patient.identifier:versichertenId.assigner.identifier.value Eine IK muss eine numerische 9-stellige Zeichenkette (mit Prüfziffer) sein matches('^[0-9]{9}$')
kvid-1 warning Patient.identifier:versichertenId.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:versichertenId.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, Patient.address:Postfach 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'))
ref-1 error Patient.identifier:versichertenId.assigner, Patient.identifier:pid.assigner, Patient.link.other SHALL have a contained resource if a local reference is provided reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Differential View

This structure is derived from MII_PR_Person_Patient

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient 0..* MII_PR_Person_Patient Information about an individual or animal receiving health care services
... identifier 2..* Identifier Identifier
... Slices for identifier Content/Rules for all slices
.... identifier:versichertenId 1..1 IdentifierKvid10 Health insurance number
.... identifier:pid 1..* IdentifierPid Organization-internal patient identifier
... name 1..* HumanName Name
.... name:name 1..1 HumannameDeBasis Person's name
... birthDate 1..1 date Date of birth

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient C 0..* MII_PR_Person_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
Slice: Unordered, Open by value:url
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Slice: Unordered, Open by value:url
... Slices for identifier SΣ 2..* Identifier Identifier
Slice: Unordered, Open by pattern:$this
.... identifier:versichertenId SΣ 1..1 IdentifierKvid10 Health insurance number

Required Pattern: At least the following
..... 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
..... period ΣC 0..1 Period Time period when id is/was valid for use
Constraints: per-1
..... assigner SΣC 1..1 Reference(Organization) Organization that issued id (may be just text)
Constraints: ref-1
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... 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 An identifier intended for computation
....... 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 ΣC 0..1 Period Time period when id is/was valid for use
Constraints: per-1
....... assigner ΣC 0..1 Reference(Organization) Organization that issued id (may be just text)
Constraints: ref-1
...... display Σ 0..1 string Text alternative for the resource
.... identifier:pid SΣ 1..* IdentifierPid Organization-internal patient identifier

Required Pattern: At least the following
..... 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Σ 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.
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: MR
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... system SΣ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value SΣ 1..1 string The value that is unique
Example General: 123456
..... period ΣC 0..1 Period Time period when id is/was valid for use
Constraints: per-1
..... assigner SΣC 0..1 Reference(Organization) Organization that issued id (may be just text)
Constraints: ref-1
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... 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 Σ 0..1 Identifier 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 Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Required Pattern: At least the following
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
........ coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
......... id 0..1 string Unique id for inter-element referencing
......... extension 0..* Extension Additional content defined by implementations
......... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
......... version 0..1 string Version of the system - if relevant
......... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 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 ΣC 0..1 uri The namespace for the identifier value
Constraints: mii-pat-2
Example General: http://www.acme.com/identifiers/patient
....... value Σ 0..1 string The value that is unique
Example General: 123456
....... period ΣC 0..1 Period Time period when id is/was valid for use
Constraints: per-1
....... assigner ΣC 0..1 Reference(Organization) Organization that issued id (may be just text)
Constraints: ref-1
...... display Σ 0..1 string Text alternative for the resource
... active ?!Σ 0..1 boolean Whether this patient's record is in active use
... Slices for name SΣ 1..* HumanName Name
Slice: Unordered, Open by pattern:$this
.... name:name SΣC 1..1 HumannameDeBasis Person's name
Constraints: hum-1, hum-2, hum-3, hum-4

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!SΣ 1..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
Fixed Value: official
..... text Σ 0..1 string Text representation of the full name
..... family SΣ 1..1 string Familienname
...... id 0..1 string Unique id for inter-element referencing
...... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... extension:namenszusatz S 0..1 string Namenszusatz gemäß VSDM (Versichertenstammdatenmanagement, "eGK")
URL: http://fhir.de/StructureDefinition/humanname-namenszusatz
....... extension:nachname S 0..1 string Nachname ohne Vor- und Zusätze
URL: http://hl7.org/fhir/StructureDefinition/humanname-own-name
....... extension:vorsatzwort S 0..1 string Vorsatzwort
URL: http://hl7.org/fhir/StructureDefinition/humanname-own-prefix
...... value 0..1 string Primitive value for string
Max Length:1048576
..... given SΣ 1..* string Vorname
This repeating element order: Given Names appear in the correct order for presenting the name
..... prefix SΣ 0..* string Namensteile vor dem Vornamen
This repeating element order: Prefixes appear in the correct order for presenting the name
...... id 0..1 string Unique id for inter-element referencing
...... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... extension:prefix-qualifier S 0..1 code LS | AC | NB | PR | HON | BR | AD | SP | MID | CL | IN | VV
URL: http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier
Binding: EntityNamePartQualifier (required)
...... value 0..1 string Primitive value for string
Max Length:1048576
..... suffix Σ 0..* string Namensteile nach dem Nachnamen
This repeating element order: Suffixes appear in the correct order for presenting the name
..... period ΣC 0..1 Period Time period when name was/is in use
Constraints: per-1
.... name:geburtsname SΣC 0..1 HumannameDeBasis Maiden name
Constraints: hum-1, hum-2, hum-3, hum-4

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!SΣ 1..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
Fixed Value: maiden
..... text Σ 0..1 string Text representation of the full name
..... family SΣ 1..1 string Familienname
...... id 0..1 string Unique id for inter-element referencing
...... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... extension:namenszusatz S 0..1 string Namenszusatz gemäß VSDM (Versichertenstammdatenmanagement, "eGK")
URL: http://fhir.de/StructureDefinition/humanname-namenszusatz
....... extension:nachname S 0..1 string Nachname ohne Vor- und Zusätze
URL: http://hl7.org/fhir/StructureDefinition/humanname-own-name
....... extension:vorsatzwort S 0..1 string Vorsatzwort
URL: http://hl7.org/fhir/StructureDefinition/humanname-own-prefix
...... value 0..1 string Primitive value for string
Max Length:1048576
..... suffix Σ 0..* string Namensteile nach dem Nachnamen
This repeating element order: Suffixes appear in the correct order for presenting the name
..... period ΣC 0..1 Period Time period when name was/is in use
Constraints: per-1
... telecom ΣC 0..* ContactPoint A contact detail for the individual
Constraints: cpt-2
... gender SΣ 0..1 code Administrative gender
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... extension:other-amtlich S 0..1 Coding Extension administrative gender
URL: http://fhir.de/StructureDefinition/gender-amtlich-de
Binding: GenderOtherDE ValueSet (required)
.... value 0..1 code Primitive value for code
Max Length:1048576
... birthDate SΣ 1..1 date Date of birth
.... 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:data-absent-reason S 0..1 code unknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
.... value 0..1 date Primitive value for date
... deceased[x] ?!SΣ 0..1 Deceased
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
... Slices for address SΣ 0..* Address Address
Slice: Unordered, Open by pattern:$this
.... address:Strassenanschrift SΣC 0..* AddressDeBasis Street address
Constraints: add-1, add-2, add-3, add-4, add-5, add-6, add-7, pat-cnt-2or3-char

Required Pattern: At least the following
..... 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 S 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).
Fixed Value: both
..... text Σ 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
..... line SΣ 1..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 Unique id for inter-element referencing
...... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... extension:Strasse S 0..1 string Strassenname (ohne Hausnummer)
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName
....... extension:Hausnummer S 0..1 string Hausnummer
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber
....... extension:Adresszusatz S 0..1 string Adresszusatz
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator
...... value 0..1 string Primitive value for string
Max Length:1048576
..... city SΣ 1..1 string Name of city, town etc.
Example General: Erewhon
...... 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:gemeindeschluessel S 0..1 Coding Optional Extensions Element
URL: http://fhir.de/StructureDefinition/destatis/ags
...... 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 ΣC 0..1 Period Time period when address was/is in use
Constraints: per-1
Example General: {"start":"2010-03-23","end":"2010-07-01"}
.... address:Postfach SΣC 0..* AddressDeBasis Postbox
Constraints: add-1, add-2, add-3, add-4, add-5, add-6, add-7, pat-cnt-2or3-char

Required Pattern: At least the following
..... 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 S 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).
Fixed Value: postal
..... text Σ 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
..... line SΣ 1..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 Unique id for inter-element referencing
...... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... extension:Postfach S 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 SΣ 1..1 string Name of city, town etc.
Example General: Erewhon
...... 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:gemeindeschluessel S 0..1 Coding Optional Extensions Element
URL: http://fhir.de/StructureDefinition/destatis/ags
...... 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 ΣC 0..1 Period Time period when address was/is in use
Constraints: per-1
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 C 0..* Attachment Image of the patient
Constraints: att-1
... contact C 0..* BackboneElement A contact party (e.g. guardian, partner, friend) for the patient
Constraints: pat-1
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... relationship 0..* CodeableConcept The kind of relationship
Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.
.... name 0..1 HumanName A name associated with the contact person
.... telecom C 0..* ContactPoint A contact detail for the person
Constraints: cpt-2
.... address 0..1 Address Address for the contact person
.... gender 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
.... organization C 0..1 Reference(Organization) Organization that is associated with the contact
Constraints: ref-1
.... period C 0..1 Period The period during which this contact person or organization is valid to be contacted relating to this patient
Constraints: per-1
... communication 0..* BackboneElement A language which may be used to communicate with the patient about his or her health
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... language 1..1 CodeableConcept The language which can be used to communicate with the patient about his or her health
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
.... preferred 0..1 boolean Language preference indicator
... generalPractitioner C 0..* Reference(Organization | Practitioner | PractitionerRole) Patient's nominated primary care provider
Constraints: ref-1
... managingOrganization ΣC 0..1 Reference(Organization) Organization that is the custodian of the patient record
Constraints: ref-1
... link ?!SΣ 0..* BackboneElement Link
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... other SΣC 1..1 Reference(Patient | RelatedPerson) The other patient or related person resource that the link refers to
Constraints: ref-1
.... type SΣ 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:versichertenId.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:versichertenId.​type Base extensible Identifier Type DeBasis ValueSet 📦1.5.4 de.basisprofil.r4 v1.5
Patient.identifier:versichertenId.​assigner.type Base extensible ResourceType 📦4.0.1 FHIR Std.
Patient.identifier:versichertenId.​assigner.identifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:versichertenId.​assigner.identifier.​type Base extensible Identifier Type DeBasis ValueSet 📦1.5.4 de.basisprofil.r4 v1.5
Patient.identifier:pid.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:pid.​type Base extensible Identifier Type DeBasis ValueSet 📦1.5.4 de.basisprofil.r4 v1.5
Patient.identifier:pid.​assigner.type Base extensible ResourceType 📦4.0.1 FHIR Std.
Patient.identifier:pid.​assigner.identifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:pid.​assigner.identifier.​type Base extensible IdentifierType 📦4.0.1 FHIR Std.
Patient.name:name.use Base required NameUse 📍4.0.1 FHIR Std.
Patient.name:geburtsname.​use Base required NameUse 📍4.0.1 FHIR Std.
Patient.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
Patient.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.address:Postfach.​use Base required AddressUse 📍4.0.1 FHIR Std.
Patient.address:Postfach.​type Base required AddressType 📍4.0.1 FHIR Std.
Patient.address:Postfach.​state Base preferred ISO-3166-2:de-Laendercodes 📦1.5.4 de.basisprofil.r4 v1.5
Patient.address:Postfach.​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
add-1 error Patient.address:Strassenanschrift, Patient.address:Postfach Wenn die Extension 'Hausnummer' verwendet wird, muss auch Address.line gefüllt werden line.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber').empty() or $this.hasValue())
add-2 error Patient.address:Strassenanschrift, Patient.address:Postfach Wenn die Extension 'Strasse' verwendet wird, muss auch Address.line gefüllt werden line.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName').empty() or $this.hasValue())
add-3 error Patient.address:Strassenanschrift, Patient.address:Postfach Wenn die Extension 'Postfach' verwendet wird, muss auch Address.line gefüllt werden line.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox').empty() or $this.hasValue())
add-4 warning Patient.address:Strassenanschrift, Patient.address:Postfach Eine Postfach-Adresse darf nicht vom Type "physical" oder "both" sein. line.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox').empty() or $this.hasValue()) or type='postal' or type.empty()
add-5 error Patient.address:Strassenanschrift, Patient.address:Postfach Wenn die Extension 'Adresszusatz' verwendet wird, muss auch Address.line gefüllt werden line.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator').empty() or $this.hasValue())
add-6 warning Patient.address:Strassenanschrift, Patient.address:Postfach Wenn die Extension 'Postfach' verwendet wird, dürfen die Extensions 'Strasse' und 'Hausnummer' nicht verwendet werden line.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox').empty() or ($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName').empty() and $this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber').empty()))
add-7 warning Patient.address:Strassenanschrift, Patient.address:Postfach Wenn die Extension 'Precinct' (Stadtteil) verwendet wird, dann muss diese Information auch als separates line-item abgebildet sein. extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-precinct').empty() or all(line contains extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-precinct').value.ofType(string))
att-1 error Patient.photo If the Attachment has data, it SHALL have a contentType data.empty() or contentType.exists()
cpt-2 error Patient.telecom, Patient.contact.telecom A system is required if a value is provided. value.empty() or system.exists()
dom-2 error Patient If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Patient If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Patient If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Patient If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Patient A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
hum-1 error Patient.name:name, Patient.name:geburtsname Wenn die Extension 'namenszusatz' verwendet wird, dann muss der vollständige Name im Attribut 'family' angegeben werden family.extension('http://fhir.de/StructureDefinition/humanname-namenszusatz').empty() or family.hasValue()
hum-2 error Patient.name:name, Patient.name:geburtsname Wenn die Extension 'nachname' verwendet wird, dann muss der vollständige Name im Attribut 'family' angegeben werden family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-name').empty() or family.hasValue()
hum-3 error Patient.name:name, Patient.name:geburtsname Wenn die Extension 'vorsatzwort' verwendet wird, dann muss der vollständige Name im Attribut 'family' angegeben werden family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-prefix').empty() or family.hasValue()
hum-4 error Patient.name:name, Patient.name:geburtsname Wenn die Extension 'prefix-qualifier' verwendet wird, dann muss ein Namenspräfix im Attribut 'prefix' angegeben werden prefix.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier').empty() or $this.hasValue())
ik-1 warning Patient.identifier:versichertenId.assigner.identifier.value Eine IK muss eine numerische 9-stellige Zeichenkette (mit Prüfziffer) sein matches('^[0-9]{9}$')
kvid-1 warning Patient.identifier:versichertenId.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:versichertenId.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()
mii-pat-2 error Patient.identifier:pid.assigner.identifier.system Entweder IKNR oder MII Core Location Identifier muss verwendet werden $this = 'http://fhir.de/sid/arge-ik/iknr' or $this = 'https://www.medizininformatik-initiative.de/fhir/core/CodeSystem/core-location-identifier'
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, Patient.address:Postfach 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'))
per-1 error Patient.identifier:versichertenId.period, Patient.identifier:versichertenId.assigner.identifier.period, Patient.identifier:pid.period, Patient.identifier:pid.assigner.identifier.period, Patient.name:name.period, Patient.name:geburtsname.period, Patient.address:Strassenanschrift.period, Patient.address:Postfach.period, Patient.contact.period If present, start SHALL have a lower value than end start.hasValue().not() or end.hasValue().not() or (start <= end)
ref-1 error Patient.identifier:versichertenId.assigner, Patient.identifier:versichertenId.assigner.identifier.assigner, Patient.identifier:pid.assigner, Patient.identifier:pid.assigner.identifier.assigner, Patient.contact.organization, Patient.generalPractitioner, Patient.managingOrganization, Patient.link.other SHALL have a contained resource if a local reference is provided reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

This structure is derived from MII_PR_Person_Patient

Summary

Mandatory: 5 elements

 

Other representations of profile: CSV, Excel, Schematron