Data Model Libraries
    Preparing search index...

    Class ValueSetExpansionComponent

    ValueSetExpansionComponent Class

    FHIR Specification

    • Short: Used when the value set is "expanded"
    • 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.
    • Comment: Expansion is performed to produce a collection of codes that are ready to use for data entry or validation. Value set expansions are always considered to be stateless - they are a record of the set of codes in the value set at a point in time under a given set of conditions, and are not subject to ongoing maintenance. Expansion.parameter is a simplified list of parameters - a subset of the features of the Parameters resource.

    FHIR ValueSet

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    identifier? next? timestamp total? offset? parameter? property? contains?

    Methods

    parse getIdentifierElement setIdentifierElement hasIdentifierElement getIdentifier setIdentifier hasIdentifier getNextElement setNextElement hasNextElement getNext setNext hasNext getTimestampElement setTimestampElement hasTimestampElement getTimestamp setTimestamp hasTimestamp getTotalElement setTotalElement hasTotalElement getTotal setTotal hasTotal getOffsetElement setOffsetElement hasOffsetElement getOffset setOffset hasOffset getParameter setParameter addParameter hasParameter getProperty setProperty addProperty hasProperty getContains setContains addContains hasContains fhirType isEmpty isRequiredFieldsEmpty copy toJSON getModifierExtension setModifierExtension hasModifierExtension getModifierExtensionByUrl addModifierExtension removeModifierExtension getId setId hasId getExtension setExtension hasExtension getExtensionByUrl addExtension removeExtension isResource isDataType isComplexDataType isPrimitive isBooleanPrimitive isStringPrimitive isNumberPrimitive isBigIntPrimitive isDateTimePrimitive copyValues initParameter initProperty initContains

    Constructors

    Properties

    identifier?: UriType

    ValueSet.expansion.identifier Element

    FHIR Specification

    • Short: Identifies the value set expansion (business identifier)
    • Definition: An identifier that uniquely identifies this expansion of the valueset, based on a unique combination of the provided parameters, the system default parameters, and the underlying system code system versions etc. Systems may re-use the same identifier as long as those factors remain the same, and the expansion is the same, but are not required to do so. This is a business identifier.
    • Comment: Typically, this uri is a UUID (e.g. urn:uuid:8230ff20-c97a-4167-a59d-dc2cb9df16dd).
    • FHIR Type: uri
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    next?: UriType

    ValueSet.expansion.next Element

    FHIR Specification

    • Short: Opaque urls for paging through expansion results
    • Definition: As per paging Search results, the next URLs are opaque to the client, have no dictated structure, and only the server understands them.
    • Comment: Clients SHOULD use the next link, if present, to page through expansion results in preference to using the offset and count parameters. Due to the optional nature of the next link, its absence does not necessarily indicate that it is the last page of results. Instead, as the offset and count parameters SHALL be populated when paging, clients can reliably use the count/offset parameters to determine whether the whole expansion is returned.
    • FHIR Type: uri
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    timestamp: null | DateTimeType

    ValueSet.expansion.timestamp Element

    FHIR Specification

    • Short: Time ValueSet expansion happened
    • Definition: The time at which the expansion was produced by the expanding system.
    • Comment: This SHOULD be a fully populated instant, but in some circumstances, value sets are expanded by hand, and the expansion is published without that precision.
    • FHIR Type: dateTime
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: false
    total?: IntegerType

    ValueSet.expansion.total Element

    FHIR Specification

    • Short: Total number of codes in the expansion
    • 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.
    • Comment: Paging only applies to flat expansions.
    • FHIR Type: integer
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    offset?: IntegerType

    ValueSet.expansion.offset Element

    FHIR Specification

    • Short: Offset at which this resource starts
    • Definition: 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.
    • Comment: Paging only applies to flat expansions. If a filter is applied, the count is the number of concepts that matched the filter, not the number of concepts in an unfiltered view of the expansion.
    • FHIR Type: integer
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    parameter?: ValueSetExpansionParameterComponent[]

    ValueSet.expansion.parameter Element

    FHIR Specification

    • Short: Parameter that controlled the expansion process
    • 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.
    • Comment: The server decides which parameters to include here, but at a minimum, the list SHOULD include all of the parameters that affect the $expand operation. If the expansion will be persisted all of these parameters SHALL be included. If the codeSystem on the server has a specified version then this version SHALL be provided as a parameter in the expansion (note that not all code systems have a version).
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    property?: ValueSetExpansionPropertyComponent[]

    ValueSet.expansion.property Element

    FHIR Specification

    • Short: Additional information supplied about each concept
    • Definition: A property defines an additional slot through which additional information can be provided about a concept.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    contains?: ValueSetExpansionContainsComponent[]

    ValueSet.expansion.contains Element

    FHIR Specification

    • Short: Codes in the value set
    • Definition: The codes that are contained in the value set expansion.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    Methods

    • Parse the provided ValueSetExpansionComponent JSON to instantiate the ValueSetExpansionComponent data model.

      Parameters

      • sourceJson: Value

        JSON representing FHIR ValueSetExpansionComponent

      • OptionaloptSourceField: string

        Optional data source field (e.g. <complexTypeName>.<complexTypeFieldName>); defaults to ValueSetExpansionComponent

      Returns undefined | ValueSetExpansionComponent

      ValueSetExpansionComponent data model or undefined for ValueSetExpansionComponent

      JsonError if the provided JSON is not a valid JSON object

    • Determines if the modifierExtension property exists.

      Parameters

      • Optionalurl: string

        the url that identifies a specific Extension

      Returns boolean

      true if an Extension has the provided url; false otherwise

      If the url is provided, determines if an Extension having the provided url exists. If the url is not provided, determines if the modifierExtension property exists and has any values.

      AssertionError for invalid url

    • Returns undefined | string

      the id property value

    • Assigns the provided value to the id property.

      Parameters

      • value: undefined | string

        the id value

      Returns this

      this

      PrimitiveTypeError for invalid value

    • Returns boolean

      true if id exists and has a value; false otherwise

    • Determines if the extension property exists.

      Parameters

      • Optionalurl: string

        the url that identifies a specific Extension

      Returns boolean

      true if an Extension has the provided url; false otherwise

      If the url is provided, determines if an Extension having the provided url exists. If the url is not provided, determines if the extension property exists and has any values.

      AssertionError for invalid url

    • Determines if the extension property exists.

      Parameters

      • url: string

        the url that identifies a specific Extension

      Returns undefined | IExtension

      an Extension having the provided url

      If the url is provided, determines if an Extension having the provided url exists. If the url is not provided, determines if the extension property exists and has any values.

      AssertionError for invalid url

    • Adds the provided Extension to the extension property array.

      Parameters

      • extension: undefined | IExtension

        the Extension value to add to the extension property array

      Returns this

      this

    • Removes the Extension having the provided url from the extension property array.

      Parameters

      • url: string

        the url that identifies a specific Extension to remove

      Returns void

      AssertionError for invalid url

    • Returns boolean

      true if the instance is a FHIR complex or primitive datatype; false otherwise

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    parsegetIdentifierElementsetIdentifierElementhasIdentifierElementgetIdentifiersetIdentifierhasIdentifiergetNextElementsetNextElementhasNextElementgetNextsetNexthasNextgetTimestampElementsetTimestampElementhasTimestampElementgetTimestampsetTimestamphasTimestampgetTotalElementsetTotalElementhasTotalElementgetTotalsetTotalhasTotalgetOffsetElementsetOffsetElementhasOffsetElementgetOffsetsetOffsethasOffsetgetParametersetParameteraddParameterhasParametergetPropertysetPropertyaddPropertyhasPropertygetContainssetContainsaddContainshasContainsfhirTypeisEmptyisRequiredFieldsEmptycopytoJSONgetModifierExtensionsetModifierExtensionhasModifierExtensiongetModifierExtensionByUrladdModifierExtensionremoveModifierExtensiongetIdsetIdhasIdgetExtensionsetExtensionhasExtensiongetExtensionByUrladdExtensionremoveExtensionisResourceisDataTypeisComplexDataTypeisPrimitiveisBooleanPrimitiveisStringPrimitiveisNumberPrimitiveisBigIntPrimitiveisDateTimePrimitivecopyValuesinitParameterinitPropertyinitContains