2nd DSTU Draft For Comment

This page is part of the FHIR Specification (v0.4.0: DSTU 2 Draft). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

Valueset.questionnaire

This is an example form generated from the questionnaire. See also the XML or JSON format.

Valueset.questionnaire - FHIR v0.4.0 Form
2nd DSTU Draft For Comment

This is an example form generated from the questionnaire. See also the XML or JSON format

A set of codes drawn from one or more code systems

ValueSet
ValueSet.id
ValueSet.id.value Logical id of this artefact
ValueSet.id 1

Metadata about the resource

ValueSet.meta
ValueSet.meta 1
ValueSet.implicitRules
ValueSet.implicitRules.value A set of rules under which this content was created
ValueSet.implicitRules 1
ValueSet.language
ValueSet.language.value language
ValueSet.language 1

Text summary of the resource, for human interpretation

ValueSet.text
ValueSet.text 1

Contained, inline Resources

ValueSet.contained
ValueSet.contained 1
ValueSet.url
ValueSet.url.value Globally unique logical id for value set
ValueSet.url 1

Additional identifier for the value set (v2 / CDA)

ValueSet.identifier
ValueSet.identifier.label label:
ValueSet.identifier.system system:
ValueSet.identifier.value value:
ValueSet.identifier 1
ValueSet.version
ValueSet.version.value Logical id for this version of the value set
ValueSet.version 1
ValueSet.name
ValueSet.name.value Informal name for this value set
ValueSet.name 1
ValueSet.immutable
ValueSet.immutable.value Indicates whether or not any change to the content logical definition may occur
ValueSet.immutable 1
ValueSet.publisher
ValueSet.publisher.value Name of the publisher (Organization or individual)
ValueSet.publisher 1

Contact details of the publisher

May be a web site, an email address, a telephone number (tel:), etc.

ValueSet.contact
ValueSet.contact.id
ValueSet.contact.id.value xml:id (or equivalent in JSON)
ValueSet.contact.id 1
ValueSet.contact.name
ValueSet.contact.name.value Name of a individual to contact
ValueSet.contact.name 1

Contact details for individual or publisher

ValueSet.contact.telecom
ValueSet.contact.telecom.system type:
ValueSet.contact.telecom.value value:
ValueSet.contact.telecom.use use:
ValueSet.contact.telecom 1
ValueSet.contact 1
ValueSet.description
ValueSet.description.value Human language description of the value set
ValueSet.description 1
ValueSet.requirements
ValueSet.requirements.value Why is this needed?
ValueSet.requirements 1
ValueSet.copyright
ValueSet.copyright.value Use and/or Publishing restrictions
ValueSet.copyright 1
ValueSet.status
ValueSet.status.value status
ValueSet.status 1
ValueSet.experimental
ValueSet.experimental.value If for testing purposes, not real usage
ValueSet.experimental 1
ValueSet.extensible
ValueSet.extensible.value Whether this is intended to be used with an extensible binding
ValueSet.extensible 1
ValueSet.date
ValueSet.date.value Date for given status
ValueSet.date 1
ValueSet.stableDate
ValueSet.stableDate.value Fixed date for the version of all referenced code systems and value sets
ValueSet.stableDate 1

When value set defines its own codes

ValueSet.define
ValueSet.define.id
ValueSet.define.id.value xml:id (or equivalent in JSON)
ValueSet.define.id 1
ValueSet.define.system
ValueSet.define.system.value URI to identify the code system
ValueSet.define.system 1
ValueSet.define.version
ValueSet.define.version.value Version of this system
ValueSet.define.version 1
ValueSet.define.caseSensitive
ValueSet.define.caseSensitive.value If code comparison is case sensitive
ValueSet.define.caseSensitive 1

Concepts in the code system

ValueSet.define.concept
ValueSet.define.concept.id
ValueSet.define.concept.id.value xml:id (or equivalent in JSON)
ValueSet.define.concept.id 1
ValueSet.define.concept.code
ValueSet.define.concept.code.value code
ValueSet.define.concept.code 1
ValueSet.define.concept.abstract
ValueSet.define.concept.abstract.value If this code is not for use as a real concept
ValueSet.define.concept.abstract 1
ValueSet.define.concept.display
ValueSet.define.concept.display.value Text to Display to the user
ValueSet.define.concept.display 1
ValueSet.define.concept.definition
ValueSet.define.concept.definition.value Formal Definition
ValueSet.define.concept.definition 1

Additional representations for the concept

ValueSet.define.concept.designation
ValueSet.define.concept.designation.id
ValueSet.define.concept.designation.id.value xml:id (or equivalent in JSON)
ValueSet.define.concept.designation.id 1
ValueSet.define.concept.designation.language
ValueSet.define.concept.designation.language.value language
ValueSet.define.concept.designation.language 1
ValueSet.define.concept.designation.use
ValueSet.define.concept.designation.use.value Details how this designation would be used
ValueSet.define.concept.designation.use 1
ValueSet.define.concept.designation.value
ValueSet.define.concept.designation.value.value The text value for this designation
ValueSet.define.concept.designation.value 1
ValueSet.define.concept.designation 1

Child Concepts (is-a / contains)

ValueSet.define.concept.concept
ValueSet.define.concept.concept 1
ValueSet.define.concept 1
ValueSet.define 1

When value set includes codes from elsewhere

ValueSet.compose
ValueSet.compose.id
ValueSet.compose.id.value xml:id (or equivalent in JSON)
ValueSet.compose.id 1
ValueSet.compose.import
ValueSet.compose.import.value Import the contents of another value set
ValueSet.compose.import 1

Include one or more codes from a code system

If there are no codes or filters, the entire code system is included. Note that the set of codes hat are included may contain abstract codes.

ValueSet.compose.include
ValueSet.compose.include.id
ValueSet.compose.include.id.value xml:id (or equivalent in JSON)
ValueSet.compose.include.id 1
ValueSet.compose.include.system
ValueSet.compose.include.system.value The system the codes come from
ValueSet.compose.include.system 1
ValueSet.compose.include.version
ValueSet.compose.include.version.value Specific version of the code system referred to
ValueSet.compose.include.version 1

A concept defined in the system

The list of concepts is considered ordered, though the order may not have any particular significance. Typically, the order an an expansion follows that defined in the compose.

ValueSet.compose.include.concept
ValueSet.compose.include.concept.id
ValueSet.compose.include.concept.id.value xml:id (or equivalent in JSON)
ValueSet.compose.include.concept.id 1
ValueSet.compose.include.concept.code
ValueSet.compose.include.concept.code.value code
ValueSet.compose.include.concept.code 1
ValueSet.compose.include.concept.display
ValueSet.compose.include.concept.display.value Test to display for this code for this value set
ValueSet.compose.include.concept.display 1
Additional representations for this valueset
ValueSet.compose.include.concept.designation
ValueSet.compose.include.concept.designation 1
ValueSet.compose.include.concept 1

Select codes/concepts by their properties (including relationships)

Selecting codes by specifying filters based on properties is only possible where the underlying code system defines appropriate properties. Note that in some cases, the underlying code system defines the logical concepts but not the literal codes for the concepts. In such cases, the literal definitions may be provided by a third party.

ValueSet.compose.include.filter
ValueSet.compose.include.filter.id
ValueSet.compose.include.filter.id.value xml:id (or equivalent in JSON)
ValueSet.compose.include.filter.id 1
ValueSet.compose.include.filter.property
ValueSet.compose.include.filter.property.value property
ValueSet.compose.include.filter.property 1
ValueSet.compose.include.filter.op
ValueSet.compose.include.filter.op.value op
ValueSet.compose.include.filter.op 1
ValueSet.compose.include.filter.value
ValueSet.compose.include.filter.value.value value
ValueSet.compose.include.filter.value 1
ValueSet.compose.include.filter 1
ValueSet.compose.include 1

Explicitly exclude codes

Usually this is used to selectively exclude codes that were included by subsumption in the inclusions. Any display names specified for the codes are ignored.

ValueSet.compose.exclude
ValueSet.compose.exclude 1
ValueSet.compose 1

Used when the value set is "expanded"

Expansion is performed to produce a collection of codes that are ready to use for data entry or validation.

ValueSet.expansion
ValueSet.expansion.id
ValueSet.expansion.id.value xml:id (or equivalent in JSON)
ValueSet.expansion.id 1

Uniquely identifies this expansion

ValueSet.expansion.identifier
ValueSet.expansion.identifier.label label:
ValueSet.expansion.identifier.system system:
ValueSet.expansion.identifier.value value:
ValueSet.expansion.identifier 1
ValueSet.expansion.timestamp
ValueSet.expansion.timestamp.value Time valueset expansion happened
ValueSet.expansion.timestamp 1

Codes in the value set

ValueSet.expansion.contains
ValueSet.expansion.contains.id
ValueSet.expansion.contains.id.value xml:id (or equivalent in JSON)
ValueSet.expansion.contains.id 1
ValueSet.expansion.contains.system
ValueSet.expansion.contains.system.value System value for the code
ValueSet.expansion.contains.system 1
ValueSet.expansion.contains.abstract
ValueSet.expansion.contains.abstract.value If user cannot select this entry
ValueSet.expansion.contains.abstract 1
ValueSet.expansion.contains.version
ValueSet.expansion.contains.version.value Version in which this code / display is defined
ValueSet.expansion.contains.version 1
ValueSet.expansion.contains.code
ValueSet.expansion.contains.code.value code
ValueSet.expansion.contains.code 1
ValueSet.expansion.contains.display
ValueSet.expansion.contains.display.value User display for the concept
ValueSet.expansion.contains.display 1

Codes contained in this concept

ValueSet.expansion.contains.contains
ValueSet.expansion.contains.contains 1
ValueSet.expansion.contains 1
ValueSet.expansion 1
ValueSet 1