Research Data Sharing IG
1.0.0 - CI Build
Research Data Sharing IG, published by IEHR-Workgroup. This guide is not an authorized publication; it is the continuous build for version 1.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/InteropEHRate-project/research-data-sharing/ and changes regularly. See the Directory of published versions
Draft as of 2024-04-08 |
Definitions for the Narrative-IEHR data type profile.
Guidance on how to interpret the contents of this table can be found here
0. Narrative | |
2. Narrative.extension | |
Slicing | This element introduces a set of slices on Narrative.extension . The slices are unordered and Open, and can be differentiated using the following discriminators: |
4. Narrative.extension:translation | |
Slice Name | translation |
Type | Extension(NarrativeExtension - IEHR) (Complex Extension) |
Guidance on how to interpret the contents of this table can be found here
0. Narrative | |
Definition | A human-readable summary of the resource conveying the essential clinical and business information for the resource. |
Short | Human-readable summary of the resource (essential clinical and business information) |
Control | 0..* This element is affected by the following invariants: ele-1 |
Is Modifier | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
2. Narrative.extension | |
Definition | An Extension 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 | ExtensionAdditional 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 Narrative.extension . The slices are unordered and Open, and can be differentiated using the following discriminators: |
4. Narrative.extension:translation | |
Slice Name | translation |
Definition | The extension represents the Narrative in additional languages |
Short | NarrativeExtension |
Control | 0..* |
Type | Extension(NarrativeExtension - IEHR) (Complex Extension) |
Is Modifier | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
6. Narrative.status | |
Definition | The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data. |
Short | generated | extensions | additional | empty |
Control | 1..1 |
Binding | The codes SHALL be taken from NarrativeStatushttp://hl7.org/fhir/ValueSet/narrative-status|4.0.1 (required to http://hl7.org/fhir/ValueSet/narrative-status|4.0.1 )The status of a resource narrative. |
Type | code |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
8. Narrative.div | |
Definition | The actual narrative content, a stripped down version of XHTML. |
Short | Limited xhtml content |
Comments | The contents of the html element are an XHTML fragment containing only the basic html formatting elements described in chapters 7-11 and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained stylesheets. The XHTML content SHALL NOT contain a head, a body, external stylesheet references, scripts, forms, base/link/xlink, frames, iframes and objects. |
Control | 1..1 |
Type | xhtml |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) txt-1: The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes ( htmlChecks() )txt-2: The narrative SHALL have some non-whitespace content ( htmlChecks() )txt-1: The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes (htmlChecks()) txt-2: The narrative SHALL have some non-whitespace content (htmlChecks()) |
Guidance on how to interpret the contents of this table can be found here
0. Narrative | |
Definition | A human-readable summary of the resource conveying the essential clinical and business information for the resource. |
Short | Human-readable summary of the resource (essential clinical and business information) |
Control | 0..* This element is affected by the following invariants: ele-1 |
Is Modifier | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
2. Narrative.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 |
4. Narrative.extension | |
Definition | An Extension |
Short | Extension |
Control | 0..* |
Type | Extension |
Is Modifier | false |
Summary | false |
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 Narrative.extension . The slices are unordered and Open, and can be differentiated using the following discriminators: |
6. Narrative.extension:translation | |
Slice Name | translation |
Definition | The extension represents the Narrative in additional languages |
Short | NarrativeExtension |
Control | 0..* |
Type | Extension(NarrativeExtension - IEHR) (Complex Extension) |
Is Modifier | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
8. Narrative.status | |
Definition | The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data. |
Short | generated | extensions | additional | empty |
Control | 1..1 |
Binding | The codes SHALL be taken from NarrativeStatus (required to http://hl7.org/fhir/ValueSet/narrative-status|4.0.1 )The status of a resource narrative. |
Type | code |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
10. Narrative.div | |
Definition | The actual narrative content, a stripped down version of XHTML. |
Short | Limited xhtml content |
Comments | The contents of the html element are an XHTML fragment containing only the basic html formatting elements described in chapters 7-11 and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained stylesheets. The XHTML content SHALL NOT contain a head, a body, external stylesheet references, scripts, forms, base/link/xlink, frames, iframes and objects. |
Control | 1..1 |
Type | xhtml |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )txt-1: The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes ( htmlChecks() )txt-2: The narrative SHALL have some non-whitespace content ( htmlChecks() ) |