Data Model Libraries
    Preparing search index...

    Class SubstanceSpecificationPropertyComponent

    SubstanceSpecificationPropertyComponent Class

    FHIR Specification

    • Short: General specifications for this substance, including how it is related to other substances
    • Definition: General specifications for this substance, including how it is related to other substances.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    category?: CodeableConcept

    SubstanceSpecification.property.category Element

    FHIR Specification

    • Short: A category for this property, e.g. Physical, Chemical, Enzymatic
    • Definition: A category for this property, e.g. Physical, Chemical, Enzymatic.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true

    SubstanceSpecification.property.code Element

    FHIR Specification

    • Short: Property type e.g. viscosity, pH, isoelectric point
    • Definition: Property type e.g. viscosity, pH, isoelectric point.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    parameters?: StringType

    SubstanceSpecification.property.parameters Element

    FHIR Specification

    • Short: Parameters that were used in the measurement of a property (e.g. for viscosity: measured at 20C with a pH of 7.1)
    • Definition: Parameters that were used in the measurement of a property (e.g. for viscosity: measured at 20C with a pH of 7.1).
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    definingSubstance?: IDataType

    SubstanceSpecification.property.definingSubstance[x] Element

    @ChoiceDataTypesMeta('SubstanceSpecification.property.definingSubstance[x]', ['Reference','CodeableConcept',]

    FHIR Specification

    • Short: A substance upon which a defining property depends (e.g. for solubility: in water, in alcohol)
    • Definition: A substance upon which a defining property depends (e.g. for solubility: in water, in alcohol).
    • FHIR Types: 'Reference', 'CodeableConcept',
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    amount?: IDataType

    SubstanceSpecification.property.amount[x] Element

    @ChoiceDataTypesMeta('SubstanceSpecification.property.amount[x]', ['Quantity','string',]

    FHIR Specification

    • Short: Quantitative value for this property
    • Definition: Quantitative value for this property.
    • FHIR Types: 'Quantity', 'string',
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR SubstanceSpecificationPropertyComponent

      • OptionaloptSourceField: string

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

      Returns undefined | SubstanceSpecificationPropertyComponent

      SubstanceSpecificationPropertyComponent data model or undefined for SubstanceSpecificationPropertyComponent

      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