HL7 Europe Patient Summary, published by HL7 Europe. This guide is not an authorized publication; it is the continuous build for version 0.0.1-ci built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7-eu/eps/ and changes regularly. See the Directory of published versions
Draft as of 2024-10-19 |
Definitions for the Subject logical model.
Guidance on how to interpret the contents of this table can be found here
0. Subject | |
Definition | Patient or Subject of care. Sections A1.1 and A1.2 of the eHN guideline. |
Short | A1.1, A1.2 - Subject of care |
Logical Model | Instances of this logical model are not marked to be the target of a Reference |
2. Subject.identification | |
Definition | A.1.1.1 National healthcare patient ID - Country ID, unique to the patient in that country. Example: ID for Portuguese patient |
Short | A.1.1.1 National healthcare patient ID |
Control | 1..1 |
Type | BackboneElement |
4. Subject.identification.identifier | |
Definition | A.1.1.2 Family name/surname - The family name/surname/last name of the patient. This field can contain more than one element or multiple fields could be present. |
Short | A.1.1.2 Family name/surname |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 0..* |
Type | Identifier |
6. Subject.identification.familyName | |
Definition | A.1.1.3 Given name� - The given name/first name of the patient (also known as forename or first name). This field can contain more than one element.�� |
Short | A.1.1.3 Given name |
Control | 0..* |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
8. Subject.identification.givenName | |
Definition | A.1.1.4 Date of birth� - The date of birth of the patient [ISO TS 22220]. As age of the patient might be important for correct interpretation of the test result values, complete date of birth should be provided. - Preferred system(s): Complete date, without time, following the ISO 8601� |
Short | A.1.1.4 Date of birth |
Control | 0..* |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
10. Subject.identification.dateOfBirth | |
Definition | A.1.1.5 Gender - This field must contain a recognised valid value for ""administrative gender"". If different, ""physiological gender"" should be communicated elsewhere. - Preferred system(s): HL7 Administrative Gender� |
Short | A.1.1.5 Gender |
Control | 0..1 |
Type | dateTime |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
12. Subject.identification.gender | |
Definition | A.1.1.5 Country of affiliation - Name of country of affiliation - Preferred system(s): ISO 3166 |
Short | A.1.1.5 Country of affiliation |
Control | 0..1 |
Type | CodeableConcept |
14. Subject.identification.countryOfAffiliation | |
Definition | A.1.2.1 Patient address - Patient address |
Short | A.1.2.1 Patient address |
Control | 0..1 |
Type | CodeableConcept |
16. Subject.telcomContact | |
Definition | Address |
Short | Address |
Control | 0..* |
Type | BackboneElement |
18. Subject.telcomContact.address | |
Definition | A.1.2.1.1 Street - Example: Rua dos Campe�es |
Short | A.1.2.1.1 Street |
Control | 0..* |
Type | BackboneElement |
20. Subject.telcomContact.address.street | |
Definition | A.1.2.1.2 House number - Example: 246 |
Short | A.1.2.1.2 House number |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
22. Subject.telcomContact.address.houseNumber | |
Definition | A.1.2.1.3 City - Example: Porto |
Short | A.1.2.1.3 City |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
24. Subject.telcomContact.address.city | |
Definition | A.1.2.1.4 Post code - Example: 4500 |
Short | A.1.2.1.4 Post code |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
26. Subject.telcomContact.address.postalCode | |
Definition | A.1.2.1.5 State or province - Example: Vila Nova de Gaia |
Short | A.1.2.1.5 State or province |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
28. Subject.telcomContact.address.stateOrProvince | |
Definition | A.1.2.1.6 Country - Example: PT - Preferred system(s): ISO 3166 |
Short | A.1.2.1.6 Country |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
30. Subject.telcomContact.address.country | |
Definition | A.1.2.1.7 Telephone no. - Example: +351 20 7025 6161 |
Short | A.1.2.1.7 Telephone no. |
Control | 0..1 |
Type | CodeableConcept |
32. Subject.telcomContact.telephone | |
Definition | A.1.2.1.8 Email - Example: jens@bigsmile.eu |
Short | A.1.2.1.8 Email |
Control | 0..* |
Type | ContactPoint |
34. Subject.telcomContact.email | |
Definition | A.1.2.2 Preferred HP to contact - This section can be repeated and linked to any specific information in the Patient Summary, for example a link between a rare disease problem (A.2.3.1) and the rare disease specialist responsible for the care of the individual patient (this section). |
Short | A.1.2.2 Preferred HP to contact |
Control | 0..* |
Type | ContactPoint |
36. Subject.hpToContact | |
Definition | A.1.2.2.1 Name of the HP - Name of the Health Professional that has been treating or taking responsibility for the patient. |
Short | A.1.2.2.1 Name of the HP |
Control | 0..* |
Type | BackboneElement |
38. Subject.hpToContact.name | |
Definition | A.1.2.2.2 Role of the HP - Health professional role |
Short | A.1.2.2.2 Role of the HP |
Control | 0..* |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
40. Subject.hpToContact.role | |
Definition | A.1.2.2.3 HP Organisation - Health professional organisation |
Short | A.1.2.2.3 HP Organisation |
Control | 0..* |
Type | CodeableConcept |
42. Subject.hpToContact.organization | |
Definition | A.1.2.2.4 Telephone no. - Example: +45 20 7025 6161 |
Short | A.1.2.2.4 Telephone no. |
Control | 0..* |
Type | BackboneElement |
44. Subject.hpToContact.telephone | |
Definition | A.1.2.2.5 Email - Email of the HP/legal organisation |
Short | A.1.2.2.5 Email |
Control | 0..* |
Type | ContactPoint |
46. Subject.hpToContact.email | |
Definition | A.1.2.2.6 Network affiliation - The HP organization is affiliated with a European network, for example an ERN. |
Short | A.1.2.2.6 Network affiliation |
Control | 0..* |
Type | ContactPoint |
48. Subject.hpToContact.affiliatedNetwork | |
Definition | A.1.2.2.7 Related with - Identify the entry or entries of this Patient Summary for which the health professional is the preferred contact. |
Short | A.1.2.2.7 Related with |
Control | 0..* |
Type | BackboneElement |
50. Subject.hpToContact.relatedWith | |
Definition | A.1.2.3 Contact person/ legal guardian - Role of the contact person: legal guardian, next of kin, other person to contact - Preferred system(s): HL7 RoleClass |
Short | A.1.2.3 Contact person/ legal guardian |
Control | 0..* |
Type | Reference |
52. Subject.contactPerson | |
Definition | A.1.2.3.1 Role of that person - Relationship type with the patient (e.g. father, wife, daughter) HL7 RoleCode |
Short | A.1.2.3.1 Role of that person |
Control | 0..* |
Type | BackboneElement |
54. Subject.contactPerson.role | |
Definition | A.1.2.3.2 Relationship level - The first name of the contact person/guardian (Example: Peter). This field can contain more than one element. |
Short | A.1.2.3.2 Relationship level |
Control | 0..* |
Type | CodeableConcept |
56. Subject.contactPerson.relationship | |
Definition | A.1.2.3.3 Given name - The first name of the contact person/guardian (Example: Peter). This field can contain more than one element. |
Short | A.1.2.3.3 Given name |
Control | 0..* |
Type | CodeableConcept |
58. Subject.contactPerson.givenName | |
Definition | A.1.2.3.4 Family name/surname - This field can contain more than one element. Example: Espa�ol Smith |
Short | A.1.2.3.4 Family name/surname |
Control | 0..* |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
60. Subject.contactPerson.familyName | |
Definition | A.1.2.3.5 Telephone no. - Example: +45 20 7025 6161 |
Short | A.1.2.3.5 Telephone no. |
Control | 0..* |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
62. Subject.contactPerson.telephone | |
Definition | A.1.2.3.6 Email - Email of the contact person/legal guardian |
Short | A.1.2.3.6 Email |
Control | 0..* |
Type | ContactPoint |
Guidance on how to interpret the contents of this table can be found here
0. Subject | |
Definition | Patient or Subject of care. Sections A1.1 and A1.2 of the eHN guideline. |
Short | A1.1, A1.2 - Subject of care |
Control | 0..* |
Is Modifier | false |
Logical Model | Instances of this logical model are not marked to be the target of a Reference |
2. Subject.identification | |
Definition | A.1.1.1 National healthcare patient ID - Country ID, unique to the patient in that country. Example: ID for Portuguese patient |
Short | A.1.1.1 National healthcare patient ID |
Control | 1..1 |
Type | BackboneElement |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
4. Subject.identification.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Short | Extensions that cannot be ignored even if unrecognized |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
6. Subject.identification.identifier | |
Definition | A.1.1.2 Family name/surname - The family name/surname/last name of the patient. This field can contain more than one element or multiple fields could be present. |
Short | A.1.1.2 Family name/surname |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 0..* |
Type | Identifier |
8. Subject.identification.familyName | |
Definition | A.1.1.3 Given name� - The given name/first name of the patient (also known as forename or first name). This field can contain more than one element.�� |
Short | A.1.1.3 Given name |
Control | 0..* |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
10. Subject.identification.givenName | |
Definition | A.1.1.4 Date of birth� - The date of birth of the patient [ISO TS 22220]. As age of the patient might be important for correct interpretation of the test result values, complete date of birth should be provided. - Preferred system(s): Complete date, without time, following the ISO 8601� |
Short | A.1.1.4 Date of birth |
Control | 0..* |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
12. Subject.identification.dateOfBirth | |
Definition | A.1.1.5 Gender - This field must contain a recognised valid value for ""administrative gender"". If different, ""physiological gender"" should be communicated elsewhere. - Preferred system(s): HL7 Administrative Gender� |
Short | A.1.1.5 Gender |
Control | 0..1 |
Type | dateTime |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
14. Subject.identification.gender | |
Definition | A.1.1.5 Country of affiliation - Name of country of affiliation - Preferred system(s): ISO 3166 |
Short | A.1.1.5 Country of affiliation |
Control | 0..1 |
Type | CodeableConcept |
16. Subject.identification.countryOfAffiliation | |
Definition | A.1.2.1 Patient address - Patient address |
Short | A.1.2.1 Patient address |
Control | 0..1 |
Type | CodeableConcept |
18. Subject.telcomContact | |
Definition | Address |
Short | Address |
Control | 0..* |
Type | BackboneElement |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
20. Subject.telcomContact.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Short | Extensions that cannot be ignored even if unrecognized |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
22. Subject.telcomContact.address | |
Definition | A.1.2.1.1 Street - Example: Rua dos Campe�es |
Short | A.1.2.1.1 Street |
Control | 0..* |
Type | BackboneElement |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
24. Subject.telcomContact.address.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Short | Extensions that cannot be ignored even if unrecognized |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
26. Subject.telcomContact.address.street | |
Definition | A.1.2.1.2 House number - Example: 246 |
Short | A.1.2.1.2 House number |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
28. Subject.telcomContact.address.houseNumber | |
Definition | A.1.2.1.3 City - Example: Porto |
Short | A.1.2.1.3 City |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
30. Subject.telcomContact.address.city | |
Definition | A.1.2.1.4 Post code - Example: 4500 |
Short | A.1.2.1.4 Post code |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
32. Subject.telcomContact.address.postalCode | |
Definition | A.1.2.1.5 State or province - Example: Vila Nova de Gaia |
Short | A.1.2.1.5 State or province |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
34. Subject.telcomContact.address.stateOrProvince | |
Definition | A.1.2.1.6 Country - Example: PT - Preferred system(s): ISO 3166 |
Short | A.1.2.1.6 Country |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
36. Subject.telcomContact.address.country | |
Definition | A.1.2.1.7 Telephone no. - Example: +351 20 7025 6161 |
Short | A.1.2.1.7 Telephone no. |
Control | 0..1 |
Type | CodeableConcept |
38. Subject.telcomContact.telephone | |
Definition | A.1.2.1.8 Email - Example: jens@bigsmile.eu |
Short | A.1.2.1.8 Email |
Control | 0..* |
Type | ContactPoint |
40. Subject.telcomContact.email | |
Definition | A.1.2.2 Preferred HP to contact - This section can be repeated and linked to any specific information in the Patient Summary, for example a link between a rare disease problem (A.2.3.1) and the rare disease specialist responsible for the care of the individual patient (this section). |
Short | A.1.2.2 Preferred HP to contact |
Control | 0..* |
Type | ContactPoint |
42. Subject.hpToContact | |
Definition | A.1.2.2.1 Name of the HP - Name of the Health Professional that has been treating or taking responsibility for the patient. |
Short | A.1.2.2.1 Name of the HP |
Control | 0..* |
Type | BackboneElement |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
44. Subject.hpToContact.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Short | Extensions that cannot be ignored even if unrecognized |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
46. Subject.hpToContact.name | |
Definition | A.1.2.2.2 Role of the HP - Health professional role |
Short | A.1.2.2.2 Role of the HP |
Control | 0..* |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
48. Subject.hpToContact.role | |
Definition | A.1.2.2.3 HP Organisation - Health professional organisation |
Short | A.1.2.2.3 HP Organisation |
Control | 0..* |
Type | CodeableConcept |
50. Subject.hpToContact.organization | |
Definition | A.1.2.2.4 Telephone no. - Example: +45 20 7025 6161 |
Short | A.1.2.2.4 Telephone no. |
Control | 0..* |
Type | BackboneElement |
52. Subject.hpToContact.telephone | |
Definition | A.1.2.2.5 Email - Email of the HP/legal organisation |
Short | A.1.2.2.5 Email |
Control | 0..* |
Type | ContactPoint |
54. Subject.hpToContact.email | |
Definition | A.1.2.2.6 Network affiliation - The HP organization is affiliated with a European network, for example an ERN. |
Short | A.1.2.2.6 Network affiliation |
Control | 0..* |
Type | ContactPoint |
56. Subject.hpToContact.affiliatedNetwork | |
Definition | A.1.2.2.7 Related with - Identify the entry or entries of this Patient Summary for which the health professional is the preferred contact. |
Short | A.1.2.2.7 Related with |
Control | 0..* |
Type | BackboneElement |
58. Subject.hpToContact.relatedWith | |
Definition | A.1.2.3 Contact person/ legal guardian - Role of the contact person: legal guardian, next of kin, other person to contact - Preferred system(s): HL7 RoleClass |
Short | A.1.2.3 Contact person/ legal guardian |
Control | 0..* |
Type | Reference |
60. Subject.contactPerson | |
Definition | A.1.2.3.1 Role of that person - Relationship type with the patient (e.g. father, wife, daughter) HL7 RoleCode |
Short | A.1.2.3.1 Role of that person |
Control | 0..* |
Type | BackboneElement |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
62. Subject.contactPerson.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Short | Extensions that cannot be ignored even if unrecognized |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
64. Subject.contactPerson.role | |
Definition | A.1.2.3.2 Relationship level - The first name of the contact person/guardian (Example: Peter). This field can contain more than one element. |
Short | A.1.2.3.2 Relationship level |
Control | 0..* |
Type | CodeableConcept |
66. Subject.contactPerson.relationship | |
Definition | A.1.2.3.3 Given name - The first name of the contact person/guardian (Example: Peter). This field can contain more than one element. |
Short | A.1.2.3.3 Given name |
Control | 0..* |
Type | CodeableConcept |
68. Subject.contactPerson.givenName | |
Definition | A.1.2.3.4 Family name/surname - This field can contain more than one element. Example: Espa�ol Smith |
Short | A.1.2.3.4 Family name/surname |
Control | 0..* |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
70. Subject.contactPerson.familyName | |
Definition | A.1.2.3.5 Telephone no. - Example: +45 20 7025 6161 |
Short | A.1.2.3.5 Telephone no. |
Control | 0..* |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
72. Subject.contactPerson.telephone | |
Definition | A.1.2.3.6 Email - Email of the contact person/legal guardian |
Short | A.1.2.3.6 Email |
Control | 0..* |
Type | ContactPoint |
Guidance on how to interpret the contents of this table can be found here
0. Subject | |
Definition | Patient or Subject of care. Sections A1.1 and A1.2 of the eHN guideline. |
Short | A1.1, A1.2 - Subject of care |
Control | 0..* |
Is Modifier | false |
Logical Model | Instances of this logical model are not marked to be the target of a Reference |
2. Subject.identification | |
Definition | A.1.1.1 National healthcare patient ID - Country ID, unique to the patient in that country. Example: ID for Portuguese patient |
Short | A.1.1.1 National healthcare patient ID |
Control | 1..1 |
Type | BackboneElement |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
4. Subject.identification.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Short | Unique id for inter-element referencing |
Control | 0..1 |
Type | string |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
6. Subject.identification.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Short | Additional content defined by implementations |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..* |
Type | Extension |
Is Modifier | false |
Summary | false |
Alternate Names | extensions, user content |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
Slicing | This element introduces a set of slices on Subject.identification.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
8. Subject.identification.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Short | Extensions that cannot be ignored even if unrecognized |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
10. Subject.identification.identifier | |
Definition | A.1.1.2 Family name/surname - The family name/surname/last name of the patient. This field can contain more than one element or multiple fields could be present. |
Short | A.1.1.2 Family name/surname |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 0..* |
Type | Identifier |
12. Subject.identification.familyName | |
Definition | A.1.1.3 Given name� - The given name/first name of the patient (also known as forename or first name). This field can contain more than one element.�� |
Short | A.1.1.3 Given name |
Control | 0..* |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
14. Subject.identification.givenName | |
Definition | A.1.1.4 Date of birth� - The date of birth of the patient [ISO TS 22220]. As age of the patient might be important for correct interpretation of the test result values, complete date of birth should be provided. - Preferred system(s): Complete date, without time, following the ISO 8601� |
Short | A.1.1.4 Date of birth |
Control | 0..* |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
16. Subject.identification.dateOfBirth | |
Definition | A.1.1.5 Gender - This field must contain a recognised valid value for ""administrative gender"". If different, ""physiological gender"" should be communicated elsewhere. - Preferred system(s): HL7 Administrative Gender� |
Short | A.1.1.5 Gender |
Control | 0..1 |
Type | dateTime |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
18. Subject.identification.gender | |
Definition | A.1.1.5 Country of affiliation - Name of country of affiliation - Preferred system(s): ISO 3166 |
Short | A.1.1.5 Country of affiliation |
Control | 0..1 |
Type | CodeableConcept |
20. Subject.identification.countryOfAffiliation | |
Definition | A.1.2.1 Patient address - Patient address |
Short | A.1.2.1 Patient address |
Control | 0..1 |
Type | CodeableConcept |
22. Subject.telcomContact | |
Definition | Address |
Short | Address |
Control | 0..* |
Type | BackboneElement |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
24. Subject.telcomContact.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Short | Unique id for inter-element referencing |
Control | 0..1 |
Type | string |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
26. Subject.telcomContact.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Short | Additional content defined by implementations |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..* |
Type | Extension |
Is Modifier | false |
Summary | false |
Alternate Names | extensions, user content |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
Slicing | This element introduces a set of slices on Subject.telcomContact.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
28. Subject.telcomContact.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Short | Extensions that cannot be ignored even if unrecognized |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
30. Subject.telcomContact.address | |
Definition | A.1.2.1.1 Street - Example: Rua dos Campe�es |
Short | A.1.2.1.1 Street |
Control | 0..* |
Type | BackboneElement |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
32. Subject.telcomContact.address.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Short | Unique id for inter-element referencing |
Control | 0..1 |
Type | string |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
34. Subject.telcomContact.address.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Short | Additional content defined by implementations |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..* |
Type | Extension |
Is Modifier | false |
Summary | false |
Alternate Names | extensions, user content |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
Slicing | This element introduces a set of slices on Subject.telcomContact.address.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
36. Subject.telcomContact.address.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Short | Extensions that cannot be ignored even if unrecognized |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
38. Subject.telcomContact.address.street | |
Definition | A.1.2.1.2 House number - Example: 246 |
Short | A.1.2.1.2 House number |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
40. Subject.telcomContact.address.houseNumber | |
Definition | A.1.2.1.3 City - Example: Porto |
Short | A.1.2.1.3 City |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
42. Subject.telcomContact.address.city | |
Definition | A.1.2.1.4 Post code - Example: 4500 |
Short | A.1.2.1.4 Post code |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
44. Subject.telcomContact.address.postalCode | |
Definition | A.1.2.1.5 State or province - Example: Vila Nova de Gaia |
Short | A.1.2.1.5 State or province |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
46. Subject.telcomContact.address.stateOrProvince | |
Definition | A.1.2.1.6 Country - Example: PT - Preferred system(s): ISO 3166 |
Short | A.1.2.1.6 Country |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
48. Subject.telcomContact.address.country | |
Definition | A.1.2.1.7 Telephone no. - Example: +351 20 7025 6161 |
Short | A.1.2.1.7 Telephone no. |
Control | 0..1 |
Type | CodeableConcept |
50. Subject.telcomContact.telephone | |
Definition | A.1.2.1.8 Email - Example: jens@bigsmile.eu |
Short | A.1.2.1.8 Email |
Control | 0..* |
Type | ContactPoint |
52. Subject.telcomContact.email | |
Definition | A.1.2.2 Preferred HP to contact - This section can be repeated and linked to any specific information in the Patient Summary, for example a link between a rare disease problem (A.2.3.1) and the rare disease specialist responsible for the care of the individual patient (this section). |
Short | A.1.2.2 Preferred HP to contact |
Control | 0..* |
Type | ContactPoint |
54. Subject.hpToContact | |
Definition | A.1.2.2.1 Name of the HP - Name of the Health Professional that has been treating or taking responsibility for the patient. |
Short | A.1.2.2.1 Name of the HP |
Control | 0..* |
Type | BackboneElement |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
56. Subject.hpToContact.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Short | Unique id for inter-element referencing |
Control | 0..1 |
Type | string |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
58. Subject.hpToContact.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Short | Additional content defined by implementations |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..* |
Type | Extension |
Is Modifier | false |
Summary | false |
Alternate Names | extensions, user content |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
Slicing | This element introduces a set of slices on Subject.hpToContact.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
60. Subject.hpToContact.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Short | Extensions that cannot be ignored even if unrecognized |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
62. Subject.hpToContact.name | |
Definition | A.1.2.2.2 Role of the HP - Health professional role |
Short | A.1.2.2.2 Role of the HP |
Control | 0..* |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
64. Subject.hpToContact.role | |
Definition | A.1.2.2.3 HP Organisation - Health professional organisation |
Short | A.1.2.2.3 HP Organisation |
Control | 0..* |
Type | CodeableConcept |
66. Subject.hpToContact.organization | |
Definition | A.1.2.2.4 Telephone no. - Example: +45 20 7025 6161 |
Short | A.1.2.2.4 Telephone no. |
Control | 0..* |
Type | BackboneElement |
68. Subject.hpToContact.telephone | |
Definition | A.1.2.2.5 Email - Email of the HP/legal organisation |
Short | A.1.2.2.5 Email |
Control | 0..* |
Type | ContactPoint |
70. Subject.hpToContact.email | |
Definition | A.1.2.2.6 Network affiliation - The HP organization is affiliated with a European network, for example an ERN. |
Short | A.1.2.2.6 Network affiliation |
Control | 0..* |
Type | ContactPoint |
72. Subject.hpToContact.affiliatedNetwork | |
Definition | A.1.2.2.7 Related with - Identify the entry or entries of this Patient Summary for which the health professional is the preferred contact. |
Short | A.1.2.2.7 Related with |
Control | 0..* |
Type | BackboneElement |
74. Subject.hpToContact.relatedWith | |
Definition | A.1.2.3 Contact person/ legal guardian - Role of the contact person: legal guardian, next of kin, other person to contact - Preferred system(s): HL7 RoleClass |
Short | A.1.2.3 Contact person/ legal guardian |
Control | 0..* |
Type | Reference |
76. Subject.contactPerson | |
Definition | A.1.2.3.1 Role of that person - Relationship type with the patient (e.g. father, wife, daughter) HL7 RoleCode |
Short | A.1.2.3.1 Role of that person |
Control | 0..* |
Type | BackboneElement |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
78. Subject.contactPerson.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Short | Unique id for inter-element referencing |
Control | 0..1 |
Type | string |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
80. Subject.contactPerson.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Short | Additional content defined by implementations |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..* |
Type | Extension |
Is Modifier | false |
Summary | false |
Alternate Names | extensions, user content |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
Slicing | This element introduces a set of slices on Subject.contactPerson.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
82. Subject.contactPerson.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Short | Extensions that cannot be ignored even if unrecognized |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
84. Subject.contactPerson.role | |
Definition | A.1.2.3.2 Relationship level - The first name of the contact person/guardian (Example: Peter). This field can contain more than one element. |
Short | A.1.2.3.2 Relationship level |
Control | 0..* |
Type | CodeableConcept |
86. Subject.contactPerson.relationship | |
Definition | A.1.2.3.3 Given name - The first name of the contact person/guardian (Example: Peter). This field can contain more than one element. |
Short | A.1.2.3.3 Given name |
Control | 0..* |
Type | CodeableConcept |
88. Subject.contactPerson.givenName | |
Definition | A.1.2.3.4 Family name/surname - This field can contain more than one element. Example: Espa�ol Smith |
Short | A.1.2.3.4 Family name/surname |
Control | 0..* |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
90. Subject.contactPerson.familyName | |
Definition | A.1.2.3.5 Telephone no. - Example: +45 20 7025 6161 |
Short | A.1.2.3.5 Telephone no. |
Control | 0..* |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
92. Subject.contactPerson.telephone | |
Definition | A.1.2.3.6 Email - Email of the contact person/legal guardian |
Short | A.1.2.3.6 Email |
Control | 0..* |
Type | ContactPoint |