2025.2.0 - ci-build

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

Resource Profile: IDAT

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

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

Patienten-Profil zur Übermittlung von angeforderten IDAT an die fTTP für den Clearing-Prozess.

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
... 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] SN 1..1 Address Value of extension
...... city SΣN 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] SN 1..1 CodeableConcept Value of extension
Binding: Iso3166-1-2 (required)
........ coding SΣ 0..1 Coding Code defined by a terminology system
......... system SΣN 1..1 uri Identity of the terminology system
......... code SΣN 1..1 code Symbol in syntax defined by the system
........ text SΣN 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"
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
.... use ?!SΣN 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
.... family SΣN 0..1 string Family name (often called 'Surname')
.... given SΣN 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ΣN 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] SN 1..1 code Value of extension
Binding: EntityNamePartQualifier (required)
Fixed Value: AC
.... suffix SΣN 0..* string Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
... gender SΣN 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
... birthDate SΣN 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ΣN 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ΣN 0..1 string Name of city, town etc.
Example General: Erewhon
.... postalCode SΣN 0..1 string Postal code for area
Example General: 9132
... maritalStatus S 0..1 CodeableConcept Marital (civil) status of a patient
Binding: Marital Status Codes (required): The domestic partnership status of a person.
.... coding SΣ 0..1 Coding Code defined by a terminology system
..... system SΣN 1..1 uri Identity of the terminology system
..... code SΣN 1..1 code Symbol in syntax defined by the system
.... text SΣN 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ΣN 1..1 uri Identity of the terminology system
...... code SΣN 1..1 code Symbol in syntax defined by the system
..... text SΣN 0..1 string Plain text representation of the concept
.... preferred SN 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.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.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
Patient.address.use Base required AddressUse 📍4.0.1 FHIR Std.
Patient.maritalStatus Base required 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
... 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] SN 1..1 Address Value of extension
...... use N 0..0 home | work | temp | old | billing - purpose of this address
...... type N 0..0 postal | physical | both
...... text N 0..0 Text representation of the address
...... line N 0..0 Street name, number, direction & P.O. Box etc.
...... city SN 1..1 string Name of city, town etc.
...... district N 0..0 District name (aka county)
...... state N 0..0 Sub-unit of country (abbreviations ok)
...... postalCode N 0..0 Postal code for area
...... country N 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] SN 1..1 CodeableConcept Value of extension
Binding: Iso3166-1-2 (required)
........ coding S 0..1 Coding Code defined by a terminology system
......... system SN 1..1 uri Identity of the terminology system
......... code SN 1..1 code Symbol in syntax defined by the system
........ text SN 0..1 string Plain text representation of the concept
... identifier 0..0 An identifier for this patient
... active N 0..0 Whether this patient's record is in active use
.... use SN 0..1 code usual | official | temp | nickname | anonymous | old | maiden
.... text N 0..0 Text representation of the full name
.... family SN 0..1 string Family name (often called 'Surname')
.... given SN 0..* string Given names (not always 'first'). Includes middle names
.... prefix SN 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] SN 1..1 code Value of extension
Fixed Value: AC
.... suffix SN 0..* string Parts that come after the name
.... period 0..0 Time period when name was/is in use
... telecom 0..0 A contact detail for the individual
... gender SN 0..1 code male | female | other | unknown
... birthDate SN 0..1 date The date of birth for the individual
... deceased[x] N 0..0 Indicates if the individual is deceased or not
... address S 0..* Address An address for the individual
.... text N 0..0 Text representation of the address
.... line SN 0..* string Street name, number, direction & P.O. Box etc.
.... city SN 0..1 string Name of city, town etc.
.... district N 0..0 District name (aka county)
.... state N 0..0 Sub-unit of country (abbreviations ok)
.... postalCode SN 0..1 string Postal code for area
.... country N 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
... maritalStatus S 0..1 CodeableConcept Marital (civil) status of a patient
Binding: Marital Status Codes (required): The domestic partnership status of a person.
.... coding S 0..1 Coding Code defined by a terminology system
..... system SN 1..1 uri Identity of the terminology system
..... code SN 1..1 code Symbol in syntax defined by the system
.... text SN 1..1 string Plain text representation of the concept
... multipleBirth[x] N 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 SN 1..1 uri Identity of the terminology system
...... code SN 1..1 code Symbol in syntax defined by the system
..... text SN 0..1 string Plain text representation of the concept
.... preferred SN 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.maritalStatus Base required 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 Σ 0..1 Meta Metadata about the resource
... 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] SN 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ΣN 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] SN 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ΣN 1..1 uri Identity of the terminology system
......... version Σ 0..1 string Version of the system - if relevant
......... code SΣN 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ΣN 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"
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... 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ΣN 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
.... family SΣN 0..1 string Family name (often called 'Surname')
.... given SΣN 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ΣN 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] SN 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ΣN 0..* string Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
... gender SΣN 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
... birthDate SΣN 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ΣN 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ΣN 0..1 string Name of city, town etc.
Example General: Erewhon
.... postalCode SΣN 0..1 string Postal code for area
Example General: 9132
... maritalStatus S 0..1 CodeableConcept Marital (civil) status of a patient
Binding: Marital Status Codes (required): 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ΣN 1..1 uri Identity of the terminology system
..... version Σ 0..1 string Version of the system - if relevant
..... code SΣN 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ΣN 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ΣN 1..1 uri Identity of the terminology system
...... version Σ 0..1 string Version of the system - if relevant
...... code SΣN 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ΣN 0..1 string Plain text representation of the concept
.... preferred SN 1..1 boolean Language preference indicator
Fixed Value: true

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
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.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.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.maritalStatus Base required 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(9 nested mandatory elements)
Must-Support: 35 elements
Fixed: 2 elements
Prohibited: 26 elements

Extensions

This structure refers to these extensions:

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient 0..* Patient Patienten-Profil zur Übermittlung von angeforderten IDAT
... 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] SN 1..1 Address Value of extension
...... city SΣN 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] SN 1..1 CodeableConcept Value of extension
Binding: Iso3166-1-2 (required)
........ coding SΣ 0..1 Coding Code defined by a terminology system
......... system SΣN 1..1 uri Identity of the terminology system
......... code SΣN 1..1 code Symbol in syntax defined by the system
........ text SΣN 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"
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
.... use ?!SΣN 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
.... family SΣN 0..1 string Family name (often called 'Surname')
.... given SΣN 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ΣN 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] SN 1..1 code Value of extension
Binding: EntityNamePartQualifier (required)
Fixed Value: AC
.... suffix SΣN 0..* string Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
... gender SΣN 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
... birthDate SΣN 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ΣN 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ΣN 0..1 string Name of city, town etc.
Example General: Erewhon
.... postalCode SΣN 0..1 string Postal code for area
Example General: 9132
... maritalStatus S 0..1 CodeableConcept Marital (civil) status of a patient
Binding: Marital Status Codes (required): The domestic partnership status of a person.
.... coding SΣ 0..1 Coding Code defined by a terminology system
..... system SΣN 1..1 uri Identity of the terminology system
..... code SΣN 1..1 code Symbol in syntax defined by the system
.... text SΣN 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ΣN 1..1 uri Identity of the terminology system
...... code SΣN 1..1 code Symbol in syntax defined by the system
..... text SΣN 0..1 string Plain text representation of the concept
.... preferred SN 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.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.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
Patient.address.use Base required AddressUse 📍4.0.1 FHIR Std.
Patient.maritalStatus Base required 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
... 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] SN 1..1 Address Value of extension
...... use N 0..0 home | work | temp | old | billing - purpose of this address
...... type N 0..0 postal | physical | both
...... text N 0..0 Text representation of the address
...... line N 0..0 Street name, number, direction & P.O. Box etc.
...... city SN 1..1 string Name of city, town etc.
...... district N 0..0 District name (aka county)
...... state N 0..0 Sub-unit of country (abbreviations ok)
...... postalCode N 0..0 Postal code for area
...... country N 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] SN 1..1 CodeableConcept Value of extension
Binding: Iso3166-1-2 (required)
........ coding S 0..1 Coding Code defined by a terminology system
......... system SN 1..1 uri Identity of the terminology system
......... code SN 1..1 code Symbol in syntax defined by the system
........ text SN 0..1 string Plain text representation of the concept
... identifier 0..0 An identifier for this patient
... active N 0..0 Whether this patient's record is in active use
.... use SN 0..1 code usual | official | temp | nickname | anonymous | old | maiden
.... text N 0..0 Text representation of the full name
.... family SN 0..1 string Family name (often called 'Surname')
.... given SN 0..* string Given names (not always 'first'). Includes middle names
.... prefix SN 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] SN 1..1 code Value of extension
Fixed Value: AC
.... suffix SN 0..* string Parts that come after the name
.... period 0..0 Time period when name was/is in use
... telecom 0..0 A contact detail for the individual
... gender SN 0..1 code male | female | other | unknown
... birthDate SN 0..1 date The date of birth for the individual
... deceased[x] N 0..0 Indicates if the individual is deceased or not
... address S 0..* Address An address for the individual
.... text N 0..0 Text representation of the address
.... line SN 0..* string Street name, number, direction & P.O. Box etc.
.... city SN 0..1 string Name of city, town etc.
.... district N 0..0 District name (aka county)
.... state N 0..0 Sub-unit of country (abbreviations ok)
.... postalCode SN 0..1 string Postal code for area
.... country N 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
... maritalStatus S 0..1 CodeableConcept Marital (civil) status of a patient
Binding: Marital Status Codes (required): The domestic partnership status of a person.
.... coding S 0..1 Coding Code defined by a terminology system
..... system SN 1..1 uri Identity of the terminology system
..... code SN 1..1 code Symbol in syntax defined by the system
.... text SN 1..1 string Plain text representation of the concept
... multipleBirth[x] N 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 SN 1..1 uri Identity of the terminology system
...... code SN 1..1 code Symbol in syntax defined by the system
..... text SN 0..1 string Plain text representation of the concept
.... preferred SN 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.maritalStatus Base required 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 Σ 0..1 Meta Metadata about the resource
... 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] SN 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ΣN 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] SN 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ΣN 1..1 uri Identity of the terminology system
......... version Σ 0..1 string Version of the system - if relevant
......... code SΣN 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ΣN 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"
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... 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ΣN 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
.... family SΣN 0..1 string Family name (often called 'Surname')
.... given SΣN 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ΣN 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] SN 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ΣN 0..* string Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
... gender SΣN 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
... birthDate SΣN 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ΣN 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ΣN 0..1 string Name of city, town etc.
Example General: Erewhon
.... postalCode SΣN 0..1 string Postal code for area
Example General: 9132
... maritalStatus S 0..1 CodeableConcept Marital (civil) status of a patient
Binding: Marital Status Codes (required): 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ΣN 1..1 uri Identity of the terminology system
..... version Σ 0..1 string Version of the system - if relevant
..... code SΣN 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ΣN 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ΣN 1..1 uri Identity of the terminology system
...... version Σ 0..1 string Version of the system - if relevant
...... code SΣN 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ΣN 0..1 string Plain text representation of the concept
.... preferred SN 1..1 boolean Language preference indicator
Fixed Value: true

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
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.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.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.maritalStatus Base required 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(9 nested mandatory elements)
Must-Support: 35 elements
Fixed: 2 elements
Prohibited: 26 elements

Extensions

This structure refers to these extensions:

 

Other representations of profile: CSV, Excel, Schematron