Structured Data Capture
4.0.0-ballot - STU 4 ballot 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-ballot 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: Launch Contexts

Official URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-launchContext Version: 4.0.0-ballot
Standards status: Trial-use Maturity Level: 4 Computable Name: LaunchContextExtension
Other Identifiers: OID:2.16.840.1.113883.4.642.40.17.42.34

Resources that provide context for form processing logic (pre-population, flow-control, drop-down selection, etc.) when creating/displaying/editing a QuestionnaireResponse.

Indicates to systems creating or updating a QuestionnaireResponse what types of information to pass in for internal processing. May also influence things like SMART on FHIR permission requests.

Context of Use

This extension may be used on the following element(s):

  • Element ID Questionnaire

Scope and Usage

If a name is specified other than one of those specified in the value set, systems will have to come to prior agreement and write code to support the additional name. It will not be possible to dynamically automatically support new launch contexts without writing custom code. In addition, 'custom' names SHOULD have a prefix such that they won't collide with new standard context names introduced by future versions of SDC.

Additional details on the use of this extension can be found on the Form Behavior page.

Usage info

Usage:

Formal Views of Extension Content

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

This structure is derived from Extension

Summary

Complex Extension: Resources that provide context for form processing logic (pre-population, flow-control, drop-down selection, etc.) when creating/displaying/editing a QuestionnaireResponse.

  • name: Coding: The variable name the passed resource will be referenced by within the Questionnaire logic.
  • type: code: The kind of resource to be provided.
  • description: string: Guidance on the resource to be provided and what impact providing it will have on questionnaire behavior.
  • multiplesAllowed: boolean: Indicates whether multiple resources are permitted for this context element.

Maturity: 4

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension C 0..* Extension Context resources needed for Questionnaire
sdc-lcext-1: Types must be from the specified value set of resource types based on name: patient: Patient; user: Patient, Practitioner, PractitionerRole, Organization, RelatedPerson, Device; encounter: Encounter; location: Location; study: ResearchStudy; clinical: Any allowed clinical resource
... extension 2..* Extension Extension
... Slices for extension Content/Rules for all slices
.... extension:name 1..1 Extension Variable name
..... extension 0..0
..... url 1..1 uri "name"
..... value[x] 1..1 Coding Value of extension
Binding: Questionnaire Launch Context (extensible): Launch context codes for use in defining questionnaires context at launch time (NOTE: the Coding.code will be used for the variable name and that (at present) there is no support for Questionnaires that use multiple launch contexts which share a common code but different code systems. Also, all launch context codes must meet the requirements to be a valid FHIRPath name.).

.... extension:type 1..* Extension Resource type
..... extension 0..0
..... url 1..1 uri "type"
..... value[x] 1..1 code Value of extension
Binding: ResourceType (required)
.... extension:description 0..1 Extension Explanation of context element
..... extension 0..0
..... url 1..1 uri "description"
..... value[x] 1..1 string Value of extension
.... extension:multiplesAllowed 0..1 Extension Allow multiple resources
..... extension 0..0
..... url 1..1 uri "multiplesAllowed"
..... value[x] 0..1 boolean Value of extension
... url 1..1 uri "http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-launchContext"

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension C 0..* Extension Context resources needed for Questionnaire
sdc-lcext-1: Types must be from the specified value set of resource types based on name: patient: Patient; user: Patient, Practitioner, PractitionerRole, Organization, RelatedPerson, Device; encounter: Encounter; location: Location; study: ResearchStudy; clinical: Any allowed clinical resource
... id 0..1 string Unique id for inter-element referencing
... Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:name 1..1 Extension Variable name
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "name"
..... value[x] 1..1 Coding Value of extension
Binding: Questionnaire Launch Context (extensible): Launch context codes for use in defining questionnaires context at launch time (NOTE: the Coding.code will be used for the variable name and that (at present) there is no support for Questionnaires that use multiple launch contexts which share a common code but different code systems. Also, all launch context codes must meet the requirements to be a valid FHIRPath name.).

.... extension:type 1..* Extension Resource type
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "type"
..... value[x] 1..1 code Value of extension
Binding: ResourceType (required)
.... extension:description 0..1 Extension Explanation of context element
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "description"
..... value[x] 1..1 string Value of extension
.... extension:multiplesAllowed 0..1 Extension Allow multiple resources
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "multiplesAllowed"
..... value[x] 0..1 boolean Value of extension
... url 1..1 uri "http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-launchContext"

doco Documentation for this format

This structure is derived from Extension

Summary

Complex Extension: Resources that provide context for form processing logic (pre-population, flow-control, drop-down selection, etc.) when creating/displaying/editing a QuestionnaireResponse.

  • name: Coding: The variable name the passed resource will be referenced by within the Questionnaire logic.
  • type: code: The kind of resource to be provided.
  • description: string: Guidance on the resource to be provided and what impact providing it will have on questionnaire behavior.
  • multiplesAllowed: boolean: Indicates whether multiple resources are permitted for this context element.

Maturity: 4

Differential View

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension C 0..* Extension Context resources needed for Questionnaire
sdc-lcext-1: Types must be from the specified value set of resource types based on name: patient: Patient; user: Patient, Practitioner, PractitionerRole, Organization, RelatedPerson, Device; encounter: Encounter; location: Location; study: ResearchStudy; clinical: Any allowed clinical resource
... extension 2..* Extension Extension
... Slices for extension Content/Rules for all slices
.... extension:name 1..1 Extension Variable name
..... extension 0..0
..... url 1..1 uri "name"
..... value[x] 1..1 Coding Value of extension
Binding: Questionnaire Launch Context (extensible): Launch context codes for use in defining questionnaires context at launch time (NOTE: the Coding.code will be used for the variable name and that (at present) there is no support for Questionnaires that use multiple launch contexts which share a common code but different code systems. Also, all launch context codes must meet the requirements to be a valid FHIRPath name.).

.... extension:type 1..* Extension Resource type
..... extension 0..0
..... url 1..1 uri "type"
..... value[x] 1..1 code Value of extension
Binding: ResourceType (required)
.... extension:description 0..1 Extension Explanation of context element
..... extension 0..0
..... url 1..1 uri "description"
..... value[x] 1..1 string Value of extension
.... extension:multiplesAllowed 0..1 Extension Allow multiple resources
..... extension 0..0
..... url 1..1 uri "multiplesAllowed"
..... value[x] 0..1 boolean Value of extension
... url 1..1 uri "http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-launchContext"

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension C 0..* Extension Context resources needed for Questionnaire
sdc-lcext-1: Types must be from the specified value set of resource types based on name: patient: Patient; user: Patient, Practitioner, PractitionerRole, Organization, RelatedPerson, Device; encounter: Encounter; location: Location; study: ResearchStudy; clinical: Any allowed clinical resource
... id 0..1 string Unique id for inter-element referencing
... Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:name 1..1 Extension Variable name
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "name"
..... value[x] 1..1 Coding Value of extension
Binding: Questionnaire Launch Context (extensible): Launch context codes for use in defining questionnaires context at launch time (NOTE: the Coding.code will be used for the variable name and that (at present) there is no support for Questionnaires that use multiple launch contexts which share a common code but different code systems. Also, all launch context codes must meet the requirements to be a valid FHIRPath name.).

.... extension:type 1..* Extension Resource type
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "type"
..... value[x] 1..1 code Value of extension
Binding: ResourceType (required)
.... extension:description 0..1 Extension Explanation of context element
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "description"
..... value[x] 1..1 string Value of extension
.... extension:multiplesAllowed 0..1 Extension Allow multiple resources
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "multiplesAllowed"
..... value[x] 0..1 boolean Value of extension
... url 1..1 uri "http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-launchContext"

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSetURI
Extension.extension:name.value[x]extensibleQuestionnaireLaunchContext (a valid code from Launch Context)
http://hl7.org/fhir/uv/sdc/ValueSet/launchContext
from this IG
Extension.extension:type.value[x]requiredResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
sdc-lcext-1errorExtensionTypes must be from the specified value set of resource types based on name: patient: Patient; user: Patient, Practitioner, PractitionerRole, Organization, RelatedPerson, Device; encounter: Encounter; location: Location; study: ResearchStudy; clinical: Any allowed clinical resource
: (extension('name').value.where(code='patient' and system='http://hl7.org/fhir/uv/sdc/CodeSystem/launchContext').exists() implies extension('type').all(value = 'Patient')) and (extension('name').value.where(code='user' and system='http://hl7.org/fhir/uv/sdc/CodeSystem/launchContext').exists() implies extension('type').all(value='Patient' or value='Practitioner' or value='PractitionerRole' or value='RelatedPerson' or value='Organization' or value='Device')) and (extension('name').value.where(code='encounter' and system='http://hl7.org/fhir/uv/sdc/CodeSystem/launchContext').exists() implies extension('type').all(value = 'Encounter')) and (extension('name').value.where(code='location' and system='http://hl7.org/fhir/uv/sdc/CodeSystem/launchContext').exists() implies extension('type').all(value = 'Location')) and (extension('name').value.where(code='study' and system='http://hl7.org/fhir/uv/sdc/CodeSystem/launchContext').exists() implies extension('type').all(value = 'ResearchStudy'))