Structured Data Capture
4.0.0-ci-build - STU 4 CI-build International flag

Structured Data Capture, published by HL7 International / FHIR Infrastructure. This guide is not an authorized publication; it is the continuous build for version 4.0.0-ci-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/sdc/ and changes regularly. See the Directory of published versions

Extension: Instance Narrative Liquid

Official URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/instance-narrative-liquid Version: 4.0.0-ci-build
Standards status: Trial-use Maturity Level: 4 Computable Name: InstanceNarrativeLiquid
Other Identifiers: OID:2.16.840.1.113883.4.642.40.17.42.97

Points to a Library containing FHIR Liquid template that defines how the narrative for instantiations of this resource should be generated.

Context of Use

Narrative generation algorithms are often based on generic rules that are applied for all instances of a given resource. However, in many cases it is useful to have narrative whose appearance is specific to a narrower subset of resources. This extension allows defining a narrative generation algorithm that applies to all resources that are instantiations of a particular definition (Questionnaire, ObservationDefinition, PlanDefinition, etc.) This allows the organization of the narrative to be tied to the specific elements and structure associated with the definition.

This extension points to a Library instance. The Library instance should have a type of FHIRPath Liquid and a content.contentType of "text/html". The Library.content.data will be a base64 encoded Liquid template that uses the FHIRPath Liquid variant. This allows the use of FHIRPath expressions as part of the Liquid logic. When this logic is executed with `%resource` context being set to the resource instantiated from the definition using this extension, it will generate HTML narrative based on the data present in the resource instance.

While the Liquid can be hand-coded, in most cases it will be generated algorithmically based on core elements, and potentially custom extensions, found in the definition resource. However, once the Liquid is generated, it will be generic and can be executed by any engine that supports FHIRPath Liquid

Usage info

Usages:

  • This Extension is not used by any profiles in this Specification

You can also check for usages in the FHIR IG Statistics

Formal Views of Extension Content

Description Differentials, Snapshots, and other representations.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension 0..1 Extension Rendering library for instantiations
... extension 0..0 Extension
... url 1..1 uri "http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-responseRenderingLiquid"
... value[x] 0..1 Reference(Library) Value of extension

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension 0..1 Extension Rendering library for instantiations
... id 0..1 string Unique id for inter-element referencing
... extension 0..0 Extension
Slice: Unordered, Open by value:url
... url 1..1 uri "http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-responseRenderingLiquid"

doco Documentation for this format

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()

Summary

Simple Extension with the type Reference: Points to a Library containing FHIR Liquid template that defines how the narrative for instantiations of this resource should be generated.

Maturity: 4

Differential ViewDifferential View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension 0..1 Extension Rendering library for instantiations
... extension 0..0 Extension
... url 1..1 uri "http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-responseRenderingLiquid"
... value[x] 0..1 Reference(Library) Value of extension

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension 0..1 Extension Rendering library for instantiations
... id 0..1 string Unique id for inter-element referencing
... extension 0..0 Extension
Slice: Unordered, Open by value:url
... url 1..1 uri "http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-responseRenderingLiquid"

doco Documentation for this format

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()

Summary

Simple Extension with the type Reference: Points to a Library containing FHIR Liquid template that defines how the narrative for instantiations of this resource should be generated.

Maturity: 4

 

Other representations of profile: CSV, Excel, Schematron