{ "resourceType": "StructureDefinition", "id": "expanded-value-set-2", "meta": { "lastUpdated": "2017-06-16T05:18:30.262+00:00" }, "text": { "status": "generated", "div": "

NCTS Expanded Value Set

URL
https://healthterminologies.gov.au/fhir/StructureDefinition/expanded-value-set-2
Base Definition
http://hl7.org/fhir/StructureDefinition/ValueSet
Status
ACTIVE
Publisher
Australian Digital Health Agency
Description
This StructureDefinition describes the NCTS Expanded Value Set, a profile of the FHIR® ValueSet resource. The NCTS Expanded Value Set is designed to describe expansions of value sets published as part of the National Clinical Terminology Service, and maximise interoperability within the NCTS ecosystem.

Elements (Snapshot)

PathCardinalityTypeDefinition
ValueSet0..*A value set specifies a set of codes drawn from one or more code systems.
ValueSet.id0..1 id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
ValueSet.meta0..1 Meta The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource.
ValueSet.implicitRules0..0 uri A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.
ValueSet.language0..1 code The base language in which the resource is written.
ValueSet.text0..1 Narrative A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
ValueSet.contained0..0 Resource These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
ValueSet.extension0..* Extension May be used to represent additional information that is not part of the basic definition of the resource. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
ValueSet.modifierExtension0..0 Extension May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
ValueSet.url0..1 uri An absolute URI that is used to identify this value set when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this value set is (or will be) published. The URL SHOULD include the major version of the value set. For more information see [Technical and Business Versions](resource.html#versions).
ValueSet.identifier0..* Identifier A formal identifier that is used to identify this value set when it is represented in other formats, or referenced in a specification, model, design or an instance.
ValueSet.version0..1 string The identifier that is used to identify this version of the value set when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the value set author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.
ValueSet.name0..1 string A natural language name identifying the value set. This name should be usable as an identifier for the module by machine processing applications such as code generation.
ValueSet.title0..1 string A short, descriptive, user-friendly title for the value set.
ValueSet.status1..1 code The status of this value set. Enables tracking the life-cycle of the content.
ValueSet.experimental0..1 boolean A boolean value to indicate that this value set is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.
ValueSet.date0..1 dateTime The date (and optionally time) when the value set was published. The date must change if and when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the value set changes. (e.g. the 'content logical definition').
ValueSet.publisher0..1 string The name of the individual or organization that published the value set.
ValueSet.contact0..* ContactDetail Contact details to assist a user in finding and communicating with the publisher.
ValueSet.description0..1 markdown A free text natural language description of the value set from a consumer's perspective.
ValueSet.useContext0..* UsageContext The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching for appropriate value set instances.
ValueSet.jurisdiction0..* CodeableConcept A legal or geographic region in which the value set is intended to be used.
ValueSet.immutable0..1 boolean If this is set to 'true', then no new versions of the content logical definition can be created. Note: Other metadata might still change.
ValueSet.purpose0..1 markdown Explaination of why this value set is needed and why it has been designed as it has.
ValueSet.copyright0..1 markdown A copyright statement relating to the value set and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the value set.
ValueSet.extensible0..1 boolean Whether this is intended to be used with an extensible binding or not.
ValueSet.compose0..1 BackboneElement A set of criteria that define the content logical definition of the value set by including or excluding codes from outside this value set. This I also known as the "Content Logical Definition" (CLD).
ValueSet.compose.id0..1 string unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
ValueSet.compose.extension0..* Extension May be used to represent additional information that is not part of the basic definition of the element. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
ValueSet.compose.modifierExtension0..* Extension May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
ValueSet.compose.lockedDate0..1 date If a locked date is defined, then the Content Logical Definition must be evaluated using the current version as of the locked date for referenced code system(s) and value set instances where ValueSet.compose.include.version is not defined.
ValueSet.compose.inactive0..1 boolean Whether inactive codes - codes that are not approved for current use - are in the value set. If inactive = true, inactive codes are to be included in the expansion, if inactive = false, the inactive codes will not be included in the expansion. If absent, the behavior is determined by the implementation, or by the applicable ExpansionProfile (but generally, inactive codes would be expected to be included).
ValueSet.compose.include1..* BackboneElement Include one or more codes from a code system or other value set(s).
ValueSet.compose.include.id0..1 string unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
ValueSet.compose.include.extension0..* Extension May be used to represent additional information that is not part of the basic definition of the element. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
ValueSet.compose.include.modifierExtension0..* Extension May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
ValueSet.compose.include.system0..1 uri An absolute URI which is the code system from which the selected codes come from.
ValueSet.compose.include.version0..1 string The version of the code system that the codes are selected from.
ValueSet.compose.include.concept0..* BackboneElement Specifies a concept to be included or excluded.
ValueSet.compose.include.concept.id0..1 string unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
ValueSet.compose.include.concept.extension0..* Extension May be used to represent additional information that is not part of the basic definition of the element. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
ValueSet.compose.include.concept.modifierExtension0..* Extension May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
ValueSet.compose.include.concept.code1..1 code Specifies a code for the concept to be included or excluded.
ValueSet.compose.include.concept.display0..1 string The text to display to the user for this concept in the context of this valueset. If no display is provided, then applications using the value set use the display specified for the code by the system.
ValueSet.compose.include.concept.designation0..* BackboneElement Additional representations for this concept when used in this value set - other languages, aliases, specialized purposes, used for particular purposes, etc.
ValueSet.compose.include.concept.designation.id0..1 string unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
ValueSet.compose.include.concept.designation.extension0..* Extension May be used to represent additional information that is not part of the basic definition of the element. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
ValueSet.compose.include.concept.designation.modifierExtension0..* Extension May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
ValueSet.compose.include.concept.designation.language0..1 code The language this designation is defined for.
ValueSet.compose.include.concept.designation.use0..1 Coding A code that details how this designation would be used.
ValueSet.compose.include.concept.designation.value1..1 string The text value for this designation.
ValueSet.compose.include.filter0..* BackboneElement Select concepts by specify a matching criteria based on the properties (including relationships) defined by the system. If multiple filters are specified, they SHALL all be true.
ValueSet.compose.include.filter.id0..1 string unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
ValueSet.compose.include.filter.extension0..* Extension May be used to represent additional information that is not part of the basic definition of the element. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
ValueSet.compose.include.filter.modifierExtension0..* Extension May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
ValueSet.compose.include.filter.property1..1 code A code that identifies a property defined in the code system.
ValueSet.compose.include.filter.op1..1 code The kind of operation to perform as a part of the filter criteria.
ValueSet.compose.include.filter.value1..1 code The match value may be either a code defined by the system, or a string value, which is a regex match on the literal string of the property value when the operation is 'regex', or one of the values (true and false), when the operation is 'exists'.
ValueSet.compose.include.valueSet0..* uri Selects concepts found in this value set. This is an absolute URI that is a reference to ValueSet.url.
ValueSet.compose.exclude0..* see ValueSet.compose.include Exclude one or more codes from the value set based on code system filters and/or other value sets.
ValueSet.expansion1..1 BackboneElement A value set can also be "expanded", where the value set is turned into a simple collection of enumerated codes. This element holds the expansion, if it has been performed.
ValueSet.expansion.id0..1 string unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
ValueSet.expansion.extension0..* Extension May be used to represent additional information that is not part of the basic definition of the element. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
ValueSet.expansion.modifierExtension0..* Extension May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
ValueSet.expansion.identifier1..1 uri An identifier that uniquely identifies this expansion of the valueset. Systems may re-use the same identifier as long as the expansion and the definition remain the same, but are not required to do so.
ValueSet.expansion.timestamp1..1 dateTime The time at which the expansion was produced by the expanding system.
ValueSet.expansion.total1..1 integer The total number of concepts in the expansion. If the number of concept nodes in this resource is less than the stated number, then the server can return more using the offset parameter.
ValueSet.expansion.offset0..1 integer If paging is being used, the offset at which this resource starts. I.e. this resource is a partial view into the expansion. If paging is not being used, this element SHALL not be present.
ValueSet.expansion.parameter1..* BackboneElement A parameter that controlled the expansion process. These parameters may be used by users of expanded value sets to check whether the expansion is suitable for a particular purpose, or to pick the correct expansion.
ValueSet.expansion.parameter.id0..1 string unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
ValueSet.expansion.parameter.extension0..* Extension May be used to represent additional information that is not part of the basic definition of the element. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
ValueSet.expansion.parameter.modifierExtension0..* Extension May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
ValueSet.expansion.parameter.name1..1 string The name of the parameter.
ValueSet.expansion.parameter.value[x]1..1 [ string | boolean | integer | decimal | uri | code ] The value of the parameter.
ValueSet.expansion.contains0..* BackboneElement The codes that are contained in the value set expansion.
ValueSet.expansion.contains.id0..1 string unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
ValueSet.expansion.contains.extension0..* Extension May be used to represent additional information that is not part of the basic definition of the element. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
ValueSet.expansion.contains.modifierExtension0..* Extension May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
ValueSet.expansion.contains.system1..1 uri An absolute URI which is the code system in which the code for this item in the expansion is defined.
ValueSet.expansion.contains.abstract0..1 boolean If true, this entry is included in the expansion for navigational purposes, and the user cannot select the code directly as a proper value.
ValueSet.expansion.contains.inactive0..1 boolean If the concept is inactive in the code system that defines it. Inactive codes are those that are no longer to be used, but are maintained by the code system for understanding legacy data.
ValueSet.expansion.contains.version0..1 string The version of this code system that defined this code and/or display. This should only be used with code systems that do not enforce concept permanence.
ValueSet.expansion.contains.code1..1 code The code for this item in the expansion hierarchy. If this code is missing the entry in the hierarchy is a place holder (abstract) and does not represent a valid code in the value set.
ValueSet.expansion.contains.display1..1 string The recommended display for this item in the expansion.
ValueSet.expansion.contains.designation0..* see ValueSet.compose.include.concept.designation Additional representations for this item - other languages, aliases, specialized purposes, used for particular purposes, etc. These are relevant when the conditions of the expansion do not fix to a single correct representation.
ValueSet.expansion.contains.contains0..* see ValueSet.expansion.contains Other codes and entries contained under this entry in the hierarchy.
" }, "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg", "valueCode": "vocab" } ], "url": "https://healthterminologies.gov.au/fhir/StructureDefinition/expanded-value-set-2", "version": "2.0.0", "name": "NCTS Expanded Value Set", "title": "NCTS Expanded Value Set", "status": "active", "date": "2017-10-13", "publisher": "Australian Digital Health Agency", "description": "This StructureDefinition describes the NCTS Expanded Value Set, a profile of the FHIR® ValueSet resource. The NCTS Expanded Value Set is designed to describe expansions of value sets published as part of the National Clinical Terminology Service, and maximise interoperability within the NCTS ecosystem.", "purpose": "The purpose of this profile is to codify a set of general best practices with respect to representing value set expansions in FHIR.", "fhirVersion": "3.0.1", "mapping": [ { "identity": "rim", "uri": "http://hl7.org/v3", "name": "RIM Mapping" }, { "identity": "w5", "uri": "http://hl7.org/fhir/w5", "name": "W5 Mapping" }, { "identity": "define.xml2.0", "uri": "http://www.cdisc.org/define-xml", "name": "CDISC Define XML 2.0 metadata standard" }, { "identity": "objimpl", "uri": "http://hl7.org/fhir/object-implementation", "name": "Object Implementation Information" } ], "kind": "resource", "abstract": false, "type": "ValueSet", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/ValueSet", "derivation": "constraint", "differential": { "element": [ { "id": "ValueSet.implicitRules", "path": "ValueSet.implicitRules", "definition": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.", "max": "0" }, { "id": "ValueSet.contained", "path": "ValueSet.contained", "definition": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", "max": "0" }, { "id": "ValueSet.expansion", "path": "ValueSet.expansion", "definition": "A value set can also be \"expanded\", where the value set is turned into a simple collection of enumerated codes. This element holds the expansion, if it has been performed.", "min": 1 }, { "id": "ValueSet.expansion.total", "path": "ValueSet.expansion.total", "definition": "The total number of concepts in the expansion. If the number of concept nodes in this resource is less than the stated number, then the server can return more using the offset parameter.", "min": 1 }, { "id": "ValueSet.expansion.parameter", "path": "ValueSet.expansion.parameter", "definition": "A parameter that controlled the expansion process. These parameters may be used by users of expanded value sets to check whether the expansion is suitable for a particular purpose, or to pick the correct expansion.", "min": 1 }, { "id": "ValueSet.expansion.parameter.value[x]", "path": "ValueSet.expansion.parameter.value[x]", "definition": "The value of the parameter.", "min": 1 }, { "id": "ValueSet.expansion.contains.system", "path": "ValueSet.expansion.contains.system", "definition": "An absolute URI which is the code system in which the code for this item in the expansion is defined.", "min": 1 }, { "id": "ValueSet.expansion.contains.code", "path": "ValueSet.expansion.contains.code", "definition": "The code for this item in the expansion hierarchy. If this code is missing the entry in the hierarchy is a place holder (abstract) and does not represent a valid code in the value set.", "min": 1 }, { "id": "ValueSet.expansion.contains.display", "path": "ValueSet.expansion.contains.display", "definition": "The recommended display for this item in the expansion.", "min": 1 }, { "id": "ValueSet.modifierExtension", "path": "ValueSet.modifierExtension", "definition": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.", "max": "0" } ] } }