Release 5 R6 Ballot (3rd Draft)

This page is part of the FHIR Specification (v5.0.0: R5 - STU v6.0.0-ballot3: Release 6 Ballot (3rd Draft) (see Ballot Notes ). This is the The current published version in it's permanent home (it will always be available at this URL). is 5.0.0 . For a full list of available versions, see the Directory of published versions

12.31 Resource BiologicallyDerivedProductDispense - Content

Orders and Observations icon Work Group Maturity Level : 0 1   Draft Security Category : Business Compartments : Patient , Practitioner

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.

12.31.1 Scope and Usage

This resource covers the supply of biologically derived products to a patient. Examples include provision of highly matched cellular therapy products or crossmatched blood for a patient, supply of a cornea for ocular surgery, supply of a skin products for burn trauma therapy, provision of banked human milk for very low birthweight babies. The biologically derived product dispense can be the result of a transfusion laboratory or tissue bank system responding to a request or order. Typically the dispense is only considered completed (i.e., status=allocated or issued) after necessary medical release conditions have been met.

12.31.2 Boundaries and Relationships

This resource has boundaries with MedicationDispense and DeviceDispense. BiologicallyDerivedProductDispense should be used when the product is a biologic derived from a human donor or another biological entity. Biologics prepared from large pool donor sources such as human albumin solutions or immune globulin preparations are often handled through pharmacy and MedicationDispense may be more appropriate.

The request to initiate a BiologicallyDerivedProductDispense may be via a ServiceRequest resource.

The details of the clinical application of the dispensed product may be captured in a Procedure resource.

12.31.3 References to this Resource

  • Resource References: itself

12.31.4 Resource Content

Structure

Name Flags Card. Type Description & Constraints doco
. . BiologicallyDerivedProductDispense Σ D DomainResource A record of dispensation of a biologically derived product

Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension
. . . identifier Σ 0..* Identifier Business identifier for this dispense

. . . basedOn Σ 0..* Reference ( ServiceRequest ) The order or request that this dispense is fulfilling

. . . partOf Σ 0..* Reference ( BiologicallyDerivedProductDispense ) Short description

. . . originRelationshipType Σ 0..1 CodeableConcept Relationship between the donor and intended recipient
Binding: Biologically derived product dispense - origin relationship Derived Product Dispense Origin Relationship ( Example )
. . . product Σ 1..1 Reference ( BiologicallyDerivedProduct ) The BiologicallyDerivedProduct that is dispensed
. . . patient Σ 1..1 Reference ( Patient ) The intended recipient of the dispensed product
. . . matchStatus Σ 0..1 CodeableConcept Indicates the type of matching associated with the dispense
Binding: Biologically derived product dispense - match status Derived Product Dispense Match Status ( Example )
. . . performer Σ 0..* BackboneElement Indicates who or what performed an action

. . . . function Σ 0..1 CodeableConcept Identifies the function of the performer during the dispense
Binding: Biologically derived product dispense - performer function Derived Product Dispense Performer Function ( Example )
. . . . actor Σ 1..1 Reference ( Practitioner ) Who performed the action
. . . location Σ 0..1 Reference ( Location ) Where the dispense occurred
. . . quantity Σ 0..1 SimpleQuantity Amount dispensed
. . . preparedDate Σ 0..1 dateTime When product was selected/matched
. . . whenHandedOver Σ 0..1 dateTime When the product was dispatched
. . . destination Σ 0..1 Reference ( Location ) Where the product was dispatched to
. . . note Σ 0..* Annotation Additional notes

. . . usageInstruction Σ 0..1 string Specific instructions for use

doco Documentation for this format icon

See the Extensions for this resource

UML Diagram ( Legend )

BiologicallyDerivedProductDispense ( DomainResource ) Unique instance identifiers assigned to a biologically derived product dispense. Note: This is a business identifier, not a resource identifier identifier : Identifier [0..*] The order or request that the dispense is fulfilling. This is a reference to a ServiceRequest resource basedOn : Reference [0..*] « ServiceRequest » A larger event of which this particular event is a component partOf : Reference [0..*] « BiologicallyDerivedProductDispense » A code specifying the state of the dispense event status : code [1..1] « A coded concept specifying the state of the dispense event. (Strength=Required) BiologicallyDerivedProductDis... ! » Indicates the relationship between the donor of the biologically derived product and the intended recipient originRelationshipType : CodeableConcept [0..1] « A coded concept specifying the relationship between the recipient and origin of the dispensed product. (Strength=Example) BiologicallyDerivedProductDis... ?? » A link to a resource identifying the biologically derived product that is being dispensed product : Reference [1..1] « BiologicallyDerivedProduct » A link to a resource representing the patient that the product is dispensed for patient : Reference [1..1] « Patient » Indicates the type of matching associated with the dispense matchStatus : CodeableConcept [0..1] « A coded concept specifying the type of matching between the recipient and origin of the dispensed product. (Strength=Example) BiologicallyDerivedProductDis... ?? » The physical location where the dispense was performed location : Reference [0..1] « Location » The amount of product in the dispense. Quantity will depend on the product being dispensed. Examples are: volume; cell count; concentration quantity : Quantity ( SimpleQuantity ) [0..1] When the product was selected/ matched preparedDate : dateTime [0..1] When the product was dispatched for clinical use whenHandedOver : dateTime [0..1] Link to a resource identifying the physical location that the product was dispatched to destination : Reference [0..1] « Location » Additional notes note : Annotation [0..*] Specific instructions for use usageInstruction : string [0..1] Performer Identifies the function of the performer during the dispense function : CodeableConcept [0..1] « A coded concept specifying the role or function of the performer in the dispense. (Strength=Example) BiologicallyDerivedProductDis... ?? » Identifies the person responsible for the action actor : Reference [1..1] « Practitioner » Indicates who or what performed an action performer [0..*]

XML Template 

<BiologicallyDerivedProductDispense xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <identifier><!-- 0..* Identifier Business identifier for this dispense --></identifier>
 <basedOn><!-- 0..* Reference(ServiceRequest) The order or request that this dispense is fulfilling --></basedOn>
 <partOf><!-- 0..* Reference(BiologicallyDerivedProductDispense) Short description --></partOf>
 <status value="[code]"/><!-- 1..1 preparation | in-progress | allocated | issued | unfulfilled | returned | entered-in-error | unknown -->
 <originRelationshipType><!-- 0..1 CodeableConcept Relationship between the donor and intended recipient --></originRelationshipType>
 <product><!-- 1..1 Reference(BiologicallyDerivedProduct) The BiologicallyDerivedProduct that is dispensed --></product>
 <patient><!-- 1..1 Reference(Patient) The intended recipient of the dispensed product --></patient>
 <matchStatus><!-- 0..1 CodeableConcept Indicates the type of matching associated with the dispense --></matchStatus>
 <performer>  <!-- 0..* Indicates who or what performed an action -->
  <function><!-- 0..1 CodeableConcept Identifies the function of the performer during the dispense --></function>
  <actor><!-- 1..1 Reference(Practitioner) Who performed the action --></actor>
 </performer>
 <location><!-- 0..1 Reference(Location) Where the dispense occurred --></location>
 <quantity><!-- 0..1 Quantity(SimpleQuantity) Amount dispensed --></quantity>
 <preparedDate value="[dateTime]"/><!-- 0..1 When product was selected/matched -->
 <whenHandedOver value="[dateTime]"/><!-- 0..1 When the product was dispatched -->
 <destination><!-- 0..1 Reference(Location) Where the product was dispatched to --></destination>
 <note><!-- 0..* Annotation Additional notes --></note>
 <usageInstruction value="[string]"/><!-- 0..1 Specific instructions for use -->
</BiologicallyDerivedProductDispense>

JSON Template 

{doco
  "resourceType" : "BiologicallyDerivedProductDispense",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : [{ Identifier }], // Business identifier for this dispense
  "basedOn" : [{ Reference(ServiceRequest) }], // The order or request that this dispense is fulfilling
  "partOf" : [{ Reference(BiologicallyDerivedProductDispense) }], // Short description
  "status" : "<code>", // R!  preparation | in-progress | allocated | issued | unfulfilled | returned | entered-in-error | unknown
  "originRelationshipType" : { CodeableConcept }, // Relationship between the donor and intended recipient
  "product" : { Reference(BiologicallyDerivedProduct) }, // R!  The BiologicallyDerivedProduct that is dispensed
  "patient" : { Reference(Patient) }, // R!  The intended recipient of the dispensed product
  "matchStatus" : { CodeableConcept }, // Indicates the type of matching associated with the dispense
  "performer" : [{ // Indicates who or what performed an action
    "function" : { CodeableConcept }, // Identifies the function of the performer during the dispense
    "actor" : { Reference(Practitioner) } // R!  Who performed the action
  }],
  "location" : { Reference(Location) }, // Where the dispense occurred
  "quantity" : { Quantity(SimpleQuantity) }, // Amount dispensed
  "preparedDate" : "<dateTime>", // When product was selected/matched
  "whenHandedOver" : "<dateTime>", // When the product was dispatched
  "destination" : { Reference(Location) }, // Where the product was dispatched to
  "note" : [{ Annotation }], // Additional notes
  "usageInstruction" : "<string>" // Specific instructions for use
}

Turtle Template 

@prefix fhir: <http://hl7.org/fhir/> .doco


[ a fhir:BiologicallyDerivedProductDispense;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:identifier  ( [ Identifier ] ... ) ; # 0..* Business identifier for this dispense
  fhir:basedOn  ( [ Reference(ServiceRequest) ] ... ) ; # 0..* The order or request that this dispense is fulfilling
  fhir:partOf  ( [ Reference(BiologicallyDerivedProductDispense) ] ... ) ; # 0..* Short description
  fhir:status [ code ] ; # 1..1 preparation | in-progress | allocated | issued | unfulfilled | returned | entered-in-error | unknown
  fhir:originRelationshipType [ CodeableConcept ] ; # 0..1 Relationship between the donor and intended recipient
  fhir:product [ Reference(BiologicallyDerivedProduct) ] ; # 1..1 The BiologicallyDerivedProduct that is dispensed
  fhir:patient [ Reference(Patient) ] ; # 1..1 The intended recipient of the dispensed product
  fhir:matchStatus [ CodeableConcept ] ; # 0..1 Indicates the type of matching associated with the dispense
  fhir:performer ( [ # 0..* Indicates who or what performed an action
    fhir:function [ CodeableConcept ] ; # 0..1 Identifies the function of the performer during the dispense
    fhir:actor [ Reference(Practitioner) ] ; # 1..1 Who performed the action
  ] ... ) ;
  fhir:location [ Reference(Location) ] ; # 0..1 Where the dispense occurred
  fhir:quantity [ Quantity(SimpleQuantity) ] ; # 0..1 Amount dispensed
  fhir:preparedDate [ dateTime ] ; # 0..1 When product was selected/matched
  fhir:whenHandedOver [ dateTime ] ; # 0..1 When the product was dispatched
  fhir:destination [ Reference(Location) ] ; # 0..1 Where the product was dispatched to
  fhir:note  ( [ Annotation ] ... ) ; # 0..* Additional notes
  fhir:usageInstruction [ string ] ; # 0..1 Specific instructions for use
]

Changes from both R4 and R4B

This resource did not exist in Release R4

See the Full Difference for further information

This analysis is available for R4 as XML or JSON and for R4B as XML or JSON .

Structure

Name Flags Card. Type Description & Constraints doco
. . BiologicallyDerivedProductDispense Σ D DomainResource A record of dispensation of a biologically derived product

Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension
. . . identifier Σ 0..* Identifier Business identifier for this dispense

. . . basedOn Σ 0..* Reference ( ServiceRequest ) The order or request that this dispense is fulfilling

. . . partOf Σ 0..* Reference ( BiologicallyDerivedProductDispense ) Short description

. . . originRelationshipType Σ 0..1 CodeableConcept Relationship between the donor and intended recipient
Binding: Biologically derived product dispense - origin relationship Derived Product Dispense Origin Relationship ( Example )
. . . product Σ 1..1 Reference ( BiologicallyDerivedProduct ) The BiologicallyDerivedProduct that is dispensed
. . . patient Σ 1..1 Reference ( Patient ) The intended recipient of the dispensed product
. . . matchStatus Σ 0..1 CodeableConcept Indicates the type of matching associated with the dispense
Binding: Biologically derived product dispense - match status Derived Product Dispense Match Status ( Example )
. . . performer Σ 0..* BackboneElement Indicates who or what performed an action

. . . . function Σ 0..1 CodeableConcept Identifies the function of the performer during the dispense
Binding: Biologically derived product dispense - performer function Derived Product Dispense Performer Function ( Example )
. . . . actor Σ 1..1 Reference ( Practitioner ) Who performed the action
. . . location Σ 0..1 Reference ( Location ) Where the dispense occurred
. . . quantity Σ 0..1 SimpleQuantity Amount dispensed
. . . preparedDate Σ 0..1 dateTime When product was selected/matched
. . . whenHandedOver Σ 0..1 dateTime When the product was dispatched
. . . destination Σ 0..1 Reference ( Location ) Where the product was dispatched to
. . . note Σ 0..* Annotation Additional notes

. . . usageInstruction Σ 0..1 string Specific instructions for use

doco Documentation for this format icon

See the Extensions for this resource

UML Diagram ( Legend )

BiologicallyDerivedProductDispense ( DomainResource ) Unique instance identifiers assigned to a biologically derived product dispense. Note: This is a business identifier, not a resource identifier identifier : Identifier [0..*] The order or request that the dispense is fulfilling. This is a reference to a ServiceRequest resource basedOn : Reference [0..*] « ServiceRequest » A larger event of which this particular event is a component partOf : Reference [0..*] « BiologicallyDerivedProductDispense » A code specifying the state of the dispense event status : code [1..1] « A coded concept specifying the state of the dispense event. (Strength=Required) BiologicallyDerivedProductDis... ! » Indicates the relationship between the donor of the biologically derived product and the intended recipient originRelationshipType : CodeableConcept [0..1] « A coded concept specifying the relationship between the recipient and origin of the dispensed product. (Strength=Example) BiologicallyDerivedProductDis... ?? » A link to a resource identifying the biologically derived product that is being dispensed product : Reference [1..1] « BiologicallyDerivedProduct » A link to a resource representing the patient that the product is dispensed for patient : Reference [1..1] « Patient » Indicates the type of matching associated with the dispense matchStatus : CodeableConcept [0..1] « A coded concept specifying the type of matching between the recipient and origin of the dispensed product. (Strength=Example) BiologicallyDerivedProductDis... ?? » The physical location where the dispense was performed location : Reference [0..1] « Location » The amount of product in the dispense. Quantity will depend on the product being dispensed. Examples are: volume; cell count; concentration quantity : Quantity ( SimpleQuantity ) [0..1] When the product was selected/ matched preparedDate : dateTime [0..1] When the product was dispatched for clinical use whenHandedOver : dateTime [0..1] Link to a resource identifying the physical location that the product was dispatched to destination : Reference [0..1] « Location » Additional notes note : Annotation [0..*] Specific instructions for use usageInstruction : string [0..1] Performer Identifies the function of the performer during the dispense function : CodeableConcept [0..1] « A coded concept specifying the role or function of the performer in the dispense. (Strength=Example) BiologicallyDerivedProductDis... ?? » Identifies the person responsible for the action actor : Reference [1..1] « Practitioner » Indicates who or what performed an action performer [0..*]

XML Template 

<BiologicallyDerivedProductDispense xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <identifier><!-- 0..* Identifier Business identifier for this dispense --></identifier>
 <basedOn><!-- 0..* Reference(ServiceRequest) The order or request that this dispense is fulfilling --></basedOn>
 <partOf><!-- 0..* Reference(BiologicallyDerivedProductDispense) Short description --></partOf>
 <status value="[code]"/><!-- 1..1 preparation | in-progress | allocated | issued | unfulfilled | returned | entered-in-error | unknown -->
 <originRelationshipType><!-- 0..1 CodeableConcept Relationship between the donor and intended recipient --></originRelationshipType>
 <product><!-- 1..1 Reference(BiologicallyDerivedProduct) The BiologicallyDerivedProduct that is dispensed --></product>
 <patient><!-- 1..1 Reference(Patient) The intended recipient of the dispensed product --></patient>
 <matchStatus><!-- 0..1 CodeableConcept Indicates the type of matching associated with the dispense --></matchStatus>
 <performer>  <!-- 0..* Indicates who or what performed an action -->
  <function><!-- 0..1 CodeableConcept Identifies the function of the performer during the dispense --></function>
  <actor><!-- 1..1 Reference(Practitioner) Who performed the action --></actor>
 </performer>
 <location><!-- 0..1 Reference(Location) Where the dispense occurred --></location>
 <quantity><!-- 0..1 Quantity(SimpleQuantity) Amount dispensed --></quantity>
 <preparedDate value="[dateTime]"/><!-- 0..1 When product was selected/matched -->
 <whenHandedOver value="[dateTime]"/><!-- 0..1 When the product was dispatched -->
 <destination><!-- 0..1 Reference(Location) Where the product was dispatched to --></destination>
 <note><!-- 0..* Annotation Additional notes --></note>
 <usageInstruction value="[string]"/><!-- 0..1 Specific instructions for use -->
</BiologicallyDerivedProductDispense>

JSON Template 

{doco
  "resourceType" : "BiologicallyDerivedProductDispense",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : [{ Identifier }], // Business identifier for this dispense
  "basedOn" : [{ Reference(ServiceRequest) }], // The order or request that this dispense is fulfilling
  "partOf" : [{ Reference(BiologicallyDerivedProductDispense) }], // Short description
  "status" : "<code>", // R!  preparation | in-progress | allocated | issued | unfulfilled | returned | entered-in-error | unknown
  "originRelationshipType" : { CodeableConcept }, // Relationship between the donor and intended recipient
  "product" : { Reference(BiologicallyDerivedProduct) }, // R!  The BiologicallyDerivedProduct that is dispensed
  "patient" : { Reference(Patient) }, // R!  The intended recipient of the dispensed product
  "matchStatus" : { CodeableConcept }, // Indicates the type of matching associated with the dispense
  "performer" : [{ // Indicates who or what performed an action
    "function" : { CodeableConcept }, // Identifies the function of the performer during the dispense
    "actor" : { Reference(Practitioner) } // R!  Who performed the action
  }],
  "location" : { Reference(Location) }, // Where the dispense occurred
  "quantity" : { Quantity(SimpleQuantity) }, // Amount dispensed
  "preparedDate" : "<dateTime>", // When product was selected/matched
  "whenHandedOver" : "<dateTime>", // When the product was dispatched
  "destination" : { Reference(Location) }, // Where the product was dispatched to
  "note" : [{ Annotation }], // Additional notes
  "usageInstruction" : "<string>" // Specific instructions for use
}

Turtle Template 

@prefix fhir: <http://hl7.org/fhir/> .doco


[ a fhir:BiologicallyDerivedProductDispense;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:identifier  ( [ Identifier ] ... ) ; # 0..* Business identifier for this dispense
  fhir:basedOn  ( [ Reference(ServiceRequest) ] ... ) ; # 0..* The order or request that this dispense is fulfilling
  fhir:partOf  ( [ Reference(BiologicallyDerivedProductDispense) ] ... ) ; # 0..* Short description
  fhir:status [ code ] ; # 1..1 preparation | in-progress | allocated | issued | unfulfilled | returned | entered-in-error | unknown
  fhir:originRelationshipType [ CodeableConcept ] ; # 0..1 Relationship between the donor and intended recipient
  fhir:product [ Reference(BiologicallyDerivedProduct) ] ; # 1..1 The BiologicallyDerivedProduct that is dispensed
  fhir:patient [ Reference(Patient) ] ; # 1..1 The intended recipient of the dispensed product
  fhir:matchStatus [ CodeableConcept ] ; # 0..1 Indicates the type of matching associated with the dispense
  fhir:performer ( [ # 0..* Indicates who or what performed an action
    fhir:function [ CodeableConcept ] ; # 0..1 Identifies the function of the performer during the dispense
    fhir:actor [ Reference(Practitioner) ] ; # 1..1 Who performed the action
  ] ... ) ;
  fhir:location [ Reference(Location) ] ; # 0..1 Where the dispense occurred
  fhir:quantity [ Quantity(SimpleQuantity) ] ; # 0..1 Amount dispensed
  fhir:preparedDate [ dateTime ] ; # 0..1 When product was selected/matched
  fhir:whenHandedOver [ dateTime ] ; # 0..1 When the product was dispatched
  fhir:destination [ Reference(Location) ] ; # 0..1 Where the product was dispatched to
  fhir:note  ( [ Annotation ] ... ) ; # 0..* Additional notes
  fhir:usageInstruction [ string ] ; # 0..1 Specific instructions for use
]

Changes from both R4 and R4B

This resource did not exist in Release R4

See the Full Difference for further information

This analysis is available for R4 as XML or JSON and for R4B as XML or JSON .

 

Additional definitions: Master Definition XML + JSON , XML Schema / Schematron + JSON Schema , ShEx (for Turtle ) + see the extensions , the spreadsheet version & the dependency analysis

12.31.4.1 Terminology Bindings

Path ValueSet Type Documentation
BiologicallyDerivedProductDispense.status BiologicallyDerivedProductDispenseCodes BiologicallyDerivedProductDispenseStatus (a valid code from BiologicallyDerivedProductDispense Biologically Derived Product Dispense Status Codes ) Required

BiologicallyDerivedProductDispense Biologically Derived Product Dispense Status Codes Codes.

BiologicallyDerivedProductDispense.originRelationshipType BiologicallyDerivedProductDispenseOriginRelationship (a valid code from Biologically derived product dispense - origin relationship ) Example

Biologically derived product dispense - origin relationship Derived Product Dispense Origin Relationship.

BiologicallyDerivedProductDispense.matchStatus BiologicallyDerivedProductDispenseMatchStatus (a valid code from Biologically derived product dispense - match status ) Example

Biologically derived product dispense - match status Derived Product Dispense Match Status.

BiologicallyDerivedProductDispense.performer.function BiologicallyDerivedProductDispensePerformerFunction (a valid code from Biologically derived product dispense - performer function ) Example

Biologically derived product dispense - performer function Derived Product Dispense Performer Function.

12.31.5 Search Parameters

Search parameters for this resource. See also the full list of search parameters for this resource , and check the Extensions registry for search parameters on extensions related to this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.

Name Type Description Expression In Common
identifier TU token The identifier of the dispense BiologicallyDerivedProductDispense.identifier
patient TU reference The identity of a patient for whom to list dispenses BiologicallyDerivedProductDispense.patient
( Patient )
performer TU reference The identity of a patient for whom to list dispenses BiologicallyDerivedProductDispense.performer.actor
( Practitioner )
product TU reference Search for products that match this code BiologicallyDerivedProductDispense.product
( BiologicallyDerivedProduct )
status TU token The status of the dispense BiologicallyDerivedProductDispense.status