OO Incubator Implementation Guide
0.1.0 - ci-build International flag

OO Incubator Implementation Guide, published by HL7 International / Orders and Observations. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/oo-incubator/ and changes regularly. See the Directory of published versions

Resource: BiologicallyDerivedProductDispense

Official URL: http://hl7.org/fhir/StructureDefinition/BiologicallyDerivedProductDispense Version: 0.1.0
Standards status: Trial-use Draft as of 2021-01-02 Maturity Level: 0 Computable Name: BiologicallyDerivedProductDispense

A record of dispensation of a biologically derived product.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Resource Content

Description Differentials, Snapshots, and other representations.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. BiologicallyDerivedProductDispense 0..* 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) Part of referenced event
... originRelationshipType 0..1 CodeableConcept Relationship between the donor and intended recipient
Binding: BiologicallyDerivedProductDispenseOriginRelationship (example): Describes the relationship between the recipient and origin of the dispensed product.
... product 1..1 Reference(BiologicallyDerivedProduct) The BiologicallyDerivedProduct that is dispensed
... subject 1..1 Reference(Patient | Group) The intended recipient(s) of the dispensed product
... matchStatus 0..1 CodeableConcept Indicates the type of matching associated with the dispense
Binding: BiologicallyDerivedProductDispenseMatchStatus (example): Describes the type of matching between the recipient and origin of the dispensed product.
... performer 0..* BackboneElement Indicates who or what performed an action
.... function 0..1 CodeableConcept Identifies the function of the performer during the dispense
Binding: BiologicallyDerivedProductDispensePerformerFunction (example): Describes the the role or function of the performer in the dispense.
.... 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

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
BiologicallyDerivedProductDispense.​status Base required Biologically Derived Product Dispense Status 📦6.0.0-ballot3 FHIR Std.
BiologicallyDerivedProductDispense.​originRelationshipType Base example Biologically Derived Product Dispense Origin Relationship 📦6.0.0-ballot3 FHIR Std.
BiologicallyDerivedProductDispense.​matchStatus Base example Biologically Derived Product Dispense Match Status 📦6.0.0-ballot3 FHIR Std.
BiologicallyDerivedProductDispense.​performer.function Base example Biologically Derived Product Dispense Performer Function 📦6.0.0-ballot3 FHIR Std. 
<BiologicallyDerivedProductDispense xmlns="http://hl7.org/fhir"> ​​doco
 ​<id value="[id]"/><!-- 0..1 ​* ​Logical id of this artifact  -->
 ​<meta><!-- ​I 0..1 ​* ​Metadata about the resource  --></meta>
 ​<implicitRules value="[uri]"/><!-- ​I 0..1 ​* ​A set of rules under which this content was created  -->
 ​<language value="[code]"/><!-- ​I 0..1 ​* Language of the resource content  -->
 ​<text><!-- ​I 0..1 ​* ​Text summary of the resource, for human interpretation  --></text>
 ​<contained><!-- 0..* ​* ​Contained, inline Resources  --></contained>
 ​<extension><!-- See Extensions  ​Additional content defined by implementations  --></extension>
 ​<modifierExtension><!-- ​I 0..* ​* ​Extensions that cannot be ignored  --></modifierExtension>
 <identifier><!-- 0..* ​* ​Business identifier for this dispense  --></identifier>
 <basedOn><!-- 0..* ​* ​The order or request that this dispense is fulfilling  --></basedOn>
 <partOf><!-- 0..* ​* ​Part of referenced event  --></partOf>
 <status value="[code]"/><!-- 1..1 ​* preparation | in-progress | allocated | issued | unfulfilled | returned | entered-in-error | unknown  -->
 <originRelationshipType><!-- 0..1 ​* Relationship between the donor and intended recipient  --></originRelationshipType>
 <product><!-- 1..1 ​* ​The BiologicallyDerivedProduct that is dispensed  --></product>
 <subject><!-- 1..1 ​* ​The intended recipient(s) of the dispensed product  --></subject>
 <matchStatus><!-- 0..1 ​* Indicates the type of matching associated with the dispense  --></matchStatus>
 <performer> ​I 0..* ​*  <!-- ​I 0..* Indicates who or what performed an action -->
  ​<id value="[id]"/><!-- 0..1 ​* ​Unique id for inter-element referencing   -->
  ​<extension><!-- See Extensions  ​Additional content defined by implementations   --></extension>
  ​<modifierExtension><!-- ​I 0..* ​* ​Extensions that cannot be ignored even if unrecognized   --></modifierExtension>
  <function><!-- 0..1 ​* Identifies the function of the performer during the dispense   --></function>
  <actor><!-- 1..1 ​* ​Who performed the action   --></actor>
 </performer>
 <location><!-- 0..1 ​* ​Where the dispense occurred  --></location>
 <quantity><!-- 0..1 ​* ​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 ​* ​Where the product was dispatched to  --></destination>
 <note><!-- 0..* ​* ​Additional notes  --></note>
 <usageInstruction value="[string]"/><!-- 0..1 ​* ​Specific instructions for use  -->
</BiologicallyDerivedProductDispense>

​
{​​doco
  "resourceType" : "BiologicallyDerivedProductDispense",
  "id" : "<id>", // 0..1 ​Logical id of this artifact
  "meta" : { Meta }, // ​I 0..1 ​Metadata about the resource
  "implicitRules" : "<uri>", // ​I 0..1 ​A set of rules under which this content was created
  "language" : "<code>", // ​I 0..1 Language of the resource content
  "text" : { Narrative }, // ​I 0..1 ​Text summary of the resource, for human interpretation
  "contained" : [{ ​Resource }], // 0..* ​Contained, inline Resources
  (Extensions - see JSON page)
  (Modifier Extensions - see JSON page)
  "identifier" : [{ Identifier }], // 0..* ​Business identifier for this dispense
  "basedOn" : [{ Reference(ServiceRequest) }], // 0..* ​The order or request that this dispense is fulfilling
  "partOf" : [{ Reference(BiologicallyDerivedProductDispense) }], // 0..* ​Part of referenced event
  "status" : "<code>", // 1..1 preparation | in-progress | allocated | issued | unfulfilled | returned | entered-in-error | unknown
  "originRelationshipType" : { CodeableConcept }, // 0..1 Relationship between the donor and intended recipient
  "product" : { Reference(BiologicallyDerivedProduct) }, // 1..1 ​The BiologicallyDerivedProduct that is dispensed
  "subject" : { Reference(Group|Patient) }, // 1..1 ​The intended recipient(s) of the dispensed product
  "matchStatus" : { CodeableConcept }, // 0..1 Indicates the type of matching associated with the dispense
  "performer" : [{ BackboneElement }], // ​I 0..* ​Indicates who or what performed an action
    "id" : "<id>", // 0..1 ​Unique id for inter-element referencing
  (Extensions - see JSON page)
  (Modifier Extensions - see JSON page)
    "function" : { CodeableConcept }, // 0..1 Identifies the function of the performer during the dispense
    "actor" : { Reference(Practitioner) } // 1..1 ​Who performed the action
  }
  "location" : { Reference(Location) }, // 0..1 ​Where the dispense occurred
  "quantity" : { Quantity }, // 0..1 ​Amount dispensed
  "preparedDate" : "<dateTime>", // 0..1 ​When product was selected/matched
  "whenHandedOver" : "<dateTime>", // 0..1 ​When the product was dispatched
  "destination" : { Reference(Location) }, // 0..1 ​Where the product was dispatched to
  "note" : [{ Annotation }], // 0..* ​Additional notes
  "usageInstruction" : "<string>" // 0..1 ​Specific instructions for use
}

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


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

  fhir:id [ id ] ; # 0..1 Logical id of this artifact
  fhir:meta [ Meta ] ; # 0..1 ​I Metadata about the resource
  fhir:implicitRules [ uri ] ; # 0..1 ​I A set of rules under which this content was created
  fhir:language [ code ] ; # 0..1 ​I Language of the resource content
  fhir:text [ Narrative ] ; # 0..1 ​I Text summary of the resource, for human interpretation
  fhir:contained  ( [ Resource ] ... ) ; # 0..* Contained, inline Resources
  fhir:extension  ( [ Extension ] ... ) ; # 0..* ​I Additional content defined by implementations
  fhir:modifierExtension  ( [ Extension ] ... ) ; # 0..* ​I Extensions that cannot be ignored
  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..* Part of referenced event
  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:subject [ Reference(Group|Patient) ] ; # 1..1 The intended recipient(s) of the dispensed product
  fhir:matchStatus [ CodeableConcept ] ; # 0..1 Indicates the type of matching associated with the dispense
  fhir:performer  ( [ BackboneElement ] ... ) ; # 0..* ​I Indicates who or what performed an action
  fhir:location [ Reference(Location) ] ; # 0..1 Where the dispense occurred
  fhir:quantity [ Quantity ] ; # 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
]

Differential View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. BiologicallyDerivedProductDispense 0..* 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) Part of referenced event
... originRelationshipType 0..1 CodeableConcept Relationship between the donor and intended recipient
Binding: BiologicallyDerivedProductDispenseOriginRelationship (example): Describes the relationship between the recipient and origin of the dispensed product.
... product 1..1 Reference(BiologicallyDerivedProduct) The BiologicallyDerivedProduct that is dispensed
... subject 1..1 Reference(Patient | Group) The intended recipient(s) of the dispensed product
... matchStatus 0..1 CodeableConcept Indicates the type of matching associated with the dispense
Binding: BiologicallyDerivedProductDispenseMatchStatus (example): Describes the type of matching between the recipient and origin of the dispensed product.
... performer 0..* BackboneElement Indicates who or what performed an action
.... function 0..1 CodeableConcept Identifies the function of the performer during the dispense
Binding: BiologicallyDerivedProductDispensePerformerFunction (example): Describes the the role or function of the performer in the dispense.
.... 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

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
BiologicallyDerivedProductDispense.​status Base required Biologically Derived Product Dispense Status 📦6.0.0-ballot3 FHIR Std.
BiologicallyDerivedProductDispense.​originRelationshipType Base example Biologically Derived Product Dispense Origin Relationship 📦6.0.0-ballot3 FHIR Std.
BiologicallyDerivedProductDispense.​matchStatus Base example Biologically Derived Product Dispense Match Status 📦6.0.0-ballot3 FHIR Std.
BiologicallyDerivedProductDispense.​performer.function Base example Biologically Derived Product Dispense Performer Function 📦6.0.0-ballot3 FHIR Std.

 

Other representations of resource: CSV, Excel

Notes:

Name Type Description Expression
based-on reference

The order or request that this dispense is fulfilling

 BiologicallyDerivedProductDispense.basedOn
identifier token

The identifier of the dispense

 BiologicallyDerivedProductDispense.identifier
part-of reference

Part of referenced event

 BiologicallyDerivedProductDispense.partOf
patient reference

The identity of a patient for whom to list dispenses

 BiologicallyDerivedProductDispense.subject.where(resolve() is Patient)
performer reference

Who performed the action

 BiologicallyDerivedProductDispense.performer.actor
product reference

Search for products that match this code

 BiologicallyDerivedProductDispense.product
status token

The status of the dispense

 BiologicallyDerivedProductDispense.status
subject reference

The intended recipient(s) of the dispensed product

 BiologicallyDerivedProductDispense.subject