2025.0.1 - ci-build-obligations

MII_IG_Person - Local Development build (v2025.0.1) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: MII PR Person Patient (Pseudonymisiert)

Official URL: https://www.medizininformatik-initiative.de/fhir/core/modul-person/StructureDefinition/PatientPseudonymisiert Version: 2025.0.1
Active as of 2025-02-28 Computable Name: MII_PR_Person_PatientPseudonymisiert

Dieses Profil beschreibt einen pseudonymisierten Patient*in in der Medizininformatik-Initiative.

Usage:

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient C 0..* Patient Information about an individual or animal receiving health care services
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-3: 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
dom-6: A resource should have narrative for robust management
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
mii-pat-1: Falls die Geschlechtsangabe 'other' gewählt wird, muss die amtliche Differenzierung per Extension angegeben werden
... id SΣ 0..1 id Logical id of this artifact
... meta SΣ 0..1 Meta Metadata about the resource
ele-1: All FHIR elements must have a @value or children
.... profile SΣ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
ele-1: All FHIR elements must have a @value or children
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... Slices for identifier SΣ 1..* Identifier Identifier
Slice: Unordered, Open by pattern:$this
ele-1: All FHIR elements must have a @value or children
.... identifier:PseudonymisierterIdentifier SΣ 0..* Identifier Pseudonymisierter Identifikator
ele-1: All FHIR elements must have a @value or children

Required Pattern: At least the following
..... type 1..1 CodeableConcept Description of identifier
Fixed Value: (complex)
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ObservationValue
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: PSEUDED
.... identifier:AnonymisierterIdentifier SΣ 0..* Identifier Anonymisierter Identifikator
ele-1: All FHIR elements must have a @value or children

Required Pattern: At least the following
..... type 1..1 CodeableConcept Description of identifier
Fixed Value: (complex)
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ObservationValue
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: ANONYED
... active ?!SΣ 0..1 boolean Active
ele-1: All FHIR elements must have a @value or children
... gender SΣ 0..1 code Administrative gender
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.


ele-1: All FHIR elements must have a @value or children
.... Slices for extension Content/Rules for all slices
..... extension:other-amtlich S 0..1 Coding Extension administrative gender
URL: http://fhir.de/StructureDefinition/gender-amtlich-de
Binding: GenderOtherDE ValueSet (required)
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... birthDate SΣC 0..1 date Date of birth
ele-1: All FHIR elements must have a @value or children
pat-pseuded-1: Das Geburtsdatum MUSS auf Quartal und Jahr vergröbert werden. Das Jahr SOLLTE NICHT verändert werden. Wenn vorhanden, MUSS der Monat auf den ersten Monat des Quartals abgerundet werden. Die Angabe des Tags ist OPTIONAL. Wenn vorhanden, MUSS der Tag auf den ersten des Monats abgerundet werden. Die Datumsangabe MUSS entweder vierstellig, siebenstellig oder zehnstellig sein.
... deceased[x] ?!Σ 0..1 Indicates if the individual is deceased or not
ele-1: All FHIR elements must have a @value or children
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
... Slices for address SΣ 0..* Address Address
Slice: Unordered, Open by pattern:$this
ele-1: All FHIR elements must have a @value or children
.... address:Strassenanschrift SΣC 0..* AddressDeBasis Street address
ele-1: All FHIR elements must have a @value or children
pat-cnt-2or3-char: 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.

Required Pattern: At least the following
..... type 1..1 code postal | physical | both
Fixed Value: both
..... Slices for extension Content/Rules for all slices
...... extension:Stadtteil N 0..1 string Stadt- oder Ortsteil
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-precinct
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


ele-1: All FHIR elements must have a @value or children
Example General: home
..... type SΣ 1..1 code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).


ele-1: All FHIR elements must have a @value or children
Example General: both
..... line Σ 0..3 string Straßenname mit Hausnummer oder Postfach sowie weitere Angaben zur Zustellung
ele-1: All FHIR elements must have a @value or children
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
Example Beipiel für Adresszeile mit Extensions für Straße und Hausnummer: Musterweg 42
...... Slices for extension Content/Rules for all slices
....... extension:Strasse N 0..1 string Strassenname (ohne Hausnummer)
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
....... extension:Hausnummer N 0..1 string Hausnummer
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
....... extension:Adresszusatz N 0..1 string Adresszusatz
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
....... extension:Postfach N 0..1 string Postfach
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... city Σ 0..1 string Name of city, town etc.
ele-1: All FHIR elements must have a @value or children
Example General: Erewhon
...... Slices for extension Content/Rules for all slices
....... extension:gemeindeschluessel S 0..1 Coding Optional Extensions Element
URL: http://fhir.de/StructureDefinition/destatis/ags
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... postalCode SΣC 1..1 string Postleitzahl
ele-1: All FHIR elements must have a @value or children
pat-pseuded-2: Die Postleitzahl MUSS auf die ersten beiden Ziffern vergröbert werden.
Example General: 9132
..... country SΣ 1..1 string Staat
Binding: Iso3166-1-2 (preferred)
ele-1: All FHIR elements must have a @value or children
... link ?!Σ 0..* BackboneElement Link to another patient resource that concerns the same actual person
ele-1: All FHIR elements must have a @value or children
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... other ΣC 1..1 Reference(Patient | RelatedPerson) The other patient or related person resource that the link refers to
ele-1: All FHIR elements must have a @value or children
ref-1: SHALL have a contained resource if a local reference is provided
.... type Σ 1..1 code replaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.


ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Patient.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
from the FHIR Standard
Patient.address:Strassenanschrift.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
Patient.address:Strassenanschrift.typerequiredAddressType
http://hl7.org/fhir/ValueSet/address-type|4.0.1
from the FHIR Standard
Patient.address:Strassenanschrift.countrypreferredIso3166-1-2
http://hl7.org/fhir/ValueSet/iso3166-1-2
from the FHIR Standard
Patient.link.typerequiredLinkType
http://hl7.org/fhir/ValueSet/link-type|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorPatientIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorPatientIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorPatientIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorPatientIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practicePatientA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** elementsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
mii-pat-1errorPatientFalls die Geschlechtsangabe 'other' gewählt wird, muss die amtliche Differenzierung per Extension angegeben werden
: gender.exists() and gender='other' implies gender.extension('http://fhir.de/StructureDefinition/gender-amtlich-de').exists()
pat-cnt-2or3-charwarningPatient.address:StrassenanschriftThe 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'))
pat-pseuded-1errorPatient.birthDateDas Geburtsdatum MUSS auf Quartal und Jahr vergröbert werden. Das Jahr SOLLTE NICHT verändert werden. Wenn vorhanden, MUSS der Monat auf den ersten Monat des Quartals abgerundet werden. Die Angabe des Tags ist OPTIONAL. Wenn vorhanden, MUSS der Tag auf den ersten des Monats abgerundet werden. Die Datumsangabe MUSS entweder vierstellig, siebenstellig oder zehnstellig sein.
: toString().matches('^\\d{4}(-(01|04|07|10)(-01)?)?$')
pat-pseuded-2errorPatient.address:Strassenanschrift.postalCodeDie Postleitzahl MUSS auf die ersten beiden Ziffern vergröbert werden.
: length() = 2
ref-1errorPatient.link.otherSHALL have a contained resource if a local reference is provided
: reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

This structure is derived from Patient

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient C 0..* Patient Information about an individual or animal receiving health care services
mii-pat-1: Falls die Geschlechtsangabe 'other' gewählt wird, muss die amtliche Differenzierung per Extension angegeben werden
... id S 0..1 id Logical id of this artifact
... meta S 0..1 Meta Metadata about the resource
.... profile S 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
... Slices for identifier S 1..* Identifier Identifier
Slice: Unordered, Open by pattern:$this
.... identifier:PseudonymisierterIdentifier S 0..* Identifier Pseudonymisierter Identifikator

Required Pattern: At least the following
..... type 1..1 CodeableConcept Description of identifier
Fixed Value: (complex)
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ObservationValue
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: PSEUDED
.... identifier:AnonymisierterIdentifier S 0..* Identifier Anonymisierter Identifikator

Required Pattern: At least the following
..... type 1..1 CodeableConcept Description of identifier
Fixed Value: (complex)
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ObservationValue
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: ANONYED
... gender S 0..1 code Administrative gender
.... Slices for extension Content/Rules for all slices
..... extension:other-amtlich S 0..1 Coding Extension administrative gender
URL: http://fhir.de/StructureDefinition/gender-amtlich-de
Binding: GenderOtherDE ValueSet (required)
... birthDate SC 0..1 date Date of birth
pat-pseuded-1: Das Geburtsdatum MUSS auf Quartal und Jahr vergröbert werden. Das Jahr SOLLTE NICHT verändert werden. Wenn vorhanden, MUSS der Monat auf den ersten Monat des Quartals abgerundet werden. Die Angabe des Tags ist OPTIONAL. Wenn vorhanden, MUSS der Tag auf den ersten des Monats abgerundet werden. Die Datumsangabe MUSS entweder vierstellig, siebenstellig oder zehnstellig sein.
... Slices for address S 0..* Address Address
Slice: Unordered, Open by pattern:$this
.... address:Strassenanschrift SC 0..* AddressDeBasis Street address
pat-cnt-2or3-char: 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.

Required Pattern: At least the following
..... type 1..1 code postal | physical | both
Fixed Value: both
..... type S 1..1 code postal | physical | both
..... city
...... Slices for extension Content/Rules for all slices
....... extension:gemeindeschluessel S 0..1 Coding Optional Extensions Element
URL: http://fhir.de/StructureDefinition/destatis/ags
..... postalCode SC 1..1 string Postleitzahl
pat-pseuded-2: Die Postleitzahl MUSS auf die ersten beiden Ziffern vergröbert werden.
..... country S 1..1 string Staat

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
mii-pat-1errorPatientFalls die Geschlechtsangabe 'other' gewählt wird, muss die amtliche Differenzierung per Extension angegeben werden
: gender.exists() and gender='other' implies gender.extension('http://fhir.de/StructureDefinition/gender-amtlich-de').exists()
pat-cnt-2or3-charwarningPatient.address:StrassenanschriftThe 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'))
pat-pseuded-1errorPatient.birthDateDas Geburtsdatum MUSS auf Quartal und Jahr vergröbert werden. Das Jahr SOLLTE NICHT verändert werden. Wenn vorhanden, MUSS der Monat auf den ersten Monat des Quartals abgerundet werden. Die Angabe des Tags ist OPTIONAL. Wenn vorhanden, MUSS der Tag auf den ersten des Monats abgerundet werden. Die Datumsangabe MUSS entweder vierstellig, siebenstellig oder zehnstellig sein.
: toString().matches('^\\d{4}(-(01|04|07|10)(-01)?)?$')
pat-pseuded-2errorPatient.address:Strassenanschrift.postalCodeDie Postleitzahl MUSS auf die ersten beiden Ziffern vergröbert werden.
: length() = 2
NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient C 0..* Patient Information about an individual or animal receiving health care services
mii-pat-1: Falls die Geschlechtsangabe 'other' gewählt wird, muss die amtliche Differenzierung per Extension angegeben werden
... 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 N 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
... contained 0..* Resource Contained, inline Resources
... extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
... modifierExtension ?!N 0..* Extension Extensions that cannot be ignored
Slice: Unordered, Open by value:url
... Slices for identifier SΣ 1..* Identifier Identifier
Slice: Unordered, Open by pattern:$this
.... identifier:PseudonymisierterIdentifier SΣ 0..* Identifier Pseudonymisierter Identifikator

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... use 0..1 code usual | official | temp | secondary | old (If known)
..... type 1..1 CodeableConcept Description of identifier
Fixed Value: (complex)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ObservationValue
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: PSEUDED
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... system 0..1 uri The namespace for the identifier value
..... value 0..1 string The value that is unique
..... period 0..1 Period Time period when id is/was valid for use
..... assigner 0..1 Reference(Organization) Organization that issued id (may be just text)
.... identifier:AnonymisierterIdentifier SΣ 0..* Identifier Anonymisierter Identifikator

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... use 0..1 code usual | official | temp | secondary | old (If known)
..... type 1..1 CodeableConcept Description of identifier
Fixed Value: (complex)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ObservationValue
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: ANONYED
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... system 0..1 uri The namespace for the identifier value
..... value 0..1 string The value that is unique
..... period 0..1 Period Time period when id is/was valid for use
..... assigner 0..1 Reference(Organization) Organization that issued id (may be just text)
... active ?!SΣ 0..1 boolean Active
... name Σ 0..* HumanName A name associated with the patient
... telecom ΣC 0..* ContactPoint A contact detail for the individual
cpt-2: A system is required if a value is provided.
... gender SΣ 0..1 code Administrative gender
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... extension:other-amtlich S 0..1 Coding Extension administrative gender
URL: http://fhir.de/StructureDefinition/gender-amtlich-de
Binding: GenderOtherDE ValueSet (required)
.... value 0..1 code Primitive value for code
Max Length:1048576
... birthDate SΣC 0..1 date Date of birth
pat-pseuded-1: Das Geburtsdatum MUSS auf Quartal und Jahr vergröbert werden. Das Jahr SOLLTE NICHT verändert werden. Wenn vorhanden, MUSS der Monat auf den ersten Monat des Quartals abgerundet werden. Die Angabe des Tags ist OPTIONAL. Wenn vorhanden, MUSS der Tag auf den ersten des Monats abgerundet werden. Die Datumsangabe MUSS entweder vierstellig, siebenstellig oder zehnstellig sein.
... deceased[x] ?!Σ 0..1 Indicates if the individual is deceased or not
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
... Slices for address SΣ 0..* Address Address
Slice: Unordered, Open by pattern:$this
.... address:Strassenanschrift SΣC 0..* AddressDeBasis Street address
pat-cnt-2or3-char: 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.

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... use 0..1 code home | work | temp | old | billing - purpose of this address
..... type 1..1 code postal | physical | both
Fixed Value: both
..... text 0..1 string Text representation of the address
..... line 0..* string Street name, number, direction & P.O. Box etc.
..... city 0..1 string Name of city, town etc.
..... district 0..1 string District name (aka county)
..... state 0..1 string Sub-unit of country (abbreviations ok)
..... postalCode 0..1 string Postal code for area
..... country 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
..... period 0..1 Period Time period when address was/is in use
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... extension:Stadtteil N 0..1 string Stadt- oder Ortsteil
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-precinct
..... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
..... type SΣ 1..1 code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).


Example General: both
..... text Σ 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
..... line Σ 0..3 string Straßenname mit Hausnummer oder Postfach sowie weitere Angaben zur Zustellung
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
Example Beipiel für Adresszeile mit Extensions für Straße und Hausnummer: Musterweg 42
...... id 0..1 string Unique id for inter-element referencing
...... Slices for extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... extension:Strasse N 0..1 string Strassenname (ohne Hausnummer)
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName
....... extension:Hausnummer N 0..1 string Hausnummer
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber
....... extension:Adresszusatz N 0..1 string Adresszusatz
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator
....... extension:Postfach N 0..1 string Postfach
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox
...... value 0..1 string Primitive value for string
Max Length:1048576
..... city Σ 0..1 string Name of city, town etc.
Example General: Erewhon
...... id 0..1 string Unique id for inter-element referencing
...... Slices for extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... extension:gemeindeschluessel S 0..1 Coding Optional Extensions Element
URL: http://fhir.de/StructureDefinition/destatis/ags
...... value 0..1 string Primitive value for string
Max Length:1048576
..... state Σ 0..1 string Bundesland
Binding: ISO-3166-2:de-Laendercodes (preferred)
..... postalCode SΣC 1..1 string Postleitzahl
pat-pseuded-2: Die Postleitzahl MUSS auf die ersten beiden Ziffern vergröbert werden.
Example General: 9132
..... country SΣ 1..1 string Staat
Binding: Iso3166-1-2 (preferred)
..... period ΣC 0..1 Period Time period when address was/is in use
per-1: If present, start SHALL have a lower value than end
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... maritalStatus 0..1 CodeableConcept Marital (civil) status of a patient
Binding: Marital Status Codes (extensible): The domestic partnership status of a person.

... multipleBirth[x] 0..1 Whether patient is part of a multiple birth
.... multipleBirthBoolean boolean
.... multipleBirthInteger integer
... photo C 0..* Attachment Image of the patient
att-1: If the Attachment has data, it SHALL have a contentType
... contact C 0..* BackboneElement A contact party (e.g. guardian, partner, friend) for the patient
pat-1: SHALL at least contain a contact's details or a reference to an organization
.... id 0..1 string Unique id for inter-element referencing
.... extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... relationship 0..* CodeableConcept The kind of relationship
Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.


.... name 0..1 HumanName A name associated with the contact person
.... telecom C 0..* ContactPoint A contact detail for the person
cpt-2: A system is required if a value is provided.
.... 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
ref-1: SHALL have a contained resource if a local reference is provided
.... period C 0..1 Period The period during which this contact person or organization is valid to be contacted relating to this patient
per-1: If present, start SHALL have a lower value than end
... 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 N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... language 1..1 CodeableConcept The language which can be used to communicate with the patient about his or her health
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguages Max Binding
.... preferred 0..1 boolean Language preference indicator
... generalPractitioner C 0..* Reference(Organization | Practitioner | PractitionerRole) Patient's nominated primary care provider
ref-1: SHALL have a contained resource if a local reference is provided
... managingOrganization ΣC 0..1 Reference(Organization) Organization that is the custodian of the patient record
ref-1: SHALL have a contained resource if a local reference is provided
... link ?!Σ 0..* BackboneElement Link to another patient resource that concerns the same actual person
.... id 0..1 string Unique id for inter-element referencing
.... extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... other ΣC 1..1 Reference(Patient | RelatedPerson) The other patient or related person resource that the link refers to
ref-1: SHALL have a contained resource if a local reference is provided
.... type Σ 1..1 code replaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.


doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Patient.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
Patient.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
Patient.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Patient.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
from the FHIR Standard
Patient.address:Strassenanschrift.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
Patient.address:Strassenanschrift.typerequiredAddressType
http://hl7.org/fhir/ValueSet/address-type|4.0.1
from the FHIR Standard
Patient.address:Strassenanschrift.statepreferredValueSetISO31662DE
http://fhir.de/ValueSet/iso/bundeslaender
Patient.address:Strassenanschrift.countrypreferredIso3166-1-2
http://hl7.org/fhir/ValueSet/iso3166-1-2
from the FHIR Standard
Patient.maritalStatusextensibleMarital Status Codes
http://hl7.org/fhir/ValueSet/marital-status
from the FHIR Standard
Patient.contact.relationshipextensiblePatientContactRelationship
http://hl7.org/fhir/ValueSet/patient-contactrelationship
from the FHIR Standard
Patient.contact.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
from the FHIR Standard
Patient.communication.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Patient.link.typerequiredLinkType
http://hl7.org/fhir/ValueSet/link-type|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
att-1errorPatient.photoIf the Attachment has data, it SHALL have a contentType
: data.empty() or contentType.exists()
cpt-2errorPatient.telecom, Patient.contact.telecomA system is required if a value is provided.
: value.empty() or system.exists()
dom-2errorPatientIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorPatientIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorPatientIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorPatientIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practicePatientA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** elementsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
mii-pat-1errorPatientFalls die Geschlechtsangabe 'other' gewählt wird, muss die amtliche Differenzierung per Extension angegeben werden
: gender.exists() and gender='other' implies gender.extension('http://fhir.de/StructureDefinition/gender-amtlich-de').exists()
pat-1errorPatient.contactSHALL 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-charwarningPatient.address:StrassenanschriftThe 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'))
pat-pseuded-1errorPatient.birthDateDas Geburtsdatum MUSS auf Quartal und Jahr vergröbert werden. Das Jahr SOLLTE NICHT verändert werden. Wenn vorhanden, MUSS der Monat auf den ersten Monat des Quartals abgerundet werden. Die Angabe des Tags ist OPTIONAL. Wenn vorhanden, MUSS der Tag auf den ersten des Monats abgerundet werden. Die Datumsangabe MUSS entweder vierstellig, siebenstellig oder zehnstellig sein.
: toString().matches('^\\d{4}(-(01|04|07|10)(-01)?)?$')
pat-pseuded-2errorPatient.address:Strassenanschrift.postalCodeDie Postleitzahl MUSS auf die ersten beiden Ziffern vergröbert werden.
: length() = 2
per-1errorPatient.address:Strassenanschrift.period, Patient.contact.periodIf present, start SHALL have a lower value than end
: start.hasValue().not() or end.hasValue().not() or (start <= end)
ref-1errorPatient.contact.organization, Patient.generalPractitioner, Patient.managingOrganization, Patient.link.otherSHALL have a contained resource if a local reference is provided
: reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

This structure is derived from Patient

Summary

Mandatory: 1 element(3 nested mandatory elements)
Must-Support: 16 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

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

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient C 0..* Patient Information about an individual or animal receiving health care services
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-3: 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
dom-6: A resource should have narrative for robust management
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
mii-pat-1: Falls die Geschlechtsangabe 'other' gewählt wird, muss die amtliche Differenzierung per Extension angegeben werden
... id SΣ 0..1 id Logical id of this artifact
... meta SΣ 0..1 Meta Metadata about the resource
ele-1: All FHIR elements must have a @value or children
.... profile SΣ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
ele-1: All FHIR elements must have a @value or children
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... Slices for identifier SΣ 1..* Identifier Identifier
Slice: Unordered, Open by pattern:$this
ele-1: All FHIR elements must have a @value or children
.... identifier:PseudonymisierterIdentifier SΣ 0..* Identifier Pseudonymisierter Identifikator
ele-1: All FHIR elements must have a @value or children

Required Pattern: At least the following
..... type 1..1 CodeableConcept Description of identifier
Fixed Value: (complex)
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ObservationValue
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: PSEUDED
.... identifier:AnonymisierterIdentifier SΣ 0..* Identifier Anonymisierter Identifikator
ele-1: All FHIR elements must have a @value or children

Required Pattern: At least the following
..... type 1..1 CodeableConcept Description of identifier
Fixed Value: (complex)
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ObservationValue
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: ANONYED
... active ?!SΣ 0..1 boolean Active
ele-1: All FHIR elements must have a @value or children
... gender SΣ 0..1 code Administrative gender
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.


ele-1: All FHIR elements must have a @value or children
.... Slices for extension Content/Rules for all slices
..... extension:other-amtlich S 0..1 Coding Extension administrative gender
URL: http://fhir.de/StructureDefinition/gender-amtlich-de
Binding: GenderOtherDE ValueSet (required)
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... birthDate SΣC 0..1 date Date of birth
ele-1: All FHIR elements must have a @value or children
pat-pseuded-1: Das Geburtsdatum MUSS auf Quartal und Jahr vergröbert werden. Das Jahr SOLLTE NICHT verändert werden. Wenn vorhanden, MUSS der Monat auf den ersten Monat des Quartals abgerundet werden. Die Angabe des Tags ist OPTIONAL. Wenn vorhanden, MUSS der Tag auf den ersten des Monats abgerundet werden. Die Datumsangabe MUSS entweder vierstellig, siebenstellig oder zehnstellig sein.
... deceased[x] ?!Σ 0..1 Indicates if the individual is deceased or not
ele-1: All FHIR elements must have a @value or children
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
... Slices for address SΣ 0..* Address Address
Slice: Unordered, Open by pattern:$this
ele-1: All FHIR elements must have a @value or children
.... address:Strassenanschrift SΣC 0..* AddressDeBasis Street address
ele-1: All FHIR elements must have a @value or children
pat-cnt-2or3-char: 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.

Required Pattern: At least the following
..... type 1..1 code postal | physical | both
Fixed Value: both
..... Slices for extension Content/Rules for all slices
...... extension:Stadtteil N 0..1 string Stadt- oder Ortsteil
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-precinct
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


ele-1: All FHIR elements must have a @value or children
Example General: home
..... type SΣ 1..1 code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).


ele-1: All FHIR elements must have a @value or children
Example General: both
..... line Σ 0..3 string Straßenname mit Hausnummer oder Postfach sowie weitere Angaben zur Zustellung
ele-1: All FHIR elements must have a @value or children
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
Example Beipiel für Adresszeile mit Extensions für Straße und Hausnummer: Musterweg 42
...... Slices for extension Content/Rules for all slices
....... extension:Strasse N 0..1 string Strassenname (ohne Hausnummer)
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
....... extension:Hausnummer N 0..1 string Hausnummer
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
....... extension:Adresszusatz N 0..1 string Adresszusatz
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
....... extension:Postfach N 0..1 string Postfach
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... city Σ 0..1 string Name of city, town etc.
ele-1: All FHIR elements must have a @value or children
Example General: Erewhon
...... Slices for extension Content/Rules for all slices
....... extension:gemeindeschluessel S 0..1 Coding Optional Extensions Element
URL: http://fhir.de/StructureDefinition/destatis/ags
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... postalCode SΣC 1..1 string Postleitzahl
ele-1: All FHIR elements must have a @value or children
pat-pseuded-2: Die Postleitzahl MUSS auf die ersten beiden Ziffern vergröbert werden.
Example General: 9132
..... country SΣ 1..1 string Staat
Binding: Iso3166-1-2 (preferred)
ele-1: All FHIR elements must have a @value or children
... link ?!Σ 0..* BackboneElement Link to another patient resource that concerns the same actual person
ele-1: All FHIR elements must have a @value or children
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... other ΣC 1..1 Reference(Patient | RelatedPerson) The other patient or related person resource that the link refers to
ele-1: All FHIR elements must have a @value or children
ref-1: SHALL have a contained resource if a local reference is provided
.... type Σ 1..1 code replaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.


ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Patient.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
from the FHIR Standard
Patient.address:Strassenanschrift.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
Patient.address:Strassenanschrift.typerequiredAddressType
http://hl7.org/fhir/ValueSet/address-type|4.0.1
from the FHIR Standard
Patient.address:Strassenanschrift.countrypreferredIso3166-1-2
http://hl7.org/fhir/ValueSet/iso3166-1-2
from the FHIR Standard
Patient.link.typerequiredLinkType
http://hl7.org/fhir/ValueSet/link-type|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorPatientIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorPatientIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorPatientIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorPatientIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practicePatientA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** elementsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
mii-pat-1errorPatientFalls die Geschlechtsangabe 'other' gewählt wird, muss die amtliche Differenzierung per Extension angegeben werden
: gender.exists() and gender='other' implies gender.extension('http://fhir.de/StructureDefinition/gender-amtlich-de').exists()
pat-cnt-2or3-charwarningPatient.address:StrassenanschriftThe 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'))
pat-pseuded-1errorPatient.birthDateDas Geburtsdatum MUSS auf Quartal und Jahr vergröbert werden. Das Jahr SOLLTE NICHT verändert werden. Wenn vorhanden, MUSS der Monat auf den ersten Monat des Quartals abgerundet werden. Die Angabe des Tags ist OPTIONAL. Wenn vorhanden, MUSS der Tag auf den ersten des Monats abgerundet werden. Die Datumsangabe MUSS entweder vierstellig, siebenstellig oder zehnstellig sein.
: toString().matches('^\\d{4}(-(01|04|07|10)(-01)?)?$')
pat-pseuded-2errorPatient.address:Strassenanschrift.postalCodeDie Postleitzahl MUSS auf die ersten beiden Ziffern vergröbert werden.
: length() = 2
ref-1errorPatient.link.otherSHALL have a contained resource if a local reference is provided
: reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Differential View

This structure is derived from Patient

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient C 0..* Patient Information about an individual or animal receiving health care services
mii-pat-1: Falls die Geschlechtsangabe 'other' gewählt wird, muss die amtliche Differenzierung per Extension angegeben werden
... id S 0..1 id Logical id of this artifact
... meta S 0..1 Meta Metadata about the resource
.... profile S 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
... Slices for identifier S 1..* Identifier Identifier
Slice: Unordered, Open by pattern:$this
.... identifier:PseudonymisierterIdentifier S 0..* Identifier Pseudonymisierter Identifikator

Required Pattern: At least the following
..... type 1..1 CodeableConcept Description of identifier
Fixed Value: (complex)
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ObservationValue
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: PSEUDED
.... identifier:AnonymisierterIdentifier S 0..* Identifier Anonymisierter Identifikator

Required Pattern: At least the following
..... type 1..1 CodeableConcept Description of identifier
Fixed Value: (complex)
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ObservationValue
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: ANONYED
... gender S 0..1 code Administrative gender
.... Slices for extension Content/Rules for all slices
..... extension:other-amtlich S 0..1 Coding Extension administrative gender
URL: http://fhir.de/StructureDefinition/gender-amtlich-de
Binding: GenderOtherDE ValueSet (required)
... birthDate SC 0..1 date Date of birth
pat-pseuded-1: Das Geburtsdatum MUSS auf Quartal und Jahr vergröbert werden. Das Jahr SOLLTE NICHT verändert werden. Wenn vorhanden, MUSS der Monat auf den ersten Monat des Quartals abgerundet werden. Die Angabe des Tags ist OPTIONAL. Wenn vorhanden, MUSS der Tag auf den ersten des Monats abgerundet werden. Die Datumsangabe MUSS entweder vierstellig, siebenstellig oder zehnstellig sein.
... Slices for address S 0..* Address Address
Slice: Unordered, Open by pattern:$this
.... address:Strassenanschrift SC 0..* AddressDeBasis Street address
pat-cnt-2or3-char: 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.

Required Pattern: At least the following
..... type 1..1 code postal | physical | both
Fixed Value: both
..... type S 1..1 code postal | physical | both
..... city
...... Slices for extension Content/Rules for all slices
....... extension:gemeindeschluessel S 0..1 Coding Optional Extensions Element
URL: http://fhir.de/StructureDefinition/destatis/ags
..... postalCode SC 1..1 string Postleitzahl
pat-pseuded-2: Die Postleitzahl MUSS auf die ersten beiden Ziffern vergröbert werden.
..... country S 1..1 string Staat

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
mii-pat-1errorPatientFalls die Geschlechtsangabe 'other' gewählt wird, muss die amtliche Differenzierung per Extension angegeben werden
: gender.exists() and gender='other' implies gender.extension('http://fhir.de/StructureDefinition/gender-amtlich-de').exists()
pat-cnt-2or3-charwarningPatient.address:StrassenanschriftThe 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'))
pat-pseuded-1errorPatient.birthDateDas Geburtsdatum MUSS auf Quartal und Jahr vergröbert werden. Das Jahr SOLLTE NICHT verändert werden. Wenn vorhanden, MUSS der Monat auf den ersten Monat des Quartals abgerundet werden. Die Angabe des Tags ist OPTIONAL. Wenn vorhanden, MUSS der Tag auf den ersten des Monats abgerundet werden. Die Datumsangabe MUSS entweder vierstellig, siebenstellig oder zehnstellig sein.
: toString().matches('^\\d{4}(-(01|04|07|10)(-01)?)?$')
pat-pseuded-2errorPatient.address:Strassenanschrift.postalCodeDie Postleitzahl MUSS auf die ersten beiden Ziffern vergröbert werden.
: length() = 2

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient C 0..* Patient Information about an individual or animal receiving health care services
mii-pat-1: Falls die Geschlechtsangabe 'other' gewählt wird, muss die amtliche Differenzierung per Extension angegeben werden
... 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 N 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
... contained 0..* Resource Contained, inline Resources
... extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
... modifierExtension ?!N 0..* Extension Extensions that cannot be ignored
Slice: Unordered, Open by value:url
... Slices for identifier SΣ 1..* Identifier Identifier
Slice: Unordered, Open by pattern:$this
.... identifier:PseudonymisierterIdentifier SΣ 0..* Identifier Pseudonymisierter Identifikator

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... use 0..1 code usual | official | temp | secondary | old (If known)
..... type 1..1 CodeableConcept Description of identifier
Fixed Value: (complex)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ObservationValue
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: PSEUDED
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... system 0..1 uri The namespace for the identifier value
..... value 0..1 string The value that is unique
..... period 0..1 Period Time period when id is/was valid for use
..... assigner 0..1 Reference(Organization) Organization that issued id (may be just text)
.... identifier:AnonymisierterIdentifier SΣ 0..* Identifier Anonymisierter Identifikator

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... use 0..1 code usual | official | temp | secondary | old (If known)
..... type 1..1 CodeableConcept Description of identifier
Fixed Value: (complex)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ObservationValue
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: ANONYED
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... system 0..1 uri The namespace for the identifier value
..... value 0..1 string The value that is unique
..... period 0..1 Period Time period when id is/was valid for use
..... assigner 0..1 Reference(Organization) Organization that issued id (may be just text)
... active ?!SΣ 0..1 boolean Active
... name Σ 0..* HumanName A name associated with the patient
... telecom ΣC 0..* ContactPoint A contact detail for the individual
cpt-2: A system is required if a value is provided.
... gender SΣ 0..1 code Administrative gender
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... extension:other-amtlich S 0..1 Coding Extension administrative gender
URL: http://fhir.de/StructureDefinition/gender-amtlich-de
Binding: GenderOtherDE ValueSet (required)
.... value 0..1 code Primitive value for code
Max Length:1048576
... birthDate SΣC 0..1 date Date of birth
pat-pseuded-1: Das Geburtsdatum MUSS auf Quartal und Jahr vergröbert werden. Das Jahr SOLLTE NICHT verändert werden. Wenn vorhanden, MUSS der Monat auf den ersten Monat des Quartals abgerundet werden. Die Angabe des Tags ist OPTIONAL. Wenn vorhanden, MUSS der Tag auf den ersten des Monats abgerundet werden. Die Datumsangabe MUSS entweder vierstellig, siebenstellig oder zehnstellig sein.
... deceased[x] ?!Σ 0..1 Indicates if the individual is deceased or not
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
... Slices for address SΣ 0..* Address Address
Slice: Unordered, Open by pattern:$this
.... address:Strassenanschrift SΣC 0..* AddressDeBasis Street address
pat-cnt-2or3-char: 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.

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... use 0..1 code home | work | temp | old | billing - purpose of this address
..... type 1..1 code postal | physical | both
Fixed Value: both
..... text 0..1 string Text representation of the address
..... line 0..* string Street name, number, direction & P.O. Box etc.
..... city 0..1 string Name of city, town etc.
..... district 0..1 string District name (aka county)
..... state 0..1 string Sub-unit of country (abbreviations ok)
..... postalCode 0..1 string Postal code for area
..... country 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
..... period 0..1 Period Time period when address was/is in use
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... extension:Stadtteil N 0..1 string Stadt- oder Ortsteil
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-precinct
..... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
..... type SΣ 1..1 code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).


Example General: both
..... text Σ 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
..... line Σ 0..3 string Straßenname mit Hausnummer oder Postfach sowie weitere Angaben zur Zustellung
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
Example Beipiel für Adresszeile mit Extensions für Straße und Hausnummer: Musterweg 42
...... id 0..1 string Unique id for inter-element referencing
...... Slices for extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... extension:Strasse N 0..1 string Strassenname (ohne Hausnummer)
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName
....... extension:Hausnummer N 0..1 string Hausnummer
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber
....... extension:Adresszusatz N 0..1 string Adresszusatz
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator
....... extension:Postfach N 0..1 string Postfach
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox
...... value 0..1 string Primitive value for string
Max Length:1048576
..... city Σ 0..1 string Name of city, town etc.
Example General: Erewhon
...... id 0..1 string Unique id for inter-element referencing
...... Slices for extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... extension:gemeindeschluessel S 0..1 Coding Optional Extensions Element
URL: http://fhir.de/StructureDefinition/destatis/ags
...... value 0..1 string Primitive value for string
Max Length:1048576
..... state Σ 0..1 string Bundesland
Binding: ISO-3166-2:de-Laendercodes (preferred)
..... postalCode SΣC 1..1 string Postleitzahl
pat-pseuded-2: Die Postleitzahl MUSS auf die ersten beiden Ziffern vergröbert werden.
Example General: 9132
..... country SΣ 1..1 string Staat
Binding: Iso3166-1-2 (preferred)
..... period ΣC 0..1 Period Time period when address was/is in use
per-1: If present, start SHALL have a lower value than end
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... maritalStatus 0..1 CodeableConcept Marital (civil) status of a patient
Binding: Marital Status Codes (extensible): The domestic partnership status of a person.

... multipleBirth[x] 0..1 Whether patient is part of a multiple birth
.... multipleBirthBoolean boolean
.... multipleBirthInteger integer
... photo C 0..* Attachment Image of the patient
att-1: If the Attachment has data, it SHALL have a contentType
... contact C 0..* BackboneElement A contact party (e.g. guardian, partner, friend) for the patient
pat-1: SHALL at least contain a contact's details or a reference to an organization
.... id 0..1 string Unique id for inter-element referencing
.... extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... relationship 0..* CodeableConcept The kind of relationship
Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.


.... name 0..1 HumanName A name associated with the contact person
.... telecom C 0..* ContactPoint A contact detail for the person
cpt-2: A system is required if a value is provided.
.... 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
ref-1: SHALL have a contained resource if a local reference is provided
.... period C 0..1 Period The period during which this contact person or organization is valid to be contacted relating to this patient
per-1: If present, start SHALL have a lower value than end
... 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 N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... language 1..1 CodeableConcept The language which can be used to communicate with the patient about his or her health
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguages Max Binding
.... preferred 0..1 boolean Language preference indicator
... generalPractitioner C 0..* Reference(Organization | Practitioner | PractitionerRole) Patient's nominated primary care provider
ref-1: SHALL have a contained resource if a local reference is provided
... managingOrganization ΣC 0..1 Reference(Organization) Organization that is the custodian of the patient record
ref-1: SHALL have a contained resource if a local reference is provided
... link ?!Σ 0..* BackboneElement Link to another patient resource that concerns the same actual person
.... id 0..1 string Unique id for inter-element referencing
.... extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... other ΣC 1..1 Reference(Patient | RelatedPerson) The other patient or related person resource that the link refers to
ref-1: SHALL have a contained resource if a local reference is provided
.... type Σ 1..1 code replaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.


doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Patient.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
Patient.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
Patient.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Patient.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
from the FHIR Standard
Patient.address:Strassenanschrift.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
Patient.address:Strassenanschrift.typerequiredAddressType
http://hl7.org/fhir/ValueSet/address-type|4.0.1
from the FHIR Standard
Patient.address:Strassenanschrift.statepreferredValueSetISO31662DE
http://fhir.de/ValueSet/iso/bundeslaender
Patient.address:Strassenanschrift.countrypreferredIso3166-1-2
http://hl7.org/fhir/ValueSet/iso3166-1-2
from the FHIR Standard
Patient.maritalStatusextensibleMarital Status Codes
http://hl7.org/fhir/ValueSet/marital-status
from the FHIR Standard
Patient.contact.relationshipextensiblePatientContactRelationship
http://hl7.org/fhir/ValueSet/patient-contactrelationship
from the FHIR Standard
Patient.contact.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
from the FHIR Standard
Patient.communication.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Patient.link.typerequiredLinkType
http://hl7.org/fhir/ValueSet/link-type|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
att-1errorPatient.photoIf the Attachment has data, it SHALL have a contentType
: data.empty() or contentType.exists()
cpt-2errorPatient.telecom, Patient.contact.telecomA system is required if a value is provided.
: value.empty() or system.exists()
dom-2errorPatientIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorPatientIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorPatientIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorPatientIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practicePatientA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** elementsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
mii-pat-1errorPatientFalls die Geschlechtsangabe 'other' gewählt wird, muss die amtliche Differenzierung per Extension angegeben werden
: gender.exists() and gender='other' implies gender.extension('http://fhir.de/StructureDefinition/gender-amtlich-de').exists()
pat-1errorPatient.contactSHALL 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-charwarningPatient.address:StrassenanschriftThe 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'))
pat-pseuded-1errorPatient.birthDateDas Geburtsdatum MUSS auf Quartal und Jahr vergröbert werden. Das Jahr SOLLTE NICHT verändert werden. Wenn vorhanden, MUSS der Monat auf den ersten Monat des Quartals abgerundet werden. Die Angabe des Tags ist OPTIONAL. Wenn vorhanden, MUSS der Tag auf den ersten des Monats abgerundet werden. Die Datumsangabe MUSS entweder vierstellig, siebenstellig oder zehnstellig sein.
: toString().matches('^\\d{4}(-(01|04|07|10)(-01)?)?$')
pat-pseuded-2errorPatient.address:Strassenanschrift.postalCodeDie Postleitzahl MUSS auf die ersten beiden Ziffern vergröbert werden.
: length() = 2
per-1errorPatient.address:Strassenanschrift.period, Patient.contact.periodIf present, start SHALL have a lower value than end
: start.hasValue().not() or end.hasValue().not() or (start <= end)
ref-1errorPatient.contact.organization, Patient.generalPractitioner, Patient.managingOrganization, Patient.link.otherSHALL have a contained resource if a local reference is provided
: reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

This structure is derived from Patient

Summary

Mandatory: 1 element(3 nested mandatory elements)
Must-Support: 16 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

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

 

Other representations of profile: CSV, Excel, Schematron