Data Model Libraries
    Preparing search index...

    Class SpecimenDefinitionTypeTestedContainerComponent

    SpecimenDefinitionTypeTestedContainerComponent Class

    FHIR Specification

    • Short: The specimen's container
    • Definition: The specimen's container.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    material?: CodeableConcept

    SpecimenDefinition.typeTested.container.material Element

    FHIR Specification

    • Short: The material type used for the container
    • Definition: The type of material of the container.
    • Comment: Examples: glass, plastic, metal.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    SpecimenDefinition.typeTested.container.type Element

    FHIR Specification

    • Short: Kind of container associated with the kind of specimen
    • Definition: The type of container used to contain this kind of specimen.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    SpecimenDefinition.typeTested.container.cap Element

    FHIR Specification

    • Short: Color of container cap
    • Definition: Color of container cap.
    • Requirements: From ISO 6710-2017 Table F.1 Recommended colour codes.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    description?: MarkdownType

    SpecimenDefinition.typeTested.container.description Element

    FHIR Specification

    • Short: The description of the kind of container
    • Definition: The textual description of the kind of container.
    • FHIR Type: markdown
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    capacity?: Quantity

    SpecimenDefinition.typeTested.container.capacity Element

    FHIR Specification

    • Short: The capacity of this kind of container
    • Definition: The capacity (volume or other measure) of this kind of container.
    • FHIR Type: Quantity
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    minimumVolume?: IDataType

    SpecimenDefinition.typeTested.container.minimumVolume[x] Element

    @ChoiceDataTypesMeta('SpecimenDefinition.typeTested.container.minimumVolume[x]', ['Quantity','string',]

    FHIR Specification

    • Short: Minimum volume
    • Definition: The minimum volume to be conditioned in the container.
    • FHIR Types: 'Quantity', 'string',
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    SpecimenDefinition.typeTested.container.additive Element

    FHIR Specification

    • Short: Additive associated with container
    • Definition: Substance introduced in the kind of container to preserve, maintain or enhance the specimen. Examples: Formalin, Citrate, EDTA.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    preparation?: MarkdownType

    SpecimenDefinition.typeTested.container.preparation Element

    FHIR Specification

    • Short: Special processing applied to the container for this specimen type
    • Definition: Special processing that should be applied to the container for this kind of specimen.
    • FHIR Type: markdown
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR SpecimenDefinitionTypeTestedContainerComponent

      • OptionaloptSourceField: string

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

      Returns undefined | SpecimenDefinitionTypeTestedContainerComponent

      SpecimenDefinitionTypeTestedContainerComponent data model or undefined for SpecimenDefinitionTypeTestedContainerComponent

      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