R4 Ballot #1 #2 (Mixed Normative/Trial use)

This page is part of the FHIR Specification ~~(v3.3.0:~~ (v3.5.0: R4 Ballot ~~2).~~ #2). The current version which supercedes this version is 5.0.0 . For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4

10.11 Resource BiologicallyDerivedProduct - Content

Orders and Observations

Work Group

Maturity Level : 0

~~Draft~~ Trial Use

Compartments : Not linked to any defined compartments

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

10.11.1 Scope and Usage

Note that this content is preliminary has not undergone proper review by the appropriate Workgroups.

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

Examples include:

hematopoietic stem cells (bone marrow, peripheral blood, or cord blood extraction)
blood (whole, extracted cells, plasma, etc.)
organs
tissues (porcine valves, skin, bovine cardiac tissue, etc.)
manipulated cells (e.g. CAR T-cells)

The workflow using this resource (e.g., request, administration) should be discussed and implemented in a consistent way as other similar resources are handled (e.g., device, medication)

10.11.2 Boundaries and Relationships

This resource relates to these other resource:

ProcedureRequest (for collection)
Patient ("receiver" and "source")
Practitioner (who collected product)
Substance (product processing)
DiagnosticReport (containing HLA-typing)
BiologicallyDerivedProduct ("parent" product for multi-day collections)
Procedure (one for collection and one for transplantation, will need to add BiologicallyDerivedProduct to the "usedReference")

Structure

Name	Flags	Card.	Type	Description & Constraints
BiologicallyDerivedProduct	D TU		DomainResource	A material substance originating from a biological entity Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension
identifier	Σ	0..*	Identifier	External ids for this item
productCategory		0..1	code	organ \| tissue \| fluid \| cells \| biologicalAgent BiologicallyDerivedProductCategory ( Required )
productCode		0..1	CodeableConcept	What this biologically derived product is
status		0..1	code	available \| unavailable BiologicallyDerivedProductStatus ( Required )
request		0..*	Reference ( ServiceRequest )	Procedure request
quantity		0..1	integer	The amount of this biologically derived product
parent		0..1	Reference ( Any )	BiologicallyDerivedProduct parent
collection		0..1	BackboneElement	How this product was collected
collector		0..1	Reference ( Practitioner \| PractitionerRole \| Patient \| RelatedPerson )	HealthCare Professional performing collection
source		0..1	Reference ( Patient \| Organization )	Person or entity providing product
collected[x]		0..1		Time of product collection
collectedDateTime			dateTime
collectedPeriod			Period
processing		0..*	BackboneElement	Any processing of the product during collection
description		0..1	string	Description of of processing
procedure		0..1	CodeableConcept	Procesing code Procedure Codes (SNOMED CT) ( Example )
additive		0..1	Reference ( Substance )	Substance added during processing
time[x]		0..1		Time of processing
timeDateTime			dateTime
timePeriod			Period
manipulation		0..1	BackboneElement	Any manipulation of product post-collection
description		0..1	string	Description of manipulation
time[x]		0..1		Time of manipulation
timeDateTime			dateTime
timePeriod			Period
storage		0..*	BackboneElement	Product storage
description		0..1	string	Description of storage
temperature		0..1	decimal	Storage temperature
scale		0..1	code	farenheit \| celsius \| kelvin BiologicallyDerivedProductStorageScale ( Required )
duration		0..1	Period	Storage timeperiod
Documentation for this format

UML Diagram ( Legend )

XML Template

<BiologicallyDerivedProduct xmlns="http://hl7.org/fhir"> 
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <identifier><!-- 0..* Identifier External ids for this item --></identifier>
 <productCategory value="[code]"/><!-- 0..1 organ | tissue | fluid | cells | biologicalAgent -->
 <productCode><!-- 0..1 CodeableConcept What this biologically derived product is --></productCode>
 <status value="[code]"/><!-- 0..1 available | unavailable -->
 <request><!-- 0..* Reference(ServiceRequest) Procedure request --></request>
 <quantity value="[integer]"/><!-- 0..1 The amount of this biologically derived product -->
 <parent><!-- 0..1 Reference(Any) BiologicallyDerivedProduct parent --></parent>
 <collection>  <!-- 0..1 How this product was collected -->
  <collector><!-- 0..1 Reference(Practitioner|PractitionerRole|Patient|
    RelatedPerson) HealthCare Professional performing collection --></collector>
  <source><!-- 0..1 Reference(Patient|Organization) Person or entity providing product --></source>
  <collected[x]><!-- 0..1 dateTime|Period Time of product collection --></collected[x]>
 </collection>
 <processing>  <!-- 0..* Any processing of the product during collection -->
  <description value="[string]"/><!-- 0..1 Description of of processing -->
  <procedure><!-- 0..1 CodeableConcept Procesing code --></procedure>
  <additive><!-- 0..1 Reference(Substance) Substance added during processing --></additive>
  <time[x]><!-- 0..1 dateTime|Period Time of processing --></time[x]>
 </processing>
 <manipulation>  <!-- 0..1 Any manipulation of product post-collection -->
  <description value="[string]"/><!-- 0..1 Description of manipulation -->
  <time[x]><!-- 0..1 dateTime|Period Time of manipulation --></time[x]>
 </manipulation>
 <storage>  <!-- 0..* Product storage -->
  <description value="[string]"/><!-- 0..1 Description of storage -->
  <temperature value="[decimal]"/><!-- 0..1 Storage temperature -->
  <scale value="[code]"/><!-- 0..1 farenheit | celsius | kelvin -->
  <duration><!-- 0..1 Period Storage timeperiod --></duration>
 </storage>
</BiologicallyDerivedProduct>

JSON Template

{
  "resourceType" : "BiologicallyDerivedProduct",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : [{ Identifier }], // External ids for this item
  "productCategory" : "<code>", // organ | tissue | fluid | cells | biologicalAgent
  "productCode" : { CodeableConcept }, // What this biologically derived product is
  "status" : "<code>", // available | unavailable
  "request" : [{ Reference(ServiceRequest) }], // Procedure request
  "quantity" : <integer>, // The amount of this biologically derived product
  "parent" : { Reference(Any) }, // BiologicallyDerivedProduct parent
  "collection" : { // How this product was collected
    "collector" : { Reference(Practitioner|PractitionerRole|Patient|
    RelatedPerson) }, // HealthCare Professional performing collection
    "source" : { Reference(Patient|Organization) }, // Person or entity providing product
    // collected[x]: Time of product collection. One of these 2:
    "collectedDateTime" : "<dateTime>"
    "collectedPeriod" : { Period }
  },
  "processing" : [{ // Any processing of the product during collection
    "description" : "<string>", // Description of of processing
    "procedure" : { CodeableConcept }, // Procesing code
    "additive" : { Reference(Substance) }, // Substance added during processing
    // time[x]: Time of processing. One of these 2:
    "timeDateTime" : "<dateTime>"
    "timePeriod" : { Period }
  }],
  "manipulation" : { // Any manipulation of product post-collection
    "description" : "<string>", // Description of manipulation
    // time[x]: Time of manipulation. One of these 2:
    "timeDateTime" : "<dateTime>"
    "timePeriod" : { Period }
  },
  "storage" : [{ // Product storage
    "description" : "<string>", // Description of storage
    "temperature" : <decimal>, // Storage temperature
    "scale" : "<code>", // farenheit | celsius | kelvin
    "duration" : { Period } // Storage timeperiod
  }]
}

Turtle Template

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


[ a fhir:BiologicallyDerivedProduct;
  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:BiologicallyDerivedProduct.identifier [ Identifier ], ... ; # 0..* External ids for this item
  fhir:BiologicallyDerivedProduct.productCategory [ code ]; # 0..1 organ | tissue | fluid | cells | biologicalAgent
  fhir:BiologicallyDerivedProduct.productCode [ CodeableConcept ]; # 0..1 What this biologically derived product is
  fhir:BiologicallyDerivedProduct.status [ code ]; # 0..1 available | unavailable
  fhir:BiologicallyDerivedProduct.request [ Reference(ServiceRequest) ], ... ; # 0..* Procedure request
  fhir:BiologicallyDerivedProduct.quantity [ integer ]; # 0..1 The amount of this biologically derived product
  fhir:BiologicallyDerivedProduct.parent [ Reference(Any) ]; # 0..1 BiologicallyDerivedProduct parent
  fhir:BiologicallyDerivedProduct.collection [ # 0..1 How this product was collected
    fhir:BiologicallyDerivedProduct.collection.collector [ Reference(Practitioner|PractitionerRole|Patient|RelatedPerson) ]; # 0..1 HealthCare Professional performing collection
    fhir:BiologicallyDerivedProduct.collection.source [ Reference(Patient|Organization) ]; # 0..1 Person or entity providing product
    # BiologicallyDerivedProduct.collection.collected[x] : 0..1 Time of product collection. One of these 2
      fhir:BiologicallyDerivedProduct.collection.collectedDateTime [ dateTime ]
      fhir:BiologicallyDerivedProduct.collection.collectedPeriod [ Period ]
  ];
  fhir:BiologicallyDerivedProduct.processing [ # 0..* Any processing of the product during collection
    fhir:BiologicallyDerivedProduct.processing.description [ string ]; # 0..1 Description of of processing
    fhir:BiologicallyDerivedProduct.processing.procedure [ CodeableConcept ]; # 0..1 Procesing code
    fhir:BiologicallyDerivedProduct.processing.additive [ Reference(Substance) ]; # 0..1 Substance added during processing
    # BiologicallyDerivedProduct.processing.time[x] : 0..1 Time of processing. One of these 2
      fhir:BiologicallyDerivedProduct.processing.timeDateTime [ dateTime ]
      fhir:BiologicallyDerivedProduct.processing.timePeriod [ Period ]
  ], ...;
  fhir:BiologicallyDerivedProduct.manipulation [ # 0..1 Any manipulation of product post-collection
    fhir:BiologicallyDerivedProduct.manipulation.description [ string ]; # 0..1 Description of manipulation
    # BiologicallyDerivedProduct.manipulation.time[x] : 0..1 Time of manipulation. One of these 2
      fhir:BiologicallyDerivedProduct.manipulation.timeDateTime [ dateTime ]
      fhir:BiologicallyDerivedProduct.manipulation.timePeriod [ Period ]
  ];
  fhir:BiologicallyDerivedProduct.storage [ # 0..* Product storage
    fhir:BiologicallyDerivedProduct.storage.description [ string ]; # 0..1 Description of storage
    fhir:BiologicallyDerivedProduct.storage.temperature [ decimal ]; # 0..1 Storage temperature
    fhir:BiologicallyDerivedProduct.storage.scale [ code ]; # 0..1 farenheit | celsius | kelvin
    fhir:BiologicallyDerivedProduct.storage.duration [ Period ]; # 0..1 Storage timeperiod
  ], ...;
]

Changes since R3

This resource did not exist in Release 2

This analysis is available as XML or JSON .

See R3 <--> R4 Conversion Maps (status = Not Mapped)

Structure

Name	Flags	Card.	Type	Description & Constraints
BiologicallyDerivedProduct	D TU		DomainResource	A material substance originating from a biological entity Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension
identifier	Σ	0..*	Identifier	External ids for this item
productCategory		0..1	code	organ \| tissue \| fluid \| cells \| biologicalAgent BiologicallyDerivedProductCategory ( Required )
productCode		0..1	CodeableConcept	What this biologically derived product is
status		0..1	code	available \| unavailable BiologicallyDerivedProductStatus ( Required )
request		0..*	Reference ( ServiceRequest )	Procedure request
quantity		0..1	integer	The amount of this biologically derived product
parent		0..1	Reference ( Any )	BiologicallyDerivedProduct parent
collection		0..1	BackboneElement	How this product was collected
collector		0..1	Reference ( Practitioner \| PractitionerRole \| Patient \| RelatedPerson )	HealthCare Professional performing collection
source		0..1	Reference ( Patient \| Organization )	Person or entity providing product
collected[x]		0..1		Time of product collection
collectedDateTime			dateTime
collectedPeriod			Period
processing		0..*	BackboneElement	Any processing of the product during collection
description		0..1	string	Description of of processing
procedure		0..1	CodeableConcept	Procesing code Procedure Codes (SNOMED CT) ( Example )
additive		0..1	Reference ( Substance )	Substance added during processing
time[x]		0..1		Time of processing
timeDateTime			dateTime
timePeriod			Period
manipulation		0..1	BackboneElement	Any manipulation of product post-collection
description		0..1	string	Description of manipulation
time[x]		0..1		Time of manipulation
timeDateTime			dateTime
timePeriod			Period
storage		0..*	BackboneElement	Product storage
description		0..1	string	Description of storage
temperature		0..1	decimal	Storage temperature
scale		0..1	code	farenheit \| celsius \| kelvin BiologicallyDerivedProductStorageScale ( Required )
duration		0..1	Period	Storage timeperiod
Documentation for this format

UML Diagram ( Legend )

XML Template

<BiologicallyDerivedProduct xmlns="http://hl7.org/fhir"> 
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <identifier><!-- 0..* Identifier External ids for this item --></identifier>
 <productCategory value="[code]"/><!-- 0..1 organ | tissue | fluid | cells | biologicalAgent -->
 <productCode><!-- 0..1 CodeableConcept What this biologically derived product is --></productCode>
 <status value="[code]"/><!-- 0..1 available | unavailable -->
 <request><!-- 0..* Reference(ServiceRequest) Procedure request --></request>
 <quantity value="[integer]"/><!-- 0..1 The amount of this biologically derived product -->
 <parent><!-- 0..1 Reference(Any) BiologicallyDerivedProduct parent --></parent>
 <collection>  <!-- 0..1 How this product was collected -->
  <collector><!-- 0..1 Reference(Practitioner|PractitionerRole|Patient|
    RelatedPerson) HealthCare Professional performing collection --></collector>
  <source><!-- 0..1 Reference(Patient|Organization) Person or entity providing product --></source>
  <collected[x]><!-- 0..1 dateTime|Period Time of product collection --></collected[x]>
 </collection>
 <processing>  <!-- 0..* Any processing of the product during collection -->
  <description value="[string]"/><!-- 0..1 Description of of processing -->
  <procedure><!-- 0..1 CodeableConcept Procesing code --></procedure>
  <additive><!-- 0..1 Reference(Substance) Substance added during processing --></additive>
  <time[x]><!-- 0..1 dateTime|Period Time of processing --></time[x]>
 </processing>
 <manipulation>  <!-- 0..1 Any manipulation of product post-collection -->
  <description value="[string]"/><!-- 0..1 Description of manipulation -->
  <time[x]><!-- 0..1 dateTime|Period Time of manipulation --></time[x]>
 </manipulation>
 <storage>  <!-- 0..* Product storage -->
  <description value="[string]"/><!-- 0..1 Description of storage -->
  <temperature value="[decimal]"/><!-- 0..1 Storage temperature -->
  <scale value="[code]"/><!-- 0..1 farenheit | celsius | kelvin -->
  <duration><!-- 0..1 Period Storage timeperiod --></duration>
 </storage>
</BiologicallyDerivedProduct>

JSON Template

{
  "resourceType" : "BiologicallyDerivedProduct",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : [{ Identifier }], // External ids for this item
  "productCategory" : "<code>", // organ | tissue | fluid | cells | biologicalAgent
  "productCode" : { CodeableConcept }, // What this biologically derived product is
  "status" : "<code>", // available | unavailable
  "request" : [{ Reference(ServiceRequest) }], // Procedure request
  "quantity" : <integer>, // The amount of this biologically derived product
  "parent" : { Reference(Any) }, // BiologicallyDerivedProduct parent
  "collection" : { // How this product was collected
    "collector" : { Reference(Practitioner|PractitionerRole|Patient|
    RelatedPerson) }, // HealthCare Professional performing collection
    "source" : { Reference(Patient|Organization) }, // Person or entity providing product
    // collected[x]: Time of product collection. One of these 2:
    "collectedDateTime" : "<dateTime>"
    "collectedPeriod" : { Period }
  },
  "processing" : [{ // Any processing of the product during collection
    "description" : "<string>", // Description of of processing
    "procedure" : { CodeableConcept }, // Procesing code
    "additive" : { Reference(Substance) }, // Substance added during processing
    // time[x]: Time of processing. One of these 2:
    "timeDateTime" : "<dateTime>"
    "timePeriod" : { Period }
  }],
  "manipulation" : { // Any manipulation of product post-collection
    "description" : "<string>", // Description of manipulation
    // time[x]: Time of manipulation. One of these 2:
    "timeDateTime" : "<dateTime>"
    "timePeriod" : { Period }
  },
  "storage" : [{ // Product storage
    "description" : "<string>", // Description of storage
    "temperature" : <decimal>, // Storage temperature
    "scale" : "<code>", // farenheit | celsius | kelvin
    "duration" : { Period } // Storage timeperiod
  }]
}

Turtle Template

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


[ a fhir:BiologicallyDerivedProduct;
  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:BiologicallyDerivedProduct.identifier [ Identifier ], ... ; # 0..* External ids for this item
  fhir:BiologicallyDerivedProduct.productCategory [ code ]; # 0..1 organ | tissue | fluid | cells | biologicalAgent
  fhir:BiologicallyDerivedProduct.productCode [ CodeableConcept ]; # 0..1 What this biologically derived product is
  fhir:BiologicallyDerivedProduct.status [ code ]; # 0..1 available | unavailable
  fhir:BiologicallyDerivedProduct.request [ Reference(ServiceRequest) ], ... ; # 0..* Procedure request
  fhir:BiologicallyDerivedProduct.quantity [ integer ]; # 0..1 The amount of this biologically derived product
  fhir:BiologicallyDerivedProduct.parent [ Reference(Any) ]; # 0..1 BiologicallyDerivedProduct parent
  fhir:BiologicallyDerivedProduct.collection [ # 0..1 How this product was collected
    fhir:BiologicallyDerivedProduct.collection.collector [ Reference(Practitioner|PractitionerRole|Patient|RelatedPerson) ]; # 0..1 HealthCare Professional performing collection
    fhir:BiologicallyDerivedProduct.collection.source [ Reference(Patient|Organization) ]; # 0..1 Person or entity providing product
    # BiologicallyDerivedProduct.collection.collected[x] : 0..1 Time of product collection. One of these 2
      fhir:BiologicallyDerivedProduct.collection.collectedDateTime [ dateTime ]
      fhir:BiologicallyDerivedProduct.collection.collectedPeriod [ Period ]
  ];
  fhir:BiologicallyDerivedProduct.processing [ # 0..* Any processing of the product during collection
    fhir:BiologicallyDerivedProduct.processing.description [ string ]; # 0..1 Description of of processing
    fhir:BiologicallyDerivedProduct.processing.procedure [ CodeableConcept ]; # 0..1 Procesing code
    fhir:BiologicallyDerivedProduct.processing.additive [ Reference(Substance) ]; # 0..1 Substance added during processing
    # BiologicallyDerivedProduct.processing.time[x] : 0..1 Time of processing. One of these 2
      fhir:BiologicallyDerivedProduct.processing.timeDateTime [ dateTime ]
      fhir:BiologicallyDerivedProduct.processing.timePeriod [ Period ]
  ], ...;
  fhir:BiologicallyDerivedProduct.manipulation [ # 0..1 Any manipulation of product post-collection
    fhir:BiologicallyDerivedProduct.manipulation.description [ string ]; # 0..1 Description of manipulation
    # BiologicallyDerivedProduct.manipulation.time[x] : 0..1 Time of manipulation. One of these 2
      fhir:BiologicallyDerivedProduct.manipulation.timeDateTime [ dateTime ]
      fhir:BiologicallyDerivedProduct.manipulation.timePeriod [ Period ]
  ];
  fhir:BiologicallyDerivedProduct.storage [ # 0..* Product storage
    fhir:BiologicallyDerivedProduct.storage.description [ string ]; # 0..1 Description of storage
    fhir:BiologicallyDerivedProduct.storage.temperature [ decimal ]; # 0..1 Storage temperature
    fhir:BiologicallyDerivedProduct.storage.scale [ code ]; # 0..1 farenheit | celsius | kelvin
    fhir:BiologicallyDerivedProduct.storage.duration [ Period ]; # 0..1 Storage timeperiod
  ], ...;
]

Changes since ~~DSTU2~~ Release 3

This resource did not exist in Release 2

This analysis is available as XML or JSON .

See R3 <--> R4 Conversion Maps (status = Not Mapped)

~~Alternate~~ See the Profiles & Extensions and the alternate definitions: Master Definition XML + JSON , XML Schema / Schematron + JSON Schema , ShEx (for Turtle ) + see the extensions & the dependency analysis

10.11.3.1 Terminology Bindings

Path	Definition	Type	Reference
BiologicallyDerivedProduct.productCategory	Biologically Derived Product ~~Category~~ Category.	Required	BiologicallyDerivedProductCategory
BiologicallyDerivedProduct.productCode	Biologically Derived Product ~~Code~~ Code.	Unknown	No details provided yet
BiologicallyDerivedProduct.status	Biologically Derived Product ~~Status~~ Status.	Required	BiologicallyDerivedProductStatus
BiologicallyDerivedProduct.processing.procedure	Biologically Derived Product ~~Procedure~~ Procedure.	Example	~~Procedure Codes (SNOMED CT)~~ ProcedureCodes(SNOMEDCT)
BiologicallyDerivedProduct.storage.scale	BiologicallyDerived Product Storage ~~Scale~~ Scale.	Required	BiologicallyDerivedProductStorageScale

Path

Definition

Type

Reference

BiologicallyDerivedProduct.productCategory

Biologically Derived Product ~~Category~~ Category.

Required

BiologicallyDerivedProductCategory

BiologicallyDerivedProduct.productCode

Biologically Derived Product ~~Code~~ Code.

Unknown

No details provided yet