2025.2.0 - ci-build

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

Resource Profile: Patient

Official URL: https://ths-greifswald.de/fhir/StructureDefinition/epix/Patient Version: 2025.2.0
Active as of 2026-02-05 Computable Name: Patient

Copyright/Legal: Copyright 2020-2026 Unabhängige Treuhandstelle der Universitätsmedizin Greifswald

Patienten-Identität (Variante/Schreibweise) einer realen Person (vgl. auch MPI Eintrag, Person-Profil).

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient 0..* Patient Patienten-Profil zur Übermittlung von angeforderten IDAT
... meta SΣ 0..1 Meta Metadata about the resource
.... versionId SΣ 0..1 id Version specific identifier
.... lastUpdated SΣ 0..1 instant When the resource version last changed
.... source SΣ 0..1 uri Identifies where the resource comes from
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:birthPlace S 0..1 (Complex) Place of Birth for patient
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/patient-birthPlace"
..... value[x] S 1..1 Address Value of extension
...... city SΣ 1..1 string Name of city, town etc.
Example General: Erewhon
.... extension:nationality S 0..1 (Complex) Nationality
URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
..... Slices for extension Content/Rules for all slices
...... extension:code 0..1 Extension Extension
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "code"
....... value[x] S 1..1 CodeableConcept Value of extension
Binding: Iso3166-1-2 (required)
........ coding SΣ 0..1 Coding Code defined by a terminology system
......... system SΣ 1..1 uri Identity of the terminology system
......... code SΣ 1..1 code Symbol in syntax defined by the system
........ text SΣ 0..1 string Plain text representation of the concept
...... extension:period 0..1 Extension Nationality Period
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "period"
....... value[x] 1..1 Period Value of extension
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/patient-nationality"
.... extension:customIdatValues S 0..1 (Complex) Benutzerdefinierter Satz von IDAT Werten
URL: https://ths-greifswald.de/fhir/StructureDefinition/epix/CustomIdatValues
... identifier SΣ 0..* Identifier An identifier for this patient
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
.... 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
... active ?!SΣ 0..1 boolean Whether this patient's record is in active use
... name SΣ 0..* HumanName A name associated with the patient
.... use ?!SΣ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
.... family SΣ 0..1 string Family name (often called 'Surname')
.... given SΣ 0..* string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
.... prefix SΣ 0..* string Parts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:academic S 0..1 (Complex) LS | AC | NB | PR | HON | BR | AD | SP | MID | CL | IN | VV
URL: http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier"
....... value[x] S 1..1 code Value of extension
Binding: EntityNamePartQualifier (required)
Fixed Value: AC
.... suffix SΣ 0..* string Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
... Slices for telecom SΣ 0..* ContactPoint A contact detail for the individual
Slice: Unordered, Open by pattern:$this
.... telecom:email SΣ 0..* ContactPoint A contact detail for the individual
..... system SΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Required Pattern: email
..... value SΣ 1..1 string The actual contact point details
..... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
.... telecom:telefon SΣ 0..* ContactPoint A contact detail for the individual
..... system SΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Required Pattern: phone
..... value SΣ 1..1 string The actual contact point details
..... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
... gender SΣ 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
... birthDate SΣ 0..1 date The date of birth for the individual
... address SΣ 0..* Address An address for the individual
.... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.
Example General: home
.... line SΣ 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 SΣ 0..1 string Name of city, town etc.
Example General: Erewhon
.... state SΣ 0..1 string Bundesland
Binding: http://fhir.de/ValueSet/iso/bundeslaender (required)
.... postalCode SΣ 0..1 string Postal code for area
Example General: 9132
.... country SΣ 0..1 string Staat
Binding: Iso3166-1-2 (required)
... maritalStatus S 0..1 CodeableConcept Marital (civil) status of a patient
Binding: Marital Status Codes (preferred): The domestic partnership status of a person.
.... coding SΣ 0..1 Coding Code defined by a terminology system
..... system SΣ 1..1 uri Identity of the terminology system
..... code SΣ 1..1 code Symbol in syntax defined by the system
.... text SΣ 1..1 string Plain text representation of the concept
... communication S 0..* BackboneElement A language which may be used to communicate with the patient about his or her health
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... language S 1..1 CodeableConcept The language which can be used to communicate with the patient about his or her health
Binding: CommonLanguages (required): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
..... coding SΣ 0..1 Coding Code defined by a terminology system
...... system SΣ 1..1 uri Identity of the terminology system
...... code SΣ 1..1 code Symbol in syntax defined by the system
..... text SΣ 0..1 string Plain text representation of the concept
.... preferred S 1..1 boolean Language preference indicator
Fixed Value: true

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Patient.extension:nationality.​extension:code.value[x] Base required Iso 3166 Part 1: 2 Letter Codes 📦4.0.1 FHIR Std.
Patient.identifier.use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.name.use Base required NameUse 📍4.0.1 FHIR Std.
Patient.name.prefix.​extension:academic.value[x] Base required EntityNamePartQualifier 📦5.2.0 FHIR Extensions Pack v5.2
Patient.telecom:email.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
Patient.telecom:email.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
Patient.telecom:telefon.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
Patient.telecom:telefon.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
Patient.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
Patient.address.use Base required AddressUse 📍4.0.1 FHIR Std.
Patient.address.state Base required http://fhir.de/ValueSet/iso/bundeslaender Not State Unknown
Patient.address.country Base required Iso 3166 Part 1: 2 Letter Codes 📦4.0.1 FHIR Std.
Patient.maritalStatus Base preferred MaritalStatus 📦4.0.1 FHIR Std.
Patient.communication.​language Base required Common Languages 📦4.0.1 FHIR Std.
Patient.link.type Base required LinkType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Patient If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Patient If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Patient If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Patient If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Patient A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from Patient

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient 0..* Patient Patienten-Profil zur Übermittlung von angeforderten IDAT
... meta S 0..1 Meta Metadata about the resource
.... versionId S 0..1 id Version specific identifier
.... lastUpdated S 0..1 instant When the resource version last changed
.... source S 0..1 uri Identifies where the resource comes from
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:birthPlace S 0..1 (Complex) Place of Birth for patient
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
..... value[x] S 1..1 Address Value of extension
...... use 0..0 home | work | temp | old | billing - purpose of this address
...... type 0..0 postal | physical | both
...... text 0..0 Text representation of the address
...... line 0..0 Street name, number, direction & P.O. Box etc.
...... city S 1..1 string Name of city, town etc.
...... district 0..0 District name (aka county)
...... state 0..0 Sub-unit of country (abbreviations ok)
...... postalCode 0..0 Postal code for area
...... country 0..0 Country (e.g. can be ISO 3166 2 or 3 letter code)
...... period 0..0 Time period when address was/is in use
.... extension:nationality S 0..1 (Complex) Nationality
URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
..... Slices for extension Content/Rules for all slices
...... extension:code 0..1 Extension Extension
....... value[x] S 1..1 CodeableConcept Value of extension
Binding: Iso3166-1-2 (required)
........ coding S 0..1 Coding Code defined by a terminology system
......... system S 1..1 uri Identity of the terminology system
......... code S 1..1 code Symbol in syntax defined by the system
........ text S 0..1 string Plain text representation of the concept
.... extension:customIdatValues S 0..1 (Complex) Benutzerdefinierter Satz von IDAT Werten
URL: https://ths-greifswald.de/fhir/StructureDefinition/epix/CustomIdatValues
... identifier S 0..* Identifier An identifier for this patient
.... system S 1..1 uri The namespace for the identifier value
.... value S 1..1 string The value that is unique
... name S 0..* HumanName A name associated with the patient
.... use S 0..1 code usual | official | temp | nickname | anonymous | old | maiden
.... text 0..0 Text representation of the full name
.... family S 0..1 string Family name (often called 'Surname')
.... given S 0..* string Given names (not always 'first'). Includes middle names
.... prefix S 0..* string Parts that come before the name
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:academic S 0..1 (Complex) LS | AC | NB | PR | HON | BR | AD | SP | MID | CL | IN | VV
URL: http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier
....... value[x] S 1..1 code Value of extension
Fixed Value: AC
.... suffix S 0..* string Parts that come after the name
.... period 0..0 Time period when name was/is in use
... Slices for telecom S 0..* ContactPoint A contact detail for the individual
Slice: Unordered, Open by pattern:$this
.... telecom:email S 0..* ContactPoint A contact detail for the individual
..... system S 1..1 code phone | fax | email | pager | url | sms | other
Required Pattern: email
..... value S 1..1 string The actual contact point details
.... telecom:telefon S 0..* ContactPoint A contact detail for the individual
..... system S 1..1 code phone | fax | email | pager | url | sms | other
Required Pattern: phone
..... value S 1..1 string The actual contact point details
... gender S 0..1 code male | female | other | unknown
... birthDate S 0..1 date The date of birth for the individual
... deceased[x] 0..0 Indicates if the individual is deceased or not
... address S 0..* Address An address for the individual
.... text 0..0 Text representation of the address
.... line S 0..* string Street name, number, direction & P.O. Box etc.
.... city S 0..1 string Name of city, town etc.
.... district 0..0 District name (aka county)
.... state S 0..1 string Bundesland
Binding: http://fhir.de/ValueSet/iso/bundeslaender (required)
.... postalCode S 0..1 string Postal code for area
.... country S 0..1 string Staat
Binding: Iso3166-1-2 (required)
.... period 0..0 Time period when address was/is in use
... maritalStatus S 0..1 CodeableConcept Marital (civil) status of a patient
Binding: Marital Status Codes (preferred): The domestic partnership status of a person.
.... coding S 0..1 Coding Code defined by a terminology system
..... system S 1..1 uri Identity of the terminology system
..... code S 1..1 code Symbol in syntax defined by the system
.... text S 1..1 string Plain text representation of the concept
... multipleBirth[x] 0..0 Whether patient is part of a multiple birth
... photo 0..0 Image of the patient
... contact 0..0 A contact party (e.g. guardian, partner, friend) for the patient
... communication S 0..* BackboneElement A language which may be used to communicate with the patient about his or her health
.... language S 1..1 CodeableConcept The language which can be used to communicate with the patient about his or her health
Binding: CommonLanguages (required): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
..... coding S 0..1 Coding Code defined by a terminology system
...... system S 1..1 uri Identity of the terminology system
...... code S 1..1 code Symbol in syntax defined by the system
..... text S 0..1 string Plain text representation of the concept
.... preferred S 1..1 boolean Language preference indicator
Fixed Value: true
... generalPractitioner 0..0 Patient's nominated primary care provider
... managingOrganization 0..0 Organization that is the custodian of the patient record
... link 0..0 Link to another patient resource that concerns the same actual person

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Patient.extension:nationality.​extension:code.value[x] Base required Iso 3166 Part 1: 2 Letter Codes 📦4.0.1 FHIR Std.
Patient.address.state Base required http://fhir.de/ValueSet/iso/bundeslaender Not State Unknown
Patient.address.country Base required Iso 3166 Part 1: 2 Letter Codes 📦4.0.1 FHIR Std.
Patient.maritalStatus Base preferred MaritalStatus 📦4.0.1 FHIR Std.
Patient.communication.​language Base required Common Languages 📦4.0.1 FHIR Std.
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient 0..* Patient Patienten-Profil zur Übermittlung von angeforderten IDAT
... id Σ 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 SΣ 0..1 id Version specific identifier
.... lastUpdated SΣ 0..1 instant When the resource version last changed
.... source SΣ 0..1 uri Identifies where the resource comes from
.... profile Σ 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) Place of Birth for patient
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/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
...... city SΣ 1..1 string Name of city, town etc.
Example General: Erewhon
.... extension:nationality S 0..1 (Complex) Nationality
URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
..... id 0..1 id Unique id for inter-element referencing
..... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... extension:code 0..1 Extension Extension
....... id 0..1 id Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "code"
....... value[x] S 1..1 CodeableConcept Value of extension
Binding: Iso3166-1-2 (required)
........ 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..1 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Σ 1..1 uri Identity of the terminology system
......... version Σ 0..1 string Version of the system - if relevant
......... code SΣ 1..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 SΣ 0..1 string Plain text representation of the concept
...... extension:period 0..1 Extension Nationality Period
....... id 0..1 id Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "period"
....... value[x] 1..1 Period Value of extension
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/patient-nationality"
.... extension:customIdatValues S 0..1 (Complex) Benutzerdefinierter Satz von IDAT Werten
URL: https://ths-greifswald.de/fhir/StructureDefinition/epix/CustomIdatValues
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier SΣ 0..* Identifier An identifier for this patient
.... 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 Σ 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.
.... 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 Σ 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 Whether this patient's record is in active use
... name SΣ 0..* HumanName A name associated with the patient
.... 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Σ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
.... family SΣ 0..1 string Family name (often called 'Surname')
.... given SΣ 0..* string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
.... prefix SΣ 0..* string Parts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:academic S 0..1 (Complex) LS | AC | NB | PR | HON | BR | AD | SP | MID | CL | IN | VV
URL: http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier
....... id 0..1 id Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier"
....... value[x] S 1..1 code Value of extension
Binding: EntityNamePartQualifier (required)
Fixed Value: AC
..... value 0..1 string Primitive value for string
Max Length:1048576
.... suffix SΣ 0..* string Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
... Slices for telecom SΣ 0..* ContactPoint A contact detail for the individual
Slice: Unordered, Open by pattern:$this
.... telecom:email SΣ 0..* ContactPoint A contact detail for the individual
..... 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ΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Required Pattern: email
..... value SΣ 1..1 string The actual contact point details
..... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
..... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
..... period Σ 0..1 Period Time period when the contact point was/is in use
.... telecom:telefon SΣ 0..* ContactPoint A contact detail for the individual
..... 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ΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Required Pattern: phone
..... value SΣ 1..1 string The actual contact point details
..... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
..... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
..... period Σ 0..1 Period Time period when the contact point was/is in use
... gender SΣ 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
... birthDate SΣ 0..1 date The date of birth for the individual
... address SΣ 0..* Address An address for the individual
.... 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
.... line SΣ 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 SΣ 0..1 string Name of city, town etc.
Example General: Erewhon
.... state SΣ 0..1 string Bundesland
Binding: http://fhir.de/ValueSet/iso/bundeslaender (required)
.... postalCode SΣ 0..1 string Postal code for area
Example General: 9132
.... country SΣ 0..1 string Staat
Binding: Iso3166-1-2 (required)
... maritalStatus S 0..1 CodeableConcept Marital (civil) status of a patient
Binding: Marital Status Codes (preferred): The domestic partnership status of a person.
.... 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..1 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Σ 1..1 uri Identity of the terminology system
..... version Σ 0..1 string Version of the system - if relevant
..... code SΣ 1..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 SΣ 1..1 string Plain text representation of the concept
... communication S 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 S 1..1 CodeableConcept The language which can be used to communicate with the patient about his or her health
Binding: CommonLanguages (required): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
..... 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..1 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Σ 1..1 uri Identity of the terminology system
...... version Σ 0..1 string Version of the system - if relevant
...... code SΣ 1..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 SΣ 0..1 string Plain text representation of the concept
.... preferred S 1..1 boolean Language preference indicator
Fixed Value: true

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:nationality.​extension:code.value[x] Base required Iso 3166 Part 1: 2 Letter Codes 📦4.0.1 FHIR Std.
Patient.identifier.use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier.type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Patient.name.use Base required NameUse 📍4.0.1 FHIR Std.
Patient.name.prefix.​extension:academic.value[x] Base required EntityNamePartQualifier 📦5.2.0 FHIR Extensions Pack v5.2
Patient.telecom:email.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
Patient.telecom:email.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
Patient.telecom:telefon.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
Patient.telecom:telefon.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
Patient.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
Patient.address.use Base required AddressUse 📍4.0.1 FHIR Std.
Patient.address.type Base required AddressType 📍4.0.1 FHIR Std.
Patient.address.state Base required http://fhir.de/ValueSet/iso/bundeslaender Not State Unknown
Patient.address.country Base required Iso 3166 Part 1: 2 Letter Codes 📦4.0.1 FHIR Std.
Patient.maritalStatus Base preferred 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 required Common Languages 📦4.0.1 FHIR Std.
Patient.link.type Base required LinkType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Patient If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Patient If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Patient If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Patient If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Patient A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from Patient

Summary

Mandatory: 0 element(15 nested mandatory elements)
Must-Support: 53 elements
Fixed: 2 elements
Prohibited: 21 elements

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.telecom

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient 0..* Patient Patienten-Profil zur Übermittlung von angeforderten IDAT
... meta SΣ 0..1 Meta Metadata about the resource
.... versionId SΣ 0..1 id Version specific identifier
.... lastUpdated SΣ 0..1 instant When the resource version last changed
.... source SΣ 0..1 uri Identifies where the resource comes from
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:birthPlace S 0..1 (Complex) Place of Birth for patient
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/patient-birthPlace"
..... value[x] S 1..1 Address Value of extension
...... city SΣ 1..1 string Name of city, town etc.
Example General: Erewhon
.... extension:nationality S 0..1 (Complex) Nationality
URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
..... Slices for extension Content/Rules for all slices
...... extension:code 0..1 Extension Extension
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "code"
....... value[x] S 1..1 CodeableConcept Value of extension
Binding: Iso3166-1-2 (required)
........ coding SΣ 0..1 Coding Code defined by a terminology system
......... system SΣ 1..1 uri Identity of the terminology system
......... code SΣ 1..1 code Symbol in syntax defined by the system
........ text SΣ 0..1 string Plain text representation of the concept
...... extension:period 0..1 Extension Nationality Period
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "period"
....... value[x] 1..1 Period Value of extension
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/patient-nationality"
.... extension:customIdatValues S 0..1 (Complex) Benutzerdefinierter Satz von IDAT Werten
URL: https://ths-greifswald.de/fhir/StructureDefinition/epix/CustomIdatValues
... identifier SΣ 0..* Identifier An identifier for this patient
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
.... 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
... active ?!SΣ 0..1 boolean Whether this patient's record is in active use
... name SΣ 0..* HumanName A name associated with the patient
.... use ?!SΣ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
.... family SΣ 0..1 string Family name (often called 'Surname')
.... given SΣ 0..* string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
.... prefix SΣ 0..* string Parts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:academic S 0..1 (Complex) LS | AC | NB | PR | HON | BR | AD | SP | MID | CL | IN | VV
URL: http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier"
....... value[x] S 1..1 code Value of extension
Binding: EntityNamePartQualifier (required)
Fixed Value: AC
.... suffix SΣ 0..* string Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
... Slices for telecom SΣ 0..* ContactPoint A contact detail for the individual
Slice: Unordered, Open by pattern:$this
.... telecom:email SΣ 0..* ContactPoint A contact detail for the individual
..... system SΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Required Pattern: email
..... value SΣ 1..1 string The actual contact point details
..... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
.... telecom:telefon SΣ 0..* ContactPoint A contact detail for the individual
..... system SΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Required Pattern: phone
..... value SΣ 1..1 string The actual contact point details
..... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
... gender SΣ 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
... birthDate SΣ 0..1 date The date of birth for the individual
... address SΣ 0..* Address An address for the individual
.... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.
Example General: home
.... line SΣ 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 SΣ 0..1 string Name of city, town etc.
Example General: Erewhon
.... state SΣ 0..1 string Bundesland
Binding: http://fhir.de/ValueSet/iso/bundeslaender (required)
.... postalCode SΣ 0..1 string Postal code for area
Example General: 9132
.... country SΣ 0..1 string Staat
Binding: Iso3166-1-2 (required)
... maritalStatus S 0..1 CodeableConcept Marital (civil) status of a patient
Binding: Marital Status Codes (preferred): The domestic partnership status of a person.
.... coding SΣ 0..1 Coding Code defined by a terminology system
..... system SΣ 1..1 uri Identity of the terminology system
..... code SΣ 1..1 code Symbol in syntax defined by the system
.... text SΣ 1..1 string Plain text representation of the concept
... communication S 0..* BackboneElement A language which may be used to communicate with the patient about his or her health
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... language S 1..1 CodeableConcept The language which can be used to communicate with the patient about his or her health
Binding: CommonLanguages (required): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
..... coding SΣ 0..1 Coding Code defined by a terminology system
...... system SΣ 1..1 uri Identity of the terminology system
...... code SΣ 1..1 code Symbol in syntax defined by the system
..... text SΣ 0..1 string Plain text representation of the concept
.... preferred S 1..1 boolean Language preference indicator
Fixed Value: true

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Patient.extension:nationality.​extension:code.value[x] Base required Iso 3166 Part 1: 2 Letter Codes 📦4.0.1 FHIR Std.
Patient.identifier.use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.name.use Base required NameUse 📍4.0.1 FHIR Std.
Patient.name.prefix.​extension:academic.value[x] Base required EntityNamePartQualifier 📦5.2.0 FHIR Extensions Pack v5.2
Patient.telecom:email.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
Patient.telecom:email.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
Patient.telecom:telefon.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
Patient.telecom:telefon.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
Patient.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
Patient.address.use Base required AddressUse 📍4.0.1 FHIR Std.
Patient.address.state Base required http://fhir.de/ValueSet/iso/bundeslaender Not State Unknown
Patient.address.country Base required Iso 3166 Part 1: 2 Letter Codes 📦4.0.1 FHIR Std.
Patient.maritalStatus Base preferred MaritalStatus 📦4.0.1 FHIR Std.
Patient.communication.​language Base required Common Languages 📦4.0.1 FHIR Std.
Patient.link.type Base required LinkType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Patient If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Patient If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Patient If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Patient If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Patient A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

Differential View

This structure is derived from Patient

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient 0..* Patient Patienten-Profil zur Übermittlung von angeforderten IDAT
... meta S 0..1 Meta Metadata about the resource
.... versionId S 0..1 id Version specific identifier
.... lastUpdated S 0..1 instant When the resource version last changed
.... source S 0..1 uri Identifies where the resource comes from
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:birthPlace S 0..1 (Complex) Place of Birth for patient
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
..... value[x] S 1..1 Address Value of extension
...... use 0..0 home | work | temp | old | billing - purpose of this address
...... type 0..0 postal | physical | both
...... text 0..0 Text representation of the address
...... line 0..0 Street name, number, direction & P.O. Box etc.
...... city S 1..1 string Name of city, town etc.
...... district 0..0 District name (aka county)
...... state 0..0 Sub-unit of country (abbreviations ok)
...... postalCode 0..0 Postal code for area
...... country 0..0 Country (e.g. can be ISO 3166 2 or 3 letter code)
...... period 0..0 Time period when address was/is in use
.... extension:nationality S 0..1 (Complex) Nationality
URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
..... Slices for extension Content/Rules for all slices
...... extension:code 0..1 Extension Extension
....... value[x] S 1..1 CodeableConcept Value of extension
Binding: Iso3166-1-2 (required)
........ coding S 0..1 Coding Code defined by a terminology system
......... system S 1..1 uri Identity of the terminology system
......... code S 1..1 code Symbol in syntax defined by the system
........ text S 0..1 string Plain text representation of the concept
.... extension:customIdatValues S 0..1 (Complex) Benutzerdefinierter Satz von IDAT Werten
URL: https://ths-greifswald.de/fhir/StructureDefinition/epix/CustomIdatValues
... identifier S 0..* Identifier An identifier for this patient
.... system S 1..1 uri The namespace for the identifier value
.... value S 1..1 string The value that is unique
... name S 0..* HumanName A name associated with the patient
.... use S 0..1 code usual | official | temp | nickname | anonymous | old | maiden
.... text 0..0 Text representation of the full name
.... family S 0..1 string Family name (often called 'Surname')
.... given S 0..* string Given names (not always 'first'). Includes middle names
.... prefix S 0..* string Parts that come before the name
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:academic S 0..1 (Complex) LS | AC | NB | PR | HON | BR | AD | SP | MID | CL | IN | VV
URL: http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier
....... value[x] S 1..1 code Value of extension
Fixed Value: AC
.... suffix S 0..* string Parts that come after the name
.... period 0..0 Time period when name was/is in use
... Slices for telecom S 0..* ContactPoint A contact detail for the individual
Slice: Unordered, Open by pattern:$this
.... telecom:email S 0..* ContactPoint A contact detail for the individual
..... system S 1..1 code phone | fax | email | pager | url | sms | other
Required Pattern: email
..... value S 1..1 string The actual contact point details
.... telecom:telefon S 0..* ContactPoint A contact detail for the individual
..... system S 1..1 code phone | fax | email | pager | url | sms | other
Required Pattern: phone
..... value S 1..1 string The actual contact point details
... gender S 0..1 code male | female | other | unknown
... birthDate S 0..1 date The date of birth for the individual
... deceased[x] 0..0 Indicates if the individual is deceased or not
... address S 0..* Address An address for the individual
.... text 0..0 Text representation of the address
.... line S 0..* string Street name, number, direction & P.O. Box etc.
.... city S 0..1 string Name of city, town etc.
.... district 0..0 District name (aka county)
.... state S 0..1 string Bundesland
Binding: http://fhir.de/ValueSet/iso/bundeslaender (required)
.... postalCode S 0..1 string Postal code for area
.... country S 0..1 string Staat
Binding: Iso3166-1-2 (required)
.... period 0..0 Time period when address was/is in use
... maritalStatus S 0..1 CodeableConcept Marital (civil) status of a patient
Binding: Marital Status Codes (preferred): The domestic partnership status of a person.
.... coding S 0..1 Coding Code defined by a terminology system
..... system S 1..1 uri Identity of the terminology system
..... code S 1..1 code Symbol in syntax defined by the system
.... text S 1..1 string Plain text representation of the concept
... multipleBirth[x] 0..0 Whether patient is part of a multiple birth
... photo 0..0 Image of the patient
... contact 0..0 A contact party (e.g. guardian, partner, friend) for the patient
... communication S 0..* BackboneElement A language which may be used to communicate with the patient about his or her health
.... language S 1..1 CodeableConcept The language which can be used to communicate with the patient about his or her health
Binding: CommonLanguages (required): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
..... coding S 0..1 Coding Code defined by a terminology system
...... system S 1..1 uri Identity of the terminology system
...... code S 1..1 code Symbol in syntax defined by the system
..... text S 0..1 string Plain text representation of the concept
.... preferred S 1..1 boolean Language preference indicator
Fixed Value: true
... generalPractitioner 0..0 Patient's nominated primary care provider
... managingOrganization 0..0 Organization that is the custodian of the patient record
... link 0..0 Link to another patient resource that concerns the same actual person

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Patient.extension:nationality.​extension:code.value[x] Base required Iso 3166 Part 1: 2 Letter Codes 📦4.0.1 FHIR Std.
Patient.address.state Base required http://fhir.de/ValueSet/iso/bundeslaender Not State Unknown
Patient.address.country Base required Iso 3166 Part 1: 2 Letter Codes 📦4.0.1 FHIR Std.
Patient.maritalStatus Base preferred MaritalStatus 📦4.0.1 FHIR Std.
Patient.communication.​language Base required Common Languages 📦4.0.1 FHIR Std.

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient 0..* Patient Patienten-Profil zur Übermittlung von angeforderten IDAT
... id Σ 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 SΣ 0..1 id Version specific identifier
.... lastUpdated SΣ 0..1 instant When the resource version last changed
.... source SΣ 0..1 uri Identifies where the resource comes from
.... profile Σ 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) Place of Birth for patient
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/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
...... city SΣ 1..1 string Name of city, town etc.
Example General: Erewhon
.... extension:nationality S 0..1 (Complex) Nationality
URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
..... id 0..1 id Unique id for inter-element referencing
..... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... extension:code 0..1 Extension Extension
....... id 0..1 id Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "code"
....... value[x] S 1..1 CodeableConcept Value of extension
Binding: Iso3166-1-2 (required)
........ 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..1 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Σ 1..1 uri Identity of the terminology system
......... version Σ 0..1 string Version of the system - if relevant
......... code SΣ 1..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 SΣ 0..1 string Plain text representation of the concept
...... extension:period 0..1 Extension Nationality Period
....... id 0..1 id Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "period"
....... value[x] 1..1 Period Value of extension
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/patient-nationality"
.... extension:customIdatValues S 0..1 (Complex) Benutzerdefinierter Satz von IDAT Werten
URL: https://ths-greifswald.de/fhir/StructureDefinition/epix/CustomIdatValues
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier SΣ 0..* Identifier An identifier for this patient
.... 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 Σ 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.
.... 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 Σ 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 Whether this patient's record is in active use
... name SΣ 0..* HumanName A name associated with the patient
.... 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Σ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
.... family SΣ 0..1 string Family name (often called 'Surname')
.... given SΣ 0..* string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
.... prefix SΣ 0..* string Parts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:academic S 0..1 (Complex) LS | AC | NB | PR | HON | BR | AD | SP | MID | CL | IN | VV
URL: http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier
....... id 0..1 id Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier"
....... value[x] S 1..1 code Value of extension
Binding: EntityNamePartQualifier (required)
Fixed Value: AC
..... value 0..1 string Primitive value for string
Max Length:1048576
.... suffix SΣ 0..* string Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
... Slices for telecom SΣ 0..* ContactPoint A contact detail for the individual
Slice: Unordered, Open by pattern:$this
.... telecom:email SΣ 0..* ContactPoint A contact detail for the individual
..... 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ΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Required Pattern: email
..... value SΣ 1..1 string The actual contact point details
..... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
..... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
..... period Σ 0..1 Period Time period when the contact point was/is in use
.... telecom:telefon SΣ 0..* ContactPoint A contact detail for the individual
..... 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ΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Required Pattern: phone
..... value SΣ 1..1 string The actual contact point details
..... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
..... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
..... period Σ 0..1 Period Time period when the contact point was/is in use
... gender SΣ 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
... birthDate SΣ 0..1 date The date of birth for the individual
... address SΣ 0..* Address An address for the individual
.... 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
.... line SΣ 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 SΣ 0..1 string Name of city, town etc.
Example General: Erewhon
.... state SΣ 0..1 string Bundesland
Binding: http://fhir.de/ValueSet/iso/bundeslaender (required)
.... postalCode SΣ 0..1 string Postal code for area
Example General: 9132
.... country SΣ 0..1 string Staat
Binding: Iso3166-1-2 (required)
... maritalStatus S 0..1 CodeableConcept Marital (civil) status of a patient
Binding: Marital Status Codes (preferred): The domestic partnership status of a person.
.... 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..1 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Σ 1..1 uri Identity of the terminology system
..... version Σ 0..1 string Version of the system - if relevant
..... code SΣ 1..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 SΣ 1..1 string Plain text representation of the concept
... communication S 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 S 1..1 CodeableConcept The language which can be used to communicate with the patient about his or her health
Binding: CommonLanguages (required): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
..... 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..1 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Σ 1..1 uri Identity of the terminology system
...... version Σ 0..1 string Version of the system - if relevant
...... code SΣ 1..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 SΣ 0..1 string Plain text representation of the concept
.... preferred S 1..1 boolean Language preference indicator
Fixed Value: true

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:nationality.​extension:code.value[x] Base required Iso 3166 Part 1: 2 Letter Codes 📦4.0.1 FHIR Std.
Patient.identifier.use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier.type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Patient.name.use Base required NameUse 📍4.0.1 FHIR Std.
Patient.name.prefix.​extension:academic.value[x] Base required EntityNamePartQualifier 📦5.2.0 FHIR Extensions Pack v5.2
Patient.telecom:email.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
Patient.telecom:email.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
Patient.telecom:telefon.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
Patient.telecom:telefon.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
Patient.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
Patient.address.use Base required AddressUse 📍4.0.1 FHIR Std.
Patient.address.type Base required AddressType 📍4.0.1 FHIR Std.
Patient.address.state Base required http://fhir.de/ValueSet/iso/bundeslaender Not State Unknown
Patient.address.country Base required Iso 3166 Part 1: 2 Letter Codes 📦4.0.1 FHIR Std.
Patient.maritalStatus Base preferred 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 required Common Languages 📦4.0.1 FHIR Std.
Patient.link.type Base required LinkType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Patient If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Patient If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Patient If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Patient If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Patient A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from Patient

Summary

Mandatory: 0 element(15 nested mandatory elements)
Must-Support: 53 elements
Fixed: 2 elements
Prohibited: 21 elements

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.telecom

 

Other representations of profile: CSV, Excel, Schematron