STU3 Candidate
TerminologyThis page is part of the FHIR Specification (v1.8.0: STU 3 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 
. Page versions: R5 R4B R4 R3 R2
| (No assigned work group) | Maturity Level: 0 | Context: Any |
The official URL for this profile is:
http://hl7.org/fhir/StructureDefinition/shareablevalueset
Enforces the minimum information set for the value set metadata required by HL7 and other organisations that share and publish value sets
This profile was published on [no date] as a draft by HL7.
Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.
This structure is derived from ValueSet.
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  ValueSet | I | 1..1 | 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) | |
| 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 | ∑ | 1..1 | uri | Logical uri to reference this value set (globally unique) |
| identifier | ∑ | 0..* | Identifier | Additional identifier for the value set |
| version | ∑ | 1..1 | string | Business version of the value set |
| name | ∑ | 1..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 Binding: PublicationStatus (required) |
| experimental | ?!∑ | 1..1 | boolean | If for testing purposes, not real usage |
| publisher | ∑ | 1..1 | string | Name of the publisher (Organization or individual) |
| contact | ∑ | 0..* | ContactDetail | Contact details for the publisher |
| date | ∑ | 0..1 | dateTime | Date this was last changed |
| description | 1..1 | markdown | Natural language description of the value set | |
| useContext | ∑ | 0..* | UsageContext | Content intends to support these contexts |
| 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 | |
 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) | |
| 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 | |
| valueSet | ∑I | 0..* | uri | Select only contents included in this value set |
| exclude | I | 0..* | Unknown reference to #ValueSet:shareablevalueset.compose.include Explicitly exclude codes from a code system or other value sets | |
| expansion | I | 0..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 | I | 0..* | BackboneElement | Codes in the value set vsd-6: SHALL have a code or a display vsd-9: Must have a code if not abstract vsd-10: Must have a system if a code is present |
| 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 | 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:shareablevalueset.compose.include.concept.designation Additional representations for this item | ||
| contains | 0..* | Unknown reference to #ValueSet:shareablevalueset.expansion.contains Codes contained under this entry | ||
| Documentation for this format | ||||
todo
This structure is derived from ValueSet.
Differential View
This structure is derived from ValueSet.
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ValueSet | I | 1..1 | 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) | |
| 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 | ∑ | 1..1 | uri | Logical uri to reference this value set (globally unique) |
| identifier | ∑ | 0..* | Identifier | Additional identifier for the value set |
| version | ∑ | 1..1 | string | Business version of the value set |
| name | ∑ | 1..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 Binding: PublicationStatus (required) |
| experimental | ?!∑ | 1..1 | boolean | If for testing purposes, not real usage |
| publisher | ∑ | 1..1 | string | Name of the publisher (Organization or individual) |
| contact | ∑ | 0..* | ContactDetail | Contact details for the publisher |
| date | ∑ | 0..1 | dateTime | Date this was last changed |
| description | 1..1 | markdown | Natural language description of the value set | |
| useContext | ∑ | 0..* | UsageContext | Content intends to support these contexts |
| 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 | |
| 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) | |
| 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 | |
| valueSet | ∑I | 0..* | uri | Select only contents included in this value set |
| exclude | I | 0..* | Unknown reference to #ValueSet:shareablevalueset.compose.include Explicitly exclude codes from a code system or other value sets | |
| expansion | I | 0..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 | I | 0..* | BackboneElement | Codes in the value set vsd-6: SHALL have a code or a display vsd-9: Must have a code if not abstract vsd-10: Must have a system if a code is present |
| 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 | 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:shareablevalueset.compose.include.concept.designation Additional representations for this item | ||
| contains | 0..* | Unknown reference to #ValueSet:shareablevalueset.expansion.contains Codes contained under this entry | ||
| Documentation for this format | ||||
XML Template
JSON Template
todo
Other representations of profile: Schematron
| Path | Name | Conformance | ValueSet |
| ValueSet.language | Common Languages | extensible | Common Languages |
| ValueSet.status | PublicationStatus | required | PublicationStatus |
| ValueSet.jurisdiction | Jurisdiction ValueSet | extensible | Jurisdiction ValueSet |
| ValueSet.compose.include.concept.designation.language | Common Languages | extensible | Common Languages |
| ValueSet.compose.include.concept.designation.use | Designation Use | extensible | Designation Use |
| ValueSet.compose.include.filter.op | FilterOperator | required | FilterOperator |
| Id | Path | Details | Requirements |
| vsd-2 | ValueSet.compose.include | A value set with concepts or filters SHALL include a system XPath: not(exists(f:concept) or exists(f:filter)) or exists(f:system) | |
| vsd-3 | ValueSet.compose.include | Cannot have both concept and filter XPath: not(exists(f:concept)) or not(exists(f:filter)) | |
| vsd-1 | ValueSet.compose.include | A value set include/exclude SHALL have a value set or a system XPath: exists(f:valueSet) or exists(f:system) | |
| vsd-6 | ValueSet.expansion.contains | SHALL have a code or a display XPath: exists(f:code) or exists(f:display) | |
| vsd-9 | ValueSet.expansion.contains | Must have a code if not abstract XPath: exists(f:code) or (f:abstract/@value = true()) | |
| vsd-10 | ValueSet.expansion.contains | Must have a system if a code is present XPath: exists(f:system) or not(exists(f:code)) |
© HL7.org 2011+. FHIR STU3 Candidate (v1.8.0-10521) generated on Tue, Dec 6, 2016 12:24+1100. QA Page
Links: Search |
Version History |
Table of Contents |
Compare to DSTU2 |
|
Propose a change