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

Extension: Narrative Generation

Official URL: http://fhir.tiro.health/StructureDefinition/narrative-generation Version: 0.1.0
Draft as of 2025-10-16 Computable Name: NarrativeGeneration

This extension is used to define the narrative generation based on the QuestionnaireResponse.

Context of Use

Usage info

Usages:

  • This Extension is not used by any profiles in this Implementation Guide

You can also check for usages in the FHIR IG Statistics

Formal Views of Extension Content

Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension 0..* Extension Narrative Generation
... extension 2..* Extension Extension
... Slices for extension Content/Rules for all slices
.... extension:default S 1..1 Extension Default text generation for the answer.
..... extension 0..0
..... url 1..1 uri "default"
..... value[x] 0..1 Expression Value of extension
.... extension:empty S 0..1 Extension Text generation if no answer is given.
..... extension 0..0
..... url 1..1 uri "empty"
..... value[x] 0..1 Expression Value of extension
.... extension:answerOption 1..* Extension Text generation for specific answer options.
..... extension 2..* Extension Extension
..... Slices for extension Content/Rules for all slices
...... extension:template 1..1 Extension Template for the answer option
....... extension 0..0
....... url 1..1 uri "template"
....... value[x] 0..1 Expression Value of extension
...... extension:answer 1..1 Extension Answer option
....... url 1..1 uri "answer"
..... url 1..1 uri "answerOption"
..... value[x] 0..0
.... extension:aggregator 0..1 Extension Aggregator for multiple answers. Only used if `repeats` is set to `true`.
..... extension 0..0
..... url 1..1 uri "aggregator"
..... value[x] 0..1 string Value of extension
... url 1..1 uri "http://fhir.tiro.health/StructureDefinition/narrative-generation"

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension 0..* Extension Narrative Generation
... id 0..1 id Unique id for inter-element referencing
... Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:default S 1..1 Extension Default text generation for the answer.
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "default"
..... value[x] 0..1 Expression Value of extension
.... extension:empty S 0..1 Extension Text generation if no answer is given.
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "empty"
..... value[x] 0..1 Expression Value of extension
.... extension:answerOption 1..* Extension Text generation for specific answer options.
..... id 0..1 id Unique id for inter-element referencing
..... Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:template 1..1 Extension Template for the answer option
....... id 0..1 id Unique id for inter-element referencing
....... extension 0..0
....... url 1..1 uri "template"
....... value[x] 0..1 Expression Value of extension
...... extension:answer 1..1 Extension Answer option
....... id 0..1 id Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... url 1..1 uri "answer"
....... value[x] 0..1 Value of extension
........ valueBase64Binary base64Binary
........ valueBoolean boolean
........ valueCanonical canonical(Any)
........ valueCode code
........ valueDate date
........ valueDateTime dateTime
........ valueDecimal decimal
........ valueId id
........ valueInstant instant
........ valueInteger integer
........ valueInteger64 integer64
........ valueMarkdown markdown
........ valueOid oid
........ valuePositiveInt positiveInt
........ valueString string
........ valueTime time
........ valueUnsignedInt unsignedInt
........ valueUri uri
........ valueUrl url
........ valueUuid uuid
........ valueAddress Address
........ valueAge Age
........ valueAnnotation Annotation
........ valueAttachment Attachment
........ valueCodeableConcept CodeableConcept
........ valueCodeableReference CodeableReference
........ valueCoding Coding
........ valueContactPoint ContactPoint
........ valueCount Count
........ valueDistance Distance
........ valueDuration Duration
........ valueHumanName HumanName
........ valueIdentifier Identifier
........ valueMoney Money
........ valuePeriod Period
........ valueQuantity Quantity
........ valueRange Range
........ valueRatio Ratio
........ valueRatioRange RatioRange
........ valueReference Reference(Any)
........ valueSampledData SampledData
........ valueSignature Signature
........ valueTiming Timing
........ valueContactDetail ContactDetail
........ valueDataRequirement DataRequirement
........ valueExpression Expression
........ valueParameterDefinition ParameterDefinition
........ valueRelatedArtifact RelatedArtifact
........ valueTriggerDefinition TriggerDefinition
........ valueUsageContext UsageContext
........ valueAvailability Availability
........ valueExtendedContactDetail ExtendedContactDetail
........ valueDosage Dosage
........ valueMeta Meta
..... url 1..1 uri "answerOption"
.... extension:aggregator 0..1 Extension Aggregator for multiple answers. Only used if `repeats` is set to `true`.
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "aggregator"
..... value[x] 0..1 string Value of extension
... url 1..1 uri "http://fhir.tiro.health/StructureDefinition/narrative-generation"

doco Documentation for this format

This structure is derived from Extension

Summary

Complex Extension: This extension is used to define the narrative generation based on the QuestionnaireResponse.

  • default: Expression: An Extension
  • empty: Expression: An Extension
  • template: Expression: An Extension
  • answer: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, integer64, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, CodeableReference, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, RatioRange, Reference, SampledData, Signature, Timing, ContactDetail, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Availability, ExtendedContactDetail, Dosage, Meta: An Extension
  • aggregator: string: An Extension

Differential View

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension 0..* Extension Narrative Generation
... extension 2..* Extension Extension
... Slices for extension Content/Rules for all slices
.... extension:default S 1..1 Extension Default text generation for the answer.
..... extension 0..0
..... url 1..1 uri "default"
..... value[x] 0..1 Expression Value of extension
.... extension:empty S 0..1 Extension Text generation if no answer is given.
..... extension 0..0
..... url 1..1 uri "empty"
..... value[x] 0..1 Expression Value of extension
.... extension:answerOption 1..* Extension Text generation for specific answer options.
..... extension 2..* Extension Extension
..... Slices for extension Content/Rules for all slices
...... extension:template 1..1 Extension Template for the answer option
....... extension 0..0
....... url 1..1 uri "template"
....... value[x] 0..1 Expression Value of extension
...... extension:answer 1..1 Extension Answer option
....... url 1..1 uri "answer"
..... url 1..1 uri "answerOption"
..... value[x] 0..0
.... extension:aggregator 0..1 Extension Aggregator for multiple answers. Only used if `repeats` is set to `true`.
..... extension 0..0
..... url 1..1 uri "aggregator"
..... value[x] 0..1 string Value of extension
... url 1..1 uri "http://fhir.tiro.health/StructureDefinition/narrative-generation"

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension 0..* Extension Narrative Generation
... id 0..1 id Unique id for inter-element referencing
... Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:default S 1..1 Extension Default text generation for the answer.
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "default"
..... value[x] 0..1 Expression Value of extension
.... extension:empty S 0..1 Extension Text generation if no answer is given.
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "empty"
..... value[x] 0..1 Expression Value of extension
.... extension:answerOption 1..* Extension Text generation for specific answer options.
..... id 0..1 id Unique id for inter-element referencing
..... Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:template 1..1 Extension Template for the answer option
....... id 0..1 id Unique id for inter-element referencing
....... extension 0..0
....... url 1..1 uri "template"
....... value[x] 0..1 Expression Value of extension
...... extension:answer 1..1 Extension Answer option
....... id 0..1 id Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... url 1..1 uri "answer"
....... value[x] 0..1 Value of extension
........ valueBase64Binary base64Binary
........ valueBoolean boolean
........ valueCanonical canonical(Any)
........ valueCode code
........ valueDate date
........ valueDateTime dateTime
........ valueDecimal decimal
........ valueId id
........ valueInstant instant
........ valueInteger integer
........ valueInteger64 integer64
........ valueMarkdown markdown
........ valueOid oid
........ valuePositiveInt positiveInt
........ valueString string
........ valueTime time
........ valueUnsignedInt unsignedInt
........ valueUri uri
........ valueUrl url
........ valueUuid uuid
........ valueAddress Address
........ valueAge Age
........ valueAnnotation Annotation
........ valueAttachment Attachment
........ valueCodeableConcept CodeableConcept
........ valueCodeableReference CodeableReference
........ valueCoding Coding
........ valueContactPoint ContactPoint
........ valueCount Count
........ valueDistance Distance
........ valueDuration Duration
........ valueHumanName HumanName
........ valueIdentifier Identifier
........ valueMoney Money
........ valuePeriod Period
........ valueQuantity Quantity
........ valueRange Range
........ valueRatio Ratio
........ valueRatioRange RatioRange
........ valueReference Reference(Any)
........ valueSampledData SampledData
........ valueSignature Signature
........ valueTiming Timing
........ valueContactDetail ContactDetail
........ valueDataRequirement DataRequirement
........ valueExpression Expression
........ valueParameterDefinition ParameterDefinition
........ valueRelatedArtifact RelatedArtifact
........ valueTriggerDefinition TriggerDefinition
........ valueUsageContext UsageContext
........ valueAvailability Availability
........ valueExtendedContactDetail ExtendedContactDetail
........ valueDosage Dosage
........ valueMeta Meta
..... url 1..1 uri "answerOption"
.... extension:aggregator 0..1 Extension Aggregator for multiple answers. Only used if `repeats` is set to `true`.
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "aggregator"
..... value[x] 0..1 string Value of extension
... url 1..1 uri "http://fhir.tiro.health/StructureDefinition/narrative-generation"

doco Documentation for this format

This structure is derived from Extension

Summary

Complex Extension: This extension is used to define the narrative generation based on the QuestionnaireResponse.

  • default: Expression: An Extension
  • empty: Expression: An Extension
  • template: Expression: An Extension
  • answer: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, integer64, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, CodeableReference, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, RatioRange, Reference, SampledData, Signature, Timing, ContactDetail, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Availability, ExtendedContactDetail, Dosage, Meta: An Extension
  • aggregator: string: An Extension

 

Other representations of profile: CSV, Excel, Schematron

Constraints

Id Grade Path(s) Description Expression
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()