MyHealth@Eu Medical Imaging Report
0.0.1 - ci-build
150
MyHealth@Eu Medical Imaging Report - Local Development build (v0.0.1) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
Draft as of 2025-06-25 |
Definitions for the Header logical model.
Guidance on how to interpret the contents of this table can be foundhere
0. Header | |
Definition | Medical Imaging Report - Header data element |
Short | A.1 - Medical Imaging 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.insurance | |
Definition | 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.1 - Health insurance information |
Control | 0..1 |
Type | BackboneElement |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
4. Header.insurance.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. Header.insurance.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.insurance.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
8. Header.insurance.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. Header.insurance.identifier | |
Definition | Unique health insurance company identification code. |
Short | A.1.3.1.1 - Health insurance code |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 0..* |
Type | Identifier |
12. Header.insurance.name | |
Definition | The full, official name of the healthcare insurance provider. |
Short | A.1.3.1.2 - Health insurance provider name |
Control | 0..* |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
14. Header.insurance.subjectIdentifier | |
Definition | Number or code under which the insured person is registered at the insurance provider. |
Short | A.1.3.1.3 - Health insurance policy number |
Control | 0..* |
Type | Identifier |
16. 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()) ) |
18. 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 |
20. 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: |
22. 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()) |
24. 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 |
26. 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 |
28. Header.informationRecipient.organization | |
Definition | The healthcare provider organisation information. |
Short | A.1.4.3 - Recipient organisation |
Control | 0..1 |
Type | BackboneElement |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
30. Header.informationRecipient.organization.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 |
32. Header.informationRecipient.organization.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.organization.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
34. Header.informationRecipient.organization.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.informationRecipient.organization.name | |
Definition | Name of the organization |
Short | A.1.4.3.1 - Organization Name |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
38. Header.informationRecipient.organization.address | |
Definition | Address of the organization |
Short | A.1.4.3.2 - Organization Address |
Control | 0..* |
Type | Address |
40. Header.informationRecipient.organization.telecom | |
Definition | Telecom of the organization |
Short | A.1.4.3.3 - Telecom of the organization |
Control | 0..* |
Type | ContactPoint |
42. Header.informationRecipient.organization.specialty | |
Definition | Specialty of the organization |
Short | A.1.4.3.4 - Specialty of the organization |
Control | 0..1 |
Type | CodeableConcept |
44. 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.4 - Address |
Control | 0..1 |
Type | Address |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
46. Header.informationRecipient.address.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Short | Unique id for inter-element referencing |
Control | 0..1 |
Type | string |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
48. Header.informationRecipient.address.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Short | Additional content defined by implementations |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..* |
Type | Extension |
Is Modifier | false |
Summary | false |
Alternate Names | extensions, user content |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
Slicing | This element introduces a set of slices on Header.informationRecipient.address.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
50. Header.informationRecipient.address.use | |
Definition | The purpose of this address. |
Short | home | work | temp | old | billing - purpose of this address |
Comments | Applications can assume that an address is current unless it explicitly says that it is temporary or old. |
Control | 0..1 |
Binding | The codes SHALL be taken from AddressUsehttp://hl7.org/fhir/ValueSet/address-use|4.0.1 (required to http://hl7.org/fhir/ValueSet/address-use|4.0.1 )The use of an address. |
Type | code |
Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary or old address etc.for a current/permanent one |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Requirements | Allows an appropriate address to be chosen from a list of many. |
Example | <br/><b>General</b>:home |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
52. Header.informationRecipient.address.type | |
Definition | Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both. |
Short | postal | physical | both |
Comments | The definition of Address states that "address is intended to describe postal addresses, not physical locations". However, many applications track whether an address has a dual purpose of being a location that can be visited as well as being a valid delivery destination, and Postal addresses are often used as proxies for physical locations (also see the Location resource). The definition of Address states that "address is intended to describe postal addresses, not physical locations". However, many applications track whether an address has a dual purpose of being a location that can be visited as well as being a valid delivery destination, and Postal addresses are often used as proxies for physical locations (also see the Location resource). |
Control | 0..1 |
Binding | The codes SHALL be taken from AddressTypehttp://hl7.org/fhir/ValueSet/address-type|4.0.1 (required to http://hl7.org/fhir/ValueSet/address-type|4.0.1 )The type of an address (physical / postal). |
Type | code |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Example | <br/><b>General</b>:both |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
54. Header.informationRecipient.address.text | |
Definition | Specifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts. |
Short | Text representation of the address |
Comments | Can provide both a text representation and parts. Applications updating an address SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part. |
Control | 0..1 |
Type | string |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Requirements | A renderable, unencoded form. |
Example | <br/><b>General</b>:137 Nowhere Street, Erewhon 9132 |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
56. Header.informationRecipient.address.line | |
Definition | This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information. |
Short | Street name, number, direction & P.O. Box etc. |
Control | 0..* |
Type | string |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Example | <br/><b>General</b>:137 Nowhere Street |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
58. Header.informationRecipient.address.city | |
Definition | The city where the patient has his/her domicile. The name of the city, town, suburb, village or other community or delivery center. |
Short | A.1.4.4.3 - CityName of city, town etc. |
Control | 0..1 |
Type | string |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Alternate Names | Municpality |
Example | <br/><b>General</b>:Erewhon |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
60. Header.informationRecipient.address.district | |
Definition | The name of the administrative area (county). |
Short | District name (aka county) |
Comments | District is sometimes known as county, but in some regions 'county' is used in place of city (municipality), so county name should be conveyed in city instead. |
Control | 0..1 |
Type | string |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Alternate Names | County |
Example | <br/><b>General</b>:Madison |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
62. Header.informationRecipient.address.state | |
Definition | The state or province where the patient has his/her domicile. Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (e.g. US 2 letter state codes). |
Short | A.1.4.4.5 - State or ProvinceSub-unit of country (abbreviations ok) |
Control | 0..1 |
Type | string |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Alternate Names | Province, Territory |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
64. Header.informationRecipient.address.postalCode | |
Definition | A postal code designating a region defined by the postal service. |
Short | Postal code for area |
Control | 0..1 |
Type | string |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Alternate Names | Zip |
Example | <br/><b>General</b>:9132 |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
66. Header.informationRecipient.address.country | |
Definition | The country where the patient has his/her domicile (Country of affiliation). Country - a nation as commonly understood or generally accepted. |
Short | A.1.4.4.6 - CountryCountry (e.g. can be ISO 3166 2 or 3 letter code) |
Comments | ISO 3166 3 letter codes can be used in place of a human readable country name. |
Control | 0..1 |
Type | string |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
68. Header.informationRecipient.address.period | |
Definition | Time period when address was/is in use. |
Short | Time period when address was/is in use |
Control | 0..1 |
Type | Period |
Is Modifier | false |
Summary | true |
Requirements | Allows addresses to be placed in historical context. |
Example | <br/><b>General</b>:{ "start" : "2010-03-23", "end" : "2010-07-01" } |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
70. Header.informationRecipient.address.street | |
Definition | The street where the patient has his/her domicile. |
Short | A.1.4.4.1 - Street |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
72. Header.informationRecipient.address.numberofstreet | |
Definition | The number of the street where the patient has his/her domicile. |
Short | A.1.4.4.2 - Number of Street |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
74. Header.informationRecipient.address.postalcode | |
Definition | The postal code where the patient has his/her domicile. |
Short | A.1.4.4.4 - Postal Code |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
76. Header.informationRecipient.country | |
Definition | Country of the intended recipient as part of the address. |
Short | A.1.4.5 - Country |
Control | 0..1 |
Type | CodeableConcept |
78. 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.6 - Telecom |
Control | 0..* |
Type | ContactPoint |
80. 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 Medical Imaging 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()) ) |
82. 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 |
84. 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: |
86. 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()) |
88. 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 |
90. 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 |
92. Header.author.organization | |
Definition | The healthcare provider organisation information. |
Short | A.1.5.3 - Author organisation |
Control | 0..1 |
Type | BackboneElement |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
94. Header.author.organization.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 |
96. Header.author.organization.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.organization.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
98. Header.author.organization.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()) |
100. Header.author.organization.name | |
Definition | Name of the organization |
Short | A.1.5.3.1- Organization Name |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
102. Header.author.organization.address | |
Definition | Address of the organization |
Short | A.1.5.3.2 - Organization Address |
Control | 0..* |
Type | Address |
104. Header.author.organization.telecom | |
Definition | Telecom of the organization |
Short | A.1.5.3.3 - Telecom of the organization |
Control | 0..* |
Type | ContactPoint |
106. Header.author.organization.specialty | |
Definition | Specialty of the organization |
Short | A.1.5.3.4 - Specialty of the organization |
Control | 0..1 |
Type | CodeableConcept |
108. Header.author.dateTime | |
Definition | Date and time of the last modification of the document by its Author. |
Short | A.1.5.4 - Date Time |
Control | 1..1 |
Type | dateTime |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
110. Header.legalAuthenticator | |
Definition | Legal authenticator (The person taking responsibility for the medical content of the document) |
Short | A.1.6 - 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()) ) |
112. 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 |
114. 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: |
116. 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()) |
118. 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.6.1 - Legal authenticator identifier |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 1..* |
Type | Identifier |
120. 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.6.2 - Legal authenticator name |
Control | 1..1 |
Type | HumanName |
122. Header.legalAuthenticator.organization | |
Definition | The healthcare provider organisation information. |
Short | A.1.6.3 - Legal authenticator organisation |
Control | 1..1 |
Type | BackboneElement |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
124. Header.legalAuthenticator.organization.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 |
126. Header.legalAuthenticator.organization.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.organization.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
128. Header.legalAuthenticator.organization.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()) |
130. Header.legalAuthenticator.organization.name | |
Definition | Name of the organization |
Short | A.1.6.3.1-Organization Name |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
132. Header.legalAuthenticator.organization.address | |
Definition | Address of the organization |
Short | A.1.6.3.2-Organization Address |
Control | 0..* |
Type | Address |
134. Header.legalAuthenticator.organization.telecom | |
Definition | Telecom of the organization |
Short | A.1.6.3.3-Telecom of the organization |
Control | 0..* |
Type | ContactPoint |
136. Header.legalAuthenticator.organization.specialty | |
Definition | Specialty of the organization |
Short | A.1.6.3.4 - Specialty of the organization |
Control | 0..1 |
Type | CodeableConcept |
138. Header.legalAuthenticator.dateTime | |
Definition | Date and time when the document was authorised. |
Short | A.1.6.4 - Authentication date and time |
Control | 0..1 |
Type | dateTime |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
140. Header.resultValidator | |
Definition | Result validator (multiple Result validators could be provided) |
Short | A.1.7 - Result validator (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()) ) |
142. Header.resultValidator.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 |
144. Header.resultValidator.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.resultValidator.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
146. Header.resultValidator.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()) |
148. Header.resultValidator.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 license or registration number. |
Short | A.1.6.1 - Result validator identifier |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 1..* |
Type | Identifier |
150. Header.resultValidator.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 - Result validator name |
Control | 1..1 |
Type | HumanName |
152. Header.resultValidator.organization | |
Definition | The healthcare provider organisation information. |
Short | A.1.6.4 - Result validator organisation |
Control | 1..1 |
Type | BackboneElement |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
154. Header.resultValidator.organization.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 |
156. Header.resultValidator.organization.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.resultValidator.organization.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
158. Header.resultValidator.organization.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()) |
160. Header.resultValidator.organization.name | |
Definition | Name of the organization |
Short | A.1.6.4.1-Organization Name |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
162. Header.resultValidator.organization.address | |
Definition | Address of the organization |
Short | A.1.6.4.2-Organization Address |
Control | 0..* |
Type | Address |
164. Header.resultValidator.organization.telecom | |
Definition | Telecom of the organization |
Short | A.1.6.4.3-Telecom of the organization |
Control | 0..* |
Type | ContactPoint |
166. Header.resultValidator.organization.specialty | |
Definition | Specialty of the organization |
Short | A.1.6.4.4-Specialty of the organization |
Control | 0..1 |
Type | CodeableConcept |
168. Header.resultValidator.dateTime | |
Definition | Date and time when the document was validated |
Short | A.1.6.5 - Validation date and time |
Control | 1..1 |
Type | dateTime |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
170. 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()) ) |
172. 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 |
174. 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: |
176. 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()) |
178. Header.documentMetadata.identifier | |
Definition | Unique identifier of the document |
Short | A.1.8.0 - Document ID |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 1..1 |
Type | Identifier |
180. Header.documentMetadata.type | |
Definition | Identifies the type of document at hand, e.g. Hospital discharge report. |
Short | A.1.8.1 - Document type |
Control | 1..1 |
Type | CodeableConcept |
182. Header.documentMetadata.status | |
Definition | The status of the Hospital discharge report. E.g., preliminary, final. |
Short | A.1.8.2 - Document status |
Control | 1..1 |
Type | CodeableConcept |
184. Header.documentMetadata.dateTime | |
Definition | Date and time of the Hospital discharge report creation. |
Short | A.1.8.3 - Report date and time |
Control | 1..1 |
Type | dateTime |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
186. Header.documentMetadata.title | |
Definition | Document title, fix value 'Hospital discharge report'. |
Short | A.1.8.4 - Document title |
Control | 1..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
188. Header.documentMetadata.ImagingProcedure | |
Definition | Imaging study procedure(s) performed. This element is relevant for the interactive selection of the available studies. |
Short | A.1.8.5 - Imaging Procedure |
Control | 0..* |
Type | BackboneElement |
190. 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 | 0..1 |
Type | BackboneElement |
192. Header.documentMetadata.confidentiality | |
Definition | Level of confidentiality of the document. Implicit value is normal. |
Short | A.1.8.7 - Confidentiality |
Control | 0..1 |
Type | CodeableConcept |
194. 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 |
196. 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 |
198. Header.documentMetadata.StudyInstanceUID | |
Definition | Unique global identifier(s) that identifies an imaging study upon which the imaging report is based. An identifier that links an imaging report to one or more imaging studies. This element is relevant for the interactive selection of the available studies. |
Short | A.1.8.10 - Study Instance UID |
Control | 1..* |
Type | oid |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
200. Header.documentMetadata.AccessionNumber | |
Definition | This is an identifier, managed by the RIS at the local level, which usually uniquely identifies an imaging procedure request, and links it to imaging study(ies) and related imaging report(s). As it is prefixed by the registration authority it is a globally unique ID, usable both nationally and cross-border. |
Short | A.1.8.11 - Accession number |
Control | 1..1 |
Type | Identifier |
Guidance on how to interpret the contents of this table can be foundhere
0. Header | |
Definition | Medical Imaging Report - Header data element |
Short | A.1 - Medical Imaging Report header data element |
Logical Model | Instances of this logical model are not marked to be the target of a Reference |
2. Header.insurance | |
Definition | 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.1 - Health insurance information |
Control | 0..1 |
Type | BackboneElement |
4. Header.insurance.identifier | |
Definition | Unique health insurance company identification code. |
Short | A.1.3.1.1 - Health insurance code |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 0..* |
Type | Identifier |
6. Header.insurance.name | |
Definition | The full, official name of the healthcare insurance provider. |
Short | A.1.3.1.2 - Health insurance provider name |
Control | 0..* |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
8. Header.insurance.subjectIdentifier | |
Definition | Number or code under which the insured person is registered at the insurance provider. |
Short | A.1.3.1.3 - Health insurance policy number |
Control | 0..* |
Type | Identifier |
10. 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 |
12. 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 |
14. 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 |
16. Header.informationRecipient.organization | |
Definition | The healthcare provider organisation information. |
Short | A.1.4.3 - Recipient organisation |
Control | 0..1 |
Type | BackboneElement |
18. Header.informationRecipient.organization.name | |
Definition | Name of the organization |
Short | A.1.4.3.1 - Organization Name |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
20. Header.informationRecipient.organization.address | |
Definition | Address of the organization |
Short | A.1.4.3.2 - Organization Address |
Control | 0..* |
Type | Address |
22. Header.informationRecipient.organization.telecom | |
Definition | Telecom of the organization |
Short | A.1.4.3.3 - Telecom of the organization |
Control | 0..* |
Type | ContactPoint |
24. Header.informationRecipient.organization.specialty | |
Definition | Specialty of the organization |
Short | A.1.4.3.4 - Specialty of the organization |
Control | 0..1 |
Type | CodeableConcept |
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.4 - Address |
Control | 0..1 |
Type | Address |
28. Header.informationRecipient.address.street | |
Definition | The street where the patient has his/her domicile. |
Short | A.1.4.4.1 - Street |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
30. Header.informationRecipient.address.numberofstreet | |
Definition | The number of the street where the patient has his/her domicile. |
Short | A.1.4.4.2 - Number of Street |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
32. Header.informationRecipient.address.city | |
Definition | The city where the patient has his/her domicile. |
Short | A.1.4.4.3 - City |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
34. Header.informationRecipient.address.postalcode | |
Definition | The postal code where the patient has his/her domicile. |
Short | A.1.4.4.4 - Postal Code |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
36. Header.informationRecipient.address.state | |
Definition | The state or province where the patient has his/her domicile. |
Short | A.1.4.4.5 - State or Province |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
38. Header.informationRecipient.address.country | |
Definition | The country where the patient has his/her domicile (Country of affiliation). |
Short | A.1.4.4.6 - Country |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
40. Header.informationRecipient.country | |
Definition | Country of the intended recipient as part of the address. |
Short | A.1.4.5 - Country |
Control | 0..1 |
Type | CodeableConcept |
42. 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.6 - Telecom |
Control | 0..* |
Type | ContactPoint |
44. 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 Medical Imaging report was/were authored). Multiple authors could be provided. |
Control | 1..* |
Type | BackboneElement |
46. 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 |
48. 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 |
50. Header.author.organization | |
Definition | The healthcare provider organisation information. |
Short | A.1.5.3 - Author organisation |
Control | 0..1 |
Type | BackboneElement |
52. Header.author.organization.name | |
Definition | Name of the organization |
Short | A.1.5.3.1- Organization Name |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
54. Header.author.organization.address | |
Definition | Address of the organization |
Short | A.1.5.3.2 - Organization Address |
Control | 0..* |
Type | Address |
56. Header.author.organization.telecom | |
Definition | Telecom of the organization |
Short | A.1.5.3.3 - Telecom of the organization |
Control | 0..* |
Type | ContactPoint |
58. Header.author.organization.specialty | |
Definition | Specialty of the organization |
Short | A.1.5.3.4 - Specialty of the organization |
Control | 0..1 |
Type | CodeableConcept |
60. Header.author.dateTime | |
Definition | Date and time of the last modification of the document by its Author. |
Short | A.1.5.4 - Date Time |
Control | 1..1 |
Type | dateTime |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
62. Header.legalAuthenticator | |
Definition | Legal authenticator (The person taking responsibility for the medical content of the document) |
Short | A.1.6 - Legal authenticator (The person taking responsibility for the medical content of the document) |
Control | 0..1 |
Type | BackboneElement |
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.6.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.6.2 - Legal authenticator name |
Control | 1..1 |
Type | HumanName |
68. Header.legalAuthenticator.organization | |
Definition | The healthcare provider organisation information. |
Short | A.1.6.3 - Legal authenticator organisation |
Control | 1..1 |
Type | BackboneElement |
70. Header.legalAuthenticator.organization.name | |
Definition | Name of the organization |
Short | A.1.6.3.1-Organization Name |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
72. Header.legalAuthenticator.organization.address | |
Definition | Address of the organization |
Short | A.1.6.3.2-Organization Address |
Control | 0..* |
Type | Address |
74. Header.legalAuthenticator.organization.telecom | |
Definition | Telecom of the organization |
Short | A.1.6.3.3-Telecom of the organization |
Control | 0..* |
Type | ContactPoint |
76. Header.legalAuthenticator.organization.specialty | |
Definition | Specialty of the organization |
Short | A.1.6.3.4 - Specialty of the organization |
Control | 0..1 |
Type | CodeableConcept |
78. Header.legalAuthenticator.dateTime | |
Definition | Date and time when the document was authorised. |
Short | A.1.6.4 - Authentication date and time |
Control | 0..1 |
Type | dateTime |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
80. Header.resultValidator | |
Definition | Result validator (multiple Result validators could be provided) |
Short | A.1.7 - Result validator (multiple attesters could be provided) |
Control | 0..* |
Type | BackboneElement |
82. Header.resultValidator.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 license or registration number. |
Short | A.1.6.1 - Result validator identifier |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 1..* |
Type | Identifier |
84. Header.resultValidator.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 - Result validator name |
Control | 1..1 |
Type | HumanName |
86. Header.resultValidator.organization | |
Definition | The healthcare provider organisation information. |
Short | A.1.6.4 - Result validator organisation |
Control | 1..1 |
Type | BackboneElement |
88. Header.resultValidator.organization.name | |
Definition | Name of the organization |
Short | A.1.6.4.1-Organization Name |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
90. Header.resultValidator.organization.address | |
Definition | Address of the organization |
Short | A.1.6.4.2-Organization Address |
Control | 0..* |
Type | Address |
92. Header.resultValidator.organization.telecom | |
Definition | Telecom of the organization |
Short | A.1.6.4.3-Telecom of the organization |
Control | 0..* |
Type | ContactPoint |
94. Header.resultValidator.organization.specialty | |
Definition | Specialty of the organization |
Short | A.1.6.4.4-Specialty of the organization |
Control | 0..1 |
Type | CodeableConcept |
96. Header.resultValidator.dateTime | |
Definition | Date and time when the document was validated |
Short | A.1.6.5 - Validation date and time |
Control | 1..1 |
Type | dateTime |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
98. Header.documentMetadata | |
Definition | Document metadata |
Short | A.1.8 - Document metadata |
Control | 1..1 |
Type | BackboneElement |
100. Header.documentMetadata.identifier | |
Definition | Unique identifier of the document |
Short | A.1.8.0 - Document ID |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 1..1 |
Type | Identifier |
102. Header.documentMetadata.type | |
Definition | Identifies the type of document at hand, e.g. Hospital discharge report. |
Short | A.1.8.1 - Document type |
Control | 1..1 |
Type | CodeableConcept |
104. Header.documentMetadata.status | |
Definition | The status of the Hospital discharge report. E.g., preliminary, final. |
Short | A.1.8.2 - Document status |
Control | 1..1 |
Type | CodeableConcept |
106. Header.documentMetadata.dateTime | |
Definition | Date and time of the Hospital discharge report creation. |
Short | A.1.8.3 - Report date and time |
Control | 1..1 |
Type | dateTime |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
108. Header.documentMetadata.title | |
Definition | Document title, fix value 'Hospital discharge report'. |
Short | A.1.8.4 - Document title |
Control | 1..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
110. Header.documentMetadata.ImagingProcedure | |
Definition | Imaging study procedure(s) performed. This element is relevant for the interactive selection of the available studies. |
Short | A.1.8.5 - Imaging Procedure |
Control | 0..* |
Type | BackboneElement |
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 | 0..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 | 0..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 |
120. Header.documentMetadata.StudyInstanceUID | |
Definition | Unique global identifier(s) that identifies an imaging study upon which the imaging report is based. An identifier that links an imaging report to one or more imaging studies. This element is relevant for the interactive selection of the available studies. |
Short | A.1.8.10 - Study Instance UID |
Control | 1..* |
Type | oid |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
122. Header.documentMetadata.AccessionNumber | |
Definition | This is an identifier, managed by the RIS at the local level, which usually uniquely identifies an imaging procedure request, and links it to imaging study(ies) and related imaging report(s). As it is prefixed by the registration authority it is a globally unique ID, usable both nationally and cross-border. |
Short | A.1.8.11 - Accession number |
Control | 1..1 |
Type | Identifier |
Guidance on how to interpret the contents of this table can be foundhere
0. Header | |
Definition | Medical Imaging Report - Header data element |
Short | A.1 - Medical Imaging 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.insurance | |
Definition | 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.1 - Health insurance information |
Control | 0..1 |
Type | BackboneElement |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
4. Header.insurance.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. Header.insurance.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.insurance.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
8. Header.insurance.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. Header.insurance.identifier | |
Definition | Unique health insurance company identification code. |
Short | A.1.3.1.1 - Health insurance code |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 0..* |
Type | Identifier |
12. Header.insurance.name | |
Definition | The full, official name of the healthcare insurance provider. |
Short | A.1.3.1.2 - Health insurance provider name |
Control | 0..* |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
14. Header.insurance.subjectIdentifier | |
Definition | Number or code under which the insured person is registered at the insurance provider. |
Short | A.1.3.1.3 - Health insurance policy number |
Control | 0..* |
Type | Identifier |
16. 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()) ) |
18. 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 |
20. 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: |
22. 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() ) |
24. 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 |
26. 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 |
28. Header.informationRecipient.organization | |
Definition | The healthcare provider organisation information. |
Short | A.1.4.3 - Recipient organisation |
Control | 0..1 |
Type | BackboneElement |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
30. Header.informationRecipient.organization.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 |
32. Header.informationRecipient.organization.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.organization.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
34. Header.informationRecipient.organization.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.informationRecipient.organization.name | |
Definition | Name of the organization |
Short | A.1.4.3.1 - Organization Name |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
38. Header.informationRecipient.organization.address | |
Definition | Address of the organization |
Short | A.1.4.3.2 - Organization Address |
Control | 0..* |
Type | Address |
40. Header.informationRecipient.organization.telecom | |
Definition | Telecom of the organization |
Short | A.1.4.3.3 - Telecom of the organization |
Control | 0..* |
Type | ContactPoint |
42. Header.informationRecipient.organization.specialty | |
Definition | Specialty of the organization |
Short | A.1.4.3.4 - Specialty of the organization |
Control | 0..1 |
Type | CodeableConcept |
44. 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.4 - Address |
Control | 0..1 |
Type | Address |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
46. Header.informationRecipient.address.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Short | Unique id for inter-element referencing |
Control | 0..1 |
Type | string |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
48. Header.informationRecipient.address.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Short | Additional content defined by implementations |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..* |
Type | Extension |
Is Modifier | false |
Summary | false |
Alternate Names | extensions, user content |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
Slicing | This element introduces a set of slices on Header.informationRecipient.address.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
50. Header.informationRecipient.address.use | |
Definition | The purpose of this address. |
Short | home | work | temp | old | billing - purpose of this address |
Comments | Applications can assume that an address is current unless it explicitly says that it is temporary or old. |
Control | 0..1 |
Binding | The codes SHALL be taken from AddressUse (required to http://hl7.org/fhir/ValueSet/address-use|4.0.1 )The use of an address. |
Type | code |
Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary or old address etc.for a current/permanent one |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Requirements | Allows an appropriate address to be chosen from a list of many. |
Example | <br/><b>General</b>:home |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
52. Header.informationRecipient.address.type | |
Definition | Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both. |
Short | postal | physical | both |
Comments | The definition of Address states that "address is intended to describe postal addresses, not physical locations". However, many applications track whether an address has a dual purpose of being a location that can be visited as well as being a valid delivery destination, and Postal addresses are often used as proxies for physical locations (also see the Location resource). |
Control | 0..1 |
Binding | The codes SHALL be taken from AddressType (required to http://hl7.org/fhir/ValueSet/address-type|4.0.1 )The type of an address (physical / postal). |
Type | code |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Example | <br/><b>General</b>:both |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
54. Header.informationRecipient.address.text | |
Definition | Specifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts. |
Short | Text representation of the address |
Comments | Can provide both a text representation and parts. Applications updating an address SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part. |
Control | 0..1 |
Type | string |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Requirements | A renderable, unencoded form. |
Example | <br/><b>General</b>:137 Nowhere Street, Erewhon 9132 |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
56. Header.informationRecipient.address.line | |
Definition | This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information. |
Short | Street name, number, direction & P.O. Box etc. |
Control | 0..* |
Type | string |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Example | <br/><b>General</b>:137 Nowhere Street |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
58. Header.informationRecipient.address.city | |
Definition | The city where the patient has his/her domicile. |
Short | A.1.4.4.3 - City |
Control | 0..1 |
Type | string |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Alternate Names | Municpality |
Example | <br/><b>General</b>:Erewhon |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
60. Header.informationRecipient.address.district | |
Definition | The name of the administrative area (county). |
Short | District name (aka county) |
Comments | District is sometimes known as county, but in some regions 'county' is used in place of city (municipality), so county name should be conveyed in city instead. |
Control | 0..1 |
Type | string |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Alternate Names | County |
Example | <br/><b>General</b>:Madison |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
62. Header.informationRecipient.address.state | |
Definition | The state or province where the patient has his/her domicile. |
Short | A.1.4.4.5 - State or Province |
Control | 0..1 |
Type | string |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Alternate Names | Province, Territory |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
64. Header.informationRecipient.address.postalCode | |
Definition | A postal code designating a region defined by the postal service. |
Short | Postal code for area |
Control | 0..1 |
Type | string |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Alternate Names | Zip |
Example | <br/><b>General</b>:9132 |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
66. Header.informationRecipient.address.country | |
Definition | The country where the patient has his/her domicile (Country of affiliation). |
Short | A.1.4.4.6 - Country |
Comments | ISO 3166 3 letter codes can be used in place of a human readable country name. |
Control | 0..1 |
Type | string |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
68. Header.informationRecipient.address.period | |
Definition | Time period when address was/is in use. |
Short | Time period when address was/is in use |
Control | 0..1 |
Type | Period |
Is Modifier | false |
Summary | true |
Requirements | Allows addresses to be placed in historical context. |
Example | <br/><b>General</b>:{ "start" : "2010-03-23", "end" : "2010-07-01" } |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
70. Header.informationRecipient.address.street | |
Definition | The street where the patient has his/her domicile. |
Short | A.1.4.4.1 - Street |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
72. Header.informationRecipient.address.numberofstreet | |
Definition | The number of the street where the patient has his/her domicile. |
Short | A.1.4.4.2 - Number of Street |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
74. Header.informationRecipient.address.postalcode | |
Definition | The postal code where the patient has his/her domicile. |
Short | A.1.4.4.4 - Postal Code |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
76. Header.informationRecipient.country | |
Definition | Country of the intended recipient as part of the address. |
Short | A.1.4.5 - Country |
Control | 0..1 |
Type | CodeableConcept |
78. 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.6 - Telecom |
Control | 0..* |
Type | ContactPoint |
80. 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 Medical Imaging 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()) ) |
82. 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 |
84. 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: |
86. 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() ) |
88. 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 |
90. 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 |
92. Header.author.organization | |
Definition | The healthcare provider organisation information. |
Short | A.1.5.3 - Author organisation |
Control | 0..1 |
Type | BackboneElement |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
94. Header.author.organization.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 |
96. Header.author.organization.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.organization.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
98. Header.author.organization.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() ) |
100. Header.author.organization.name | |
Definition | Name of the organization |
Short | A.1.5.3.1- Organization Name |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
102. Header.author.organization.address | |
Definition | Address of the organization |
Short | A.1.5.3.2 - Organization Address |
Control | 0..* |
Type | Address |
104. Header.author.organization.telecom | |
Definition | Telecom of the organization |
Short | A.1.5.3.3 - Telecom of the organization |
Control | 0..* |
Type | ContactPoint |
106. Header.author.organization.specialty | |
Definition | Specialty of the organization |
Short | A.1.5.3.4 - Specialty of the organization |
Control | 0..1 |
Type | CodeableConcept |
108. Header.author.dateTime | |
Definition | Date and time of the last modification of the document by its Author. |
Short | A.1.5.4 - Date Time |
Control | 1..1 |
Type | dateTime |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
110. Header.legalAuthenticator | |
Definition | Legal authenticator (The person taking responsibility for the medical content of the document) |
Short | A.1.6 - 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()) ) |
112. 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 |
114. 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: |
116. 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() ) |
118. 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.6.1 - Legal authenticator identifier |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 1..* |
Type | Identifier |
120. 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.6.2 - Legal authenticator name |
Control | 1..1 |
Type | HumanName |
122. Header.legalAuthenticator.organization | |
Definition | The healthcare provider organisation information. |
Short | A.1.6.3 - Legal authenticator organisation |
Control | 1..1 |
Type | BackboneElement |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
124. Header.legalAuthenticator.organization.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 |
126. Header.legalAuthenticator.organization.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.organization.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
128. Header.legalAuthenticator.organization.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() ) |
130. Header.legalAuthenticator.organization.name | |
Definition | Name of the organization |
Short | A.1.6.3.1-Organization Name |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
132. Header.legalAuthenticator.organization.address | |
Definition | Address of the organization |
Short | A.1.6.3.2-Organization Address |
Control | 0..* |
Type | Address |
134. Header.legalAuthenticator.organization.telecom | |
Definition | Telecom of the organization |
Short | A.1.6.3.3-Telecom of the organization |
Control | 0..* |
Type | ContactPoint |
136. Header.legalAuthenticator.organization.specialty | |
Definition | Specialty of the organization |
Short | A.1.6.3.4 - Specialty of the organization |
Control | 0..1 |
Type | CodeableConcept |
138. Header.legalAuthenticator.dateTime | |
Definition | Date and time when the document was authorised. |
Short | A.1.6.4 - Authentication date and time |
Control | 0..1 |
Type | dateTime |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
140. Header.resultValidator | |
Definition | Result validator (multiple Result validators could be provided) |
Short | A.1.7 - Result validator (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()) ) |
142. Header.resultValidator.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 |
144. Header.resultValidator.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.resultValidator.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
146. Header.resultValidator.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() ) |
148. Header.resultValidator.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 license or registration number. |
Short | A.1.6.1 - Result validator identifier |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 1..* |
Type | Identifier |
150. Header.resultValidator.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 - Result validator name |
Control | 1..1 |
Type | HumanName |
152. Header.resultValidator.organization | |
Definition | The healthcare provider organisation information. |
Short | A.1.6.4 - Result validator organisation |
Control | 1..1 |
Type | BackboneElement |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
154. Header.resultValidator.organization.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 |
156. Header.resultValidator.organization.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.resultValidator.organization.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
158. Header.resultValidator.organization.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() ) |
160. Header.resultValidator.organization.name | |
Definition | Name of the organization |
Short | A.1.6.4.1-Organization Name |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
162. Header.resultValidator.organization.address | |
Definition | Address of the organization |
Short | A.1.6.4.2-Organization Address |
Control | 0..* |
Type | Address |
164. Header.resultValidator.organization.telecom | |
Definition | Telecom of the organization |
Short | A.1.6.4.3-Telecom of the organization |
Control | 0..* |
Type | ContactPoint |
166. Header.resultValidator.organization.specialty | |
Definition | Specialty of the organization |
Short | A.1.6.4.4-Specialty of the organization |
Control | 0..1 |
Type | CodeableConcept |
168. Header.resultValidator.dateTime | |
Definition | Date and time when the document was validated |
Short | A.1.6.5 - Validation date and time |
Control | 1..1 |
Type | dateTime |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
170. 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()) ) |
172. 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 |
174. 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: |
176. 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() ) |
178. Header.documentMetadata.identifier | |
Definition | Unique identifier of the document |
Short | A.1.8.0 - Document ID |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 1..1 |
Type | Identifier |
180. Header.documentMetadata.type | |
Definition | Identifies the type of document at hand, e.g. Hospital discharge report. |
Short | A.1.8.1 - Document type |
Control | 1..1 |
Type | CodeableConcept |
182. Header.documentMetadata.status | |
Definition | The status of the Hospital discharge report. E.g., preliminary, final. |
Short | A.1.8.2 - Document status |
Control | 1..1 |
Type | CodeableConcept |
184. Header.documentMetadata.dateTime | |
Definition | Date and time of the Hospital discharge report creation. |
Short | A.1.8.3 - Report date and time |
Control | 1..1 |
Type | dateTime |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
186. Header.documentMetadata.title | |
Definition | Document title, fix value 'Hospital discharge report'. |
Short | A.1.8.4 - Document title |
Control | 1..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
188. Header.documentMetadata.ImagingProcedure | |
Definition | Imaging study procedure(s) performed. This element is relevant for the interactive selection of the available studies. |
Short | A.1.8.5 - Imaging Procedure |
Control | 0..* |
Type | BackboneElement |
190. 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 | 0..1 |
Type | BackboneElement |
192. Header.documentMetadata.confidentiality | |
Definition | Level of confidentiality of the document. Implicit value is normal. |
Short | A.1.8.7 - Confidentiality |
Control | 0..1 |
Type | CodeableConcept |
194. 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 |
196. 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 |
198. Header.documentMetadata.StudyInstanceUID | |
Definition | Unique global identifier(s) that identifies an imaging study upon which the imaging report is based. An identifier that links an imaging report to one or more imaging studies. This element is relevant for the interactive selection of the available studies. |
Short | A.1.8.10 - Study Instance UID |
Control | 1..* |
Type | oid |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
200. Header.documentMetadata.AccessionNumber | |
Definition | This is an identifier, managed by the RIS at the local level, which usually uniquely identifies an imaging procedure request, and links it to imaging study(ies) and related imaging report(s). As it is prefixed by the registration authority it is a globally unique ID, usable both nationally and cross-border. |
Short | A.1.8.11 - Accession number |
Control | 1..1 |
Type | Identifier |