Data Model Libraries
    Preparing search index...

    Class BiologicallyDerivedProductDispense

    BiologicallyDerivedProductDispense Class

    A record of dispensation of a biologically derived product.

    FHIR Specification

    • Short: A record of dispensation of a biologically derived product
    • Definition: This resource reflects an instance of a biologically derived product dispense. The supply or dispense of a biologically derived product from the supply organization or department (e.g. hospital transfusion laboratory) to the clinical team responsible for clinical application.
    • FHIR Version: 5.0.0

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    Methods

    parse getIdentifier setIdentifier addIdentifier hasIdentifier getBasedOn setBasedOn addBasedOn hasBasedOn getPartOf setPartOf addPartOf hasPartOf getStatusEnumType setStatusEnumType hasStatusEnumType getStatusElement setStatusElement hasStatusElement getStatus setStatus hasStatus getOriginRelationshipType setOriginRelationshipType hasOriginRelationshipType getProduct setProduct hasProduct getPatient setPatient hasPatient getMatchStatus setMatchStatus hasMatchStatus getPerformer setPerformer addPerformer hasPerformer getLocation setLocation hasLocation getQuantity setQuantity hasQuantity getPreparedDateElement setPreparedDateElement hasPreparedDateElement getPreparedDate setPreparedDate hasPreparedDate getWhenHandedOverElement setWhenHandedOverElement hasWhenHandedOverElement getWhenHandedOver setWhenHandedOver hasWhenHandedOver getDestination setDestination hasDestination getNote setNote addNote hasNote getUsageInstructionElement setUsageInstructionElement hasUsageInstructionElement getUsageInstruction setUsageInstruction hasUsageInstruction fhirType isEmpty isRequiredFieldsEmpty 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 isDataType isComplexDataType isPrimitive isBooleanPrimitive isStringPrimitive isNumberPrimitive isBigIntPrimitive isDateTimePrimitive copyValues initIdentifier initBasedOn initPartOf initPerformer initNote

    Constructors

    Properties

    identifier?: Identifier[]

    BiologicallyDerivedProductDispense.identifier Element

    FHIR Specification

    • Short: Business identifier for this dispense
    • Definition: Unique instance identifiers assigned to a biologically derived product dispense. Note: This is a business identifier, not a resource identifier.
    • FHIR Type: Identifier
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    basedOn?: Reference[]

    BiologicallyDerivedProductDispense.basedOn Element

    FHIR Specification

    • Short: The order or request that this dispense is fulfilling
    • Definition: The order or request that the dispense is fulfilling. This is a reference to a ServiceRequest resource.
    • FHIR Type: Reference
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    partOf?: Reference[]

    BiologicallyDerivedProductDispense.partOf Element

    FHIR Specification

    biologicallyderivedproductdispenseStatusEnum: BiologicallyderivedproductdispenseStatusEnum

    FHIR CodeSystem: BiologicallyderivedproductdispenseStatus

    status: null | EnumCodeType

    BiologicallyDerivedProductDispense.status Element

    FHIR Specification

    • Short: preparation | in-progress | allocated | issued | unfulfilled | returned | entered-in-error | unknown
    • Definition: A code specifying the state of the dispense event.
    • FHIR Type: code
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true
    originRelationshipType?: CodeableConcept

    BiologicallyDerivedProductDispense.originRelationshipType Element

    FHIR Specification

    • Short: Relationship between the donor and intended recipient
    • Definition: Indicates the relationship between the donor of the biologically derived product and the intended recipient.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    product: null | Reference

    BiologicallyDerivedProductDispense.product Element

    FHIR Specification

    patient: null | Reference

    BiologicallyDerivedProductDispense.patient Element

    FHIR Specification

    • Short: The intended recipient of the dispensed product
    • Definition: A link to a resource representing the patient that the product is dispensed for.
    • FHIR Type: Reference
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true
    matchStatus?: CodeableConcept

    BiologicallyDerivedProductDispense.matchStatus Element

    FHIR Specification

    • Short: Indicates the type of matching associated with the dispense
    • Definition: Indicates the type of matching associated with the dispense.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true

    BiologicallyDerivedProductDispense.performer Element

    FHIR Specification

    • Short: Indicates who or what performed an action
    • Definition: Indicates who or what performed an action.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    location?: Reference

    BiologicallyDerivedProductDispense.location Element

    FHIR Specification

    • Short: Where the dispense occurred
    • Definition: The physical location where the dispense was performed.
    • FHIR Type: Reference
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    quantity?: Quantity

    BiologicallyDerivedProductDispense.quantity Element

    FHIR Specification

    • Short: Amount dispensed
    • Definition: The amount of product in the dispense. Quantity will depend on the product being dispensed. Examples are: volume; cell count; concentration.
    • FHIR Type: Quantity
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    preparedDate?: DateTimeType

    BiologicallyDerivedProductDispense.preparedDate Element

    FHIR Specification

    • Short: When product was selected/matched
    • Definition: When the product was selected/ matched.
    • FHIR Type: dateTime
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    whenHandedOver?: DateTimeType

    BiologicallyDerivedProductDispense.whenHandedOver Element

    FHIR Specification

    • Short: When the product was dispatched
    • Definition: When the product was dispatched for clinical use.
    • FHIR Type: dateTime
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    destination?: Reference

    BiologicallyDerivedProductDispense.destination Element

    FHIR Specification

    • Short: Where the product was dispatched to
    • Definition: Link to a resource identifying the physical location that the product was dispatched to.
    • FHIR Type: Reference
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    note?: Annotation[]

    BiologicallyDerivedProductDispense.note Element

    FHIR Specification

    • Short: Additional notes
    • Definition: Additional notes.
    • FHIR Type: Annotation
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    usageInstruction?: StringType

    BiologicallyDerivedProductDispense.usageInstruction Element

    FHIR Specification

    • Short: Specific instructions for use
    • Definition: Specific instructions for use.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true

    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 the instance is a FHIR complex or primitive datatype; false otherwise