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-21 |
Definitions for the Header logical model.
Guidance on how to interpret the contents of this table can be found here
0. Header | |
Definition | Hospital Discharge Report - Hospital Discharge Report header data element - A.1 eHN |
Short | A.1 - Hospital Discharge Report header data element |
Logical Model | Instances of this logical model are not marked to be the target of a Reference |
2. Header.subject | |
Definition | Identification of the patient/subject and Patient/subject related contact information |
Short | A.1.1 - Identification and A.1.2 - related contact information of the Patient/subject |
Control | 1..1 |
Type | http://hl7.eu/fhir/hdr/StructureDefinition/Subject |
4. Header.payer | |
Definition | Health insurance and payment information - Health insurance information is not always required, however, in some jurisdictions, the insurance number is also used as the patient identifier. It is necessary not just for identification but also forms access to funding for care. |
Short | A.1.3 - Health insurance and payment information - Health insurance information is not always required, however, in some jurisdictions, the insurance number is also used as the patient identifier. It is necessary not just for identification but also forms access to funding for care. |
Control | 0..1 |
Type | BackboneElement |
6. Header.payer.insuranceCode | |
Definition | Unique health insurance company identification code. |
Short | A.1.3.1 - Health insurance code |
Control | 0..1 |
Type | Identifier |
8. Header.payer.insuranceName | |
Definition | Full, official name of the healthcare insurance provider. |
Short | A.1.3.2 - Health insurance name |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
10. Header.payer.insuranceNumber | |
Definition | Number or code under which the insured person is registered at the insurance provider. |
Short | A.1.3.3 - Health insurance number |
Control | 0..1 |
Type | Identifier |
12. Header.informationRecipient | |
Definition | Information recipient - (intended recipient or recipients of the report), if applicable |
Short | A.1.4 - Information recipient - (intended recipient or recipients of the report), if applicable |
Control | 0..* |
Type | BackboneElement |
14. Header.informationRecipient.identifier | |
Definition | The health professional or patient identifier. Either an internal identifier assigned by a healthcare provider institution or (preferably) a national health professional ID such as the licence or registration number. In case when the recipient is not a health professional, e.g. patient, appropriate personal identifier could be used. |
Short | A.1.4.1 - Recipient identifier |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 0..1 |
Type | Identifier |
16. Header.informationRecipient.name | |
Definition | Person name [the structure of the name will be the same as for the patient (given name, family name / surname)]. |
Short | A.1.4.2 - Recipient name |
Control | 0..1 |
Type | HumanName |
18. Header.informationRecipient.organizationID | |
Definition | The healthcare provider organisation identifier. Identifier that is unique within a defined scope. Example: National healthcare provider ID. Multiple identifiers could be provided. |
Short | A.1.4.3 - Recipient organisation ID |
Control | 0..* |
Type | Identifier |
20. Header.informationRecipient.organization | |
Definition | The healthcare provider organisation information. |
Short | A.1.4.4 - Recipient organisation |
Control | 0..1 |
Type | BackboneElement |
22. Header.informationRecipient.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.4.5 - Address |
Control | 0..1 |
Type | Address |
24. Header.informationRecipient.country | |
Definition | Country of the intended recipient as part of the address. |
Short | A.1.4.6 - Country |
Control | 1..1 |
Type | CodeableConcept |
26. Header.informationRecipient.telecom | |
Definition | Telecommunication contact information (addresses) associated to a person, such as phone number, email, or messaging service. Multiple telecommunication addresses might be provided. |
Short | A.1.4.7 - Telecom |
Control | 0..* |
Type | ContactPoint |
28. Header.author | |
Definition | Author (by whom the Hospital discharge report was/were authored). Multiple authors could be provided. |
Short | A.1.5 - Author (by whom the Hospital discharge report was/were authored). Multiple authors could be provided. |
Control | 1..* |
Type | BackboneElement |
30. Header.author.identifier | |
Definition | The health professional identifier that will allow addressing recipients within a national or international data exchange infrastructure, such as the licence or registration number. In case when the recipient is not a health professional, e.g. patient, appropriate personal identifier should be used. |
Short | A.1.5.1 - Author identifier |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 1..* |
Type | Identifier |
32. Header.author.name | |
Definition | Person name [the structure of the name will be the same as for the patient (given name, family name / surname)]. |
Short | A.1.5.2 - Author name |
Control | 1..1 |
Type | HumanName |
34. Header.author.organizationID | |
Definition | The healthcare provider organisation identifier. Identifier that is unique within a defined scope. Example: National healthcare provider ID. Multiple identifiers could be provided. |
Short | A.1.5.3 - Author organisation ID |
Control | 0..* |
Type | Identifier |
36. Header.author.organization | |
Definition | The healthcare provider organisation information. |
Short | A.1.5.4 - Author organisation |
Control | 1..1 |
Type | BackboneElement |
38. Header.author.dateTime | |
Definition | Date and time of the last modification of the document by its Author. |
Short | A.1.5.5 - Date Time |
Control | 1..1 |
Type | dateTime |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
40. Header.attester | |
Definition | Attester (multiple attesters could be provided) |
Short | A.1.6 - Attester (multiple attesters could be provided) |
Control | 0..* |
Type | BackboneElement |
42. Header.attester.identifier | |
Definition | The health professional identification number. Either an internal identifier assigned by a healthcare provider institution or (preferably) a national health professional ID such as the licence or registration number. |
Short | A.1.6.1 - Attester identifier |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 1..* |
Type | Identifier |
44. Header.attester.name | |
Definition | Person name [the structure of the name will be the same as for the patient (given name, family name / surname)]. |
Short | A.1.6.2 - Attester name |
Control | 1..1 |
Type | HumanName |
46. Header.attester.organizationID | |
Definition | The healthcare provider organisation identifier. Identifier that is unique within a defined scope. Example: National healthcare provider ID. Multiple identifiers could be provided. |
Short | A.1.6.3 - Attester organisation ID |
Control | 0..* |
Type | Identifier |
48. Header.attester.organization | |
Definition | The healthcare provider organisation information. |
Short | A.1.6.4 - Attester organisation |
Control | 1..1 |
Type | BackboneElement |
50. Header.attester.dateTime | |
Definition | Date and time of the approval of the document by Attester. |
Short | A.1.6.5 - Approval date and time |
Control | 1..1 |
Type | dateTime |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
52. Header.legalAuthenticator | |
Definition | Legal authenticator (The person taking responsibility for the medical content of the document) |
Short | A.1.7 - Legal authenticator (The person taking responsibility for the medical content of the document) |
Control | 0..1 |
Type | BackboneElement |
54. Header.legalAuthenticator.identifier | |
Definition | The health professional identification number. Either an internal identifier assigned by a healthcare provider institution or (preferably) a national health professional ID such as the licence or registration number. Multiple identifiers could be provided. |
Short | A.1.7.1 - Legal authenticator identifier |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 1..* |
Type | Identifier |
56. Header.legalAuthenticator.name | |
Definition | Person name [the structure of the name will be the same as for the patient (given name, family name / surname)]. |
Short | A.1.7.2 - Legal authenticator name |
Control | 1..1 |
Type | HumanName |
58. Header.legalAuthenticator.organizationID | |
Definition | The healthcare provider organisation identifier. Identifier that is unique within a defined scope. Example: National healthcare provider ID. Multiple identifiers could be provided. |
Short | A.1.7.3 - Legal authenticator organisation ID |
Control | 0..* |
Type | Identifier |
60. Header.legalAuthenticator.organization | |
Definition | The healthcare provider organisation information. |
Short | A.1.7.4 - Legal authenticator organisation |
Control | 1..1 |
Type | BackboneElement |
62. Header.legalAuthenticator.dateTime | |
Definition | Date and time when the document was authorised. |
Short | A.1.7.5 - Authentication date and time |
Control | 1..1 |
Type | dateTime |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
64. Header.documentMetadata | |
Definition | Document metadata |
Short | A.1.8 - Document metadata |
Control | 1..1 |
Type | BackboneElement |
66. Header.documentMetadata.identifier | |
Definition | Unique identifier of the document |
Short | A.1.8.1 - Document ID |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 1..1 |
Type | Identifier |
68. Header.documentMetadata.type | |
Definition | Identifies the type of document at hand, e.g. Hospital discharge report. |
Short | A.1.8.2 - Document type |
Control | 1..1 |
Type | CodeableConcept |
70. Header.documentMetadata.status | |
Definition | The status of the Hospital discharge report. E.g., preliminary, final. |
Short | A.1.8.3 - Document status |
Control | 1..1 |
Type | CodeableConcept |
72. Header.documentMetadata.dateTime | |
Definition | Date and time of the Hospital discharge report creation. |
Short | A.1.8.4 - Report date and time |
Control | 1..1 |
Type | dateTime |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
74. Header.documentMetadata.title | |
Definition | Document title, fix value "Hospital discharge report". |
Short | A.1.8.5 - Document title |
Control | 1..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
76. Header.documentMetadata.custodian | |
Definition | Organisation that is in charge of maintaining the report [this element will include organisation ID, name, address etc., as other elements describing organisations]. |
Short | A.1.8.6 - Report custodian |
Control | 1..1 |
Type | BackboneElement |
78. Header.documentMetadata.confidentiality | |
Definition | Level of confidentiality of the document. Implicit value is normal. |
Short | A.1.8.7 - Confidentiality |
Control | 1..1 |
Type | CodeableConcept |
80. Header.documentMetadata.language | |
Definition | Language in which the document is written. Language is expressed by the ISO language code. |
Short | A.1.8.8 - Language |
Control | 1..1 |
Type | CodeableConcept |
82. Header.documentMetadata.version | |
Definition | Version of the document |
Short | A.1.8.9 - Version |
Note | This is a business version Id, not a resource version Id (see discussion) |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Guidance on how to interpret the contents of this table can be found here
0. Header | |
Definition | Hospital Discharge Report - Hospital Discharge Report header data element - A.1 eHN |
Short | A.1 - Hospital Discharge Report header data element |
Control | 0..* |
Is Modifier | false |
Logical Model | Instances of this logical model are not marked to be the target of a Reference |
2. Header.subject | |
Definition | Identification of the patient/subject and Patient/subject related contact information |
Short | A.1.1 - Identification and A.1.2 - related contact information of the Patient/subject |
Control | 1..1 |
Type | http://hl7.eu/fhir/hdr/StructureDefinition/Subject |
4. Header.payer | |
Definition | Health insurance and payment information - Health insurance information is not always required, however, in some jurisdictions, the insurance number is also used as the patient identifier. It is necessary not just for identification but also forms access to funding for care. |
Short | A.1.3 - Health insurance and payment information - Health insurance information is not always required, however, in some jurisdictions, the insurance number is also used as the patient identifier. It is necessary not just for identification but also forms access to funding for care. |
Control | 0..1 |
Type | BackboneElement |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
6. Header.payer.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()) |
8. Header.payer.insuranceCode | |
Definition | Unique health insurance company identification code. |
Short | A.1.3.1 - Health insurance code |
Control | 0..1 |
Type | Identifier |
10. Header.payer.insuranceName | |
Definition | Full, official name of the healthcare insurance provider. |
Short | A.1.3.2 - Health insurance name |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
12. Header.payer.insuranceNumber | |
Definition | Number or code under which the insured person is registered at the insurance provider. |
Short | A.1.3.3 - Health insurance number |
Control | 0..1 |
Type | Identifier |
14. Header.informationRecipient | |
Definition | Information recipient - (intended recipient or recipients of the report), if applicable |
Short | A.1.4 - Information recipient - (intended recipient or recipients of the report), if applicable |
Control | 0..* |
Type | BackboneElement |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
16. Header.informationRecipient.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()) |
18. Header.informationRecipient.identifier | |
Definition | The health professional or patient identifier. Either an internal identifier assigned by a healthcare provider institution or (preferably) a national health professional ID such as the licence or registration number. In case when the recipient is not a health professional, e.g. patient, appropriate personal identifier could be used. |
Short | A.1.4.1 - Recipient identifier |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 0..1 |
Type | Identifier |
20. Header.informationRecipient.name | |
Definition | Person name [the structure of the name will be the same as for the patient (given name, family name / surname)]. |
Short | A.1.4.2 - Recipient name |
Control | 0..1 |
Type | HumanName |
22. Header.informationRecipient.organizationID | |
Definition | The healthcare provider organisation identifier. Identifier that is unique within a defined scope. Example: National healthcare provider ID. Multiple identifiers could be provided. |
Short | A.1.4.3 - Recipient organisation ID |
Control | 0..* |
Type | Identifier |
24. Header.informationRecipient.organization | |
Definition | The healthcare provider organisation information. |
Short | A.1.4.4 - Recipient organisation |
Control | 0..1 |
Type | BackboneElement |
26. Header.informationRecipient.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.4.5 - Address |
Control | 0..1 |
Type | Address |
28. Header.informationRecipient.country | |
Definition | Country of the intended recipient as part of the address. |
Short | A.1.4.6 - Country |
Control | 1..1 |
Type | CodeableConcept |
30. Header.informationRecipient.telecom | |
Definition | Telecommunication contact information (addresses) associated to a person, such as phone number, email, or messaging service. Multiple telecommunication addresses might be provided. |
Short | A.1.4.7 - Telecom |
Control | 0..* |
Type | ContactPoint |
32. Header.author | |
Definition | Author (by whom the Hospital discharge report was/were authored). Multiple authors could be provided. |
Short | A.1.5 - Author (by whom the Hospital discharge report was/were authored). Multiple authors could be provided. |
Control | 1..* |
Type | BackboneElement |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
34. Header.author.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. Header.author.identifier | |
Definition | The health professional identifier that will allow addressing recipients within a national or international data exchange infrastructure, such as the licence or registration number. In case when the recipient is not a health professional, e.g. patient, appropriate personal identifier should be used. |
Short | A.1.5.1 - Author identifier |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 1..* |
Type | Identifier |
38. Header.author.name | |
Definition | Person name [the structure of the name will be the same as for the patient (given name, family name / surname)]. |
Short | A.1.5.2 - Author name |
Control | 1..1 |
Type | HumanName |
40. Header.author.organizationID | |
Definition | The healthcare provider organisation identifier. Identifier that is unique within a defined scope. Example: National healthcare provider ID. Multiple identifiers could be provided. |
Short | A.1.5.3 - Author organisation ID |
Control | 0..* |
Type | Identifier |
42. Header.author.organization | |
Definition | The healthcare provider organisation information. |
Short | A.1.5.4 - Author organisation |
Control | 1..1 |
Type | BackboneElement |
44. Header.author.dateTime | |
Definition | Date and time of the last modification of the document by its Author. |
Short | A.1.5.5 - Date Time |
Control | 1..1 |
Type | dateTime |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
46. Header.attester | |
Definition | Attester (multiple attesters could be provided) |
Short | A.1.6 - Attester (multiple attesters 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()) ) |
48. Header.attester.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()) |
50. Header.attester.identifier | |
Definition | The health professional identification number. Either an internal identifier assigned by a healthcare provider institution or (preferably) a national health professional ID such as the licence or registration number. |
Short | A.1.6.1 - Attester identifier |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 1..* |
Type | Identifier |
52. Header.attester.name | |
Definition | Person name [the structure of the name will be the same as for the patient (given name, family name / surname)]. |
Short | A.1.6.2 - Attester name |
Control | 1..1 |
Type | HumanName |
54. Header.attester.organizationID | |
Definition | The healthcare provider organisation identifier. Identifier that is unique within a defined scope. Example: National healthcare provider ID. Multiple identifiers could be provided. |
Short | A.1.6.3 - Attester organisation ID |
Control | 0..* |
Type | Identifier |
56. Header.attester.organization | |
Definition | The healthcare provider organisation information. |
Short | A.1.6.4 - Attester organisation |
Control | 1..1 |
Type | BackboneElement |
58. Header.attester.dateTime | |
Definition | Date and time of the approval of the document by Attester. |
Short | A.1.6.5 - Approval date and time |
Control | 1..1 |
Type | dateTime |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
60. Header.legalAuthenticator | |
Definition | Legal authenticator (The person taking responsibility for the medical content of the document) |
Short | A.1.7 - Legal authenticator (The person taking responsibility for the medical content of the document) |
Control | 0..1 |
Type | BackboneElement |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
62. Header.legalAuthenticator.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. Header.legalAuthenticator.identifier | |
Definition | The health professional identification number. Either an internal identifier assigned by a healthcare provider institution or (preferably) a national health professional ID such as the licence or registration number. Multiple identifiers could be provided. |
Short | A.1.7.1 - Legal authenticator identifier |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 1..* |
Type | Identifier |
66. Header.legalAuthenticator.name | |
Definition | Person name [the structure of the name will be the same as for the patient (given name, family name / surname)]. |
Short | A.1.7.2 - Legal authenticator name |
Control | 1..1 |
Type | HumanName |
68. Header.legalAuthenticator.organizationID | |
Definition | The healthcare provider organisation identifier. Identifier that is unique within a defined scope. Example: National healthcare provider ID. Multiple identifiers could be provided. |
Short | A.1.7.3 - Legal authenticator organisation ID |
Control | 0..* |
Type | Identifier |
70. Header.legalAuthenticator.organization | |
Definition | The healthcare provider organisation information. |
Short | A.1.7.4 - Legal authenticator organisation |
Control | 1..1 |
Type | BackboneElement |
72. Header.legalAuthenticator.dateTime | |
Definition | Date and time when the document was authorised. |
Short | A.1.7.5 - Authentication date and time |
Control | 1..1 |
Type | dateTime |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
74. Header.documentMetadata | |
Definition | Document metadata |
Short | A.1.8 - Document metadata |
Control | 1..1 |
Type | BackboneElement |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
76. Header.documentMetadata.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()) |
78. Header.documentMetadata.identifier | |
Definition | Unique identifier of the document |
Short | A.1.8.1 - Document ID |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 1..1 |
Type | Identifier |
80. Header.documentMetadata.type | |
Definition | Identifies the type of document at hand, e.g. Hospital discharge report. |
Short | A.1.8.2 - Document type |
Control | 1..1 |
Type | CodeableConcept |
82. Header.documentMetadata.status | |
Definition | The status of the Hospital discharge report. E.g., preliminary, final. |
Short | A.1.8.3 - Document status |
Control | 1..1 |
Type | CodeableConcept |
84. Header.documentMetadata.dateTime | |
Definition | Date and time of the Hospital discharge report creation. |
Short | A.1.8.4 - Report date and time |
Control | 1..1 |
Type | dateTime |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
86. Header.documentMetadata.title | |
Definition | Document title, fix value "Hospital discharge report". |
Short | A.1.8.5 - Document title |
Control | 1..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
88. Header.documentMetadata.custodian | |
Definition | Organisation that is in charge of maintaining the report [this element will include organisation ID, name, address etc., as other elements describing organisations]. |
Short | A.1.8.6 - Report custodian |
Control | 1..1 |
Type | BackboneElement |
90. Header.documentMetadata.confidentiality | |
Definition | Level of confidentiality of the document. Implicit value is normal. |
Short | A.1.8.7 - Confidentiality |
Control | 1..1 |
Type | CodeableConcept |
92. Header.documentMetadata.language | |
Definition | Language in which the document is written. Language is expressed by the ISO language code. |
Short | A.1.8.8 - Language |
Control | 1..1 |
Type | CodeableConcept |
94. Header.documentMetadata.version | |
Definition | Version of the document |
Short | A.1.8.9 - Version |
Note | This is a business version Id, not a resource version Id (see discussion) |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Guidance on how to interpret the contents of this table can be found here
0. Header | |
Definition | Hospital Discharge Report - Hospital Discharge Report header data element - A.1 eHN |
Short | A.1 - Hospital Discharge Report header data element |
Control | 0..* |
Is Modifier | false |
Logical Model | Instances of this logical model are not marked to be the target of a Reference |
2. Header.subject | |
Definition | Identification of the patient/subject and Patient/subject related contact information |
Short | A.1.1 - Identification and A.1.2 - related contact information of the Patient/subject |
Control | 1..1 |
Type | http://hl7.eu/fhir/hdr/StructureDefinition/Subject |
4. Header.payer | |
Definition | Health insurance and payment information - Health insurance information is not always required, however, in some jurisdictions, the insurance number is also used as the patient identifier. It is necessary not just for identification but also forms access to funding for care. |
Short | A.1.3 - Health insurance and payment information - Health insurance information is not always required, however, in some jurisdictions, the insurance number is also used as the patient identifier. It is necessary not just for identification but also forms access to funding for care. |
Control | 0..1 |
Type | BackboneElement |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
6. Header.payer.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 |
8. Header.payer.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 Header.payer.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
10. Header.payer.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() ) |
12. Header.payer.insuranceCode | |
Definition | Unique health insurance company identification code. |
Short | A.1.3.1 - Health insurance code |
Control | 0..1 |
Type | Identifier |
14. Header.payer.insuranceName | |
Definition | Full, official name of the healthcare insurance provider. |
Short | A.1.3.2 - Health insurance name |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
16. Header.payer.insuranceNumber | |
Definition | Number or code under which the insured person is registered at the insurance provider. |
Short | A.1.3.3 - Health insurance number |
Control | 0..1 |
Type | Identifier |
18. Header.informationRecipient | |
Definition | Information recipient - (intended recipient or recipients of the report), if applicable |
Short | A.1.4 - Information recipient - (intended recipient or recipients of the report), if applicable |
Control | 0..* |
Type | BackboneElement |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
20. Header.informationRecipient.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 |
22. Header.informationRecipient.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 Header.informationRecipient.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
24. Header.informationRecipient.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. Header.informationRecipient.identifier | |
Definition | The health professional or patient identifier. Either an internal identifier assigned by a healthcare provider institution or (preferably) a national health professional ID such as the licence or registration number. In case when the recipient is not a health professional, e.g. patient, appropriate personal identifier could be used. |
Short | A.1.4.1 - Recipient identifier |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 0..1 |
Type | Identifier |
28. Header.informationRecipient.name | |
Definition | Person name [the structure of the name will be the same as for the patient (given name, family name / surname)]. |
Short | A.1.4.2 - Recipient name |
Control | 0..1 |
Type | HumanName |
30. Header.informationRecipient.organizationID | |
Definition | The healthcare provider organisation identifier. Identifier that is unique within a defined scope. Example: National healthcare provider ID. Multiple identifiers could be provided. |
Short | A.1.4.3 - Recipient organisation ID |
Control | 0..* |
Type | Identifier |
32. Header.informationRecipient.organization | |
Definition | The healthcare provider organisation information. |
Short | A.1.4.4 - Recipient organisation |
Control | 0..1 |
Type | BackboneElement |
34. Header.informationRecipient.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.4.5 - Address |
Control | 0..1 |
Type | Address |
36. Header.informationRecipient.country | |
Definition | Country of the intended recipient as part of the address. |
Short | A.1.4.6 - Country |
Control | 1..1 |
Type | CodeableConcept |
38. Header.informationRecipient.telecom | |
Definition | Telecommunication contact information (addresses) associated to a person, such as phone number, email, or messaging service. Multiple telecommunication addresses might be provided. |
Short | A.1.4.7 - Telecom |
Control | 0..* |
Type | ContactPoint |
40. Header.author | |
Definition | Author (by whom the Hospital discharge report was/were authored). Multiple authors could be provided. |
Short | A.1.5 - Author (by whom the Hospital discharge report was/were authored). Multiple authors could be provided. |
Control | 1..* |
Type | BackboneElement |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
42. Header.author.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 |
44. Header.author.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 Header.author.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
46. Header.author.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() ) |
48. Header.author.identifier | |
Definition | The health professional identifier that will allow addressing recipients within a national or international data exchange infrastructure, such as the licence or registration number. In case when the recipient is not a health professional, e.g. patient, appropriate personal identifier should be used. |
Short | A.1.5.1 - Author identifier |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 1..* |
Type | Identifier |
50. Header.author.name | |
Definition | Person name [the structure of the name will be the same as for the patient (given name, family name / surname)]. |
Short | A.1.5.2 - Author name |
Control | 1..1 |
Type | HumanName |
52. Header.author.organizationID | |
Definition | The healthcare provider organisation identifier. Identifier that is unique within a defined scope. Example: National healthcare provider ID. Multiple identifiers could be provided. |
Short | A.1.5.3 - Author organisation ID |
Control | 0..* |
Type | Identifier |
54. Header.author.organization | |
Definition | The healthcare provider organisation information. |
Short | A.1.5.4 - Author organisation |
Control | 1..1 |
Type | BackboneElement |
56. Header.author.dateTime | |
Definition | Date and time of the last modification of the document by its Author. |
Short | A.1.5.5 - Date Time |
Control | 1..1 |
Type | dateTime |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
58. Header.attester | |
Definition | Attester (multiple attesters could be provided) |
Short | A.1.6 - Attester (multiple attesters 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()) ) |
60. Header.attester.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 |
62. Header.attester.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 Header.attester.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
64. Header.attester.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() ) |
66. Header.attester.identifier | |
Definition | The health professional identification number. Either an internal identifier assigned by a healthcare provider institution or (preferably) a national health professional ID such as the licence or registration number. |
Short | A.1.6.1 - Attester identifier |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 1..* |
Type | Identifier |
68. Header.attester.name | |
Definition | Person name [the structure of the name will be the same as for the patient (given name, family name / surname)]. |
Short | A.1.6.2 - Attester name |
Control | 1..1 |
Type | HumanName |
70. Header.attester.organizationID | |
Definition | The healthcare provider organisation identifier. Identifier that is unique within a defined scope. Example: National healthcare provider ID. Multiple identifiers could be provided. |
Short | A.1.6.3 - Attester organisation ID |
Control | 0..* |
Type | Identifier |
72. Header.attester.organization | |
Definition | The healthcare provider organisation information. |
Short | A.1.6.4 - Attester organisation |
Control | 1..1 |
Type | BackboneElement |
74. Header.attester.dateTime | |
Definition | Date and time of the approval of the document by Attester. |
Short | A.1.6.5 - Approval date and time |
Control | 1..1 |
Type | dateTime |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
76. Header.legalAuthenticator | |
Definition | Legal authenticator (The person taking responsibility for the medical content of the document) |
Short | A.1.7 - Legal authenticator (The person taking responsibility for the medical content of the document) |
Control | 0..1 |
Type | BackboneElement |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
78. Header.legalAuthenticator.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. Header.legalAuthenticator.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 Header.legalAuthenticator.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
82. Header.legalAuthenticator.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. Header.legalAuthenticator.identifier | |
Definition | The health professional identification number. Either an internal identifier assigned by a healthcare provider institution or (preferably) a national health professional ID such as the licence or registration number. Multiple identifiers could be provided. |
Short | A.1.7.1 - Legal authenticator identifier |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 1..* |
Type | Identifier |
86. Header.legalAuthenticator.name | |
Definition | Person name [the structure of the name will be the same as for the patient (given name, family name / surname)]. |
Short | A.1.7.2 - Legal authenticator name |
Control | 1..1 |
Type | HumanName |
88. Header.legalAuthenticator.organizationID | |
Definition | The healthcare provider organisation identifier. Identifier that is unique within a defined scope. Example: National healthcare provider ID. Multiple identifiers could be provided. |
Short | A.1.7.3 - Legal authenticator organisation ID |
Control | 0..* |
Type | Identifier |
90. Header.legalAuthenticator.organization | |
Definition | The healthcare provider organisation information. |
Short | A.1.7.4 - Legal authenticator organisation |
Control | 1..1 |
Type | BackboneElement |
92. Header.legalAuthenticator.dateTime | |
Definition | Date and time when the document was authorised. |
Short | A.1.7.5 - Authentication date and time |
Control | 1..1 |
Type | dateTime |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
94. Header.documentMetadata | |
Definition | Document metadata |
Short | A.1.8 - Document metadata |
Control | 1..1 |
Type | BackboneElement |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
96. Header.documentMetadata.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 |
98. Header.documentMetadata.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 Header.documentMetadata.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
100. Header.documentMetadata.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() ) |
102. Header.documentMetadata.identifier | |
Definition | Unique identifier of the document |
Short | A.1.8.1 - Document ID |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 1..1 |
Type | Identifier |
104. Header.documentMetadata.type | |
Definition | Identifies the type of document at hand, e.g. Hospital discharge report. |
Short | A.1.8.2 - Document type |
Control | 1..1 |
Type | CodeableConcept |
106. Header.documentMetadata.status | |
Definition | The status of the Hospital discharge report. E.g., preliminary, final. |
Short | A.1.8.3 - Document status |
Control | 1..1 |
Type | CodeableConcept |
108. Header.documentMetadata.dateTime | |
Definition | Date and time of the Hospital discharge report creation. |
Short | A.1.8.4 - Report date and time |
Control | 1..1 |
Type | dateTime |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
110. Header.documentMetadata.title | |
Definition | Document title, fix value "Hospital discharge report". |
Short | A.1.8.5 - Document title |
Control | 1..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
112. Header.documentMetadata.custodian | |
Definition | Organisation that is in charge of maintaining the report [this element will include organisation ID, name, address etc., as other elements describing organisations]. |
Short | A.1.8.6 - Report custodian |
Control | 1..1 |
Type | BackboneElement |
114. Header.documentMetadata.confidentiality | |
Definition | Level of confidentiality of the document. Implicit value is normal. |
Short | A.1.8.7 - Confidentiality |
Control | 1..1 |
Type | CodeableConcept |
116. Header.documentMetadata.language | |
Definition | Language in which the document is written. Language is expressed by the ISO language code. |
Short | A.1.8.8 - Language |
Control | 1..1 |
Type | CodeableConcept |
118. Header.documentMetadata.version | |
Definition | Version of the document |
Short | A.1.8.9 - Version |
Note | This is a business version Id, not a resource version Id (see discussion) |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |