Data Model Libraries
    Preparing search index...

    Class SpecimenDefinitionTypeTestedComponent

    SpecimenDefinitionTypeTestedComponent Class

    FHIR Specification

    • Short: Specimen in container intended for testing by lab
    • Definition: Specimen conditioned in a container as expected by the testing laboratory.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    Methods

    Constructors

    Properties

    isDerived?: BooleanType

    SpecimenDefinition.typeTested.isDerived Element

    FHIR Specification

    • Short: Primary or secondary specimen
    • Definition: Primary of secondary specimen.
    • FHIR Type: boolean
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    SpecimenDefinition.typeTested.type Element

    FHIR Specification

    • Short: Type of intended specimen
    • Definition: The kind of specimen conditioned for testing expected by lab.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    specimenContainedPreferenceEnum: SpecimenContainedPreferenceEnum

    FHIR CodeSystem: SpecimenContainedPreference

    preference: null | EnumCodeType

    SpecimenDefinition.typeTested.preference Element

    FHIR Specification

    • Short: preferred | alternate
    • Definition: The preference for this type of conditioned specimen.
    • FHIR Type: code
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: false

    CodeSystem Enumeration: SpecimenContainedPreferenceEnum

    SpecimenDefinition.typeTested.container Element

    FHIR Specification

    • Short: The specimen's container
    • Definition: The specimen's container.
    • FHIR Type: BackboneElement
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    requirement?: MarkdownType

    SpecimenDefinition.typeTested.requirement Element

    FHIR Specification

    • Short: Requirements for specimen delivery and special handling
    • Definition: Requirements for delivery and special handling of this kind of conditioned specimen.
    • FHIR Type: markdown
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    retentionTime?: Duration

    SpecimenDefinition.typeTested.retentionTime Element

    FHIR Specification

    • Short: The usual time for retaining this kind of specimen
    • Definition: The usual time that a specimen of this kind is retained after the ordered tests are completed, for the purpose of additional testing.
    • FHIR Type: Duration
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    singleUse?: BooleanType

    SpecimenDefinition.typeTested.singleUse Element

    FHIR Specification

    • Short: Specimen for single use only
    • Definition: Specimen can be used by only one test or panel if the value is "true".
    • FHIR Type: boolean
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    rejectionCriterion?: CodeableConcept[]

    SpecimenDefinition.typeTested.rejectionCriterion Element

    FHIR Specification

    • Short: Criterion specified for specimen rejection
    • Definition: Criterion for rejection of the specimen in its container by the laboratory.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    SpecimenDefinition.typeTested.handling Element

    FHIR Specification

    • Short: Specimen handling before testing
    • Definition: Set of instructions for preservation/transport of the specimen at a defined temperature interval, prior the testing process.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    testingDestination?: CodeableConcept[]

    SpecimenDefinition.typeTested.testingDestination Element

    FHIR Specification

    • Short: Where the specimen will be tested
    • Definition: Where the specimen will be tested: e.g., lab, sector, device or any combination of these.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR SpecimenDefinitionTypeTestedComponent

      • OptionaloptSourceField: string

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

      Returns undefined | SpecimenDefinitionTypeTestedComponent

      SpecimenDefinitionTypeTestedComponent data model or undefined for SpecimenDefinitionTypeTestedComponent

      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