Argonaut Questionnaire Implementation Guide (Release 1.0.0 )

This page is part of the Argonaut Questionnaire Implementation Guide (v1.0.0: Release) based on FHIR R3. This is the current published version in it's permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

StructureDefinition-argo-questionnaire-valueset

The Argonaut Questionnaire Contained ValueSet Profile is contained within the Argonaut Questionnaire Profile:

  • It requires an expansion of the code set to constrains the concepts to particular set of conditions for a given questionnaire.

  • The ValueSet Ordinal Value Extension is added as a Must Support element to support the calculation of scores from the associated assessments.

  • The ValueSet.url element is constrained to a Must Support element to provide an alternative literal address at which this value set is (or will be) published.

Formal Views of Profile Content

Description of Profiles, Differentials, and Snapshots.

The official URL for this profile is: http://fhir.org/guides/argonaut/questionnaire/StructureDefinition/argo-questionnaire-valueset

Published on Wed May 30 00:00:00 AEST 2018 as active by the Argonaut Project.

This profile builds on ValueSet


Summary

Mandatory: 1 element
Must-Support: 5 elements

Extensions

This structure refers to these extensions:

NameFlagsCard.TypeDescription & Constraintsdoco
.. ValueSet I0..*A set of codes drawn from one or more code systems
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
Max Binding: All Languages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... url SΣ0..1uriLogical URI to reference this value set (globally unique)
... identifier Σ0..*IdentifierAdditional identifier for the value set
... version Σ0..1stringBusiness version of the value set
... name Σ0..1stringName for this value set (computer friendly)
... title Σ0..1stringName for this value set (human friendly)
... status ?!Σ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required)
... experimental ?!Σ0..1booleanFor testing purposes, not real usage
... date Σ0..1dateTimeDate this was last changed
... publisher Σ0..1stringName of the publisher (organization or individual)
... contact Σ0..*ContactDetailContact details for the publisher
... description 0..1markdownNatural language description of the value set
... useContext Σ0..*UsageContextContext the content is intended to support
... jurisdiction Σ0..*CodeableConceptIntended jurisdiction for value set (if applicable)
Binding: Jurisdiction ValueSet (extensible)
... immutable Σ0..1booleanIndicates whether or not any change to the content logical definition may occur
... purpose 0..1markdownWhy this value set is defined
... copyright 0..1markdownUse and/or publishing restrictions
... extensible Σ0..1booleanWhether this is intended to be used with an extensible binding
... compose I0..1BackboneElementDefinition of the content of the value set (CLD)
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... lockedDate Σ0..1dateFixed date for version-less references (transitive)
.... inactive Σ0..1booleanWhether inactive codes are in the value set
.... include ΣI1..*BackboneElementInclude one or more codes from a code system or other value set(s)
vsd-2: A value set with concepts or filters SHALL include a system
vsd-3: Cannot have both concept and filter
vsd-1: A value set include/exclude SHALL have a value set or a system
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
..... system ΣI0..1uriThe system the codes come from
..... version Σ0..1stringSpecific version of the code system referred to
..... concept I0..*BackboneElementA concept defined in the system
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
...... code 1..1codeCode or expression from system
...... display 0..1stringText to display for this code for this value set in this valueset
...... designation I0..*BackboneElementAdditional representations for this concept
....... id 0..1stringxml:id (or equivalent in JSON)
....... extension 0..*ExtensionAdditional Content defined by implementations
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
....... language 0..1codeHuman language of the designation
Binding: Common Languages (extensible)
Max Binding: All Languages
....... use 0..1CodingDetails how this designation would be used
Binding: Designation Use (extensible)
....... value 1..1stringThe text value for this designation
..... filter ?!ΣI0..*BackboneElementSelect codes/concepts by their properties (including relationships)
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
...... property Σ1..1codeA property defined by the code system
...... op Σ1..1code= | is-a | descendent-of | is-not-a | regex | in | not-in | generalizes | exists
Binding: FilterOperator (required)
...... value Σ1..1codeCode from the system, or regex criteria, or boolean value for exists
..... valueSet ΣI0..*uriSelect only contents included in this value set
.... exclude I0..*Unknown reference to #ValueSet.compose.include
Explicitly exclude codes from a code system or other value sets
... expansion SI1..1BackboneElementUsed when the value set is "expanded"
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... identifier 1..1uriUniquely identifies this expansion
.... timestamp 1..1dateTimeTime ValueSet expansion happened
.... total 0..1integerTotal number of codes in the expansion
.... offset 0..1integerOffset at which this resource starts
.... parameter I0..*BackboneElementParameter that controlled the expansion process
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
..... name 1..1stringName as assigned by the server
..... value[x] 0..1string, boolean, integer, decimal, uri, codeValue of the named parameter
.... contains SI0..*BackboneElementCodes in the value set
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... valueset-ordinalValue SI0..1decimalComparison value for ordinal codes
URL: http://hl7.org/fhir/StructureDefinition/valueset-ordinalValue
..... valueset-conceptOrder SI0..1integerAppearance order for user selection
URL: http://hl7.org/fhir/StructureDefinition/valueset-conceptOrder
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
..... system 0..1uriSystem value for the code
..... abstract 0..1booleanIf user cannot select this entry
..... inactive 0..1booleanIf concept is inactive in the code system
..... version 0..1stringVersion in which this code/display is defined
..... code I0..1codeCode - if blank, this is not a selectable code
..... display I0..1stringUser display for the concept
..... designation 0..*Unknown reference to #ValueSet.compose.include.concept.designation
Additional representations for this item
..... contains 0..*Unknown reference to #ValueSet.expansion.contains
Codes contained under this entry

doco Documentation for this format

Summary

Mandatory: 1 element
Must-Support: 5 elements

Extensions

This structure refers to these extensions:

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ValueSet I0..*A set of codes drawn from one or more code systems
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
Max Binding: All Languages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... url SΣ0..1uriLogical URI to reference this value set (globally unique)
... identifier Σ0..*IdentifierAdditional identifier for the value set
... version Σ0..1stringBusiness version of the value set
... name Σ0..1stringName for this value set (computer friendly)
... title Σ0..1stringName for this value set (human friendly)
... status ?!Σ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required)
... experimental ?!Σ0..1booleanFor testing purposes, not real usage
... date Σ0..1dateTimeDate this was last changed
... publisher Σ0..1stringName of the publisher (organization or individual)
... contact Σ0..*ContactDetailContact details for the publisher
... description 0..1markdownNatural language description of the value set
... useContext Σ0..*UsageContextContext the content is intended to support
... jurisdiction Σ0..*CodeableConceptIntended jurisdiction for value set (if applicable)
Binding: Jurisdiction ValueSet (extensible)
... immutable Σ0..1booleanIndicates whether or not any change to the content logical definition may occur
... purpose 0..1markdownWhy this value set is defined
... copyright 0..1markdownUse and/or publishing restrictions
... extensible Σ0..1booleanWhether this is intended to be used with an extensible binding
... compose I0..1BackboneElementDefinition of the content of the value set (CLD)
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... lockedDate Σ0..1dateFixed date for version-less references (transitive)
.... inactive Σ0..1booleanWhether inactive codes are in the value set
.... include ΣI1..*BackboneElementInclude one or more codes from a code system or other value set(s)
vsd-2: A value set with concepts or filters SHALL include a system
vsd-3: Cannot have both concept and filter
vsd-1: A value set include/exclude SHALL have a value set or a system
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
..... system ΣI0..1uriThe system the codes come from
..... version Σ0..1stringSpecific version of the code system referred to
..... concept I0..*BackboneElementA concept defined in the system
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
...... code 1..1codeCode or expression from system
...... display 0..1stringText to display for this code for this value set in this valueset
...... designation I0..*BackboneElementAdditional representations for this concept
....... id 0..1stringxml:id (or equivalent in JSON)
....... extension 0..*ExtensionAdditional Content defined by implementations
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
....... language 0..1codeHuman language of the designation
Binding: Common Languages (extensible)
Max Binding: All Languages
....... use 0..1CodingDetails how this designation would be used
Binding: Designation Use (extensible)
....... value 1..1stringThe text value for this designation
..... filter ?!ΣI0..*BackboneElementSelect codes/concepts by their properties (including relationships)
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
...... property Σ1..1codeA property defined by the code system
...... op Σ1..1code= | is-a | descendent-of | is-not-a | regex | in | not-in | generalizes | exists
Binding: FilterOperator (required)
...... value Σ1..1codeCode from the system, or regex criteria, or boolean value for exists
..... valueSet ΣI0..*uriSelect only contents included in this value set
.... exclude I0..*Unknown reference to #ValueSet.compose.include
Explicitly exclude codes from a code system or other value sets
... expansion SI1..1BackboneElementUsed when the value set is "expanded"
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... identifier 1..1uriUniquely identifies this expansion
.... timestamp 1..1dateTimeTime ValueSet expansion happened
.... total 0..1integerTotal number of codes in the expansion
.... offset 0..1integerOffset at which this resource starts
.... parameter I0..*BackboneElementParameter that controlled the expansion process
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
..... name 1..1stringName as assigned by the server
..... value[x] 0..1string, boolean, integer, decimal, uri, codeValue of the named parameter
.... contains SI0..*BackboneElementCodes in the value set
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... valueset-ordinalValue SI0..1decimalComparison value for ordinal codes
URL: http://hl7.org/fhir/StructureDefinition/valueset-ordinalValue
..... valueset-conceptOrder SI0..1integerAppearance order for user selection
URL: http://hl7.org/fhir/StructureDefinition/valueset-conceptOrder
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
..... system 0..1uriSystem value for the code
..... abstract 0..1booleanIf user cannot select this entry
..... inactive 0..1booleanIf concept is inactive in the code system
..... version 0..1stringVersion in which this code/display is defined
..... code I0..1codeCode - if blank, this is not a selectable code
..... display I0..1stringUser display for the concept
..... designation 0..*Unknown reference to #ValueSet.compose.include.concept.designation
Additional representations for this item
..... contains 0..*Unknown reference to #ValueSet.expansion.contains
Codes contained under this entry

doco Documentation for this format

Downloads: StructureDefinition: (XML, JSON), Schema: XML Schematron


Quick Start

Below is an overview of the required set of RESTful FHIR interactions - for example, search and read operations - for this profile. See the Conformance requirements for a complete list of supported RESTful interactions for this IG.

See the Argonaut Questionnaire Profile Quick Start