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.urlelement 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
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  ValueSet | 0..* | |||
 url | S | 0..1 | uri | |
 expansion | S | 1..1 | BackboneElement | |
 contains | S | 0..* | BackboneElement | |
 valueset-ordinalValue | S | 0..1 | decimal | Comparison value for ordinal codes URL: http://hl7.org/fhir/StructureDefinition/valueset-ordinalValue |
| valueset-conceptOrder | S | 0..1 | integer | Appearance order for user selection URL: http://hl7.org/fhir/StructureDefinition/valueset-conceptOrder |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ValueSet | I | 0..* | A set of codes drawn from one or more code systems | |
 id | Σ | 0..1 | id | Logical id of this artifact |
 meta | Σ | 0..1 | Meta | Metadata about the resource |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| language | 0..1 | code | Language of the resource content Binding: Common Languages (extensible) Max Binding: All Languages | |
| text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
 contained | 0..* | Resource | Contained, inline Resources | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| url | SΣ | 0..1 | uri | Logical URI to reference this value set (globally unique) |
| identifier | Σ | 0..* | Identifier | Additional identifier for the value set |
| version | Σ | 0..1 | string | Business version of the value set |
| name | Σ | 0..1 | string | Name for this value set (computer friendly) |
| title | Σ | 0..1 | string | Name for this value set (human friendly) |
| status | ?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required) |
| experimental | ?!Σ | 0..1 | boolean | For testing purposes, not real usage |
| date | Σ | 0..1 | dateTime | Date this was last changed |
| publisher | Σ | 0..1 | string | Name of the publisher (organization or individual) |
| contact | Σ | 0..* | ContactDetail | Contact details for the publisher |
| description | 0..1 | markdown | Natural language description of the value set | |
| useContext | Σ | 0..* | UsageContext | Context the content is intended to support |
| jurisdiction | Σ | 0..* | CodeableConcept | Intended jurisdiction for value set (if applicable) Binding: Jurisdiction ValueSet (extensible) |
| immutable | Σ | 0..1 | boolean | Indicates whether or not any change to the content logical definition may occur |
| purpose | 0..1 | markdown | Why this value set is defined | |
| copyright | 0..1 | markdown | Use and/or publishing restrictions | |
| extensible | Σ | 0..1 | boolean | Whether this is intended to be used with an extensible binding |
| compose | I | 0..1 | BackboneElement | Definition of the content of the value set (CLD) |
 id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| lockedDate | Σ | 0..1 | date | Fixed date for version-less references (transitive) |
| inactive | Σ | 0..1 | boolean | Whether inactive codes are in the value set |
| include | ΣI | 1..* | BackboneElement | Include 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..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| system | ΣI | 0..1 | uri | The system the codes come from |
| version | Σ | 0..1 | string | Specific version of the code system referred to |
| concept | I | 0..* | BackboneElement | A concept defined in the system |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| code | 1..1 | code | Code or expression from system | |
| display | 0..1 | string | Text to display for this code for this value set in this valueset | |
| designation | I | 0..* | BackboneElement | Additional representations for this concept |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| language | 0..1 | code | Human language of the designation Binding: Common Languages (extensible) Max Binding: All Languages | |
| use | 0..1 | Coding | Details how this designation would be used Binding: Designation Use (extensible) | |
| value | 1..1 | string | The text value for this designation | |
| filter | ?!ΣI | 0..* | BackboneElement | Select codes/concepts by their properties (including relationships) |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| property | Σ | 1..1 | code | A property defined by the code system |
| op | Σ | 1..1 | code | = | is-a | descendent-of | is-not-a | regex | in | not-in | generalizes | exists Binding: FilterOperator (required) |
| value | Σ | 1..1 | code | Code from the system, or regex criteria, or boolean value for exists |
| valueSet | ΣI | 0..* | uri | Select only contents included in this value set |
| exclude | I | 0..* | Unknown reference to #ValueSet.compose.include Explicitly exclude codes from a code system or other value sets | |
| expansion | SI | 1..1 | BackboneElement | Used when the value set is "expanded" |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| identifier | 1..1 | uri | Uniquely identifies this expansion | |
| timestamp | 1..1 | dateTime | Time ValueSet expansion happened | |
| total | 0..1 | integer | Total number of codes in the expansion | |
| offset | 0..1 | integer | Offset at which this resource starts | |
| parameter | I | 0..* | BackboneElement | Parameter that controlled the expansion process |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| name | 1..1 | string | Name as assigned by the server | |
 value[x] | 0..1 | string, boolean, integer, decimal, uri, code | Value of the named parameter | |
| contains | SI | 0..* | BackboneElement | Codes in the value set |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| valueset-ordinalValue | SI | 0..1 | decimal | Comparison value for ordinal codes URL: http://hl7.org/fhir/StructureDefinition/valueset-ordinalValue |
| valueset-conceptOrder | SI | 0..1 | integer | Appearance order for user selection URL: http://hl7.org/fhir/StructureDefinition/valueset-conceptOrder |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| system | 0..1 | uri | System value for the code | |
| abstract | 0..1 | boolean | If user cannot select this entry | |
| inactive | 0..1 | boolean | If concept is inactive in the code system | |
| version | 0..1 | string | Version in which this code/display is defined | |
| code | I | 0..1 | code | Code - if blank, this is not a selectable code |
| display | I | 0..1 | string | User 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 | ||
| Documentation for this format | ||||
Differential View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ValueSet | 0..* | |||
| url | S | 0..1 | uri | |
| expansion | S | 1..1 | BackboneElement | |
| contains | S | 0..* | BackboneElement | |
| valueset-ordinalValue | S | 0..1 | decimal | Comparison value for ordinal codes URL: http://hl7.org/fhir/StructureDefinition/valueset-ordinalValue |
| valueset-conceptOrder | S | 0..1 | integer | Appearance order for user selection URL: http://hl7.org/fhir/StructureDefinition/valueset-conceptOrder |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ValueSet | I | 0..* | A set of codes drawn from one or more code systems | |
| id | Σ | 0..1 | id | Logical id of this artifact |
| meta | Σ | 0..1 | Meta | Metadata about the resource |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| language | 0..1 | code | Language of the resource content Binding: Common Languages (extensible) Max Binding: All Languages | |
| text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
| contained | 0..* | Resource | Contained, inline Resources | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| url | SΣ | 0..1 | uri | Logical URI to reference this value set (globally unique) |
| identifier | Σ | 0..* | Identifier | Additional identifier for the value set |
| version | Σ | 0..1 | string | Business version of the value set |
| name | Σ | 0..1 | string | Name for this value set (computer friendly) |
| title | Σ | 0..1 | string | Name for this value set (human friendly) |
| status | ?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required) |
| experimental | ?!Σ | 0..1 | boolean | For testing purposes, not real usage |
| date | Σ | 0..1 | dateTime | Date this was last changed |
| publisher | Σ | 0..1 | string | Name of the publisher (organization or individual) |
| contact | Σ | 0..* | ContactDetail | Contact details for the publisher |
| description | 0..1 | markdown | Natural language description of the value set | |
| useContext | Σ | 0..* | UsageContext | Context the content is intended to support |
| jurisdiction | Σ | 0..* | CodeableConcept | Intended jurisdiction for value set (if applicable) Binding: Jurisdiction ValueSet (extensible) |
| immutable | Σ | 0..1 | boolean | Indicates whether or not any change to the content logical definition may occur |
| purpose | 0..1 | markdown | Why this value set is defined | |
| copyright | 0..1 | markdown | Use and/or publishing restrictions | |
| extensible | Σ | 0..1 | boolean | Whether this is intended to be used with an extensible binding |
| compose | I | 0..1 | BackboneElement | Definition of the content of the value set (CLD) |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| lockedDate | Σ | 0..1 | date | Fixed date for version-less references (transitive) |
| inactive | Σ | 0..1 | boolean | Whether inactive codes are in the value set |
| include | ΣI | 1..* | BackboneElement | Include 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..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| system | ΣI | 0..1 | uri | The system the codes come from |
| version | Σ | 0..1 | string | Specific version of the code system referred to |
| concept | I | 0..* | BackboneElement | A concept defined in the system |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| code | 1..1 | code | Code or expression from system | |
| display | 0..1 | string | Text to display for this code for this value set in this valueset | |
| designation | I | 0..* | BackboneElement | Additional representations for this concept |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| language | 0..1 | code | Human language of the designation Binding: Common Languages (extensible) Max Binding: All Languages | |
| use | 0..1 | Coding | Details how this designation would be used Binding: Designation Use (extensible) | |
| value | 1..1 | string | The text value for this designation | |
| filter | ?!ΣI | 0..* | BackboneElement | Select codes/concepts by their properties (including relationships) |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| property | Σ | 1..1 | code | A property defined by the code system |
| op | Σ | 1..1 | code | = | is-a | descendent-of | is-not-a | regex | in | not-in | generalizes | exists Binding: FilterOperator (required) |
| value | Σ | 1..1 | code | Code from the system, or regex criteria, or boolean value for exists |
| valueSet | ΣI | 0..* | uri | Select only contents included in this value set |
| exclude | I | 0..* | Unknown reference to #ValueSet.compose.include Explicitly exclude codes from a code system or other value sets | |
| expansion | SI | 1..1 | BackboneElement | Used when the value set is "expanded" |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| identifier | 1..1 | uri | Uniquely identifies this expansion | |
| timestamp | 1..1 | dateTime | Time ValueSet expansion happened | |
| total | 0..1 | integer | Total number of codes in the expansion | |
| offset | 0..1 | integer | Offset at which this resource starts | |
| parameter | I | 0..* | BackboneElement | Parameter that controlled the expansion process |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| name | 1..1 | string | Name as assigned by the server | |
| value[x] | 0..1 | string, boolean, integer, decimal, uri, code | Value of the named parameter | |
| contains | SI | 0..* | BackboneElement | Codes in the value set |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| valueset-ordinalValue | SI | 0..1 | decimal | Comparison value for ordinal codes URL: http://hl7.org/fhir/StructureDefinition/valueset-ordinalValue |
| valueset-conceptOrder | SI | 0..1 | integer | Appearance order for user selection URL: http://hl7.org/fhir/StructureDefinition/valueset-conceptOrder |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| system | 0..1 | uri | System value for the code | |
| abstract | 0..1 | boolean | If user cannot select this entry | |
| inactive | 0..1 | boolean | If concept is inactive in the code system | |
| version | 0..1 | string | Version in which this code/display is defined | |
| code | I | 0..1 | code | Code - if blank, this is not a selectable code |
| display | I | 0..1 | string | User 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 | ||
| 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
