Official URL: https://gematik.de/fhir/epa/StructureDefinition/epa-patient | Version: 1.1.5 | |||
Draft as of 2025-03-31 | Computable Name: EPAPatient |
Das Patient-Profil für die ePA
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
C | 0..* | TIPatient | Information about an individual or animal receiving health care services dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management pat-de-1: Die amtliche Differenzierung der Geschlechtsangabe 'other' darf nur gefüllt sein, wenn das Geschlecht 'other' angegeben ist |
![]() ![]() ![]() |
SΣ | 0..1 | id | Logical id of this artifact |
![]() ![]() ![]() |
SΣ | 0..1 | Meta | Metadata about the resource ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | id | Version specific identifier ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | instant | When the resource version last changed ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() |
SΣ | 1..* | Identifier | An identifier for this patient Slice: Unordered, Open by value:system ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | IdentifierKvid10 | An identifier for this patient ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
?!SΣ | 0..1 | boolean | Whether this patient's record is in active use ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
SΣ | 1..* | HumanName | A name associated with the patient Slice: Unordered, Open by value:$this ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | HumannameDeBasis | A name associated with the patient ele-1: All FHIR elements must have a @value or children Required Pattern: At least the following |
![]() ![]() ![]() ![]() ![]() |
1..1 | code | usual | official | temp | nickname | anonymous | old | maiden Fixed Value: official | |
![]() ![]() ![]() ![]() ![]() |
?!SΣ | 1..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Familienname ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
S | 0..1 | string | Namenszusatz gemäß VSDM (Versichertenstammdatenmanagement, "eGK") URL: http://fhir.de/StructureDefinition/humanname-namenszusatz ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
S | 0..1 | string | Portion derived from person's own surname URL: http://hl7.org/fhir/StructureDefinition/humanname-own-name ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
S | 0..1 | string | Voorvoegsel derived from person's own surname URL: http://hl7.org/fhir/StructureDefinition/humanname-own-prefix ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..* | string | Vorname ele-1: All FHIR elements must have a @value or children This repeating element order: Given Names appear in the correct order for presenting the name |
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..* | string | Namensteile vor dem Vornamen ele-1: All FHIR elements must have a @value or children This repeating element order: Prefixes appear in the correct order for presenting the name |
![]() ![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
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 ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier" | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Value of extension Binding: EntityNamePartQualifier (required) ele-1: All FHIR elements must have a @value or children Fixed Value: AC | |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | HumannameDeBasis | A name associated with the patient ele-1: All FHIR elements must have a @value or children Required Pattern: At least the following |
![]() ![]() ![]() ![]() ![]() |
1..1 | code | usual | official | temp | nickname | anonymous | old | maiden Fixed Value: maiden | |
![]() ![]() ![]() ![]() ![]() |
?!SΣ | 1..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Familienname ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
S | 0..1 | string | Namenszusatz gemäß VSDM (Versichertenstammdatenmanagement, "eGK") URL: http://fhir.de/StructureDefinition/humanname-namenszusatz ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
S | 0..1 | string | Portion derived from person's own surname URL: http://hl7.org/fhir/StructureDefinition/humanname-own-name ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
S | 0..1 | string | Voorvoegsel derived from person's own surname URL: http://hl7.org/fhir/StructureDefinition/humanname-own-prefix ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() |
SΣ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
0..1 | Coding | Optional Extensions Element URL: http://fhir.de/StructureDefinition/gender-amtlich-de Binding: GenderOtherDE ValueSet (required) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
![]() ![]() ![]() |
SΣ | 1..1 | date | The date of birth for the individual ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
?!Σ | 0..1 | Indicates if the individual is deceased or not ele-1: All FHIR elements must have a @value or children | |
![]() ![]() ![]() ![]() |
boolean | |||
![]() ![]() ![]() ![]() |
dateTime | |||
![]() ![]() ![]() |
?!Σ | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() |
ΣC | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to ele-1: All FHIR elements must have a @value or children ref-1: SHALL have a contained resource if a local reference is provided |
![]() ![]() ![]() ![]() |
Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource. ele-1: All FHIR elements must have a @value or children |
![]() |
Path | Conformance | ValueSet / Code | URI |
Patient.name:Name.use | required | NameUsehttp://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard | |
Patient.name:Name.prefix.extension:prefix-qualifier.value[x] | required | Fixed Value: AChttp://hl7.org/fhir/ValueSet/name-part-qualifier | |
Patient.name:Geburtsname.use | required | NameUsehttp://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard | |
Patient.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard | |
Patient.link.type | required | LinkTypehttp://hl7.org/fhir/ValueSet/link-type|4.0.1 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
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() | |
pat-de-1 | error | Patient | Die amtliche Differenzierung der Geschlechtsangabe 'other' darf nur gefüllt sein, wenn das Geschlecht 'other' angegeben ist : gender.exists() and gender='other' implies gender.extension('http://fhir.de/StructureDefinition/gender-amtlich-de').exists() | |
ref-1 | error | Patient.link.other | SHALL have a contained resource if a local reference is provided : reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) |
This structure is derived from TIPatient
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
0..* | TIPatient | Information about an individual or animal receiving health care services | |
![]() ![]() ![]() |
1..* | Identifier | An identifier for this patient | |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
1..1 | IdentifierKvid10 | An identifier for this patient | |
![]() |
Name | Flags | Card. | Type | Description & Constraints![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
C | 0..* | TIPatient | Information about an individual or animal receiving health care services dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management pat-de-1: Die amtliche Differenzierung der Geschlechtsangabe 'other' darf nur gefüllt sein, wenn das Geschlecht 'other' angegeben ist | ||||
![]() ![]() ![]() |
SΣ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() |
SΣ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | id | Version specific identifier | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | instant | When the resource version last changed | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | Identifies where the resource comes from | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
![]() ![]() ![]() ![]() |
Σ | 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". | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url | ||||
![]() ![]() ![]() |
SΣ | 1..* | Identifier | An identifier for this patient Slice: Unordered, Open by value:system | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | IdentifierKvid10 | An identifier for this patient | ||||
![]() ![]() ![]() |
?!SΣ | 0..1 | boolean | Whether this patient's record is in active use | ||||
![]() ![]() ![]() |
SΣ | 1..* | HumanName | A name associated with the patient Slice: Unordered, Open by value:$this | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | HumannameDeBasis | A name associated with the patient Required Pattern: At least the following | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | code | usual | official | temp | nickname | anonymous | old | maiden Fixed Value: official | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Text representation of the full name | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Family name (often called 'Surname') | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | string | Given names (not always 'first'). Includes middle names | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | string | Parts that come before the name | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | string | Parts that come after the name | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Period | Time period when name was/is in use | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
?!SΣ | 1..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Text representation of the full name | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Familienname | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
S | 0..1 | string | Namenszusatz gemäß VSDM (Versichertenstammdatenmanagement, "eGK") URL: http://fhir.de/StructureDefinition/humanname-namenszusatz | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
S | 0..1 | string | Portion derived from person's own surname URL: http://hl7.org/fhir/StructureDefinition/humanname-own-name | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
S | 0..1 | string | Voorvoegsel derived from person's own surname URL: http://hl7.org/fhir/StructureDefinition/humanname-own-prefix | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Primitive value for string Max Length:1048576 | |||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..* | string | Vorname This repeating element order: Given Names appear in the correct order for presenting the name | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..* | string | Namensteile vor dem Vornamen This repeating element order: Prefixes appear in the correct order for presenting the name | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
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 | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier" | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Value of extension Binding: EntityNamePartQualifier (required) Fixed Value: AC | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Primitive value for string Max Length:1048576 | |||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..* | string | Namensteile nach dem Nachnamen This repeating element order: Suffixes appear in the correct order for presenting the name | ||||
![]() ![]() ![]() ![]() ![]() |
ΣC | 0..1 | Period | Time period when name was/is in use per-1: If present, start SHALL have a lower value than end | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | HumannameDeBasis | A name associated with the patient Required Pattern: At least the following | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | code | usual | official | temp | nickname | anonymous | old | maiden Fixed Value: maiden | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Text representation of the full name | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Family name (often called 'Surname') | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | string | Given names (not always 'first'). Includes middle names | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | string | Parts that come before the name | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | string | Parts that come after the name | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Period | Time period when name was/is in use | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
?!SΣ | 1..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Text representation of the full name | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Familienname | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
S | 0..1 | string | Namenszusatz gemäß VSDM (Versichertenstammdatenmanagement, "eGK") URL: http://fhir.de/StructureDefinition/humanname-namenszusatz | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
S | 0..1 | string | Portion derived from person's own surname URL: http://hl7.org/fhir/StructureDefinition/humanname-own-name | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
S | 0..1 | string | Voorvoegsel derived from person's own surname URL: http://hl7.org/fhir/StructureDefinition/humanname-own-prefix | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Primitive value for string Max Length:1048576 | |||||
![]() ![]() ![]() ![]() ![]() |
ΣC | 0..1 | Period | Time period when name was/is in use per-1: If present, start SHALL have a lower value than end | ||||
![]() ![]() ![]() |
ΣC | 0..* | ContactPoint | A contact detail for the individual cpt-2: A system is required if a value is provided. | ||||
![]() ![]() ![]() |
SΣ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | ||||
![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Coding | Optional Extensions Element URL: http://fhir.de/StructureDefinition/gender-amtlich-de Binding: GenderOtherDE ValueSet (required) | |||||
![]() ![]() ![]() ![]() |
0..1 | code | Primitive value for code Max Length:1048576 | |||||
![]() ![]() ![]() |
SΣ | 1..1 | date | The date of birth for the individual | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | Indicates if the individual is deceased or not | |||||
![]() ![]() ![]() ![]() |
boolean | |||||||
![]() ![]() ![]() ![]() |
dateTime | |||||||
![]() ![]() ![]() |
Σ | 0..* | Address | An address for the individual | ||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Marital (civil) status of a patient Binding: Marital Status Codes (extensible): The domestic partnership status of a person. | |||||
![]() ![]() ![]() |
0..1 | Whether patient is part of a multiple birth | ||||||
![]() ![]() ![]() ![]() |
boolean | |||||||
![]() ![]() ![]() ![]() |
integer | |||||||
![]() ![]() ![]() |
C | 0..* | Attachment | Image of the patient att-1: If the Attachment has data, it SHALL have a contentType | ||||
![]() ![]() ![]() |
C | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient pat-1: SHALL at least contain a contact's details or a reference to an organization | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
0..* | CodeableConcept | The kind of relationship Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient. | |||||
![]() ![]() ![]() ![]() |
0..1 | HumanName | A name associated with the contact person | |||||
![]() ![]() ![]() ![]() |
C | 0..* | ContactPoint | A contact detail for the person cpt-2: A system is required if a value is provided. | ||||
![]() ![]() ![]() ![]() |
0..1 | Address | Address for the contact person | |||||
![]() ![]() ![]() ![]() |
0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | |||||
![]() ![]() ![]() ![]() |
C | 0..1 | Reference(Organization) | Organization that is associated with the contact ref-1: SHALL have a contained resource if a local reference is provided | ||||
![]() ![]() ![]() ![]() |
C | 0..1 | Period | The period during which this contact person or organization is valid to be contacted relating to this patient per-1: If present, start SHALL have a lower value than end | ||||
![]() ![]() ![]() |
0..* | BackboneElement | A language which may be used to communicate with the patient about his or her health | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() ![]() ![]() |
0..1 | boolean | Language preference indicator | |||||
![]() ![]() ![]() |
C | 0..* | Reference(Organization | Practitioner | PractitionerRole) | Patient's nominated primary care provider ref-1: SHALL have a contained resource if a local reference is provided | ||||
![]() ![]() ![]() |
ΣC | 0..1 | Reference(Organization) | Organization that is the custodian of the patient record ref-1: SHALL have a contained resource if a local reference is provided | ||||
![]() ![]() ![]() |
?!Σ | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
ΣC | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to ref-1: SHALL have a contained resource if a local reference is provided | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource. | ||||
![]() |
Path | Conformance | ValueSet / Code | URI | |||
Patient.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard | ||||
Patient.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard | ||||
Patient.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages from the FHIR Standard
| ||||
Patient.name:Name.use | required | NameUsehttp://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard | ||||
Patient.name:Name.prefix.extension:prefix-qualifier.value[x] | required | Fixed Value: AChttp://hl7.org/fhir/ValueSet/name-part-qualifier | ||||
Patient.name:Geburtsname.use | required | NameUsehttp://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard | ||||
Patient.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard | ||||
Patient.maritalStatus | extensible | Marital Status Codeshttp://hl7.org/fhir/ValueSet/marital-status from the FHIR Standard | ||||
Patient.contact.relationship | extensible | PatientContactRelationshiphttp://hl7.org/fhir/ValueSet/patient-contactrelationship from the FHIR Standard | ||||
Patient.contact.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard | ||||
Patient.communication.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages from the FHIR Standard
| ||||
Patient.link.type | required | LinkTypehttp://hl7.org/fhir/ValueSet/link-type|4.0.1 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
att-1 | error | Patient.photo | If the Attachment has data, it SHALL have a contentType : data.empty() or contentType.exists() | |
cpt-2 | error | Patient.telecom, Patient.contact.telecom | A system is required if a value is provided. : value.empty() or system.exists() | |
dom-2 | error | Patient | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Patient | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Patient | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
pat-1 | error | Patient.contact | SHALL at least contain a contact's details or a reference to an organization : name.exists() or telecom.exists() or address.exists() or organization.exists() | |
pat-de-1 | error | Patient | Die amtliche Differenzierung der Geschlechtsangabe 'other' darf nur gefüllt sein, wenn das Geschlecht 'other' angegeben ist : gender.exists() and gender='other' implies gender.extension('http://fhir.de/StructureDefinition/gender-amtlich-de').exists() | |
per-1 | error | Patient.name:Name.period, Patient.name:Geburtsname.period, Patient.contact.period | If present, start SHALL have a lower value than end : start.hasValue().not() or end.hasValue().not() or (start <= end) | |
ref-1 | error | Patient.contact.organization, Patient.generalPractitioner, Patient.managingOrganization, Patient.link.other | SHALL have a contained resource if a local reference is provided : reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) |
This structure is derived from TIPatient
Key Elements View
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
C | 0..* | TIPatient | Information about an individual or animal receiving health care services dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management pat-de-1: Die amtliche Differenzierung der Geschlechtsangabe 'other' darf nur gefüllt sein, wenn das Geschlecht 'other' angegeben ist |
![]() ![]() ![]() |
SΣ | 0..1 | id | Logical id of this artifact |
![]() ![]() ![]() |
SΣ | 0..1 | Meta | Metadata about the resource ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | id | Version specific identifier ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | instant | When the resource version last changed ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() |
SΣ | 1..* | Identifier | An identifier for this patient Slice: Unordered, Open by value:system ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | IdentifierKvid10 | An identifier for this patient ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
?!SΣ | 0..1 | boolean | Whether this patient's record is in active use ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
SΣ | 1..* | HumanName | A name associated with the patient Slice: Unordered, Open by value:$this ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | HumannameDeBasis | A name associated with the patient ele-1: All FHIR elements must have a @value or children Required Pattern: At least the following |
![]() ![]() ![]() ![]() ![]() |
1..1 | code | usual | official | temp | nickname | anonymous | old | maiden Fixed Value: official | |
![]() ![]() ![]() ![]() ![]() |
?!SΣ | 1..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Familienname ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
S | 0..1 | string | Namenszusatz gemäß VSDM (Versichertenstammdatenmanagement, "eGK") URL: http://fhir.de/StructureDefinition/humanname-namenszusatz ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
S | 0..1 | string | Portion derived from person's own surname URL: http://hl7.org/fhir/StructureDefinition/humanname-own-name ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
S | 0..1 | string | Voorvoegsel derived from person's own surname URL: http://hl7.org/fhir/StructureDefinition/humanname-own-prefix ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..* | string | Vorname ele-1: All FHIR elements must have a @value or children This repeating element order: Given Names appear in the correct order for presenting the name |
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..* | string | Namensteile vor dem Vornamen ele-1: All FHIR elements must have a @value or children This repeating element order: Prefixes appear in the correct order for presenting the name |
![]() ![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
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 ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier" | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Value of extension Binding: EntityNamePartQualifier (required) ele-1: All FHIR elements must have a @value or children Fixed Value: AC | |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | HumannameDeBasis | A name associated with the patient ele-1: All FHIR elements must have a @value or children Required Pattern: At least the following |
![]() ![]() ![]() ![]() ![]() |
1..1 | code | usual | official | temp | nickname | anonymous | old | maiden Fixed Value: maiden | |
![]() ![]() ![]() ![]() ![]() |
?!SΣ | 1..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Familienname ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
S | 0..1 | string | Namenszusatz gemäß VSDM (Versichertenstammdatenmanagement, "eGK") URL: http://fhir.de/StructureDefinition/humanname-namenszusatz ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
S | 0..1 | string | Portion derived from person's own surname URL: http://hl7.org/fhir/StructureDefinition/humanname-own-name ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
S | 0..1 | string | Voorvoegsel derived from person's own surname URL: http://hl7.org/fhir/StructureDefinition/humanname-own-prefix ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() |
SΣ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
0..1 | Coding | Optional Extensions Element URL: http://fhir.de/StructureDefinition/gender-amtlich-de Binding: GenderOtherDE ValueSet (required) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
![]() ![]() ![]() |
SΣ | 1..1 | date | The date of birth for the individual ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
?!Σ | 0..1 | Indicates if the individual is deceased or not ele-1: All FHIR elements must have a @value or children | |
![]() ![]() ![]() ![]() |
boolean | |||
![]() ![]() ![]() ![]() |
dateTime | |||
![]() ![]() ![]() |
?!Σ | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() |
ΣC | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to ele-1: All FHIR elements must have a @value or children ref-1: SHALL have a contained resource if a local reference is provided |
![]() ![]() ![]() ![]() |
Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource. ele-1: All FHIR elements must have a @value or children |
![]() |
Path | Conformance | ValueSet / Code | URI |
Patient.name:Name.use | required | NameUsehttp://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard | |
Patient.name:Name.prefix.extension:prefix-qualifier.value[x] | required | Fixed Value: AChttp://hl7.org/fhir/ValueSet/name-part-qualifier | |
Patient.name:Geburtsname.use | required | NameUsehttp://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard | |
Patient.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard | |
Patient.link.type | required | LinkTypehttp://hl7.org/fhir/ValueSet/link-type|4.0.1 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
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() | |
pat-de-1 | error | Patient | Die amtliche Differenzierung der Geschlechtsangabe 'other' darf nur gefüllt sein, wenn das Geschlecht 'other' angegeben ist : gender.exists() and gender='other' implies gender.extension('http://fhir.de/StructureDefinition/gender-amtlich-de').exists() | |
ref-1 | error | Patient.link.other | SHALL have a contained resource if a local reference is provided : reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) |
Differential View
This structure is derived from TIPatient
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
0..* | TIPatient | Information about an individual or animal receiving health care services | |
![]() ![]() ![]() |
1..* | Identifier | An identifier for this patient | |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
1..1 | IdentifierKvid10 | An identifier for this patient | |
![]() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
C | 0..* | TIPatient | Information about an individual or animal receiving health care services dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management pat-de-1: Die amtliche Differenzierung der Geschlechtsangabe 'other' darf nur gefüllt sein, wenn das Geschlecht 'other' angegeben ist | ||||
![]() ![]() ![]() |
SΣ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() |
SΣ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | id | Version specific identifier | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | instant | When the resource version last changed | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | Identifies where the resource comes from | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
![]() ![]() ![]() ![]() |
Σ | 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". | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url | ||||
![]() ![]() ![]() |
SΣ | 1..* | Identifier | An identifier for this patient Slice: Unordered, Open by value:system | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | IdentifierKvid10 | An identifier for this patient | ||||
![]() ![]() ![]() |
?!SΣ | 0..1 | boolean | Whether this patient's record is in active use | ||||
![]() ![]() ![]() |
SΣ | 1..* | HumanName | A name associated with the patient Slice: Unordered, Open by value:$this | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | HumannameDeBasis | A name associated with the patient Required Pattern: At least the following | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | code | usual | official | temp | nickname | anonymous | old | maiden Fixed Value: official | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Text representation of the full name | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Family name (often called 'Surname') | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | string | Given names (not always 'first'). Includes middle names | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | string | Parts that come before the name | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | string | Parts that come after the name | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Period | Time period when name was/is in use | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
?!SΣ | 1..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Text representation of the full name | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Familienname | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
S | 0..1 | string | Namenszusatz gemäß VSDM (Versichertenstammdatenmanagement, "eGK") URL: http://fhir.de/StructureDefinition/humanname-namenszusatz | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
S | 0..1 | string | Portion derived from person's own surname URL: http://hl7.org/fhir/StructureDefinition/humanname-own-name | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
S | 0..1 | string | Voorvoegsel derived from person's own surname URL: http://hl7.org/fhir/StructureDefinition/humanname-own-prefix | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Primitive value for string Max Length:1048576 | |||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..* | string | Vorname This repeating element order: Given Names appear in the correct order for presenting the name | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..* | string | Namensteile vor dem Vornamen This repeating element order: Prefixes appear in the correct order for presenting the name | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
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 | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier" | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Value of extension Binding: EntityNamePartQualifier (required) Fixed Value: AC | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Primitive value for string Max Length:1048576 | |||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..* | string | Namensteile nach dem Nachnamen This repeating element order: Suffixes appear in the correct order for presenting the name | ||||
![]() ![]() ![]() ![]() ![]() |
ΣC | 0..1 | Period | Time period when name was/is in use per-1: If present, start SHALL have a lower value than end | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | HumannameDeBasis | A name associated with the patient Required Pattern: At least the following | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | code | usual | official | temp | nickname | anonymous | old | maiden Fixed Value: maiden | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Text representation of the full name | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Family name (often called 'Surname') | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | string | Given names (not always 'first'). Includes middle names | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | string | Parts that come before the name | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | string | Parts that come after the name | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Period | Time period when name was/is in use | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
?!SΣ | 1..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Text representation of the full name | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Familienname | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
S | 0..1 | string | Namenszusatz gemäß VSDM (Versichertenstammdatenmanagement, "eGK") URL: http://fhir.de/StructureDefinition/humanname-namenszusatz | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
S | 0..1 | string | Portion derived from person's own surname URL: http://hl7.org/fhir/StructureDefinition/humanname-own-name | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
S | 0..1 | string | Voorvoegsel derived from person's own surname URL: http://hl7.org/fhir/StructureDefinition/humanname-own-prefix | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Primitive value for string Max Length:1048576 | |||||
![]() ![]() ![]() ![]() ![]() |
ΣC | 0..1 | Period | Time period when name was/is in use per-1: If present, start SHALL have a lower value than end | ||||
![]() ![]() ![]() |
ΣC | 0..* | ContactPoint | A contact detail for the individual cpt-2: A system is required if a value is provided. | ||||
![]() ![]() ![]() |
SΣ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | ||||
![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Coding | Optional Extensions Element URL: http://fhir.de/StructureDefinition/gender-amtlich-de Binding: GenderOtherDE ValueSet (required) | |||||
![]() ![]() ![]() ![]() |
0..1 | code | Primitive value for code Max Length:1048576 | |||||
![]() ![]() ![]() |
SΣ | 1..1 | date | The date of birth for the individual | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | Indicates if the individual is deceased or not | |||||
![]() ![]() ![]() ![]() |
boolean | |||||||
![]() ![]() ![]() ![]() |
dateTime | |||||||
![]() ![]() ![]() |
Σ | 0..* | Address | An address for the individual | ||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Marital (civil) status of a patient Binding: Marital Status Codes (extensible): The domestic partnership status of a person. | |||||
![]() ![]() ![]() |
0..1 | Whether patient is part of a multiple birth | ||||||
![]() ![]() ![]() ![]() |
boolean | |||||||
![]() ![]() ![]() ![]() |
integer | |||||||
![]() ![]() ![]() |
C | 0..* | Attachment | Image of the patient att-1: If the Attachment has data, it SHALL have a contentType | ||||
![]() ![]() ![]() |
C | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient pat-1: SHALL at least contain a contact's details or a reference to an organization | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
0..* | CodeableConcept | The kind of relationship Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient. | |||||
![]() ![]() ![]() ![]() |
0..1 | HumanName | A name associated with the contact person | |||||
![]() ![]() ![]() ![]() |
C | 0..* | ContactPoint | A contact detail for the person cpt-2: A system is required if a value is provided. | ||||
![]() ![]() ![]() ![]() |
0..1 | Address | Address for the contact person | |||||
![]() ![]() ![]() ![]() |
0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | |||||
![]() ![]() ![]() ![]() |
C | 0..1 | Reference(Organization) | Organization that is associated with the contact ref-1: SHALL have a contained resource if a local reference is provided | ||||
![]() ![]() ![]() ![]() |
C | 0..1 | Period | The period during which this contact person or organization is valid to be contacted relating to this patient per-1: If present, start SHALL have a lower value than end | ||||
![]() ![]() ![]() |
0..* | BackboneElement | A language which may be used to communicate with the patient about his or her health | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() ![]() ![]() |
0..1 | boolean | Language preference indicator | |||||
![]() ![]() ![]() |
C | 0..* | Reference(Organization | Practitioner | PractitionerRole) | Patient's nominated primary care provider ref-1: SHALL have a contained resource if a local reference is provided | ||||
![]() ![]() ![]() |
ΣC | 0..1 | Reference(Organization) | Organization that is the custodian of the patient record ref-1: SHALL have a contained resource if a local reference is provided | ||||
![]() ![]() ![]() |
?!Σ | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
ΣC | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to ref-1: SHALL have a contained resource if a local reference is provided | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource. | ||||
![]() |
Path | Conformance | ValueSet / Code | URI | |||
Patient.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard | ||||
Patient.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard | ||||
Patient.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages from the FHIR Standard
| ||||
Patient.name:Name.use | required | NameUsehttp://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard | ||||
Patient.name:Name.prefix.extension:prefix-qualifier.value[x] | required | Fixed Value: AChttp://hl7.org/fhir/ValueSet/name-part-qualifier | ||||
Patient.name:Geburtsname.use | required | NameUsehttp://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard | ||||
Patient.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard | ||||
Patient.maritalStatus | extensible | Marital Status Codeshttp://hl7.org/fhir/ValueSet/marital-status from the FHIR Standard | ||||
Patient.contact.relationship | extensible | PatientContactRelationshiphttp://hl7.org/fhir/ValueSet/patient-contactrelationship from the FHIR Standard | ||||
Patient.contact.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard | ||||
Patient.communication.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages from the FHIR Standard
| ||||
Patient.link.type | required | LinkTypehttp://hl7.org/fhir/ValueSet/link-type|4.0.1 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
att-1 | error | Patient.photo | If the Attachment has data, it SHALL have a contentType : data.empty() or contentType.exists() | |
cpt-2 | error | Patient.telecom, Patient.contact.telecom | A system is required if a value is provided. : value.empty() or system.exists() | |
dom-2 | error | Patient | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Patient | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Patient | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
pat-1 | error | Patient.contact | SHALL at least contain a contact's details or a reference to an organization : name.exists() or telecom.exists() or address.exists() or organization.exists() | |
pat-de-1 | error | Patient | Die amtliche Differenzierung der Geschlechtsangabe 'other' darf nur gefüllt sein, wenn das Geschlecht 'other' angegeben ist : gender.exists() and gender='other' implies gender.extension('http://fhir.de/StructureDefinition/gender-amtlich-de').exists() | |
per-1 | error | Patient.name:Name.period, Patient.name:Geburtsname.period, Patient.contact.period | If present, start SHALL have a lower value than end : start.hasValue().not() or end.hasValue().not() or (start <= end) | |
ref-1 | error | Patient.contact.organization, Patient.generalPractitioner, Patient.managingOrganization, Patient.link.other | SHALL have a contained resource if a local reference is provided : reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) |
This structure is derived from TIPatient
Other representations of profile: CSV, Excel, Schematron