Data Model Libraries
    Preparing search index...

    BiologicallyDerivedProduct Class

    A material substance originating from a biological entity intended to be transplanted or infused into another (possibly the same) biological entity.

    FHIR Specification

    • Short: A material substance originating from a biological entity
    • Definition: A material substance originating from a biological entity intended to be transplanted or infused into another (possibly the same) biological entity.
    • Comment: Substances include, but are not limited to: whole blood, bone marrow, organs, and manipulated blood cells.
    • FHIR Version: 4.0.1

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    Methods

    parse getIdentifier setIdentifier addIdentifier hasIdentifier getProductCategoryEnumType setProductCategoryEnumType hasProductCategoryEnumType getProductCategoryElement setProductCategoryElement hasProductCategoryElement getProductCategory setProductCategory hasProductCategory getProductCode setProductCode hasProductCode getStatusEnumType setStatusEnumType hasStatusEnumType getStatusElement setStatusElement hasStatusElement getStatus setStatus hasStatus getRequest setRequest addRequest hasRequest getQuantityElement setQuantityElement hasQuantityElement getQuantity setQuantity hasQuantity getParent setParent addParent hasParent getCollection setCollection hasCollection getProcessing setProcessing addProcessing hasProcessing getManipulation setManipulation hasManipulation getStorage setStorage addStorage hasStorage fhirType isEmpty copy toJSON getText setText hasText getContained setContained addContained hasContained getExtension setExtension hasExtension getExtensionByUrl addExtension removeExtension getModifierExtension setModifierExtension hasModifierExtension getModifierExtensionByUrl addModifierExtension removeModifierExtension resourceType getIdElement setIdElement hasIdElement getId setId hasId getMeta setMeta hasMeta getImplicitRulesElement setImplicitRulesElement hasImplicitRulesElement getImplicitRules setImplicitRules hasImplicitRules getLanguageElement setLanguageElement hasLanguageElement getLanguage setLanguage hasLanguage isResource isRequiredFieldsEmpty isDataType isComplexDataType isPrimitive isBooleanPrimitive isStringPrimitive isNumberPrimitive isBigIntPrimitive isDateTimePrimitive copyValues initIdentifier initRequest initParent initProcessing initStorage

    Constructors

    Properties

    identifier?: Identifier[]

    BiologicallyDerivedProduct.identifier Element

    FHIR Specification

    • Short: External ids for this item
    • Definition: This records identifiers associated with this biologically derived product instance that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).
    • FHIR Type: Identifier
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    productCategoryEnum: ProductCategoryEnum

    FHIR CodeSystem: ProductCategory

    productCategory?: EnumCodeType

    BiologicallyDerivedProduct.productCategory Element

    FHIR Specification

    • Short: organ | tissue | fluid | cells | biologicalAgent
    • Definition: Broad category of this product.
    • FHIR Type: code
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    CodeSystem Enumeration: ProductCategoryEnum

    productCode?: CodeableConcept

    BiologicallyDerivedProduct.productCode Element

    FHIR Specification

    • Short: What this biologically derived product is
    • Definition: A code that identifies the kind of this biologically derived product (SNOMED Ctcode).
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    productStatusEnum: ProductStatusEnum

    FHIR CodeSystem: ProductStatus

    status?: EnumCodeType

    BiologicallyDerivedProduct.status Element

    FHIR Specification

    • Short: available | unavailable
    • Definition: Whether the product is currently available.
    • FHIR Type: code
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    CodeSystem Enumeration: ProductStatusEnum

    request?: Reference[]

    BiologicallyDerivedProduct.request Element

    FHIR Specification

    quantity?: IntegerType

    BiologicallyDerivedProduct.quantity Element

    FHIR Specification

    • Short: The amount of this biologically derived product
    • Definition: Number of discrete units within this product.
    • FHIR Type: integer
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    parent?: Reference[]

    BiologicallyDerivedProduct.parent Element

    FHIR Specification

    • Short: BiologicallyDerivedProduct parent
    • Definition: Parent product (if any).
    • Comment: For products that have multiple collections. For example Peripheral Blood Stem Cells may be collected over several days from a single donor and the donation split into in multiple containers which must be linked to the parent donation.
    • FHIR Type: Reference
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    BiologicallyDerivedProduct.collection Element

    FHIR Specification

    • Short: How this product was collected
    • Definition: How this product was collected.
    • FHIR Type: BackboneElement
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    BiologicallyDerivedProduct.processing Element

    FHIR Specification

    • Short: Any processing of the product during collection
    • Definition: Any processing of the product during collection that does not change the fundamental nature of the product. For example adding anti-coagulants during the collection of Peripheral Blood Stem Cells.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    BiologicallyDerivedProduct.manipulation Element

    FHIR Specification

    • Short: Any manipulation of product post-collection
    • Definition: Any manipulation of product post-collection that is intended to alter the product. For example a buffy-coat enrichment or CD8 reduction of Peripheral Blood Stem Cells to make it more suitable for infusion.
    • FHIR Type: BackboneElement
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    BiologicallyDerivedProduct.storage Element

    FHIR Specification

    • Short: Product storage
    • Definition: Product storage.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    Methods

    • Assigns the provided value to the text property.

      Parameters

      Returns this

      this

    • Returns boolean

      true if the text property exists and has a value; false otherwise

    • Assigns the provided Resource array value to the contained property.

      Parameters

      • value: undefined | IResource[]

        the contained array value

      Returns this

      this

    • Returns boolean

      true if the contained property exists and has a value; false otherwise

    • Assigns the provided array of Extension values to the extension property.

      Parameters

      • extension: undefined | IExtension[]

        array of Extensions

      Returns this

      this

    • 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

    • 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

    • 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

      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

    • Assigns the provided PrimitiveType value to the id property.

      Parameters

      • element: undefined | IdType

        the id value

      Returns this

      this

    • Returns undefined | string

      the id property value as a primitive value

    • Assigns the provided primitive value to the id property.

      Parameters

      • value: undefined | string

        the id value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns boolean

      true if the id property exists and has a value; false otherwise

    • Assigns the provided value to the meta property.

      Parameters

      • value: undefined | Meta

        the meta value

      Returns this

      this

    • Returns boolean

      true if the meta property exists and has a value; false otherwise

    • Assigns the provided primitive value to the implicitRules property.

      Parameters

      • value: undefined | string

        the implicitRules value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns undefined | string

      the language property value as a primitive value

    • Assigns the provided primitive value to the language property.

      Parameters

      • value: undefined | string

        the language value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns boolean

      true if the language property exists and has a value; false otherwise

    • 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