Data Model Libraries
    Preparing search index...

    Class BiologicallyDerivedProduct

    BiologicallyDerivedProduct Class

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

    FHIR Specification

    • Short: This resource reflects an instance of a biologically derived product
    • Definition: This resource reflects an instance of a biologically derived product. 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: 5.0.0

    FHIR BiologicallyDerivedProduct

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    productCategory? productCode? parent? request? identifier? biologicalSourceEvent? processingFacility? division? productStatus? expirationDate? collection? storageTempRequirements? property?

    Methods

    parse getProductCategory setProductCategory hasProductCategory getProductCode setProductCode hasProductCode getParent setParent addParent hasParent getRequest setRequest addRequest hasRequest getIdentifier setIdentifier addIdentifier hasIdentifier getBiologicalSourceEvent setBiologicalSourceEvent hasBiologicalSourceEvent getProcessingFacility setProcessingFacility addProcessingFacility hasProcessingFacility getDivisionElement setDivisionElement hasDivisionElement getDivision setDivision hasDivision getProductStatus setProductStatus hasProductStatus getExpirationDateElement setExpirationDateElement hasExpirationDateElement getExpirationDate setExpirationDate hasExpirationDate getCollection setCollection hasCollection getStorageTempRequirements setStorageTempRequirements hasStorageTempRequirements getProperty setProperty addProperty hasProperty 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 initParent initRequest initIdentifier initProcessingFacility initProperty

    Constructors

    Properties

    productCategory?: Coding

    BiologicallyDerivedProduct.productCategory Element

    FHIR Specification

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

    BiologicallyDerivedProduct.productCode Element

    FHIR Specification

    • Short: A code that identifies the kind of this biologically derived product
    • Definition: A codified value that systematically supports characterization and classification of medical products of human origin inclusive of processing conditions such as additives, volumes and handling conditions.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    parent?: Reference[]

    BiologicallyDerivedProduct.parent Element

    FHIR Specification

    • Short: The parent biologically-derived product
    • Definition: Parent product (if any) for this biologically-derived product.
    • 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
    request?: Reference[]

    BiologicallyDerivedProduct.request Element

    FHIR Specification

    • Short: Request to obtain and/or infuse this product
    • Definition: Request to obtain and/or infuse this biologically derived product.
    • FHIR Type: Reference
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    identifier?: Identifier[]

    BiologicallyDerivedProduct.identifier Element

    FHIR Specification

    • Short: Instance identifier
    • Definition: Unique instance identifiers assigned to a biologically derived product. Note: This is a business identifier, not a resource identifier.
    • Comment: This identifier should uniquely identify the product instance in the business domain. Ideally it should be a globally unique identifier under the control of an ISO/IEC 15459 Issuing Agency.
    • FHIR Type: Identifier
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    biologicalSourceEvent?: Identifier

    BiologicallyDerivedProduct.biologicalSourceEvent Element

    FHIR Specification

    • Short: An identifier that supports traceability to the event during which material in this product from one or more biological entities was obtained or pooled
    • Definition: An identifier that supports traceability to the event during which material in this product from one or more biological entities was obtained or pooled.
    • Comment: Necessary to support mandatory requirements for traceability from donor/source to recipient and vice versa, while also satisfying donor anonymity requirements. The element is defined consistently across BiologicallyDerivedProduct, NutritionProduct, and Device. The identifier references an event that links to a single biological entity such as a blood donor, or to multiple biological entities (e.g. when the product is an embryo or a pooled platelet product). A single biologicalSourceEvent identifier may appear on multiple products of many types derived from a single donation event or source extraction. As an example, a single donation event may provide 2 kidneys and a liver for organ transplantation, 2 corneas for eye surgery, heart valves and arterial tissue for cardiovascular surgery, multiple skin grafts, tendons, multiple shaped bone grafts and a large number of bone putty/paste products; and each of them may be assigned to the same biological source event identifier.
    • FHIR Type: Identifier
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    processingFacility?: Reference[]

    BiologicallyDerivedProduct.processingFacility Element

    FHIR Specification

    • Short: Processing facilities responsible for the labeling and distribution of this biologically derived product
    • Definition: Processing facilities responsible for the labeling and distribution of this biologically derived product.
    • FHIR Type: Reference
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    division?: StringType

    BiologicallyDerivedProduct.division Element

    FHIR Specification

    • Short: A unique identifier for an aliquot of a product
    • Definition: A unique identifier for an aliquot of a product. Used to distinguish individual aliquots of a product carrying the same biologicalSource and productCode identifiers.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    productStatus?: Coding

    BiologicallyDerivedProduct.productStatus Element

    FHIR Specification

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

    BiologicallyDerivedProduct.expirationDate Element

    FHIR Specification

    • Short: Date, and where relevant time, of expiration
    • Definition: Date, and where relevant time, of expiration.
    • FHIR Type: dateTime
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    collection?: BiologicallyDerivedProductCollectionComponent

    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
    storageTempRequirements?: Range

    BiologicallyDerivedProduct.storageTempRequirements Element

    FHIR Specification

    • Short: Product storage temperature requirements
    • Definition: The temperature requirements for storage of the biologically-derived product.
    • Comment: May be extracted from information held in the Product Description Code.
    • FHIR Type: Range
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    property?: BiologicallyDerivedProductPropertyComponent[]

    BiologicallyDerivedProduct.property Element

    FHIR Specification

    • Short: A property that is specific to this BiologicallyDerviedProduct instance
    • Definition: A property that is specific to this BiologicallyDerviedProduct instance.
    • Comment: Property can be used to provide information on a wide range of additional information specific to a particular biologicallyDerivedProduct.
    • 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

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    parsegetProductCategorysetProductCategoryhasProductCategorygetProductCodesetProductCodehasProductCodegetParentsetParentaddParenthasParentgetRequestsetRequestaddRequesthasRequestgetIdentifiersetIdentifieraddIdentifierhasIdentifiergetBiologicalSourceEventsetBiologicalSourceEventhasBiologicalSourceEventgetProcessingFacilitysetProcessingFacilityaddProcessingFacilityhasProcessingFacilitygetDivisionElementsetDivisionElementhasDivisionElementgetDivisionsetDivisionhasDivisiongetProductStatussetProductStatushasProductStatusgetExpirationDateElementsetExpirationDateElementhasExpirationDateElementgetExpirationDatesetExpirationDatehasExpirationDategetCollectionsetCollectionhasCollectiongetStorageTempRequirementssetStorageTempRequirementshasStorageTempRequirementsgetPropertysetPropertyaddPropertyhasPropertyfhirTypeisEmptycopytoJSONgetTextsetTexthasTextgetContainedsetContainedaddContainedhasContainedgetExtensionsetExtensionhasExtensiongetExtensionByUrladdExtensionremoveExtensiongetModifierExtensionsetModifierExtensionhasModifierExtensiongetModifierExtensionByUrladdModifierExtensionremoveModifierExtensionresourceTypegetIdElementsetIdElementhasIdElementgetIdsetIdhasIdgetMetasetMetahasMetagetImplicitRulesElementsetImplicitRulesElementhasImplicitRulesElementgetImplicitRulessetImplicitRuleshasImplicitRulesgetLanguageElementsetLanguageElementhasLanguageElementgetLanguagesetLanguagehasLanguageisResourceisRequiredFieldsEmptyisDataTypeisComplexDataTypeisPrimitiveisBooleanPrimitiveisStringPrimitiveisNumberPrimitiveisBigIntPrimitiveisDateTimePrimitivecopyValuesinitParentinitRequestinitIdentifierinitProcessingFacilityinitProperty