Data Model Libraries
    Preparing search index...

    Class ValueSetComposeIncludeComponent

    ValueSetComposeIncludeComponent Class

    FHIR Specification

    • Short: Include one or more codes from a code system or other value set(s)
    • Definition: Include one or more codes from a code system or other value set(s).
    • Comment: All the conditions in an include must be true. If a system is listed, all the codes from the system are listed. If one or more filters are listed, all of the filters must apply. If one or more value sets are listed, the codes must be in all the value sets. E.g. each include is 'include all the codes that meet all these conditions'.

    FHIR ValueSet

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    system? version? concept? filter? valueSet? copyright?

    Methods

    parse getSystemElement setSystemElement hasSystemElement getSystem setSystem hasSystem getVersionElement setVersionElement hasVersionElement getVersion setVersion hasVersion getConcept setConcept addConcept hasConcept getFilter setFilter addFilter hasFilter getValueSetElement setValueSetElement addValueSetElement hasValueSetElement getValueSet setValueSet addValueSet hasValueSet getCopyrightElement setCopyrightElement hasCopyrightElement getCopyright setCopyright hasCopyright fhirType isEmpty copy toJSON getModifierExtension setModifierExtension hasModifierExtension getModifierExtensionByUrl addModifierExtension removeModifierExtension getId setId hasId getExtension setExtension hasExtension getExtensionByUrl addExtension removeExtension isRequiredFieldsEmpty isResource isDataType isComplexDataType isPrimitive isBooleanPrimitive isStringPrimitive isNumberPrimitive isBigIntPrimitive isDateTimePrimitive copyValues initConcept initFilter initValueSet

    Constructors

    Properties

    system?: UriType

    ValueSet.compose.include.system Element

    FHIR Specification

    • Short: The system the codes come from
    • Definition: An absolute URI which is the code system from which the selected codes come from.
    • Comment: If there are no codes or filters, the entire code system is included. Note that the set of codes that are included may contain abstract codes. See ''Coding.system'' for further documentation about the correct value for the system element.
    • FHIR Type: uri
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    version?: StringType

    ValueSet.compose.include.version Element

    FHIR Specification

    • Short: Specific version of the code system referred to
    • Definition: The version of the code system that the codes are selected from, or the special version '*' for all versions.
    • Comment: This is used when selecting the descendants of a concept - they may change between versions. If no version is specified, then the exact contents of the value set might not be known until a context of use binds it to a particular version. The special value '*' means all versions; It is at server discretion regarding expansions and which versions must be supported.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    concept?: ValueSetComposeIncludeConceptComponent[]

    ValueSet.compose.include.concept Element

    FHIR Specification

    • Short: A concept defined in the system
    • Definition: Specifies a concept to be included or excluded.
    • Comment: The list of concepts is considered ordered, though the order might not have any particular significance. Typically, the order of an expansion follows that defined in the compose element.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    filter?: ValueSetComposeIncludeFilterComponent[]

    ValueSet.compose.include.filter Element

    FHIR Specification

    • Short: Select codes/concepts by their properties (including relationships)
    • Definition: Select concepts by specifying a matching criterion based on the properties (including relationships) defined by the system, or on filters defined by the system. If multiple filters are specified within the include, they SHALL all be true.
    • Comment: 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.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    valueSet?: CanonicalType[]

    ValueSet.compose.include.valueSet Element

    FHIR Specification

    • Short: Select the contents included in this value set
    • Definition: Selects the concepts found in this value set (based on its value set definition). This is an absolute URI that is a reference to ValueSet.url. If multiple value sets are specified this includes the intersection of the contents of all of the referenced value sets.
    • Comment: The value set URI is either a logical reference to a defined value set such as a SNOMED CT reference set, or a direct reference to a value set definition using ValueSet.url. The reference might not refer to an actual FHIR ValueSet resource; in this case, whatever is referred to is an implicit definition of a value set that needs to be clear about how versions are resolved.
    • FHIR Type: canonical
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    copyright?: StringType

    ValueSet.compose.include.copyright Element

    FHIR Specification

    • Short: A copyright statement for the specific code system included in the value set
    • Definition: A copyright statement for the specific code system asserted by the containing ValueSet.compose.include element's system value (if the associated ValueSet.compose.include.version element is not present); or the code system and version combination (if the associated ValueSet.compose.include.version element is present).
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR ValueSetComposeIncludeComponent

      • OptionaloptSourceField: string

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

      Returns undefined | ValueSetComposeIncludeComponent

      ValueSetComposeIncludeComponent data model or undefined for ValueSetComposeIncludeComponent

      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 and only if the data model has required fields (min cardinality > 0) and at least one of those required fields in the instance is empty; false otherwise

    • Returns boolean

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

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    parsegetSystemElementsetSystemElementhasSystemElementgetSystemsetSystemhasSystemgetVersionElementsetVersionElementhasVersionElementgetVersionsetVersionhasVersiongetConceptsetConceptaddConcepthasConceptgetFiltersetFilteraddFilterhasFiltergetValueSetElementsetValueSetElementaddValueSetElementhasValueSetElementgetValueSetsetValueSetaddValueSethasValueSetgetCopyrightElementsetCopyrightElementhasCopyrightElementgetCopyrightsetCopyrighthasCopyrightfhirTypeisEmptycopytoJSONgetModifierExtensionsetModifierExtensionhasModifierExtensiongetModifierExtensionByUrladdModifierExtensionremoveModifierExtensiongetIdsetIdhasIdgetExtensionsetExtensionhasExtensiongetExtensionByUrladdExtensionremoveExtensionisRequiredFieldsEmptyisResourceisDataTypeisComplexDataTypeisPrimitiveisBooleanPrimitiveisStringPrimitiveisNumberPrimitiveisBigIntPrimitiveisDateTimePrimitivecopyValuesinitConceptinitFilterinitValueSet