HL7 Europe Hospital Discharge Report, 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/hdr/ and changes regularly. See the Directory of published versions
Draft as of 2024-11-06 |
Definitions for the Subject logical model.
Guidance on how to interpret the contents of this table can be found here
0. Subject | |
Definition | Hospital Discharge Report - Hospital Discharge Report subject data element - A.1.1 and A.1.2 eHN |
Short | A.1.1 - Identification and A.1.2 - related contact information of the Patient/subject |
Logical Model | Instances of this logical model are not marked to be the target of a Reference |
2. Subject.subjectIdentification | |
Definition | Identification of the patient/subject |
Short | A.1.1 - Identification of the patient/subject |
Control | 1..1 |
Type | BackboneElement |
4. Subject.subjectIdentification.given | |
Definition | 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.1 - Given name |
Control | 1..* |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
6. Subject.subjectIdentification.family | |
Definition | 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 |
Control | 1..* |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
8. Subject.subjectIdentification.birthDate | |
Definition | Complete date, following the ISO 8601. |
Short | A.1.1.3 - Date of birth |
Control | 1..1 |
Type | dateTime |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
10. Subject.subjectIdentification.identifier | |
Definition | An identifier of the patient that is unique within a defined scope. Example: National ID (birth number) for a Czech patient. Multiple identifiers could be provided |
Short | A.1.1.4 - National healthcare patient ID |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 1..* |
Type | Identifier |
12. Subject.subjectIdentification.nationality | |
Definition | Nationality of the patient. |
Short | A.1.1.5 - Nationality |
Control | 0..* |
Type | CodeableConcept |
14. Subject.subjectIdentification.gender | |
Definition | This field must contain a recognised valid value for "administrative gender". If different, "physiological gender" should be communicated elsewhere in the relevant clinical information section. |
Short | A.1.1.6 - Gender |
Control | 1..1 |
Type | CodeableConcept |
16. Subject.subjectIdentification.countryOfAffiliation | |
Definition | Name of country of affiliation |
Short | A.1.1.7 - Country of affiliation |
Control | 0..1 |
Type | CodeableConcept |
18. Subject.subjectContact | |
Definition | Patient/subject related contact information |
Short | A.1.2 - Patient/subject related contact information |
Control | 0..1 |
Type | BackboneElement |
20. Subject.subjectContact.personalContact | |
Definition | Patient address |
Short | A.1.2.1 - Patient address |
Control | 0..1 |
Type | BackboneElement |
22. Subject.subjectContact.personalContact.address | |
Definition | Mailing and home or office addresses. The addresses are always sequences of address parts (e.g. street address line, country, postcode, city) even if postal address formats may vary depending on the country. An address may or may not include a specific use code; if this attribute is not present it is assumed to be the default address useful for any purpose. |
Short | A.1.2.1.1 - Address |
Control | 0..* |
Type | Address |
24. Subject.subjectContact.personalContact.telecom | |
Definition | Telecommunication contact information (addresses) associated with a person, such as phone number, email, or messaging service. Multiple telecommunication addresses might be provided. |
Short | A.1.2.1.2 - Telecom |
Control | 0..* |
Type | ContactPoint |
26. Subject.subjectContact.preferredHP | |
Definition | Preferred health professional (HP) - This section can be repeated and linked to any specific information in the document, for example a link between a rare disease problem and the rare disease specialist responsible for the care of the individual patient (this section). |
Short | A.1.2.2 - Preferred health professional (HP) - This section can be repeated and linked to any specific information in the document, for example a link between a rare disease problem and the rare disease specialist responsible for the care of the individual patient (this section). |
Control | 0..* |
Type | BackboneElement |
28. Subject.subjectContact.preferredHP.identifier | |
Definition | An identifier of the health professional that is unique within a defined scope. Example: National health professional ID. Multiple identifiers could be provided. |
Short | A.1.2.2.1 - Identifier of the HP |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 0..* |
Type | Identifier |
30. Subject.subjectContact.preferredHP.name | |
Definition | Name of the health professional that has been treating or taking responsibility for the patient.[the structure of the name will be the same as for the patient (given name, family name / surname)] |
Short | A.1.2.2.2 - Name of the HP |
Control | 1..1 |
Type | HumanName |
32. Subject.subjectContact.preferredHP.role | |
Definition | Health professional role. Multiple roles could be provided. |
Short | A.1.2.2.3 - Role of the HP |
Control | 0..* |
Type | CodeableConcept |
34. Subject.subjectContact.preferredHP.organization | |
Definition | Health professional organisation |
Short | A.1.2.2.4 - HP Organisation |
Control | 0..1 |
Type | BackboneElement |
36. Subject.subjectContact.preferredHP.address | |
Definition | Mailing and home or office addresses. The addresses are always sequences of address parts (e.g. street address line, country, postcode, city) even if postal address formats may vary depending on the country. An address may or may not include a specific use code; if this attribute is not present it is assumed to be the default address useful for any purpose. |
Short | A.1.2.2.5 - Address |
Control | 0..1 |
Type | Address |
38. Subject.subjectContact.preferredHP.telecom | |
Definition | Telecommunication contact information (addresses) associated with a person, such as phone number, email, or messaging service. Multiple telecommunication addresses might be provided. |
Short | A.1.2.2.6 - Telecom |
Control | 0..* |
Type | ContactPoint |
40. Subject.subjectContact.contactPerson | |
Definition | Contact person/ legal guardian (multiple contacts could be provided) |
Short | A.1.2.3 - Contact person/ legal guardian (multiple contacts could be provided) |
Control | 0..* |
Type | BackboneElement |
42. Subject.subjectContact.contactPerson.role | |
Definition | Role of the contact person: legal guardian, next of kin, other person to contact. |
Short | A.1.2.3.1 - Role of that person |
Control | 0..* |
Type | CodeableConcept |
44. Subject.subjectContact.contactPerson.relationship | |
Definition | Relationship type with the patient (e.g. father, wife, daughter) |
Short | A.1.2.3.2 - Relationship level |
Control | 0..1 |
Type | CodeableConcept |
46. Subject.subjectContact.contactPerson.given | |
Definition | Given name of the contact person/guardian . This field can contain more than one element. |
Short | A.1.2.3.4 - Given name |
Control | 1..* |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
48. Subject.subjectContact.contactPerson.family | |
Definition | Family name of the contact person. This field can contain more than one element [the structure of the name will be the same as for the patient (given name, family name / surname)].. |
Short | A.1.2.3.5 - Family name/surname |
Control | 1..* |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
50. Subject.subjectContact.contactPerson.address | |
Definition | Mailing, home or office addresses. The addresses are always sequences of address parts (e.g. street address line, country, postcode, city) even if postal address formats may vary depending on the country. An address may or may not include a specific use code; if this attribute is not present it is assumed to be the default address useful for any purpose. |
Short | A.1.2.3.6 - Address |
Control | 0..* |
Type | Address |
52. Subject.subjectContact.contactPerson.telecom | |
Definition | Telecommunication contact information (addresses) associated with a person, such as phone number, email, or messaging service. Multiple telecommunication addresses might be provided. |
Short | A.1.2.3.7 - Telecom |
Control | 0..* |
Type | ContactPoint |
54. Subject.subjectContact.contactPerson.organization | |
Definition | Contact person organisation information. |
Short | A.1.2.3.8 - Contact person organisation |
Control | 0..1 |
Type | BackboneElement |
Guidance on how to interpret the contents of this table can be found here
0. Subject | |
Definition | Hospital Discharge Report - Hospital Discharge Report subject data element - A.1.1 and A.1.2 eHN |
Short | A.1.1 - Identification and A.1.2 - related contact information of the Patient/subject |
Control | 0..* |
Is Modifier | false |
Logical Model | Instances of this logical model are not marked to be the target of a Reference |
2. Subject.subjectIdentification | |
Definition | Identification of the patient/subject |
Short | A.1.1 - Identification of the patient/subject |
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.subjectIdentification.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.subjectIdentification.given | |
Definition | 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.1 - Given name |
Control | 1..* |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
8. Subject.subjectIdentification.family | |
Definition | 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 |
Control | 1..* |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
10. Subject.subjectIdentification.birthDate | |
Definition | Complete date, following the ISO 8601. |
Short | A.1.1.3 - Date of birth |
Control | 1..1 |
Type | dateTime |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
12. Subject.subjectIdentification.identifier | |
Definition | An identifier of the patient that is unique within a defined scope. Example: National ID (birth number) for a Czech patient. Multiple identifiers could be provided |
Short | A.1.1.4 - National healthcare patient ID |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 1..* |
Type | Identifier |
14. Subject.subjectIdentification.nationality | |
Definition | Nationality of the patient. |
Short | A.1.1.5 - Nationality |
Control | 0..* |
Type | CodeableConcept |
16. Subject.subjectIdentification.gender | |
Definition | This field must contain a recognised valid value for "administrative gender". If different, "physiological gender" should be communicated elsewhere in the relevant clinical information section. |
Short | A.1.1.6 - Gender |
Control | 1..1 |
Type | CodeableConcept |
18. Subject.subjectIdentification.countryOfAffiliation | |
Definition | Name of country of affiliation |
Short | A.1.1.7 - Country of affiliation |
Control | 0..1 |
Type | CodeableConcept |
20. Subject.subjectContact | |
Definition | Patient/subject related contact information |
Short | A.1.2 - Patient/subject related contact information |
Control | 0..1 |
Type | BackboneElement |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
22. Subject.subjectContact.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()) |
24. Subject.subjectContact.personalContact | |
Definition | Patient address |
Short | A.1.2.1 - Patient address |
Control | 0..1 |
Type | BackboneElement |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
26. Subject.subjectContact.personalContact.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()) |
28. Subject.subjectContact.personalContact.address | |
Definition | Mailing and home or office addresses. The addresses are always sequences of address parts (e.g. street address line, country, postcode, city) even if postal address formats may vary depending on the country. An address may or may not include a specific use code; if this attribute is not present it is assumed to be the default address useful for any purpose. |
Short | A.1.2.1.1 - Address |
Control | 0..* |
Type | Address |
30. Subject.subjectContact.personalContact.telecom | |
Definition | Telecommunication contact information (addresses) associated with a person, such as phone number, email, or messaging service. Multiple telecommunication addresses might be provided. |
Short | A.1.2.1.2 - Telecom |
Control | 0..* |
Type | ContactPoint |
32. Subject.subjectContact.preferredHP | |
Definition | Preferred health professional (HP) - This section can be repeated and linked to any specific information in the document, for example a link between a rare disease problem and the rare disease specialist responsible for the care of the individual patient (this section). |
Short | A.1.2.2 - Preferred health professional (HP) - This section can be repeated and linked to any specific information in the document, for example a link between a rare disease problem and the rare disease specialist responsible for the care of the individual patient (this section). |
Control | 0..* |
Type | BackboneElement |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
34. Subject.subjectContact.preferredHP.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()) |
36. Subject.subjectContact.preferredHP.identifier | |
Definition | An identifier of the health professional that is unique within a defined scope. Example: National health professional ID. Multiple identifiers could be provided. |
Short | A.1.2.2.1 - Identifier of the HP |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 0..* |
Type | Identifier |
38. Subject.subjectContact.preferredHP.name | |
Definition | Name of the health professional that has been treating or taking responsibility for the patient.[the structure of the name will be the same as for the patient (given name, family name / surname)] |
Short | A.1.2.2.2 - Name of the HP |
Control | 1..1 |
Type | HumanName |
40. Subject.subjectContact.preferredHP.role | |
Definition | Health professional role. Multiple roles could be provided. |
Short | A.1.2.2.3 - Role of the HP |
Control | 0..* |
Type | CodeableConcept |
42. Subject.subjectContact.preferredHP.organization | |
Definition | Health professional organisation |
Short | A.1.2.2.4 - HP Organisation |
Control | 0..1 |
Type | BackboneElement |
44. Subject.subjectContact.preferredHP.address | |
Definition | Mailing and home or office addresses. The addresses are always sequences of address parts (e.g. street address line, country, postcode, city) even if postal address formats may vary depending on the country. An address may or may not include a specific use code; if this attribute is not present it is assumed to be the default address useful for any purpose. |
Short | A.1.2.2.5 - Address |
Control | 0..1 |
Type | Address |
46. Subject.subjectContact.preferredHP.telecom | |
Definition | Telecommunication contact information (addresses) associated with a person, such as phone number, email, or messaging service. Multiple telecommunication addresses might be provided. |
Short | A.1.2.2.6 - Telecom |
Control | 0..* |
Type | ContactPoint |
48. Subject.subjectContact.contactPerson | |
Definition | Contact person/ legal guardian (multiple contacts could be provided) |
Short | A.1.2.3 - Contact person/ legal guardian (multiple contacts could be provided) |
Control | 0..* |
Type | BackboneElement |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
50. Subject.subjectContact.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()) |
52. Subject.subjectContact.contactPerson.role | |
Definition | Role of the contact person: legal guardian, next of kin, other person to contact. |
Short | A.1.2.3.1 - Role of that person |
Control | 0..* |
Type | CodeableConcept |
54. Subject.subjectContact.contactPerson.relationship | |
Definition | Relationship type with the patient (e.g. father, wife, daughter) |
Short | A.1.2.3.2 - Relationship level |
Control | 0..1 |
Type | CodeableConcept |
56. Subject.subjectContact.contactPerson.given | |
Definition | Given name of the contact person/guardian . This field can contain more than one element. |
Short | A.1.2.3.4 - Given name |
Control | 1..* |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
58. Subject.subjectContact.contactPerson.family | |
Definition | Family name of the contact person. This field can contain more than one element [the structure of the name will be the same as for the patient (given name, family name / surname)].. |
Short | A.1.2.3.5 - Family name/surname |
Control | 1..* |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
60. Subject.subjectContact.contactPerson.address | |
Definition | Mailing, home or office addresses. The addresses are always sequences of address parts (e.g. street address line, country, postcode, city) even if postal address formats may vary depending on the country. An address may or may not include a specific use code; if this attribute is not present it is assumed to be the default address useful for any purpose. |
Short | A.1.2.3.6 - Address |
Control | 0..* |
Type | Address |
62. Subject.subjectContact.contactPerson.telecom | |
Definition | Telecommunication contact information (addresses) associated with a person, such as phone number, email, or messaging service. Multiple telecommunication addresses might be provided. |
Short | A.1.2.3.7 - Telecom |
Control | 0..* |
Type | ContactPoint |
64. Subject.subjectContact.contactPerson.organization | |
Definition | Contact person organisation information. |
Short | A.1.2.3.8 - Contact person organisation |
Control | 0..1 |
Type | BackboneElement |
Guidance on how to interpret the contents of this table can be found here
0. Subject | |
Definition | Hospital Discharge Report - Hospital Discharge Report subject data element - A.1.1 and A.1.2 eHN |
Short | A.1.1 - Identification and A.1.2 - related contact information of the Patient/subject |
Control | 0..* |
Is Modifier | false |
Logical Model | Instances of this logical model are not marked to be the target of a Reference |
2. Subject.subjectIdentification | |
Definition | Identification of the patient/subject |
Short | A.1.1 - Identification of the patient/subject |
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.subjectIdentification.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.subjectIdentification.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.subjectIdentification.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
8. Subject.subjectIdentification.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.subjectIdentification.given | |
Definition | 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.1 - Given name |
Control | 1..* |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
12. Subject.subjectIdentification.family | |
Definition | 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 |
Control | 1..* |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
14. Subject.subjectIdentification.birthDate | |
Definition | Complete date, following the ISO 8601. |
Short | A.1.1.3 - Date of birth |
Control | 1..1 |
Type | dateTime |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
16. Subject.subjectIdentification.identifier | |
Definition | An identifier of the patient that is unique within a defined scope. Example: National ID (birth number) for a Czech patient. Multiple identifiers could be provided |
Short | A.1.1.4 - National healthcare patient ID |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 1..* |
Type | Identifier |
18. Subject.subjectIdentification.nationality | |
Definition | Nationality of the patient. |
Short | A.1.1.5 - Nationality |
Control | 0..* |
Type | CodeableConcept |
20. Subject.subjectIdentification.gender | |
Definition | This field must contain a recognised valid value for "administrative gender". If different, "physiological gender" should be communicated elsewhere in the relevant clinical information section. |
Short | A.1.1.6 - Gender |
Control | 1..1 |
Type | CodeableConcept |
22. Subject.subjectIdentification.countryOfAffiliation | |
Definition | Name of country of affiliation |
Short | A.1.1.7 - Country of affiliation |
Control | 0..1 |
Type | CodeableConcept |
24. Subject.subjectContact | |
Definition | Patient/subject related contact information |
Short | A.1.2 - Patient/subject related contact information |
Control | 0..1 |
Type | BackboneElement |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
26. Subject.subjectContact.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 |
28. Subject.subjectContact.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.subjectContact.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
30. Subject.subjectContact.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() ) |
32. Subject.subjectContact.personalContact | |
Definition | Patient address |
Short | A.1.2.1 - Patient address |
Control | 0..1 |
Type | BackboneElement |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
34. Subject.subjectContact.personalContact.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 |
36. Subject.subjectContact.personalContact.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.subjectContact.personalContact.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
38. Subject.subjectContact.personalContact.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() ) |
40. Subject.subjectContact.personalContact.address | |
Definition | Mailing and home or office addresses. The addresses are always sequences of address parts (e.g. street address line, country, postcode, city) even if postal address formats may vary depending on the country. An address may or may not include a specific use code; if this attribute is not present it is assumed to be the default address useful for any purpose. |
Short | A.1.2.1.1 - Address |
Control | 0..* |
Type | Address |
42. Subject.subjectContact.personalContact.telecom | |
Definition | Telecommunication contact information (addresses) associated with a person, such as phone number, email, or messaging service. Multiple telecommunication addresses might be provided. |
Short | A.1.2.1.2 - Telecom |
Control | 0..* |
Type | ContactPoint |
44. Subject.subjectContact.preferredHP | |
Definition | Preferred health professional (HP) - This section can be repeated and linked to any specific information in the document, for example a link between a rare disease problem and the rare disease specialist responsible for the care of the individual patient (this section). |
Short | A.1.2.2 - Preferred health professional (HP) - This section can be repeated and linked to any specific information in the document, for example a link between a rare disease problem and the rare disease specialist responsible for the care of the individual patient (this section). |
Control | 0..* |
Type | BackboneElement |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
46. Subject.subjectContact.preferredHP.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 |
48. Subject.subjectContact.preferredHP.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.subjectContact.preferredHP.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
50. Subject.subjectContact.preferredHP.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() ) |
52. Subject.subjectContact.preferredHP.identifier | |
Definition | An identifier of the health professional that is unique within a defined scope. Example: National health professional ID. Multiple identifiers could be provided. |
Short | A.1.2.2.1 - Identifier of the HP |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 0..* |
Type | Identifier |
54. Subject.subjectContact.preferredHP.name | |
Definition | Name of the health professional that has been treating or taking responsibility for the patient.[the structure of the name will be the same as for the patient (given name, family name / surname)] |
Short | A.1.2.2.2 - Name of the HP |
Control | 1..1 |
Type | HumanName |
56. Subject.subjectContact.preferredHP.role | |
Definition | Health professional role. Multiple roles could be provided. |
Short | A.1.2.2.3 - Role of the HP |
Control | 0..* |
Type | CodeableConcept |
58. Subject.subjectContact.preferredHP.organization | |
Definition | Health professional organisation |
Short | A.1.2.2.4 - HP Organisation |
Control | 0..1 |
Type | BackboneElement |
60. Subject.subjectContact.preferredHP.address | |
Definition | Mailing and home or office addresses. The addresses are always sequences of address parts (e.g. street address line, country, postcode, city) even if postal address formats may vary depending on the country. An address may or may not include a specific use code; if this attribute is not present it is assumed to be the default address useful for any purpose. |
Short | A.1.2.2.5 - Address |
Control | 0..1 |
Type | Address |
62. Subject.subjectContact.preferredHP.telecom | |
Definition | Telecommunication contact information (addresses) associated with a person, such as phone number, email, or messaging service. Multiple telecommunication addresses might be provided. |
Short | A.1.2.2.6 - Telecom |
Control | 0..* |
Type | ContactPoint |
64. Subject.subjectContact.contactPerson | |
Definition | Contact person/ legal guardian (multiple contacts could be provided) |
Short | A.1.2.3 - Contact person/ legal guardian (multiple contacts could be provided) |
Control | 0..* |
Type | BackboneElement |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
66. Subject.subjectContact.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 |
68. Subject.subjectContact.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.subjectContact.contactPerson.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
70. Subject.subjectContact.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() ) |
72. Subject.subjectContact.contactPerson.role | |
Definition | Role of the contact person: legal guardian, next of kin, other person to contact. |
Short | A.1.2.3.1 - Role of that person |
Control | 0..* |
Type | CodeableConcept |
74. Subject.subjectContact.contactPerson.relationship | |
Definition | Relationship type with the patient (e.g. father, wife, daughter) |
Short | A.1.2.3.2 - Relationship level |
Control | 0..1 |
Type | CodeableConcept |
76. Subject.subjectContact.contactPerson.given | |
Definition | Given name of the contact person/guardian . This field can contain more than one element. |
Short | A.1.2.3.4 - Given name |
Control | 1..* |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
78. Subject.subjectContact.contactPerson.family | |
Definition | Family name of the contact person. This field can contain more than one element [the structure of the name will be the same as for the patient (given name, family name / surname)].. |
Short | A.1.2.3.5 - Family name/surname |
Control | 1..* |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
80. Subject.subjectContact.contactPerson.address | |
Definition | Mailing, home or office addresses. The addresses are always sequences of address parts (e.g. street address line, country, postcode, city) even if postal address formats may vary depending on the country. An address may or may not include a specific use code; if this attribute is not present it is assumed to be the default address useful for any purpose. |
Short | A.1.2.3.6 - Address |
Control | 0..* |
Type | Address |
82. Subject.subjectContact.contactPerson.telecom | |
Definition | Telecommunication contact information (addresses) associated with a person, such as phone number, email, or messaging service. Multiple telecommunication addresses might be provided. |
Short | A.1.2.3.7 - Telecom |
Control | 0..* |
Type | ContactPoint |
84. Subject.subjectContact.contactPerson.organization | |
Definition | Contact person organisation information. |
Short | A.1.2.3.8 - Contact person organisation |
Control | 0..1 |
Type | BackboneElement |