MII Implementation Guide Core Dataset Base
2027.0.0-ballot - Germany

This page is part of the MII Implementation Guide Core Dataset Base (v2027.0.0-ballot: 2027 Ballot 1) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

Resource Profile: MII PR Person Patient

Official URL: https://www.medizininformatik-initiative.de/fhir/core/modul-person/StructureDefinition/Patient Version: 2027.0.0-ballot
Active as of 2026-09-01 Computable Name: MII_PR_Person_Patient

Demographics and other administrative information about a patient.

Example Usage Scenarios:

  • Document patient demographics including name, gender, birth date, and address for clinical care and research
  • Record health insurance information for administrative purposes
  • Maintain organizational patient identifiers (PID) for linking patient data across systems within a healthcare organization
  • Enable pseudonymized patient representations for research use cases while preserving essential demographic characteristics

Profile Specific Implementation Guidance

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

Patient Identification

Patient identification uses multiple identifier types depending on the context:

  • Patient.identifier:versichertenId: Lebenslange Krankenversicherten-ID (10-stellige KVID) for all health insurance types (GKV, PKV, Sonderkostenträger)
    • IMPORTANT: The Assigner element MUST contain the IKNR (Institutionskennzeichen) of the issuing institution
    • Always represents the current insurance number of the patient
    • Use Identifier.type code KVZ10 from http://fhir.de/CodeSystem/identifier-type-de-basis
    • Codes GKV and PKV have status retired and SHOULD NOT be used
  • Patient.identifier:pid: Organisationsinterner Patienten-Identifier - the leading (MPI) ID of the patient
    • A reference to the issuing Organization in Patient.identifier:pid.assigner is RECOMMENDED
    • Logical reference via IK-Nummer or IHE Affinity Domain OID is permitted
    • The CodeSystem Core-Location-Identifier for all MII sites can be used
  • Patient.identifier: Any other identifiers when GKV/PKV/PID are not applicable
Best Practice - Krankenversicherten-ID Changes

Compared to previous versions, the Krankenversicherten-ID in Patient.identifier is no longer distinguished between GKV and PKV. Patient.identifier:versichertenId applies to all health insurance numbers, regardless of whether GKV, PKV, or special insurance carriers.

Use the code KVZ10 from http://fhir.de/CodeSystem/identifier-type-de-basis as Identifier.type. The codes GKV and PKV have retired status. See constraint kvid-2 in the profile IdentifierKvid10 in the German FHIR Base Profiles.

Patient Name

Patient names follow the German Base Profile for HumanName:

  • Name Components: The breakdown of the complete name into components (e.g., Vorsatzwort, Namenszusatz, Nachname) SHOULD only be performed if this information is explicitly available at this granularity (e.g., through direct import based on a VSDM dataset)
  • Birth Name: By general convention, the birth name (name.use = maiden) contains only the family name
  • Multiple Names: Multiple name entries are permitted for different use cases (official, maiden, etc.)

Gender

Gender documentation follows the German Base Profile for Gender:

  • Patient.gender: Administrative gender (required)
  • Patient.gender.extension:other-amtlich: Official gender codes according to German regulations for cases beyond male/female/unknown
  • Patient.extension:recordedSexOrGender: Repeatable sex or gender statements taken from a document or other record. These statements are kept separate from the administrative gender in Patient.gender and can, for example, represent sex assigned at birth.
    • value: The recorded value. The MII ValueSet Person Recorded Sex or Gender SNOMED is bound with preferred strength and contains SNOMED CT findings related to biological sex as well as 261665006 | Unknown (qualifier value) |.
    • type: Identifies the kind of recorded sex or gender. http://loinc.org|76689-9 (Sex assigned at birth) SHOULD be used when documenting sex assigned at birth.
    • acquisitionDate: Date and time when the statement was first recorded in the system.

Indeterminate sex describes a sex that could not be determined, whereas Unknown indicates that the value is not known or was not recorded. Implementations SHOULD preserve this distinction.

Citizenship and Nationality

  • Patient.extension:patient-citizenship: The patient's legal status as a citizen of a country. Multiple citizenships and their respective periods can be represented.
  • Patient.extension:patient-nationality: The patient's nationality. Multiple nationalities and their respective periods can be represented.

Open clarification: The intended use and boundary between patient-citizenship and patient-nationality still need to be clarified. In particular, it remains unresolved whether the German concept “Staatsangehörigkeit” refers specifically to legal citizenship or to nationality in a broader legal, cultural, or ethnic sense. See #86.

Birth Date, Place of Birth, and Vital Status

  • Patient.birthDate: Full birth date when available. See German Base Profile - Geburtsdatum
  • Patient.extension:birthPlace: The patient's registered place of birth. To represent the country of birth, use valueAddress.country; the countryCode extension supports coding with ISO 3166-1 alpha-2 codes using a preferred binding.

EHDS outlook: The use and cardinalities of the FHIR core extensions patient-citizenship, patient-nationality, and patient-birthPlace are aligned with HL7 Europe Patient (EU base) 2.0.0 and HL7 Europe Patient (EU core) 2.0.0. This supports future interoperability in an EHDS context.

  • Patient.deceased[x]:
    • deceasedBoolean SHOULD be replaced by deceasedDateTime when the patient is deceased and the datetime is known

Address Information

Address details follow the German Base Profile - Adresse:

  • Multiple Addresses: Multiple addresses are permitted
  • Address History: Systems SHOULD mark former addresses appropriately so that the current address of the patient is identifiable
  • Address Components:
    • address.line with extensions for Straße, Hausnummer, Adresszusatz, Postfach
    • address.city with extension for Gemeindeschlüssel and Stadtteil (for city-states)
    • address.postalCode for PLZ
    • address.country for Land

EHDS outlook: Through the dependency on the German FHIR Base Profiles 1.6.0, the Patient address slices are based on AddressDeBasis 1.6.0. For a consistently coded country, implementations SHOULD use the inherited Address.country.extension:countryCode extension (iso21090-codedString) with an ISO 3166-1 alpha-2 code; source-system alpha-3 codes MUST be mapped to their alpha-2 equivalent when populating this extension. AddressDeBasis binds the extension with required strength to the ISO 3166 Part 1: 2 Letter Codes ValueSet. This uses the same extension and ValueSet as HL7 Europe Address (EU) 2.0.0, where the binding is preferred, and supports future EHDS interoperability. This recommendation concerns the coded representation in the extension; Address.country remains a string.

Best Practice - Address Components

Stadtteil (District): The Stadtteil is not part of the VSDM dataset from Gematik. Other sources conforming to §21 KHEntgG may need to be consulted for this information.

Address Structure: For city-states (Stadtstaaten), use Patient.address.city combined with Patient.address.extension.Stadtteil to represent Person.Demographie.Adresse.Wohnort.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots, and their representations.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient C 0..* Patient Information about an individual or animal receiving health care services
Constraints: mii-pat-1
... id SΣ 0..1 id Logical id of this artifact
... meta SΣ 0..1 Meta Metadata about the resource
.... profile SΣ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
.... extension:birthPlace S 0..1 (Complex)
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url S 1..1 uri "http://hl7.org/fhir/StructureDefinition/patient-birthPlace"
..... value[x] S 1..1 Address Value of extension
...... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.
Example General: home
...... country SΣ 0..1 string
....... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... Slices for extension Content/Rules for all slices
........ extension:countryCode S 0..1 (Complex) code for string
URL: http://hl7.org/fhir/StructureDefinition/iso21090-codedString
......... extension 0..0 Extension
Slice: Unordered, Open by value:url
......... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/iso21090-codedString"
......... value[x] S 1..1 Coding Value of extension
Binding: Iso3166-1-2 (preferred)
.......... system SΣ 0..1 uri Identity of the terminology system
.......... code SΣ 0..1 code Symbol in syntax defined by the system
.... extension:patient-citizenship S 0..* (Complex)
URL: http://hl7.org/fhir/StructureDefinition/patient-citizenship
..... Slices for extension Content/Rules for all slices
...... extension:code S 0..1 Extension Extension
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url S 1..1 uri "code"
....... value[x] S 1..1 CodeableConcept Value of extension
Binding: CountryValueSet (preferred)
........ coding SΣ 0..* Coding Code defined by a terminology system
......... system SΣ 0..1 uri Identity of the terminology system
......... code SΣ 0..1 code Symbol in syntax defined by the system
...... extension:period S 0..1 Extension Extension
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url S 1..1 uri "period"
....... value[x] S 1..1 Period Value of extension
..... url S 1..1 uri "http://hl7.org/fhir/StructureDefinition/patient-citizenship"
.... extension:patient-nationality S 0..* (Complex)
URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
..... Slices for extension Content/Rules for all slices
...... extension:code S 0..1 Extension Extension
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url S 1..1 uri "code"
....... value[x] S 1..1 CodeableConcept Value of extension
........ coding SΣ 0..* Coding Code defined by a terminology system
......... system SΣ 0..1 uri Identity of the terminology system
......... code SΣ 0..1 code Symbol in syntax defined by the system
...... extension:period S 0..1 Extension Extension
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url S 1..1 uri "period"
....... value[x] S 1..1 Period Value of extension
..... url S 1..1 uri "http://hl7.org/fhir/StructureDefinition/patient-nationality"
.... extension:recordedSexOrGender S 0..* (Complex)
URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender
..... Slices for extension 1..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... Slices for extension Content/Rules for all slices
...... extension:value S 1..1 Extension Extension
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url S 1..1 uri "value"
....... value[x] S 1..1 CodeableConcept Value of extension
Binding: MII VS Person Recorded Sex or Gender SNOMED (preferred)
........ coding SΣ 0..* Coding Code defined by a terminology system
......... system SΣ 0..1 uri Identity of the terminology system
......... code SΣ 0..1 code Symbol in syntax defined by the system
...... extension:type S 0..1 Extension Extension
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url S 1..1 uri "type"
....... value[x] S 1..1 CodeableConcept Value of extension
Binding: Recorded Sex Or Gender Type (example)
........ coding SΣ 0..* Coding Code defined by a terminology system
......... system SΣ 0..1 uri Identity of the terminology system
......... code SΣ 0..1 code Symbol in syntax defined by the system
...... extension:effectivePeriod 0..1 Extension When the recorded sex or gender value applies
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "effectivePeriod"
...... extension:acquisitionDate S 0..1 Extension Extension
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url S 1..1 uri "acquisitionDate"
....... value[x] S 1..1 dateTime Value of extension
...... extension:source 0..1 Extension The source of the Recorded Sex or Gender value.
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "source"
....... value[x] 1..1 Value of extension
........ valueCodeableConcept CodeableConcept
........ valueReference Reference(Organization | Device | RelatedPerson | Practitioner)
...... extension:sourceDocument 0..1 Extension The document the sex or gender property was acquired from.
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "sourceDocument"
....... value[x] 1..1 Value of extension
........ valueCodeableConcept CodeableConcept
........ valueReference Reference(DocumentReference)
...... extension:sourceField 0..1 Extension The name of the field within the source document where this sex or gender property is initially recorded.
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "sourceField"
....... value[x] 1..1 string Value of extension
...... extension:jurisdiction 0..1 Extension Who issued the document where the sex or gender was aquired
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "jurisdiction"
....... value[x] 1..1 CodeableConcept Value of extension
Binding: Jurisdiction ValueSet (extensible)
...... extension:comment 0..1 Extension Context or source information about the recorded sex or gender
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "comment"
....... value[x] 1..1 string Value of extension
...... extension:genderElementQualifier 0..1 Extension Whether this recorded sex or gender value qualifies the .gender element.
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "genderElementQualifier"
....... value[x] 1..1 boolean Value of extension
..... url S 1..1 uri "http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender"
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier SΣ 0..* Identifier Patienten-Identifikator
Slice: Unordered, Open by pattern:$this
.... identifier:versichertenId SΣ 0..1 IdentifierKvid10 Krankenversichertennummer

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 Kvid DeBasis ValueSet (required): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Constraints: kvid-2
Fixed Value: (Complex)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... text 0..1 string Plain text representation of the concept
...... coding SΣ 0..* 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
....... version 0..1 string Version of the system - if relevant
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
....... system SΣ 0..1 uri Identity of the terminology system
Fixed Value: http://fhir.de/CodeSystem/identifier-type-de-basis
....... code SΣ 0..1 code Symbol in syntax defined by the system
Fixed Value: KVZ10
..... 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
...... identifier SΣ 1..1 IdentifierIknr Logical reference, when literal reference is not known
....... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
....... type SΣ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type DeBasis ValueSet (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Required Pattern: At least the following
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
........ text 0..1 string Plain text representation of the concept
........ coding SΣ 0..* 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
......... version 0..1 string Version of the system - if relevant
......... display 0..1 string Representation defined by the system
......... userSelected 0..1 boolean If this coding was chosen directly by the user
......... system SΣ 0..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
......... code SΣ 0..1 code Symbol in syntax defined by the system
Fixed Value: XX
....... 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Σ 0..* IdentifierPid Patientenidentifikation

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
...... text 0..1 string Plain text representation of the concept
...... coding SΣ 0..* 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
....... version 0..1 string Version of the system - if relevant
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
....... system SΣ 0..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... code SΣ 0..1 code Symbol in syntax defined by the system
Fixed Value: MR
..... 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
...... identifier SΣ 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
........ text 0..1 string Plain text representation of the concept
........ coding SΣ 0..* 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
......... version 0..1 string Version of the system - if relevant
......... display 0..1 string Representation defined by the system
......... userSelected 0..1 boolean If this coding was chosen directly by the user
......... system SΣ 0..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
......... code SΣ 0..1 code Symbol in syntax defined by the system
Fixed Value: XX
....... system ΣC 0..1 uri The namespace for the identifier value
Constraints: mii-pat-2
Example General: http://www.acme.com/identifiers/patient
... active ?!Σ 0..1 boolean Whether this patient's record is in active use
... Slices for name SΣ 0..* HumanName Name
Slice: Unordered, Open by pattern:$this
.... name:name SΣ 0..1 HumannameDeBasis Personenname

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 Portion derived from person's own surname
URL: http://hl7.org/fhir/StructureDefinition/humanname-own-name
....... extension:vorsatzwort S 0..1 string Voorvoegsel derived from person's own surname
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Σ 0..1 HumannameDeBasis Geburtsname

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 Portion derived from person's own surname
URL: http://hl7.org/fhir/StructureDefinition/humanname-own-name
....... extension:vorsatzwort S 0..1 string Voorvoegsel derived from person's own surname
URL: http://hl7.org/fhir/StructureDefinition/humanname-own-prefix
... gender SΣ 0..1 code Administratives Geschlecht
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:other-amtlich S 0..1 (Complex) Extension Administratives Geschlecht
URL: http://fhir.de/StructureDefinition/gender-amtlich-de
...... extension 0..0 Additional content defined by implementations
Slice: Unordered, Open by value:url
...... url S 1..1 uri "http://fhir.de/StructureDefinition/gender-amtlich-de"
...... value[x] SC 1..1 Coding Value of extension
Binding: GenderOtherDE ValueSet (required)
Constraints: gender-amtlich-1
....... system SΣ 0..1 uri Identity of the terminology system
....... code SΣ 0..1 code Symbol in syntax defined by the system
... birthDate SΣ 0..1 date Geburtsdatum
.... Slices for extension 0..* Extension Extension
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)
... Slices for deceased[x] ?!SΣ 0..1 Verstorben
Slice: Unordered, Closed by type:$this
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
.... deceased[x]:deceasedBoolean ?!SΣ 0..1 boolean Indicates if the individual is deceased or not
.... deceased[x]:deceasedDateTime ?!SΣ 0..1 dateTime Indicates if the individual is deceased or not
... Slices for address SΣ 0..* Address Adresse
Slice: Unordered, Open by pattern:$this
.... address:Strassenanschrift SΣC 0..* AddressDeBasis Straßenanschrift
Constraints: pat-cnt-2or3-char

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... 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 precinct
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 Beispiel 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 streetName
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName
....... extension:Hausnummer S 0..1 string houseNumber
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber
....... extension:Adresszusatz S 0..1 string additionalLocator
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 0..* Extension Extension
Slice: Unordered, Open by value:url
...... Slices for extension Content/Rules for all slices
....... extension:gemeindeschluessel S 0..1 (Complex) Optional Extensions Element
URL: http://fhir.de/StructureDefinition/destatis/ags
........ extension 0..0 Additional content defined by implementations
Slice: Unordered, Open by value:url
........ url S 1..1 uri "http://fhir.de/StructureDefinition/destatis/ags"
........ value[x] S 1..1 Coding Value of extension
Example AGS Hildesheim: {"system":"http://fhir.de/sid/destatis/ags","code":"03254021"}
......... system SΣ 1..1 uri Identity of the terminology system
Fixed Value: http://fhir.de/sid/destatis/ags
......... code SΣC 1..1 code Symbol in syntax defined by the system
Constraints: ags-extension-1
..... postalCode SΣ 1..1 string Postleitzahl
Example General: 9132
..... country SΣ 1..1 string Staat
Example Beispiel für textuelle Landesangabe: Deutschland
...... Slices for extension Content/Rules for all slices
....... extension:countryCode 0..1 (Complex) Länderkennzeichen nach ISO 3166-1
URL: http://hl7.org/fhir/StructureDefinition/iso21090-codedString

Example Beispiel für kodierte Landesangabe: {"system":"urn:iso:std:iso:3166","code":"DE","display":"Deutschland"}
........ extension 0..0 Additional content defined by implementations
Slice: Unordered, Open by value:url
........ url 1..1 uri "http://hl7.org/fhir/StructureDefinition/iso21090-codedString"
........ value[x] 1..1 Coding Value of extension
Binding: Iso3166-1-2 (required): A coded representation for a string. Could be codes for country in a country address part, codes for prefixes in a name part, etc.
.... address:Postfach SΣC 0..* AddressDeBasis Postfach
Constraints: pat-cnt-2or3-char

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... 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 precinct
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 Beispiel 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 postBox
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 0..* Extension Extension
Slice: Unordered, Open by value:url
...... Slices for extension Content/Rules for all slices
....... extension:gemeindeschluessel S 0..1 (Complex) Optional Extensions Element
URL: http://fhir.de/StructureDefinition/destatis/ags
........ extension 0..0 Additional content defined by implementations
Slice: Unordered, Open by value:url
........ url S 1..1 uri "http://fhir.de/StructureDefinition/destatis/ags"
........ value[x] S 1..1 Coding Value of extension
Example AGS Hildesheim: {"system":"http://fhir.de/sid/destatis/ags","code":"03254021"}
......... system SΣ 1..1 uri Identity of the terminology system
Fixed Value: http://fhir.de/sid/destatis/ags
......... code SΣC 1..1 code Symbol in syntax defined by the system
Constraints: ags-extension-1
..... postalCode SΣ 1..1 string Postleitzahl
Example General: 9132
..... country SΣ 1..1 string Staat
Example Beispiel für textuelle Landesangabe: Deutschland
...... Slices for extension Content/Rules for all slices
....... extension:countryCode 0..1 (Complex) Länderkennzeichen nach ISO 3166-1
URL: http://hl7.org/fhir/StructureDefinition/iso21090-codedString

Example Beispiel für kodierte Landesangabe: {"system":"urn:iso:std:iso:3166","code":"DE","display":"Deutschland"}
........ extension 0..0 Additional content defined by implementations
Slice: Unordered, Open by value:url
........ url 1..1 uri "http://hl7.org/fhir/StructureDefinition/iso21090-codedString"
........ value[x] 1..1 Coding Value of extension
Binding: Iso3166-1-2 (required): A coded representation for a string. Could be codes for country in a country address part, codes for prefixes in a name part, etc.
... link ?!SΣ 0..* BackboneElement Verweis
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... other SΣ 1..1 Reference(Patient | RelatedPerson) The other patient or related person resource that the link refers to
.... 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.extension:birthPlace.​value[x].use Base required AddressUse 📍4.0.1 FHIR Std.
Patient.extension:birthPlace.​value[x].country.extension:countryCode.​value[x] Base preferred Iso 3166 Part 1: 2 Letter Codes 📦4.0.1 FHIR Std.
Patient.extension:patient-citizenship.​extension:code.value[x] Base preferred Country ValueSet 📦5.0.0 FHIR Extensions Pack v5.3
Patient.extension:recordedSexOrGender.​extension:value.value[x] Base preferred MII VS Person Recorded Sex or Gender SNOMED 📦2027.0.0-ballot This IG
Patient.extension:recordedSexOrGender.​extension:type.value[x] Base example Recorded Sex Or Gender Type 📦2.0.0 THO v7.2
Patient.extension:recordedSexOrGender.​extension:jurisdiction.​value[x] Base extensible Jurisdiction ValueSet 📦1.0.0 THO v7.2
Patient.identifier:versichertenId.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:versichertenId.​type Base required Identifier Type Kvid DeBasis ValueSet 📦1.6.0 de.basisprofil.r4 v1.6
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.6.0 de.basisprofil.r4 v1.6
Patient.identifier:pid.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:pid.​type Base extensible Identifier Type DeBasis ValueSet 📦1.6.0 de.basisprofil.r4 v1.6
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.gender.extension:other-amtlich.​value[x] Base required GenderOtherDE ValueSet 📦1.6.0 de.basisprofil.r4 v1.6
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.extension:countryCode.​value[x] Base required 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.extension:countryCode.​value[x] Base required 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
ags-extension-1 error Patient.address:Strassenanschrift.city.extension:gemeindeschluessel.value[x].code, Patient.address:Postfach.city.extension:gemeindeschluessel.value[x].code Der Amtliche Gemeindeschlüssel ist nummerisch und begrenzt auf acht Stellen $this.matches('^[0-9]{8}$')
dom-2 error Patient If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Patient If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Patient If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Patient If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Patient A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
gender-amtlich-1 error Patient.gender.extension:other-amtlich.value[x] Die amtliche Differenzierung der Geschlechtsangabe 'other' darf nur gefüllt sein, wenn das Geschlecht 'other' angegeben ist %resource.where(gender='other').exists()
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-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 SHALL have a contained resource if a local reference is provided reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient C 0..* Patient Information about an individual or animal receiving health care services
Constraints: mii-pat-1
... id S 0..1 id Logical id of this artifact
... meta S 0..1 Meta Metadata about the resource
.... profile S 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:birthPlace S 0..1 (Complex)
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
..... url S 1..1 uri identifies the meaning of the extension
..... value[x] S 1..1 Address Value of extension
...... country S 0..1 string
....... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... Slices for extension Content/Rules for all slices
........ extension:countryCode S 0..1 (Complex) code for string
URL: http://hl7.org/fhir/StructureDefinition/iso21090-codedString
......... value[x] S 1..1 Coding Value of extension
Binding: Iso3166-1-2 (preferred)
.......... system S 0..1 uri Identity of the terminology system
.......... code S 0..1 code Symbol in syntax defined by the system
.... extension:patient-citizenship S 0..* (Complex)
URL: http://hl7.org/fhir/StructureDefinition/patient-citizenship
..... Slices for extension Content/Rules for all slices
...... extension:code S 0..1 Extension Extension
....... url S 1..1 uri identifies the meaning of the extension
....... value[x] S 1..1 CodeableConcept Value of extension
........ coding S 0..* Coding Code defined by a terminology system
......... system S 0..1 uri Identity of the terminology system
......... code S 0..1 code Symbol in syntax defined by the system
...... extension:period S 0..1 Extension Extension
....... url S 1..1 uri identifies the meaning of the extension
....... value[x] S 1..1 Period Value of extension
..... url S 1..1 uri identifies the meaning of the extension
.... extension:patient-nationality S 0..* (Complex)
URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
..... Slices for extension Content/Rules for all slices
...... extension:code S 0..1 Extension Extension
....... url S 1..1 uri identifies the meaning of the extension
....... value[x] S 1..1 CodeableConcept Value of extension
........ coding S 0..* Coding Code defined by a terminology system
......... system S 0..1 uri Identity of the terminology system
......... code S 0..1 code Symbol in syntax defined by the system
...... extension:period S 0..1 Extension Extension
....... url S 1..1 uri identifies the meaning of the extension
....... value[x] S 1..1 Period Value of extension
..... url S 1..1 uri identifies the meaning of the extension
.... extension:recordedSexOrGender S 0..* (Complex)
URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender
..... Slices for extension Content/Rules for all slices
...... extension:value S 1..1 Extension Extension
....... url S 1..1 uri identifies the meaning of the extension
....... value[x] S 1..1 CodeableConcept Value of extension
Binding: MII VS Person Recorded Sex or Gender SNOMED (preferred)
........ coding S 0..* Coding Code defined by a terminology system
......... system S 0..1 uri Identity of the terminology system
......... code S 0..1 code Symbol in syntax defined by the system
...... extension:type S 0..1 Extension Extension
....... url S 1..1 uri identifies the meaning of the extension
....... value[x] S 1..1 CodeableConcept Value of extension
........ coding S 0..* Coding Code defined by a terminology system
......... system S 0..1 uri Identity of the terminology system
......... code S 0..1 code Symbol in syntax defined by the system
...... extension:acquisitionDate S 0..1 Extension Extension
....... url S 1..1 uri identifies the meaning of the extension
....... value[x] S 1..1 dateTime Value of extension
..... url S 1..1 uri identifies the meaning of the extension
.... identifier:versichertenId S 0..1 IdentifierKvid10 Krankenversichertennummer
Required Pattern: At least the following
..... type S 1..1 CodeableConcept Description of identifier
Fixed Value: (Complex)
...... coding S 0..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... system S 0..1 uri Identity of the terminology system
Fixed Value: http://fhir.de/CodeSystem/identifier-type-de-basis
....... code S 0..1 code Symbol in syntax defined by the system
Fixed Value: KVZ10
..... system S 1..1 uri The namespace for the identifier value
..... value S 1..1 string The value that is unique
..... assigner S 1..1 Reference(Organization) Organization that issued id (may be just text)
...... identifier S 1..1 IdentifierIknr Logical reference, when literal reference is not known
....... type S 0..1 CodeableConcept Description of identifier
........ coding S 0..* Coding Code defined by a terminology system
......... system S 0..1 uri Identity of the terminology system
......... code S 0..1 code Symbol in syntax defined by the system
....... system S 1..1 uri The namespace for the identifier value
....... value S 1..1 string The value that is unique
.... identifier:pid S 0..* IdentifierPid Patientenidentifikation

Required Pattern: At least the following
..... type S 1..1 CodeableConcept Description of identifier
Fixed Value: (Complex)
...... coding S 0..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... system S 0..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... code S 0..1 code Symbol in syntax defined by the system
Fixed Value: MR
..... system S 1..1 uri The namespace for the identifier value
..... value S 1..1 string The value that is unique
..... assigner S 0..1 Reference(Organization) Organization that issued id (may be just text)
...... identifier S 0..1 Identifier Logical reference, when literal reference is not known
....... type S 0..1 CodeableConcept Description of identifier
Required Pattern: At least the following
........ coding S 0..* Coding Code defined by a terminology system
Fixed Value: (Complex)
......... system S 0..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
......... code S 0..1 code Symbol in syntax defined by the system
Fixed Value: XX
....... system C 0..1 uri The namespace for the identifier value
Constraints: mii-pat-2
... Slices for name S 0..* HumanName Name
Slice: Unordered, Open by pattern:$this
.... name:name S 0..1 HumannameDeBasis Personenname
Required Pattern: At least the following
..... use S 1..1 code usual | official | temp | nickname | anonymous | old | maiden
Fixed Value: official
..... family S 1..1 string Familienname
...... Slices for extension Content/Rules for all slices
....... extension:namenszusatz S 0..1 HumannameNamenszusatz Namenszusatz gemäß VSDM (Versichertenstammdatenmanagement, "eGK")
....... extension:nachname S 0..1 OwnName(5.3.0) Portion derived from person's own surname
....... extension:vorsatzwort S 0..1 OwnPrefix(5.3.0) Voorvoegsel derived from person's own surname
..... given S 1..* string Vorname
..... prefix S 0..* string Namensteile vor dem Vornamen
...... Slices for extension Content/Rules for all slices
....... extension:prefix-qualifier S 0..1 ENQualifier(5.3.0) LS | AC | NB | PR | HON | BR | AD | SP | MID | CL | IN | VV
.... name:geburtsname S 0..1 HumannameDeBasis Geburtsname
Required Pattern: At least the following
..... use S 1..1 code usual | official | temp | nickname | anonymous | old | maiden
Fixed Value: maiden
..... family S 1..1 string Familienname
...... Slices for extension Content/Rules for all slices
....... extension:namenszusatz S 0..1 HumannameNamenszusatz Namenszusatz gemäß VSDM (Versichertenstammdatenmanagement, "eGK")
....... extension:nachname S 0..1 OwnName(5.3.0) Portion derived from person's own surname
....... extension:vorsatzwort S 0..1 OwnPrefix(5.3.0) Voorvoegsel derived from person's own surname
..... given 0..0 Vorname
..... prefix 0..0 Namensteile vor dem Vornamen
... gender S 0..1 code Administratives Geschlecht
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:other-amtlich S 0..1 (Complex) Extension Administratives Geschlecht
URL: http://fhir.de/StructureDefinition/gender-amtlich-de
...... url S 1..1 uri identifies the meaning of the extension
...... value[x] S 1..1 Coding Value of extension
....... system S 0..1 uri Identity of the terminology system
....... code S 0..1 code Symbol in syntax defined by the system
... birthDate S 0..1 date Geburtsdatum
.... Slices for extension 0..* Extension Extension
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)
... Slices for deceased[x] S 0..1 boolean, dateTime Verstorben
Slice: Unordered, Open by type:$this
.... deceased[x]:deceasedBoolean S 0..1 boolean Indicates if the individual is deceased or not
.... deceased[x]:deceasedDateTime S 0..1 dateTime Indicates if the individual is deceased or not
... Slices for address S 0..* Address Adresse
Slice: Unordered, Open by pattern:$this
.... address:Strassenanschrift SC 0..* AddressDeBasis Straßenanschrift
Constraints: pat-cnt-2or3-char

Required Pattern: At least the following
..... Slices for extension Content/Rules for all slices
...... extension:Stadtteil S 0..1 ADXPPrecinct(5.3.0) precinct
..... type S 1..1 code postal | physical | both
Fixed Value: both
..... line S 1..3 string Straßenname mit Hausnummer oder Postfach sowie weitere Angaben zur Zustellung
...... Slices for extension Content/Rules for all slices
....... extension:Strasse S 0..1 ADXPStreetName(5.3.0) streetName
....... extension:Hausnummer S 0..1 ADXPHouseNumber(5.3.0) houseNumber
....... extension:Adresszusatz S 0..1 ADXPAdditionalLocator(5.3.0) additionalLocator
....... extension:Postfach S 0..0 postBox
..... city S 1..1 string Name of city, town etc.
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... Slices for extension Content/Rules for all slices
....... extension:gemeindeschluessel S 0..1 (Complex) Optional Extensions Element
URL: http://fhir.de/StructureDefinition/destatis/ags
........ url S 1..1 uri identifies the meaning of the extension
........ value[x] S 1..1 Coding Value of extension
......... system S 1..1 uri Identity of the terminology system
......... code S 1..1 code Symbol in syntax defined by the system
..... postalCode S 1..1 string Postleitzahl
..... country S 1..1 string Staat
.... address:Postfach SC 0..* AddressDeBasis Postfach
Constraints: pat-cnt-2or3-char

Required Pattern: At least the following
..... Slices for extension Content/Rules for all slices
...... extension:Stadtteil S 0..1 ADXPPrecinct(5.3.0) precinct
..... type S 1..1 code postal | physical | both
Fixed Value: postal
..... line S 1..3 string Straßenname mit Hausnummer oder Postfach sowie weitere Angaben zur Zustellung
...... Slices for extension Content/Rules for all slices
....... extension:Strasse 0..0 streetName
....... extension:Hausnummer 0..0 houseNumber
....... extension:Adresszusatz 0..0 additionalLocator
....... extension:Postfach S 0..1 ADXPPostBox(5.3.0) postBox
..... city S 1..1 string Name of city, town etc.
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... Slices for extension Content/Rules for all slices
....... extension:gemeindeschluessel S 0..1 (Complex) Optional Extensions Element
URL: http://fhir.de/StructureDefinition/destatis/ags
........ url S 1..1 uri identifies the meaning of the extension
........ value[x] S 1..1 Coding Value of extension
......... system S 1..1 uri Identity of the terminology system
......... code S 1..1 code Symbol in syntax defined by the system
..... postalCode S 1..1 string Postleitzahl
..... country S 1..1 string Staat
... link S 0..* BackboneElement Verweis
.... other S 1..1 Reference(Patient | RelatedPerson) The other patient or related person resource that the link refers to
.... type S 1..1 code replaced-by | replaces | refer | seealso

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Patient.extension:birthPlace.​value[x].country.extension:countryCode.​value[x] Base preferred Iso 3166 Part 1: 2 Letter Codes 📦4.0.1 FHIR Std.
Patient.extension:recordedSexOrGender.​extension:value.value[x] Base preferred MII VS Person Recorded Sex or Gender SNOMED 📦2027.0.0-ballot This IG

Constraints

Id Grade Path(s) Description Expression
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-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'))
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient C 0..* Patient Information about an individual or animal receiving health care services
Constraints: mii-pat-1
... id SΣ 0..1 id Logical id of this artifact
... meta SΣ 0..1 Meta Metadata about the resource
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile SΣ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:birthPlace S 0..1 (Complex)
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url S 1..1 uri "http://hl7.org/fhir/StructureDefinition/patient-birthPlace"
..... value[x] S 1..1 Address Value of extension
...... 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 home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.
Example General: home
...... type Σ 0..1 code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).
Example General: both
...... text Σ 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
...... line Σ 0..* string Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
...... city Σ 0..1 string Name of city, town etc.
Example General: Erewhon
...... district Σ 0..1 string District name (aka county)
Example General: Madison
...... state Σ 0..1 string Sub-unit of country (abbreviations ok)
...... postalCode Σ 0..1 string Postal code for area
Example General: 9132
...... country SΣ 0..1 string
....... id 0..1 string xml:id (or equivalent in JSON)
....... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... Slices for extension Content/Rules for all slices
........ extension:countryCode S 0..1 (Complex) code for string
URL: http://hl7.org/fhir/StructureDefinition/iso21090-codedString
......... id 0..1 string Unique id for inter-element referencing
......... extension 0..0 Extension
Slice: Unordered, Open by value:url
......... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/iso21090-codedString"
......... value[x] S 1..1 Coding Value of extension
Binding: Iso3166-1-2 (preferred)
.......... id 0..1 string Unique id for inter-element referencing
.......... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.......... system SΣ 0..1 uri Identity of the terminology system
.......... version Σ 0..1 string Version of the system - if relevant
.......... code SΣ 0..1 code Symbol in syntax defined by the system
.......... display Σ 0..1 string Representation defined by the system
.......... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
....... value 0..1 string Primitive value for string
Max Length:1048576
...... period Σ 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
.... extension:patient-citizenship S 0..* (Complex)
URL: http://hl7.org/fhir/StructureDefinition/patient-citizenship
..... 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
..... Slices for extension Content/Rules for all slices
...... extension:code S 0..1 Extension Extension
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url S 1..1 uri "code"
....... value[x] S 1..1 CodeableConcept Value of extension
Binding: CountryValueSet (preferred)
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ coding SΣ 0..* Coding Code defined by a terminology system
......... id 0..1 string Unique id for inter-element referencing
......... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
......... system SΣ 0..1 uri Identity of the terminology system
......... version Σ 0..1 string Version of the system - if relevant
......... code SΣ 0..1 code Symbol in syntax defined by the system
......... 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
...... extension:period S 0..1 Extension Extension
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url S 1..1 uri "period"
....... value[x] S 1..1 Period Value of extension
..... url S 1..1 uri "http://hl7.org/fhir/StructureDefinition/patient-citizenship"
.... extension:patient-nationality S 0..* (Complex)
URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
..... 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
..... Slices for extension Content/Rules for all slices
...... extension:code S 0..1 Extension Extension
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url S 1..1 uri "code"
....... value[x] S 1..1 CodeableConcept Value of extension
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ coding SΣ 0..* Coding Code defined by a terminology system
......... id 0..1 string Unique id for inter-element referencing
......... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
......... system SΣ 0..1 uri Identity of the terminology system
......... version Σ 0..1 string Version of the system - if relevant
......... code SΣ 0..1 code Symbol in syntax defined by the system
......... 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
...... extension:period S 0..1 Extension Extension
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url S 1..1 uri "period"
....... value[x] S 1..1 Period Value of extension
..... url S 1..1 uri "http://hl7.org/fhir/StructureDefinition/patient-nationality"
.... extension:recordedSexOrGender S 0..* (Complex)
URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 1..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... Slices for extension Content/Rules for all slices
...... extension:value S 1..1 Extension Extension
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url S 1..1 uri "value"
....... value[x] S 1..1 CodeableConcept Value of extension
Binding: MII VS Person Recorded Sex or Gender SNOMED (preferred)
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ coding SΣ 0..* Coding Code defined by a terminology system
......... id 0..1 string Unique id for inter-element referencing
......... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
......... system SΣ 0..1 uri Identity of the terminology system
......... version Σ 0..1 string Version of the system - if relevant
......... code SΣ 0..1 code Symbol in syntax defined by the system
......... 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
...... extension:type S 0..1 Extension Extension
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url S 1..1 uri "type"
....... value[x] S 1..1 CodeableConcept Value of extension
Binding: Recorded Sex Or Gender Type (example)
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ coding SΣ 0..* Coding Code defined by a terminology system
......... id 0..1 string Unique id for inter-element referencing
......... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
......... system SΣ 0..1 uri Identity of the terminology system
......... version Σ 0..1 string Version of the system - if relevant
......... code SΣ 0..1 code Symbol in syntax defined by the system
......... 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
...... extension:effectivePeriod 0..1 Extension When the recorded sex or gender value applies
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "effectivePeriod"
....... value[x] 0..1 Period Value of extension
...... extension:acquisitionDate S 0..1 Extension Extension
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url S 1..1 uri "acquisitionDate"
....... value[x] S 1..1 dateTime Value of extension
...... extension:source 0..1 Extension The source of the Recorded Sex or Gender value.
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "source"
....... value[x] 1..1 Value of extension
........ valueCodeableConcept CodeableConcept
........ valueReference Reference(Organization | Device | RelatedPerson | Practitioner)
...... extension:sourceDocument 0..1 Extension The document the sex or gender property was acquired from.
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "sourceDocument"
....... value[x] 1..1 Value of extension
........ valueCodeableConcept CodeableConcept
........ valueReference Reference(DocumentReference)
...... extension:sourceField 0..1 Extension The name of the field within the source document where this sex or gender property is initially recorded.
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "sourceField"
....... value[x] 1..1 string Value of extension
...... extension:jurisdiction 0..1 Extension Who issued the document where the sex or gender was aquired
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "jurisdiction"
....... value[x] 1..1 CodeableConcept Value of extension
Binding: Jurisdiction ValueSet (extensible)
...... extension:comment 0..1 Extension Context or source information about the recorded sex or gender
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "comment"
....... value[x] 1..1 string Value of extension
...... extension:genderElementQualifier 0..1 Extension Whether this recorded sex or gender value qualifies the .gender element.
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "genderElementQualifier"
....... value[x] 1..1 boolean Value of extension
..... url S 1..1 uri "http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender"
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier SΣ 0..* Identifier Patienten-Identifikator
Slice: Unordered, Open by pattern:$this
.... identifier:versichertenId SΣ 0..1 IdentifierKvid10 Krankenversichertennummer

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 Kvid DeBasis ValueSet (required): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Constraints: kvid-2
Fixed Value: (Complex)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... coding SΣ 0..* 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
Slice: Unordered, Open by value:url
....... system SΣ 0..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 SΣ 0..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 Logical reference, when literal reference is not known
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
....... type SΣ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type DeBasis ValueSet (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Required Pattern: At least the following
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ coding SΣ 0..* 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
Slice: Unordered, Open by value:url
......... system SΣ 0..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 SΣ 0..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Σ 0..* IdentifierPid Patientenidentifikation

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
Slice: Unordered, Open by value:url
...... coding SΣ 0..* 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
Slice: Unordered, Open by value:url
....... system SΣ 0..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 SΣ 0..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 SΣ 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
Slice: Unordered, Open by value:url
........ coding SΣ 0..* 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
Slice: Unordered, Open by value:url
......... system SΣ 0..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 SΣ 0..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 Σ 0..1 Period Time period when id is/was valid for use
....... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
...... display Σ 0..1 string Text alternative for the resource
... active ?!Σ 0..1 boolean Whether this patient's record is in active use
... Slices for name SΣ 0..* HumanName Name
Slice: Unordered, Open by pattern:$this
.... name:name SΣ 0..1 HumannameDeBasis Personenname

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
...... 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 Portion derived from person's own surname
URL: http://hl7.org/fhir/StructureDefinition/humanname-own-name
....... extension:vorsatzwort S 0..1 string Voorvoegsel derived from person's own surname
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
...... 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)
...... 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Σ 0..1 HumannameDeBasis Geburtsname

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
...... 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 Portion derived from person's own surname
URL: http://hl7.org/fhir/StructureDefinition/humanname-own-name
....... extension:vorsatzwort S 0..1 string Voorvoegsel derived from person's own surname
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 Σ 0..* ContactPoint A contact detail for the individual
... gender SΣ 0..1 code Administratives Geschlecht
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:other-amtlich S 0..1 (Complex) Extension Administratives Geschlecht
URL: http://fhir.de/StructureDefinition/gender-amtlich-de
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..0 Additional content defined by implementations
Slice: Unordered, Open by value:url
...... url S 1..1 uri "http://fhir.de/StructureDefinition/gender-amtlich-de"
...... value[x] SC 1..1 Coding Value of extension
Binding: GenderOtherDE ValueSet (required)
Constraints: gender-amtlich-1
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... system SΣ 0..1 uri Identity of the terminology system
....... version Σ 0..1 string Version of the system - if relevant
....... code SΣ 0..1 code Symbol in syntax defined by the system
....... display Σ 0..1 string Representation defined by the system
....... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... value 0..1 string Primitive value for code
... birthDate SΣ 0..1 date Geburtsdatum
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:data-absent-reason S 0..1 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
... Slices for deceased[x] ?!SΣ 0..1 Verstorben
Slice: Unordered, Closed by type:$this
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
.... deceased[x]:deceasedBoolean ?!SΣ 0..1 boolean Indicates if the individual is deceased or not
.... deceased[x]:deceasedDateTime ?!SΣ 0..1 dateTime Indicates if the individual is deceased or not
... Slices for address SΣ 0..* Address Adresse
Slice: Unordered, Open by pattern:$this
.... address:Strassenanschrift SΣC 0..* AddressDeBasis Straßenanschrift
Constraints: pat-cnt-2or3-char

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... Slices for extension Content/Rules for all slices
...... extension:Stadtteil S 0..1 string precinct
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 Beispiel 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
...... Slices for extension Content/Rules for all slices
....... extension:Strasse S 0..1 string streetName
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName
....... extension:Hausnummer S 0..1 string houseNumber
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber
....... extension:Adresszusatz S 0..1 string additionalLocator
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 xml:id (or equivalent in JSON)
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... Slices for extension Content/Rules for all slices
....... extension:gemeindeschluessel S 0..1 (Complex) Optional Extensions Element
URL: http://fhir.de/StructureDefinition/destatis/ags
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..0 Additional content defined by implementations
Slice: Unordered, Open by value:url
........ url S 1..1 uri "http://fhir.de/StructureDefinition/destatis/ags"
........ value[x] S 1..1 Coding Value of extension
Example AGS Hildesheim: {"system":"http://fhir.de/sid/destatis/ags","code":"03254021"}
......... id 0..1 string Unique id for inter-element referencing
......... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
......... system SΣ 1..1 uri Identity of the terminology system
Fixed Value: http://fhir.de/sid/destatis/ags
......... version Σ 0..1 string Version of the system - if relevant
......... code SΣC 1..1 code Symbol in syntax defined by the system
Constraints: ags-extension-1
......... display Σ 0..1 string Representation defined by the system
......... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
...... 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
Example Beispiel für textuelle Landesangabe: Deutschland
...... 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, value:value.ofType(Coding).system
...... Slices for extension Content/Rules for all slices
....... extension:countryCode 0..1 (Complex) Länderkennzeichen nach ISO 3166-1
URL: http://hl7.org/fhir/StructureDefinition/iso21090-codedString

Example Beispiel für kodierte Landesangabe: {"system":"urn:iso:std:iso:3166","code":"DE","display":"Deutschland"}
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..0 Additional content defined by implementations
Slice: Unordered, Open by value:url
........ url 1..1 uri "http://hl7.org/fhir/StructureDefinition/iso21090-codedString"
........ value[x] 1..1 Coding Value of extension
Binding: Iso3166-1-2 (required): A coded representation for a string. Could be codes for country in a country address part, codes for prefixes in a name part, etc.
...... value 0..1 string Primitive value for string
Max Length:1048576
..... 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 Postfach
Constraints: 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
..... Slices for extension Content/Rules for all slices
...... extension:Stadtteil S 0..1 string precinct
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 Beispiel 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
...... Slices for extension Content/Rules for all slices
....... extension:Postfach S 0..1 string postBox
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 xml:id (or equivalent in JSON)
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... Slices for extension Content/Rules for all slices
....... extension:gemeindeschluessel S 0..1 (Complex) Optional Extensions Element
URL: http://fhir.de/StructureDefinition/destatis/ags
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..0 Additional content defined by implementations
Slice: Unordered, Open by value:url
........ url S 1..1 uri "http://fhir.de/StructureDefinition/destatis/ags"
........ value[x] S 1..1 Coding Value of extension
Example AGS Hildesheim: {"system":"http://fhir.de/sid/destatis/ags","code":"03254021"}
......... id 0..1 string Unique id for inter-element referencing
......... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
......... system SΣ 1..1 uri Identity of the terminology system
Fixed Value: http://fhir.de/sid/destatis/ags
......... version Σ 0..1 string Version of the system - if relevant
......... code SΣC 1..1 code Symbol in syntax defined by the system
Constraints: ags-extension-1
......... display Σ 0..1 string Representation defined by the system
......... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
...... 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
Example Beispiel für textuelle Landesangabe: Deutschland
...... 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, value:value.ofType(Coding).system
...... Slices for extension Content/Rules for all slices
....... extension:countryCode 0..1 (Complex) Länderkennzeichen nach ISO 3166-1
URL: http://hl7.org/fhir/StructureDefinition/iso21090-codedString

Example Beispiel für kodierte Landesangabe: {"system":"urn:iso:std:iso:3166","code":"DE","display":"Deutschland"}
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..0 Additional content defined by implementations
Slice: Unordered, Open by value:url
........ url 1..1 uri "http://hl7.org/fhir/StructureDefinition/iso21090-codedString"
........ value[x] 1..1 Coding Value of extension
Binding: Iso3166-1-2 (required): A coded representation for a string. Could be codes for country in a country address part, codes for prefixes in a name part, etc.
...... value 0..1 string Primitive value for string
Max Length:1048576
..... 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 0..* Attachment Image of the patient
... contact C 0..* BackboneElement A contact party (e.g. guardian, partner, friend) for the patient
Constraints: pat-1
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... relationship 0..* CodeableConcept The kind of relationship
Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.
.... name 0..1 HumanName A name associated with the contact person
.... telecom 0..* ContactPoint A contact detail for the person
.... address 0..1 Address Address for the contact person
.... gender 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
.... organization C 0..1 Reference(Organization) Organization that is associated with the contact
.... period 0..1 Period The period during which this contact person or organization is valid to be contacted relating to this patient
... communication 0..* BackboneElement A language which may be used to communicate with the patient about his or her health
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... language 1..1 CodeableConcept The language which can be used to communicate with the patient about his or her health
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
.... preferred 0..1 boolean Language preference indicator
... generalPractitioner 0..* Reference(Organization | Practitioner | PractitionerRole) Patient's nominated primary care provider
... managingOrganization Σ 0..1 Reference(Organization) Organization that is the custodian of the patient record
... link ?!SΣ 0..* BackboneElement Verweis
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... other SΣ 1..1 Reference(Patient | RelatedPerson) The other patient or related person resource that the link refers to
.... 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.extension:birthPlace.​value[x].use Base required AddressUse 📍4.0.1 FHIR Std.
Patient.extension:birthPlace.​value[x].type Base required AddressType 📍4.0.1 FHIR Std.
Patient.extension:birthPlace.​value[x].country.extension:countryCode.​value[x] Base preferred Iso 3166 Part 1: 2 Letter Codes 📦4.0.1 FHIR Std.
Patient.extension:patient-citizenship.​extension:code.value[x] Base preferred Country ValueSet 📦5.0.0 FHIR Extensions Pack v5.3
Patient.extension:recordedSexOrGender.​extension:value.value[x] Base preferred MII VS Person Recorded Sex or Gender SNOMED 📦2027.0.0-ballot This IG
Patient.extension:recordedSexOrGender.​extension:type.value[x] Base example Recorded Sex Or Gender Type 📦2.0.0 THO v7.2
Patient.extension:recordedSexOrGender.​extension:jurisdiction.​value[x] Base extensible Jurisdiction ValueSet 📦1.0.0 THO v7.2
Patient.identifier:versichertenId.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:versichertenId.​type Base required Identifier Type Kvid DeBasis ValueSet 📦1.6.0 de.basisprofil.r4 v1.6
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.6.0 de.basisprofil.r4 v1.6
Patient.identifier:pid.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:pid.​type Base extensible Identifier Type DeBasis ValueSet 📦1.6.0 de.basisprofil.r4 v1.6
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.gender.extension:other-amtlich.​value[x] Base required GenderOtherDE ValueSet 📦1.6.0 de.basisprofil.r4 v1.6
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.6.0 de.basisprofil.r4 v1.6
Patient.address:Strassenanschrift.​country.extension:countryCode.​value[x] Base required 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.6.0 de.basisprofil.r4 v1.6
Patient.address:Postfach.​country.extension:countryCode.​value[x] Base required 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
ags-extension-1 error Patient.address:Strassenanschrift.city.extension:gemeindeschluessel.value[x].code, Patient.address:Postfach.city.extension:gemeindeschluessel.value[x].code Der Amtliche Gemeindeschlüssel ist nummerisch und begrenzt auf acht Stellen $this.matches('^[0-9]{8}$')
dom-2 error Patient If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Patient If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Patient If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Patient If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Patient A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
gender-amtlich-1 error Patient.gender.extension:other-amtlich.value[x] Die amtliche Differenzierung der Geschlechtsangabe 'other' darf nur gefüllt sein, wenn das Geschlecht 'other' angegeben ist %resource.where(gender='other').exists()
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.name:name.period, Patient.name:geburtsname.period, Patient.address:Strassenanschrift.period, Patient.address:Postfach.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 SHALL have a contained resource if a local reference is provided reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Summary

Mandatory: 0 element(18 nested mandatory elements)
Must-Support: 140 elements
Prohibited: 6 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Patient.identifier
  • The element 1 is sliced based on the value of Patient.name
  • The element 1 is sliced based on the value of Patient.deceased[x]
  • The element 1 is sliced based on the value of Patient.address

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient C 0..* Patient Information about an individual or animal receiving health care services
Constraints: mii-pat-1
... id SΣ 0..1 id Logical id of this artifact
... meta SΣ 0..1 Meta Metadata about the resource
.... profile SΣ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
.... extension:birthPlace S 0..1 (Complex)
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url S 1..1 uri "http://hl7.org/fhir/StructureDefinition/patient-birthPlace"
..... value[x] S 1..1 Address Value of extension
...... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.
Example General: home
...... country SΣ 0..1 string
....... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... Slices for extension Content/Rules for all slices
........ extension:countryCode S 0..1 (Complex) code for string
URL: http://hl7.org/fhir/StructureDefinition/iso21090-codedString
......... extension 0..0 Extension
Slice: Unordered, Open by value:url
......... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/iso21090-codedString"
......... value[x] S 1..1 Coding Value of extension
Binding: Iso3166-1-2 (preferred)
.......... system SΣ 0..1 uri Identity of the terminology system
.......... code SΣ 0..1 code Symbol in syntax defined by the system
.... extension:patient-citizenship S 0..* (Complex)
URL: http://hl7.org/fhir/StructureDefinition/patient-citizenship
..... Slices for extension Content/Rules for all slices
...... extension:code S 0..1 Extension Extension
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url S 1..1 uri "code"
....... value[x] S 1..1 CodeableConcept Value of extension
Binding: CountryValueSet (preferred)
........ coding SΣ 0..* Coding Code defined by a terminology system
......... system SΣ 0..1 uri Identity of the terminology system
......... code SΣ 0..1 code Symbol in syntax defined by the system
...... extension:period S 0..1 Extension Extension
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url S 1..1 uri "period"
....... value[x] S 1..1 Period Value of extension
..... url S 1..1 uri "http://hl7.org/fhir/StructureDefinition/patient-citizenship"
.... extension:patient-nationality S 0..* (Complex)
URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
..... Slices for extension Content/Rules for all slices
...... extension:code S 0..1 Extension Extension
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url S 1..1 uri "code"
....... value[x] S 1..1 CodeableConcept Value of extension
........ coding SΣ 0..* Coding Code defined by a terminology system
......... system SΣ 0..1 uri Identity of the terminology system
......... code SΣ 0..1 code Symbol in syntax defined by the system
...... extension:period S 0..1 Extension Extension
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url S 1..1 uri "period"
....... value[x] S 1..1 Period Value of extension
..... url S 1..1 uri "http://hl7.org/fhir/StructureDefinition/patient-nationality"
.... extension:recordedSexOrGender S 0..* (Complex)
URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender
..... Slices for extension 1..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... Slices for extension Content/Rules for all slices
...... extension:value S 1..1 Extension Extension
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url S 1..1 uri "value"
....... value[x] S 1..1 CodeableConcept Value of extension
Binding: MII VS Person Recorded Sex or Gender SNOMED (preferred)
........ coding SΣ 0..* Coding Code defined by a terminology system
......... system SΣ 0..1 uri Identity of the terminology system
......... code SΣ 0..1 code Symbol in syntax defined by the system
...... extension:type S 0..1 Extension Extension
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url S 1..1 uri "type"
....... value[x] S 1..1 CodeableConcept Value of extension
Binding: Recorded Sex Or Gender Type (example)
........ coding SΣ 0..* Coding Code defined by a terminology system
......... system SΣ 0..1 uri Identity of the terminology system
......... code SΣ 0..1 code Symbol in syntax defined by the system
...... extension:effectivePeriod 0..1 Extension When the recorded sex or gender value applies
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "effectivePeriod"
...... extension:acquisitionDate S 0..1 Extension Extension
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url S 1..1 uri "acquisitionDate"
....... value[x] S 1..1 dateTime Value of extension
...... extension:source 0..1 Extension The source of the Recorded Sex or Gender value.
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "source"
....... value[x] 1..1 Value of extension
........ valueCodeableConcept CodeableConcept
........ valueReference Reference(Organization | Device | RelatedPerson | Practitioner)
...... extension:sourceDocument 0..1 Extension The document the sex or gender property was acquired from.
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "sourceDocument"
....... value[x] 1..1 Value of extension
........ valueCodeableConcept CodeableConcept
........ valueReference Reference(DocumentReference)
...... extension:sourceField 0..1 Extension The name of the field within the source document where this sex or gender property is initially recorded.
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "sourceField"
....... value[x] 1..1 string Value of extension
...... extension:jurisdiction 0..1 Extension Who issued the document where the sex or gender was aquired
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "jurisdiction"
....... value[x] 1..1 CodeableConcept Value of extension
Binding: Jurisdiction ValueSet (extensible)
...... extension:comment 0..1 Extension Context or source information about the recorded sex or gender
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "comment"
....... value[x] 1..1 string Value of extension
...... extension:genderElementQualifier 0..1 Extension Whether this recorded sex or gender value qualifies the .gender element.
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "genderElementQualifier"
....... value[x] 1..1 boolean Value of extension
..... url S 1..1 uri "http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender"
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier SΣ 0..* Identifier Patienten-Identifikator
Slice: Unordered, Open by pattern:$this
.... identifier:versichertenId SΣ 0..1 IdentifierKvid10 Krankenversichertennummer

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 Kvid DeBasis ValueSet (required): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Constraints: kvid-2
Fixed Value: (Complex)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... text 0..1 string Plain text representation of the concept
...... coding SΣ 0..* 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
....... version 0..1 string Version of the system - if relevant
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
....... system SΣ 0..1 uri Identity of the terminology system
Fixed Value: http://fhir.de/CodeSystem/identifier-type-de-basis
....... code SΣ 0..1 code Symbol in syntax defined by the system
Fixed Value: KVZ10
..... 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
...... identifier SΣ 1..1 IdentifierIknr Logical reference, when literal reference is not known
....... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
....... type SΣ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type DeBasis ValueSet (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Required Pattern: At least the following
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
........ text 0..1 string Plain text representation of the concept
........ coding SΣ 0..* 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
......... version 0..1 string Version of the system - if relevant
......... display 0..1 string Representation defined by the system
......... userSelected 0..1 boolean If this coding was chosen directly by the user
......... system SΣ 0..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
......... code SΣ 0..1 code Symbol in syntax defined by the system
Fixed Value: XX
....... 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Σ 0..* IdentifierPid Patientenidentifikation

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
...... text 0..1 string Plain text representation of the concept
...... coding SΣ 0..* 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
....... version 0..1 string Version of the system - if relevant
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
....... system SΣ 0..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... code SΣ 0..1 code Symbol in syntax defined by the system
Fixed Value: MR
..... 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
...... identifier SΣ 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
........ text 0..1 string Plain text representation of the concept
........ coding SΣ 0..* 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
......... version 0..1 string Version of the system - if relevant
......... display 0..1 string Representation defined by the system
......... userSelected 0..1 boolean If this coding was chosen directly by the user
......... system SΣ 0..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
......... code SΣ 0..1 code Symbol in syntax defined by the system
Fixed Value: XX
....... system ΣC 0..1 uri The namespace for the identifier value
Constraints: mii-pat-2
Example General: http://www.acme.com/identifiers/patient
... active ?!Σ 0..1 boolean Whether this patient's record is in active use
... Slices for name SΣ 0..* HumanName Name
Slice: Unordered, Open by pattern:$this
.... name:name SΣ 0..1 HumannameDeBasis Personenname

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 Portion derived from person's own surname
URL: http://hl7.org/fhir/StructureDefinition/humanname-own-name
....... extension:vorsatzwort S 0..1 string Voorvoegsel derived from person's own surname
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Σ 0..1 HumannameDeBasis Geburtsname

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 Portion derived from person's own surname
URL: http://hl7.org/fhir/StructureDefinition/humanname-own-name
....... extension:vorsatzwort S 0..1 string Voorvoegsel derived from person's own surname
URL: http://hl7.org/fhir/StructureDefinition/humanname-own-prefix
... gender SΣ 0..1 code Administratives Geschlecht
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:other-amtlich S 0..1 (Complex) Extension Administratives Geschlecht
URL: http://fhir.de/StructureDefinition/gender-amtlich-de
...... extension 0..0 Additional content defined by implementations
Slice: Unordered, Open by value:url
...... url S 1..1 uri "http://fhir.de/StructureDefinition/gender-amtlich-de"
...... value[x] SC 1..1 Coding Value of extension
Binding: GenderOtherDE ValueSet (required)
Constraints: gender-amtlich-1
....... system SΣ 0..1 uri Identity of the terminology system
....... code SΣ 0..1 code Symbol in syntax defined by the system
... birthDate SΣ 0..1 date Geburtsdatum
.... Slices for extension 0..* Extension Extension
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)
... Slices for deceased[x] ?!SΣ 0..1 Verstorben
Slice: Unordered, Closed by type:$this
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
.... deceased[x]:deceasedBoolean ?!SΣ 0..1 boolean Indicates if the individual is deceased or not
.... deceased[x]:deceasedDateTime ?!SΣ 0..1 dateTime Indicates if the individual is deceased or not
... Slices for address SΣ 0..* Address Adresse
Slice: Unordered, Open by pattern:$this
.... address:Strassenanschrift SΣC 0..* AddressDeBasis Straßenanschrift
Constraints: pat-cnt-2or3-char

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... 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 precinct
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 Beispiel 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 streetName
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName
....... extension:Hausnummer S 0..1 string houseNumber
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber
....... extension:Adresszusatz S 0..1 string additionalLocator
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 0..* Extension Extension
Slice: Unordered, Open by value:url
...... Slices for extension Content/Rules for all slices
....... extension:gemeindeschluessel S 0..1 (Complex) Optional Extensions Element
URL: http://fhir.de/StructureDefinition/destatis/ags
........ extension 0..0 Additional content defined by implementations
Slice: Unordered, Open by value:url
........ url S 1..1 uri "http://fhir.de/StructureDefinition/destatis/ags"
........ value[x] S 1..1 Coding Value of extension
Example AGS Hildesheim: {"system":"http://fhir.de/sid/destatis/ags","code":"03254021"}
......... system SΣ 1..1 uri Identity of the terminology system
Fixed Value: http://fhir.de/sid/destatis/ags
......... code SΣC 1..1 code Symbol in syntax defined by the system
Constraints: ags-extension-1
..... postalCode SΣ 1..1 string Postleitzahl
Example General: 9132
..... country SΣ 1..1 string Staat
Example Beispiel für textuelle Landesangabe: Deutschland
...... Slices for extension Content/Rules for all slices
....... extension:countryCode 0..1 (Complex) Länderkennzeichen nach ISO 3166-1
URL: http://hl7.org/fhir/StructureDefinition/iso21090-codedString

Example Beispiel für kodierte Landesangabe: {"system":"urn:iso:std:iso:3166","code":"DE","display":"Deutschland"}
........ extension 0..0 Additional content defined by implementations
Slice: Unordered, Open by value:url
........ url 1..1 uri "http://hl7.org/fhir/StructureDefinition/iso21090-codedString"
........ value[x] 1..1 Coding Value of extension
Binding: Iso3166-1-2 (required): A coded representation for a string. Could be codes for country in a country address part, codes for prefixes in a name part, etc.
.... address:Postfach SΣC 0..* AddressDeBasis Postfach
Constraints: pat-cnt-2or3-char

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... 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 precinct
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 Beispiel 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 postBox
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 0..* Extension Extension
Slice: Unordered, Open by value:url
...... Slices for extension Content/Rules for all slices
....... extension:gemeindeschluessel S 0..1 (Complex) Optional Extensions Element
URL: http://fhir.de/StructureDefinition/destatis/ags
........ extension 0..0 Additional content defined by implementations
Slice: Unordered, Open by value:url
........ url S 1..1 uri "http://fhir.de/StructureDefinition/destatis/ags"
........ value[x] S 1..1 Coding Value of extension
Example AGS Hildesheim: {"system":"http://fhir.de/sid/destatis/ags","code":"03254021"}
......... system SΣ 1..1 uri Identity of the terminology system
Fixed Value: http://fhir.de/sid/destatis/ags
......... code SΣC 1..1 code Symbol in syntax defined by the system
Constraints: ags-extension-1
..... postalCode SΣ 1..1 string Postleitzahl
Example General: 9132
..... country SΣ 1..1 string Staat
Example Beispiel für textuelle Landesangabe: Deutschland
...... Slices for extension Content/Rules for all slices
....... extension:countryCode 0..1 (Complex) Länderkennzeichen nach ISO 3166-1
URL: http://hl7.org/fhir/StructureDefinition/iso21090-codedString

Example Beispiel für kodierte Landesangabe: {"system":"urn:iso:std:iso:3166","code":"DE","display":"Deutschland"}
........ extension 0..0 Additional content defined by implementations
Slice: Unordered, Open by value:url
........ url 1..1 uri "http://hl7.org/fhir/StructureDefinition/iso21090-codedString"
........ value[x] 1..1 Coding Value of extension
Binding: Iso3166-1-2 (required): A coded representation for a string. Could be codes for country in a country address part, codes for prefixes in a name part, etc.
... link ?!SΣ 0..* BackboneElement Verweis
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... other SΣ 1..1 Reference(Patient | RelatedPerson) The other patient or related person resource that the link refers to
.... 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.extension:birthPlace.​value[x].use Base required AddressUse 📍4.0.1 FHIR Std.
Patient.extension:birthPlace.​value[x].country.extension:countryCode.​value[x] Base preferred Iso 3166 Part 1: 2 Letter Codes 📦4.0.1 FHIR Std.
Patient.extension:patient-citizenship.​extension:code.value[x] Base preferred Country ValueSet 📦5.0.0 FHIR Extensions Pack v5.3
Patient.extension:recordedSexOrGender.​extension:value.value[x] Base preferred MII VS Person Recorded Sex or Gender SNOMED 📦2027.0.0-ballot This IG
Patient.extension:recordedSexOrGender.​extension:type.value[x] Base example Recorded Sex Or Gender Type 📦2.0.0 THO v7.2
Patient.extension:recordedSexOrGender.​extension:jurisdiction.​value[x] Base extensible Jurisdiction ValueSet 📦1.0.0 THO v7.2
Patient.identifier:versichertenId.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:versichertenId.​type Base required Identifier Type Kvid DeBasis ValueSet 📦1.6.0 de.basisprofil.r4 v1.6
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.6.0 de.basisprofil.r4 v1.6
Patient.identifier:pid.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:pid.​type Base extensible Identifier Type DeBasis ValueSet 📦1.6.0 de.basisprofil.r4 v1.6
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.gender.extension:other-amtlich.​value[x] Base required GenderOtherDE ValueSet 📦1.6.0 de.basisprofil.r4 v1.6
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.extension:countryCode.​value[x] Base required 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.extension:countryCode.​value[x] Base required 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
ags-extension-1 error Patient.address:Strassenanschrift.city.extension:gemeindeschluessel.value[x].code, Patient.address:Postfach.city.extension:gemeindeschluessel.value[x].code Der Amtliche Gemeindeschlüssel ist nummerisch und begrenzt auf acht Stellen $this.matches('^[0-9]{8}$')
dom-2 error Patient If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Patient If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Patient If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Patient If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Patient A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
gender-amtlich-1 error Patient.gender.extension:other-amtlich.value[x] Die amtliche Differenzierung der Geschlechtsangabe 'other' darf nur gefüllt sein, wenn das Geschlecht 'other' angegeben ist %resource.where(gender='other').exists()
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-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 SHALL have a contained resource if a local reference is provided reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Differential View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient C 0..* Patient Information about an individual or animal receiving health care services
Constraints: mii-pat-1
... id S 0..1 id Logical id of this artifact
... meta S 0..1 Meta Metadata about the resource
.... profile S 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:birthPlace S 0..1 (Complex)
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
..... url S 1..1 uri identifies the meaning of the extension
..... value[x] S 1..1 Address Value of extension
...... country S 0..1 string
....... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... Slices for extension Content/Rules for all slices
........ extension:countryCode S 0..1 (Complex) code for string
URL: http://hl7.org/fhir/StructureDefinition/iso21090-codedString
......... value[x] S 1..1 Coding Value of extension
Binding: Iso3166-1-2 (preferred)
.......... system S 0..1 uri Identity of the terminology system
.......... code S 0..1 code Symbol in syntax defined by the system
.... extension:patient-citizenship S 0..* (Complex)
URL: http://hl7.org/fhir/StructureDefinition/patient-citizenship
..... Slices for extension Content/Rules for all slices
...... extension:code S 0..1 Extension Extension
....... url S 1..1 uri identifies the meaning of the extension
....... value[x] S 1..1 CodeableConcept Value of extension
........ coding S 0..* Coding Code defined by a terminology system
......... system S 0..1 uri Identity of the terminology system
......... code S 0..1 code Symbol in syntax defined by the system
...... extension:period S 0..1 Extension Extension
....... url S 1..1 uri identifies the meaning of the extension
....... value[x] S 1..1 Period Value of extension
..... url S 1..1 uri identifies the meaning of the extension
.... extension:patient-nationality S 0..* (Complex)
URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
..... Slices for extension Content/Rules for all slices
...... extension:code S 0..1 Extension Extension
....... url S 1..1 uri identifies the meaning of the extension
....... value[x] S 1..1 CodeableConcept Value of extension
........ coding S 0..* Coding Code defined by a terminology system
......... system S 0..1 uri Identity of the terminology system
......... code S 0..1 code Symbol in syntax defined by the system
...... extension:period S 0..1 Extension Extension
....... url S 1..1 uri identifies the meaning of the extension
....... value[x] S 1..1 Period Value of extension
..... url S 1..1 uri identifies the meaning of the extension
.... extension:recordedSexOrGender S 0..* (Complex)
URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender
..... Slices for extension Content/Rules for all slices
...... extension:value S 1..1 Extension Extension
....... url S 1..1 uri identifies the meaning of the extension
....... value[x] S 1..1 CodeableConcept Value of extension
Binding: MII VS Person Recorded Sex or Gender SNOMED (preferred)
........ coding S 0..* Coding Code defined by a terminology system
......... system S 0..1 uri Identity of the terminology system
......... code S 0..1 code Symbol in syntax defined by the system
...... extension:type S 0..1 Extension Extension
....... url S 1..1 uri identifies the meaning of the extension
....... value[x] S 1..1 CodeableConcept Value of extension
........ coding S 0..* Coding Code defined by a terminology system
......... system S 0..1 uri Identity of the terminology system
......... code S 0..1 code Symbol in syntax defined by the system
...... extension:acquisitionDate S 0..1 Extension Extension
....... url S 1..1 uri identifies the meaning of the extension
....... value[x] S 1..1 dateTime Value of extension
..... url S 1..1 uri identifies the meaning of the extension
.... identifier:versichertenId S 0..1 IdentifierKvid10 Krankenversichertennummer
Required Pattern: At least the following
..... type S 1..1 CodeableConcept Description of identifier
Fixed Value: (Complex)
...... coding S 0..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... system S 0..1 uri Identity of the terminology system
Fixed Value: http://fhir.de/CodeSystem/identifier-type-de-basis
....... code S 0..1 code Symbol in syntax defined by the system
Fixed Value: KVZ10
..... system S 1..1 uri The namespace for the identifier value
..... value S 1..1 string The value that is unique
..... assigner S 1..1 Reference(Organization) Organization that issued id (may be just text)
...... identifier S 1..1 IdentifierIknr Logical reference, when literal reference is not known
....... type S 0..1 CodeableConcept Description of identifier
........ coding S 0..* Coding Code defined by a terminology system
......... system S 0..1 uri Identity of the terminology system
......... code S 0..1 code Symbol in syntax defined by the system
....... system S 1..1 uri The namespace for the identifier value
....... value S 1..1 string The value that is unique
.... identifier:pid S 0..* IdentifierPid Patientenidentifikation

Required Pattern: At least the following
..... type S 1..1 CodeableConcept Description of identifier
Fixed Value: (Complex)
...... coding S 0..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... system S 0..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... code S 0..1 code Symbol in syntax defined by the system
Fixed Value: MR
..... system S 1..1 uri The namespace for the identifier value
..... value S 1..1 string The value that is unique
..... assigner S 0..1 Reference(Organization) Organization that issued id (may be just text)
...... identifier S 0..1 Identifier Logical reference, when literal reference is not known
....... type S 0..1 CodeableConcept Description of identifier
Required Pattern: At least the following
........ coding S 0..* Coding Code defined by a terminology system
Fixed Value: (Complex)
......... system S 0..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
......... code S 0..1 code Symbol in syntax defined by the system
Fixed Value: XX
....... system C 0..1 uri The namespace for the identifier value
Constraints: mii-pat-2
... Slices for name S 0..* HumanName Name
Slice: Unordered, Open by pattern:$this
.... name:name S 0..1 HumannameDeBasis Personenname
Required Pattern: At least the following
..... use S 1..1 code usual | official | temp | nickname | anonymous | old | maiden
Fixed Value: official
..... family S 1..1 string Familienname
...... Slices for extension Content/Rules for all slices
....... extension:namenszusatz S 0..1 HumannameNamenszusatz Namenszusatz gemäß VSDM (Versichertenstammdatenmanagement, "eGK")
....... extension:nachname S 0..1 OwnName(5.3.0) Portion derived from person's own surname
....... extension:vorsatzwort S 0..1 OwnPrefix(5.3.0) Voorvoegsel derived from person's own surname
..... given S 1..* string Vorname
..... prefix S 0..* string Namensteile vor dem Vornamen
...... Slices for extension Content/Rules for all slices
....... extension:prefix-qualifier S 0..1 ENQualifier(5.3.0) LS | AC | NB | PR | HON | BR | AD | SP | MID | CL | IN | VV
.... name:geburtsname S 0..1 HumannameDeBasis Geburtsname
Required Pattern: At least the following
..... use S 1..1 code usual | official | temp | nickname | anonymous | old | maiden
Fixed Value: maiden
..... family S 1..1 string Familienname
...... Slices for extension Content/Rules for all slices
....... extension:namenszusatz S 0..1 HumannameNamenszusatz Namenszusatz gemäß VSDM (Versichertenstammdatenmanagement, "eGK")
....... extension:nachname S 0..1 OwnName(5.3.0) Portion derived from person's own surname
....... extension:vorsatzwort S 0..1 OwnPrefix(5.3.0) Voorvoegsel derived from person's own surname
..... given 0..0 Vorname
..... prefix 0..0 Namensteile vor dem Vornamen
... gender S 0..1 code Administratives Geschlecht
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:other-amtlich S 0..1 (Complex) Extension Administratives Geschlecht
URL: http://fhir.de/StructureDefinition/gender-amtlich-de
...... url S 1..1 uri identifies the meaning of the extension
...... value[x] S 1..1 Coding Value of extension
....... system S 0..1 uri Identity of the terminology system
....... code S 0..1 code Symbol in syntax defined by the system
... birthDate S 0..1 date Geburtsdatum
.... Slices for extension 0..* Extension Extension
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)
... Slices for deceased[x] S 0..1 boolean, dateTime Verstorben
Slice: Unordered, Open by type:$this
.... deceased[x]:deceasedBoolean S 0..1 boolean Indicates if the individual is deceased or not
.... deceased[x]:deceasedDateTime S 0..1 dateTime Indicates if the individual is deceased or not
... Slices for address S 0..* Address Adresse
Slice: Unordered, Open by pattern:$this
.... address:Strassenanschrift SC 0..* AddressDeBasis Straßenanschrift
Constraints: pat-cnt-2or3-char

Required Pattern: At least the following
..... Slices for extension Content/Rules for all slices
...... extension:Stadtteil S 0..1 ADXPPrecinct(5.3.0) precinct
..... type S 1..1 code postal | physical | both
Fixed Value: both
..... line S 1..3 string Straßenname mit Hausnummer oder Postfach sowie weitere Angaben zur Zustellung
...... Slices for extension Content/Rules for all slices
....... extension:Strasse S 0..1 ADXPStreetName(5.3.0) streetName
....... extension:Hausnummer S 0..1 ADXPHouseNumber(5.3.0) houseNumber
....... extension:Adresszusatz S 0..1 ADXPAdditionalLocator(5.3.0) additionalLocator
....... extension:Postfach S 0..0 postBox
..... city S 1..1 string Name of city, town etc.
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... Slices for extension Content/Rules for all slices
....... extension:gemeindeschluessel S 0..1 (Complex) Optional Extensions Element
URL: http://fhir.de/StructureDefinition/destatis/ags
........ url S 1..1 uri identifies the meaning of the extension
........ value[x] S 1..1 Coding Value of extension
......... system S 1..1 uri Identity of the terminology system
......... code S 1..1 code Symbol in syntax defined by the system
..... postalCode S 1..1 string Postleitzahl
..... country S 1..1 string Staat
.... address:Postfach SC 0..* AddressDeBasis Postfach
Constraints: pat-cnt-2or3-char

Required Pattern: At least the following
..... Slices for extension Content/Rules for all slices
...... extension:Stadtteil S 0..1 ADXPPrecinct(5.3.0) precinct
..... type S 1..1 code postal | physical | both
Fixed Value: postal
..... line S 1..3 string Straßenname mit Hausnummer oder Postfach sowie weitere Angaben zur Zustellung
...... Slices for extension Content/Rules for all slices
....... extension:Strasse 0..0 streetName
....... extension:Hausnummer 0..0 houseNumber
....... extension:Adresszusatz 0..0 additionalLocator
....... extension:Postfach S 0..1 ADXPPostBox(5.3.0) postBox
..... city S 1..1 string Name of city, town etc.
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... Slices for extension Content/Rules for all slices
....... extension:gemeindeschluessel S 0..1 (Complex) Optional Extensions Element
URL: http://fhir.de/StructureDefinition/destatis/ags
........ url S 1..1 uri identifies the meaning of the extension
........ value[x] S 1..1 Coding Value of extension
......... system S 1..1 uri Identity of the terminology system
......... code S 1..1 code Symbol in syntax defined by the system
..... postalCode S 1..1 string Postleitzahl
..... country S 1..1 string Staat
... link S 0..* BackboneElement Verweis
.... other S 1..1 Reference(Patient | RelatedPerson) The other patient or related person resource that the link refers to
.... type S 1..1 code replaced-by | replaces | refer | seealso

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Patient.extension:birthPlace.​value[x].country.extension:countryCode.​value[x] Base preferred Iso 3166 Part 1: 2 Letter Codes 📦4.0.1 FHIR Std.
Patient.extension:recordedSexOrGender.​extension:value.value[x] Base preferred MII VS Person Recorded Sex or Gender SNOMED 📦2027.0.0-ballot This IG

Constraints

Id Grade Path(s) Description Expression
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-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'))

Snapshot ViewView

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient C 0..* Patient Information about an individual or animal receiving health care services
Constraints: mii-pat-1
... id SΣ 0..1 id Logical id of this artifact
... meta SΣ 0..1 Meta Metadata about the resource
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile SΣ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:birthPlace S 0..1 (Complex)
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url S 1..1 uri "http://hl7.org/fhir/StructureDefinition/patient-birthPlace"
..... value[x] S 1..1 Address Value of extension
...... 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 home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.
Example General: home
...... type Σ 0..1 code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).
Example General: both
...... text Σ 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
...... line Σ 0..* string Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
...... city Σ 0..1 string Name of city, town etc.
Example General: Erewhon
...... district Σ 0..1 string District name (aka county)
Example General: Madison
...... state Σ 0..1 string Sub-unit of country (abbreviations ok)
...... postalCode Σ 0..1 string Postal code for area
Example General: 9132
...... country SΣ 0..1 string
....... id 0..1 string xml:id (or equivalent in JSON)
....... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... Slices for extension Content/Rules for all slices
........ extension:countryCode S 0..1 (Complex) code for string
URL: http://hl7.org/fhir/StructureDefinition/iso21090-codedString
......... id 0..1 string Unique id for inter-element referencing
......... extension 0..0 Extension
Slice: Unordered, Open by value:url
......... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/iso21090-codedString"
......... value[x] S 1..1 Coding Value of extension
Binding: Iso3166-1-2 (preferred)
.......... id 0..1 string Unique id for inter-element referencing
.......... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.......... system SΣ 0..1 uri Identity of the terminology system
.......... version Σ 0..1 string Version of the system - if relevant
.......... code SΣ 0..1 code Symbol in syntax defined by the system
.......... display Σ 0..1 string Representation defined by the system
.......... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
....... value 0..1 string Primitive value for string
Max Length:1048576
...... period Σ 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
.... extension:patient-citizenship S 0..* (Complex)
URL: http://hl7.org/fhir/StructureDefinition/patient-citizenship
..... 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
..... Slices for extension Content/Rules for all slices
...... extension:code S 0..1 Extension Extension
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url S 1..1 uri "code"
....... value[x] S 1..1 CodeableConcept Value of extension
Binding: CountryValueSet (preferred)
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ coding SΣ 0..* Coding Code defined by a terminology system
......... id 0..1 string Unique id for inter-element referencing
......... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
......... system SΣ 0..1 uri Identity of the terminology system
......... version Σ 0..1 string Version of the system - if relevant
......... code SΣ 0..1 code Symbol in syntax defined by the system
......... 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
...... extension:period S 0..1 Extension Extension
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url S 1..1 uri "period"
....... value[x] S 1..1 Period Value of extension
..... url S 1..1 uri "http://hl7.org/fhir/StructureDefinition/patient-citizenship"
.... extension:patient-nationality S 0..* (Complex)
URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
..... 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
..... Slices for extension Content/Rules for all slices
...... extension:code S 0..1 Extension Extension
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url S 1..1 uri "code"
....... value[x] S 1..1 CodeableConcept Value of extension
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ coding SΣ 0..* Coding Code defined by a terminology system
......... id 0..1 string Unique id for inter-element referencing
......... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
......... system SΣ 0..1 uri Identity of the terminology system
......... version Σ 0..1 string Version of the system - if relevant
......... code SΣ 0..1 code Symbol in syntax defined by the system
......... 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
...... extension:period S 0..1 Extension Extension
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url S 1..1 uri "period"
....... value[x] S 1..1 Period Value of extension
..... url S 1..1 uri "http://hl7.org/fhir/StructureDefinition/patient-nationality"
.... extension:recordedSexOrGender S 0..* (Complex)
URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 1..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... Slices for extension Content/Rules for all slices
...... extension:value S 1..1 Extension Extension
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url S 1..1 uri "value"
....... value[x] S 1..1 CodeableConcept Value of extension
Binding: MII VS Person Recorded Sex or Gender SNOMED (preferred)
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ coding SΣ 0..* Coding Code defined by a terminology system
......... id 0..1 string Unique id for inter-element referencing
......... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
......... system SΣ 0..1 uri Identity of the terminology system
......... version Σ 0..1 string Version of the system - if relevant
......... code SΣ 0..1 code Symbol in syntax defined by the system
......... 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
...... extension:type S 0..1 Extension Extension
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url S 1..1 uri "type"
....... value[x] S 1..1 CodeableConcept Value of extension
Binding: Recorded Sex Or Gender Type (example)
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ coding SΣ 0..* Coding Code defined by a terminology system
......... id 0..1 string Unique id for inter-element referencing
......... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
......... system SΣ 0..1 uri Identity of the terminology system
......... version Σ 0..1 string Version of the system - if relevant
......... code SΣ 0..1 code Symbol in syntax defined by the system
......... 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
...... extension:effectivePeriod 0..1 Extension When the recorded sex or gender value applies
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "effectivePeriod"
....... value[x] 0..1 Period Value of extension
...... extension:acquisitionDate S 0..1 Extension Extension
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url S 1..1 uri "acquisitionDate"
....... value[x] S 1..1 dateTime Value of extension
...... extension:source 0..1 Extension The source of the Recorded Sex or Gender value.
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "source"
....... value[x] 1..1 Value of extension
........ valueCodeableConcept CodeableConcept
........ valueReference Reference(Organization | Device | RelatedPerson | Practitioner)
...... extension:sourceDocument 0..1 Extension The document the sex or gender property was acquired from.
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "sourceDocument"
....... value[x] 1..1 Value of extension
........ valueCodeableConcept CodeableConcept
........ valueReference Reference(DocumentReference)
...... extension:sourceField 0..1 Extension The name of the field within the source document where this sex or gender property is initially recorded.
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "sourceField"
....... value[x] 1..1 string Value of extension
...... extension:jurisdiction 0..1 Extension Who issued the document where the sex or gender was aquired
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "jurisdiction"
....... value[x] 1..1 CodeableConcept Value of extension
Binding: Jurisdiction ValueSet (extensible)
...... extension:comment 0..1 Extension Context or source information about the recorded sex or gender
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "comment"
....... value[x] 1..1 string Value of extension
...... extension:genderElementQualifier 0..1 Extension Whether this recorded sex or gender value qualifies the .gender element.
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "genderElementQualifier"
....... value[x] 1..1 boolean Value of extension
..... url S 1..1 uri "http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender"
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier SΣ 0..* Identifier Patienten-Identifikator
Slice: Unordered, Open by pattern:$this
.... identifier:versichertenId SΣ 0..1 IdentifierKvid10 Krankenversichertennummer

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 Kvid DeBasis ValueSet (required): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Constraints: kvid-2
Fixed Value: (Complex)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... coding SΣ 0..* 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
Slice: Unordered, Open by value:url
....... system SΣ 0..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 SΣ 0..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 Logical reference, when literal reference is not known
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
....... type SΣ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type DeBasis ValueSet (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Required Pattern: At least the following
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ coding SΣ 0..* 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
Slice: Unordered, Open by value:url
......... system SΣ 0..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 SΣ 0..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Σ 0..* IdentifierPid Patientenidentifikation

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
Slice: Unordered, Open by value:url
...... coding SΣ 0..* 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
Slice: Unordered, Open by value:url
....... system SΣ 0..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 SΣ 0..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 SΣ 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
Slice: Unordered, Open by value:url
........ coding SΣ 0..* 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
Slice: Unordered, Open by value:url
......... system SΣ 0..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 SΣ 0..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 Σ 0..1 Period Time period when id is/was valid for use
....... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
...... display Σ 0..1 string Text alternative for the resource
... active ?!Σ 0..1 boolean Whether this patient's record is in active use
... Slices for name SΣ 0..* HumanName Name
Slice: Unordered, Open by pattern:$this
.... name:name SΣ 0..1 HumannameDeBasis Personenname

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
...... 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 Portion derived from person's own surname
URL: http://hl7.org/fhir/StructureDefinition/humanname-own-name
....... extension:vorsatzwort S 0..1 string Voorvoegsel derived from person's own surname
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
...... 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)
...... 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Σ 0..1 HumannameDeBasis Geburtsname

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
...... 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 Portion derived from person's own surname
URL: http://hl7.org/fhir/StructureDefinition/humanname-own-name
....... extension:vorsatzwort S 0..1 string Voorvoegsel derived from person's own surname
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 Σ 0..* ContactPoint A contact detail for the individual
... gender SΣ 0..1 code Administratives Geschlecht
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:other-amtlich S 0..1 (Complex) Extension Administratives Geschlecht
URL: http://fhir.de/StructureDefinition/gender-amtlich-de
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..0 Additional content defined by implementations
Slice: Unordered, Open by value:url
...... url S 1..1 uri "http://fhir.de/StructureDefinition/gender-amtlich-de"
...... value[x] SC 1..1 Coding Value of extension
Binding: GenderOtherDE ValueSet (required)
Constraints: gender-amtlich-1
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... system SΣ 0..1 uri Identity of the terminology system
....... version Σ 0..1 string Version of the system - if relevant
....... code SΣ 0..1 code Symbol in syntax defined by the system
....... display Σ 0..1 string Representation defined by the system
....... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... value 0..1 string Primitive value for code
... birthDate SΣ 0..1 date Geburtsdatum
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:data-absent-reason S 0..1 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
... Slices for deceased[x] ?!SΣ 0..1 Verstorben
Slice: Unordered, Closed by type:$this
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
.... deceased[x]:deceasedBoolean ?!SΣ 0..1 boolean Indicates if the individual is deceased or not
.... deceased[x]:deceasedDateTime ?!SΣ 0..1 dateTime Indicates if the individual is deceased or not
... Slices for address SΣ 0..* Address Adresse
Slice: Unordered, Open by pattern:$this
.... address:Strassenanschrift SΣC 0..* AddressDeBasis Straßenanschrift
Constraints: pat-cnt-2or3-char

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... Slices for extension Content/Rules for all slices
...... extension:Stadtteil S 0..1 string precinct
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 Beispiel 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
...... Slices for extension Content/Rules for all slices
....... extension:Strasse S 0..1 string streetName
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName
....... extension:Hausnummer S 0..1 string houseNumber
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber
....... extension:Adresszusatz S 0..1 string additionalLocator
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 xml:id (or equivalent in JSON)
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... Slices for extension Content/Rules for all slices
....... extension:gemeindeschluessel S 0..1 (Complex) Optional Extensions Element
URL: http://fhir.de/StructureDefinition/destatis/ags
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..0 Additional content defined by implementations
Slice: Unordered, Open by value:url
........ url S 1..1 uri "http://fhir.de/StructureDefinition/destatis/ags"
........ value[x] S 1..1 Coding Value of extension
Example AGS Hildesheim: {"system":"http://fhir.de/sid/destatis/ags","code":"03254021"}
......... id 0..1 string Unique id for inter-element referencing
......... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
......... system SΣ 1..1 uri Identity of the terminology system
Fixed Value: http://fhir.de/sid/destatis/ags
......... version Σ 0..1 string Version of the system - if relevant
......... code SΣC 1..1 code Symbol in syntax defined by the system
Constraints: ags-extension-1
......... display Σ 0..1 string Representation defined by the system
......... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
...... 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
Example Beispiel für textuelle Landesangabe: Deutschland
...... 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, value:value.ofType(Coding).system
...... Slices for extension Content/Rules for all slices
....... extension:countryCode 0..1 (Complex) Länderkennzeichen nach ISO 3166-1
URL: http://hl7.org/fhir/StructureDefinition/iso21090-codedString

Example Beispiel für kodierte Landesangabe: {"system":"urn:iso:std:iso:3166","code":"DE","display":"Deutschland"}
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..0 Additional content defined by implementations
Slice: Unordered, Open by value:url
........ url 1..1 uri "http://hl7.org/fhir/StructureDefinition/iso21090-codedString"
........ value[x] 1..1 Coding Value of extension
Binding: Iso3166-1-2 (required): A coded representation for a string. Could be codes for country in a country address part, codes for prefixes in a name part, etc.
...... value 0..1 string Primitive value for string
Max Length:1048576
..... 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 Postfach
Constraints: 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
..... Slices for extension Content/Rules for all slices
...... extension:Stadtteil S 0..1 string precinct
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 Beispiel 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
...... Slices for extension Content/Rules for all slices
....... extension:Postfach S 0..1 string postBox
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 xml:id (or equivalent in JSON)
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... Slices for extension Content/Rules for all slices
....... extension:gemeindeschluessel S 0..1 (Complex) Optional Extensions Element
URL: http://fhir.de/StructureDefinition/destatis/ags
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..0 Additional content defined by implementations
Slice: Unordered, Open by value:url
........ url S 1..1 uri "http://fhir.de/StructureDefinition/destatis/ags"
........ value[x] S 1..1 Coding Value of extension
Example AGS Hildesheim: {"system":"http://fhir.de/sid/destatis/ags","code":"03254021"}
......... id 0..1 string Unique id for inter-element referencing
......... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
......... system SΣ 1..1 uri Identity of the terminology system
Fixed Value: http://fhir.de/sid/destatis/ags
......... version Σ 0..1 string Version of the system - if relevant
......... code SΣC 1..1 code Symbol in syntax defined by the system
Constraints: ags-extension-1
......... display Σ 0..1 string Representation defined by the system
......... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
...... 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
Example Beispiel für textuelle Landesangabe: Deutschland
...... 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, value:value.ofType(Coding).system
...... Slices for extension Content/Rules for all slices
....... extension:countryCode 0..1 (Complex) Länderkennzeichen nach ISO 3166-1
URL: http://hl7.org/fhir/StructureDefinition/iso21090-codedString

Example Beispiel für kodierte Landesangabe: {"system":"urn:iso:std:iso:3166","code":"DE","display":"Deutschland"}
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..0 Additional content defined by implementations
Slice: Unordered, Open by value:url
........ url 1..1 uri "http://hl7.org/fhir/StructureDefinition/iso21090-codedString"
........ value[x] 1..1 Coding Value of extension
Binding: Iso3166-1-2 (required): A coded representation for a string. Could be codes for country in a country address part, codes for prefixes in a name part, etc.
...... value 0..1 string Primitive value for string
Max Length:1048576
..... 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 0..* Attachment Image of the patient
... contact C 0..* BackboneElement A contact party (e.g. guardian, partner, friend) for the patient
Constraints: pat-1
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... relationship 0..* CodeableConcept The kind of relationship
Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.
.... name 0..1 HumanName A name associated with the contact person
.... telecom 0..* ContactPoint A contact detail for the person
.... address 0..1 Address Address for the contact person
.... gender 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
.... organization C 0..1 Reference(Organization) Organization that is associated with the contact
.... period 0..1 Period The period during which this contact person or organization is valid to be contacted relating to this patient
... communication 0..* BackboneElement A language which may be used to communicate with the patient about his or her health
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... language 1..1 CodeableConcept The language which can be used to communicate with the patient about his or her health
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
.... preferred 0..1 boolean Language preference indicator
... generalPractitioner 0..* Reference(Organization | Practitioner | PractitionerRole) Patient's nominated primary care provider
... managingOrganization Σ 0..1 Reference(Organization) Organization that is the custodian of the patient record
... link ?!SΣ 0..* BackboneElement Verweis
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... other SΣ 1..1 Reference(Patient | RelatedPerson) The other patient or related person resource that the link refers to
.... 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.extension:birthPlace.​value[x].use Base required AddressUse 📍4.0.1 FHIR Std.
Patient.extension:birthPlace.​value[x].type Base required AddressType 📍4.0.1 FHIR Std.
Patient.extension:birthPlace.​value[x].country.extension:countryCode.​value[x] Base preferred Iso 3166 Part 1: 2 Letter Codes 📦4.0.1 FHIR Std.
Patient.extension:patient-citizenship.​extension:code.value[x] Base preferred Country ValueSet 📦5.0.0 FHIR Extensions Pack v5.3
Patient.extension:recordedSexOrGender.​extension:value.value[x] Base preferred MII VS Person Recorded Sex or Gender SNOMED 📦2027.0.0-ballot This IG
Patient.extension:recordedSexOrGender.​extension:type.value[x] Base example Recorded Sex Or Gender Type 📦2.0.0 THO v7.2
Patient.extension:recordedSexOrGender.​extension:jurisdiction.​value[x] Base extensible Jurisdiction ValueSet 📦1.0.0 THO v7.2
Patient.identifier:versichertenId.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:versichertenId.​type Base required Identifier Type Kvid DeBasis ValueSet 📦1.6.0 de.basisprofil.r4 v1.6
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.6.0 de.basisprofil.r4 v1.6
Patient.identifier:pid.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:pid.​type Base extensible Identifier Type DeBasis ValueSet 📦1.6.0 de.basisprofil.r4 v1.6
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.gender.extension:other-amtlich.​value[x] Base required GenderOtherDE ValueSet 📦1.6.0 de.basisprofil.r4 v1.6
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.6.0 de.basisprofil.r4 v1.6
Patient.address:Strassenanschrift.​country.extension:countryCode.​value[x] Base required 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.6.0 de.basisprofil.r4 v1.6
Patient.address:Postfach.​country.extension:countryCode.​value[x] Base required 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
ags-extension-1 error Patient.address:Strassenanschrift.city.extension:gemeindeschluessel.value[x].code, Patient.address:Postfach.city.extension:gemeindeschluessel.value[x].code Der Amtliche Gemeindeschlüssel ist nummerisch und begrenzt auf acht Stellen $this.matches('^[0-9]{8}$')
dom-2 error Patient If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Patient If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Patient If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Patient If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Patient A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
gender-amtlich-1 error Patient.gender.extension:other-amtlich.value[x] Die amtliche Differenzierung der Geschlechtsangabe 'other' darf nur gefüllt sein, wenn das Geschlecht 'other' angegeben ist %resource.where(gender='other').exists()
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.name:name.period, Patient.name:geburtsname.period, Patient.address:Strassenanschrift.period, Patient.address:Postfach.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 SHALL have a contained resource if a local reference is provided reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Summary

Mandatory: 0 element(18 nested mandatory elements)
Must-Support: 140 elements
Prohibited: 6 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Patient.identifier
  • The element 1 is sliced based on the value of Patient.name
  • The element 1 is sliced based on the value of Patient.deceased[x]
  • The element 1 is sliced based on the value of Patient.address

 

Other representations of profile: CSV, Excel, Schematron