This page is part of the Structured Data Capture FHIR IG (v2.7.0: STU 3 Ballot 2) based on FHIR R4. The current version which supercedes this version is 3.0.0. For a full list of available versions, see the Directory of published versions

Extension: ChoiceColumnExtension - Detailed Descriptions

Definitions for the sdc-questionnaire-choiceColumn Extension

1. Extension
Definition

Provides guidelines for rendering multi-column choices. I.e. when displaying a list of codes (for choice or open-choice items) or a list of resources (for reference items), this extension allows the drop-down to have multiple columns. For codes, the author can pick additional code system properties to display - such as alternate display names strength or form for drug codes, etc. For references, the author can choose particular columns from the resource (e.g. first name, last name, specialty, address).

Control0..* This element is affected by the following invariants: ele-1
Comments

Each repetition represents a column to display.

InvariantsDefined on this element
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.

Control0..1
Typestring
3. Extension.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 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.

Control0..*
TypeExtension
Alternate Namesextensions, user content
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.

4. Extension.extension:path
Definition

The element to display within the column (see notes).

Control1..1
TypeExtension
Comments

When the question has a type of choice or open-choice, the path will be interpreted as the 'code' of a property for the code that is available from the answerValueSet. For code systems that have alternate designations, the path can also indicate the language or designation use, provided that the code system only has one designation for each language or use within the code system. A path of 'display' will refer to the default displayname for the code as specified in CodeSystem.concept.display.

When the question has a type of reference, the path will be interpreted as a FHIRPath evaluated against the candidate resources.

5. Extension.extension:path.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
6. Extension.extension:path.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 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.

Control0..*
TypeExtension
Alternate Namesextensions, user content
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.

7. Extension.extension:path.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
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.

Fixed Valuepath
8. Extension.extension:path.valueString
Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Control0..1
Typestring
9. Extension.extension:label
Definition

The label to appear at the top of the column.

Control0..1
TypeExtension
10. Extension.extension:label.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
11. Extension.extension:label.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 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.

Control0..*
TypeExtension
Alternate Namesextensions, user content
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.

12. Extension.extension:label.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
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.

Fixed Valuelabel
13. Extension.extension:label.valueString
Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Control0..1
Typestring
14. Extension.extension:width
Definition

The size to allocate for the column within the table showing the choices.

Control0..1
TypeExtension
Comments

code missing = pixels; code = % = percentage.

15. Extension.extension:width.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
16. Extension.extension:width.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 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.

Control0..*
TypeExtension
Alternate Namesextensions, user content
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.

17. Extension.extension:width.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
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.

Fixed Valuewidth
18. Extension.extension:width.valueQuantity
Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Control0..1
TypeQuantity
19. Extension.extension:forDisplay
Definition

If true, indicates that this column should be used as (or as part of) the display value for the coding or reference once selected. I.e. Coding.display or Reference.display as stored in the QuestionnaireResponse and displayed to the user as the selected answer.

Control0..1
TypeExtension
Comments

For codes, only one column can be picked and it must be a column that corresponds to a legal display name for the code from the value set. For references, multiple columns can be picked. If more than one column is chosen, the Reference.display will contain concatenate the column values in the order defined separating them with a single space.

20. Extension.extension:forDisplay.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
21. Extension.extension:forDisplay.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 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.

Control0..*
TypeExtension
Alternate Namesextensions, user content
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.

22. Extension.extension:forDisplay.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
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.

Fixed ValueforDisplay
23. Extension.extension:forDisplay.valueBoolean
Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Control0..1
Typeboolean
24. Extension.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Typeuri
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.

Fixed Valuehttp://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-choiceColumn
25. Extension.value[x]
Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Control0..0
TypeChoice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage
[x] NoteSee Choice of Data Types for further information about how to use [x]