Data Model Libraries
    Preparing search index...

    ValueSetScopeComponent Class

    FHIR Specification

    • Short: Description of the semantic space the Value Set Expansion is intended to cover and should further clarify the text in ValueSet.description
    • Definition: Description of the semantic space the Value Set Expansion is intended to cover and should further clarify the text in ValueSet.description.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    inclusionCriteria?: StringType

    ValueSet.scope.inclusionCriteria Element

    FHIR Specification

    • Short: Criteria describing which concepts or codes should be included and why
    • Definition: Criteria describing which concepts or codes should be included and why.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    exclusionCriteria?: StringType

    ValueSet.scope.exclusionCriteria Element

    FHIR Specification

    • Short: Criteria describing which concepts or codes should be excluded and why
    • Definition: Criteria describing which concepts or codes should be excluded and why.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR ValueSetScopeComponent

      • OptionaloptSourceField: string

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

      Returns undefined | ValueSetScopeComponent

      ValueSetScopeComponent data model or undefined for ValueSetScopeComponent

      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