Tiro.health Implementation Guide
0.1.0 - ci-build
Tiro.health Implementation Guide - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
Draft as of 2025-10-16 |
Definitions for the narrative-template-snippet extension.
Guidance on how to interpret the contents of this table can be foundhere
0. Extension | |
Definition | FHIR Extension for narrative snippets used in narrative templates within Questionnaires. These snippets are loaded into the rendering environment and can be referenced by narrative templates or by other snippets to generate dynamic content. Optional Extension Element - found in all resources. |
Short | Narrative Template SnippetOptional Extensions Element |
Control | 0..* |
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()) |
2. Extension.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 managable, 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..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 Extension.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
4. Extension.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Short | identifies the meaning of the extension |
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
Control | 1..1 |
Type | uri |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
Fixed Value | http://fhir.tiro.health/StructureDefinition/narrative-template-snippet |
6. Extension.value[x] | |
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). |
Short | Value of extension |
Control | 0..1 This element is affected by the following invariants: ext-1 |
Type | Expression, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, RatioRange, Coding, SampledData, id, positiveInt, Distance, Availability, integer64, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, ExtendedContactDetail, CodeableConcept, ParameterDefinition, dateTime, code, string, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, CodeableReference, Signature, unsignedInt, time |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Is Modifier | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
8. Extension.value[x].language | |
Definition | The media type of the language for the expression. |
Short | text/cql | text/fhirpath | application/x-fhir-query | etc. |
Control | 0..1 |
Binding | The codes SHALL be taken from Unless not suitable, these codes SHALL be taken from Template Languageshttp://hl7.org/fhir/ValueSet/expression-language|5.0.0 (required to http://fhir.tiro.health/ValueSet/template-languages ) |
Type | code |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Requirements | The cardinality of this element is optional to allow text only as part of the authoring process. However, in order to be executable, the expression element must be specified. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
Guidance on how to interpret the contents of this table can be foundhere
0. Extension | |
Definition | FHIR Extension for narrative snippets used in narrative templates within Questionnaires. These snippets are loaded into the rendering environment and can be referenced by narrative templates or by other snippets to generate dynamic content. |
Short | Narrative Template Snippet |
2. Extension.extension | |
Control | 0..0 |
4. Extension.url | |
Fixed Value | http://fhir.tiro.health/StructureDefinition/narrative-template-snippet |
6. Extension.value[x] | |
Type | Expression, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, RatioRange, Coding, SampledData, id, positiveInt, Distance, Availability, integer64, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, ExtendedContactDetail, CodeableConcept, ParameterDefinition, dateTime, code, string, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, CodeableReference, Signature, unsignedInt, time |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
8. Extension.value[x].language | |
Binding | The codes SHALL be taken from Template Languages (required to http://fhir.tiro.health/ValueSet/template-languages ) |
Guidance on how to interpret the contents of this table can be foundhere
0. Extension | |
Definition | FHIR Extension for narrative snippets used in narrative templates within Questionnaires. These snippets are loaded into the rendering environment and can be referenced by narrative templates or by other snippets to generate dynamic content. |
Short | Narrative Template Snippet |
Control | 0..* |
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() ) |
2. Extension.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 This element is affected by the following invariants: ele-1 |
Type | id |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
4. Extension.extension | |
Definition | An Extension |
Short | Extension |
Control | 0..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 Extension.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
6. Extension.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Short | identifies the meaning of the extension |
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
Control | 1..1 |
Type | uri |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
Fixed Value | http://fhir.tiro.health/StructureDefinition/narrative-template-snippet |
8. Extension.value[x] | |
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). |
Short | Value of extension |
Control | 0..1 This element is affected by the following invariants: ext-1 |
Type | Expression |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Is Modifier | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
10. Extension.value[x].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 This element is affected by the following invariants: ele-1 |
Type | id |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
12. Extension.value[x].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 managable, 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 Extension.value[x].extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
14. Extension.value[x].description | |
Definition | A brief, natural language description of the condition that effectively communicates the intended semantics. |
Short | Natural language description of the condition |
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()) ) |
16. Extension.value[x].name | |
Definition | A short name assigned to the expression to allow for multiple reuse of the expression in the context where it is defined. |
Short | Short name assigned to expression for reuse |
Control | 0..1 This element is affected by the following invariants: exp-2 |
Type | code |
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()) ) |
18. Extension.value[x].language | |
Definition | The media type of the language for the expression. |
Short | text/cql | text/fhirpath | application/x-fhir-query | etc. |
Control | 0..1 |
Binding | The codes SHALL be taken from Template Languages (required to http://fhir.tiro.health/ValueSet/template-languages ) |
Type | code |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Requirements | The cardinality of this element is optional to allow text only as part of the authoring process. However, in order to be executable, the expression element must be specified. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
20. Extension.value[x].expression | |
Definition | An expression in the specified language that returns a value. |
Short | Expression in specified language |
Comments | If Expression.expression and Expression.reference are both present, the Expression.expression might just be a name pointing something within the referenced content. |
Control | 0..1 This element is affected by the following invariants: exp-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()) ) |
22. Extension.value[x].reference | |
Definition | A URI that defines where the expression is found. |
Short | Where the expression is found |
Comments | If both a reference and an expression is found, the reference SHALL point to the same expression. |
Control | 0..1 This element is affected by the following invariants: exp-1 |
Type | uri |
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()) ) |