This
page
is
part
of
the
FHIR
Specification
(v4.3.0:
R4B
(v5.0.0-draft-final:
Final
QA
Preview
for
R5
-
STU
see
ballot
notes
).
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
Orders
and
Observations
Work
Group
|
Maturity
Level
:
|
Trial Use | Security Category : Patient | Compartments : Not linked to any defined compartments |
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.
Trial-Use
Note:
Note
that
this
content
This
is
preliminary
has
not
undergone
proper
review
by
the
appropriate
Workgroups.
A
a
base
resource
that
represents
a
material
substance
originating
from
a
biological
entity
intended
to
be
transplanted
or
infused
into
clinically
applied
(e.g.,
transplanted,
infused,
grafted)
to
another
(possibly
the
same)
biological
entity.
Examples
include:
This
resource
relates
The
following
boundaries
need
to
these
other
resource:
be
considered:
Structure
| Name | Flags | Card. | Type |
Description
&
Constraints
|
|---|---|---|---|---|
|
TU | DomainResource |
Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension |
|
|
|
|
Binding: Biologically Derived Product Category ( Example ) |
|
|
0..1 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Σ | 0..* |
|
|
|
Σ | 0..1 |
|
|
|
0..* |
Reference
(
|
|
|
|
0..1 |
|
|
|
|
0..1 |
|
available
|
Binding: Biologically Derived Product Status ( Example ) |
|
|
0..1 |
|
|
|
|
0..1 | BackboneElement |
|
|
|
0..1 |
|
Individual
performing
collection
|
|
|
0..1 |
|
The
patient
who
underwent
the
medical
procedure
to
collect
the
product
or
the
organization
that
facilitated
the
collection
|
|
|
|
|
|
|
|
|
|
||
|
|
|
||
|
0..1 |
|
|
|
|
|
BackboneElement |
|
|
|
1..1 |
|
Code
that
specifies
the
property
Binding: Biologically Derived Product Property Type Codes ( Example ) |
|
|
1..1 |
|
Property
values
|
|
|
|
|
||
|
|
|
||
|
|
|||
|
|
|||
|
|
|||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
Documentation
for
this
format
|
||||
See the Extensions for this resource
UML Diagram ( Legend )
XML Template
<<a href="biologicallyderivedproduct-definitions.html#BiologicallyDerivedProduct" title="A material substance originating from a biological entity intended to be transplanted or infused<BiologicallyDerivedProduct xmlns="http://hl7.org/fhir"><!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension -->
<</identifier> < <</productCode> < <</request> < <</parent><productCategory><!-- 0..1 Coding organ | tissue | fluid | cells | biologicalAgent --></productCategory> <productCode><!-- 0..1 CodeableConcept A code that identifies the kind of this biologically derived product --></productCode> <parent><!-- 0..* Reference(BiologicallyDerivedProduct) The parent biologically-derived product --></parent> <request><!-- 0..* Reference(ServiceRequest) Request to obtain and/or infuse this product --></request> <identifier><!-- 0..* Identifier Instance identifier --></identifier> <biologicalSourceEvent><!-- 0..1 Identifier An identifier that supports traceability to the event during which material in this product from one or more biological entities was obtained or pooled --></biologicalSourceEvent> <processingFacility><!-- 0..* Reference(Organization) Processing facilities responsible for the labeling and distribution of this biologically derived product --></processingFacility> <division value="[string]"/><!-- 0..1 A unique identifier for an aliquot of a product --> <productStatus><!-- 0..1 Coding available | unavailable --></productStatus> <expirationDate value="[dateTime]"/><!-- 0..1 Date, and where relevant time, of expiration --> <collection> <!-- 0..1 How this product was collected --> <collector><!-- 0..1 Reference(Practitioner|PractitionerRole) Individual performing collection --></collector><</source><source><!-- 0..1 Reference(Organization|Patient) The patient who underwent the medical procedure to collect the product or the organization that facilitated the collection --></source> <collected[x]><!-- 0..1 dateTime|Period Time of product collection --></collected[x]> </collection>< < <</procedure> <</additive> <</time[x]> </processing> < < <</time[x]> </manipulation> < < < < <</duration> </storage><storageTempRequirements><!-- 0..1 Range Product storage temperature requirements --></storageTempRequirements> <property> <!-- 0..* A property that is specific to this BiologicallyDerviedProduct instance --> <type><!-- 1..1 CodeableConcept Code that specifies the property --></type> <value[x]><!-- 1..1 boolean|integer|CodeableConcept|Period|Quantity|Range| Ratio|string|Attachment Property values --></value[x]> </property> </BiologicallyDerivedProduct>
JSON Template
{
"resourceType" : "<a href="biologicallyderivedproduct-definitions.html#BiologicallyDerivedProduct" title="A material substance originating from a biological entity intended to be transplanted or infused
"resourceType" : "BiologicallyDerivedProduct",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"
"
"
"
"
"
"
"productCategory" : { Coding }, // organ | tissue | fluid | cells | biologicalAgent
"productCode" : { CodeableConcept }, // A code that identifies the kind of this biologically derived product
"parent" : [{ Reference(BiologicallyDerivedProduct) }], // The parent biologically-derived product
"request" : [{ Reference(ServiceRequest) }], // Request to obtain and/or infuse this product
"identifier" : [{ Identifier }], // Instance identifier
"biologicalSourceEvent" : { Identifier }, // An identifier that supports traceability to the event during which material in this product from one or more biological entities was obtained or pooled
"processingFacility" : [{ Reference(Organization) }], // Processing facilities responsible for the labeling and distribution of this biologically derived product
"division" : "<string>", // A unique identifier for an aliquot of a product
"productStatus" : { Coding }, // available | unavailable
"expirationDate" : "<dateTime>", // Date, and where relevant time, of expiration
"collection" : { // How this product was collected
"collector" : { Reference(Practitioner|PractitionerRole) }, // Individual performing collection
"
"source" : { Reference(Organization|Patient) }, // The patient who underwent the medical procedure to collect the product or the organization that facilitated the collection
// collected[x]: Time of product collection. One of these 2:
">"
"collectedDateTime" : "<dateTime>",
"collectedPeriod" : { Period }
},
"
"
"
"
">"
" }
}],
"
"
">"
" }
},
"
"
"
"
"
"storageTempRequirements" : { Range }, // Product storage temperature requirements
"property" : [{ // A property that is specific to this BiologicallyDerviedProduct instance
"type" : { CodeableConcept }, // R! Code that specifies the property
// value[x]: Property values. One of these 9:
"valueBoolean" : <boolean>,
"valueInteger" : <integer>,
"valueCodeableConcept" : { CodeableConcept },
"valuePeriod" : { Period },
"valueQuantity" : { Quantity },
"valueRange" : { Range },
"valueRatio" : { Ratio },
"valueString" : "<string>",
"valueAttachment" : { Attachment }
}]
}
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> .![]()
[ a fhir:<a href="biologicallyderivedproduct-definitions.html#BiologicallyDerivedProduct" title="A material substance originating from a biological entity intended to be transplanted or infused[ 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 .modifierExtensionfhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: # . One of these 2 fhir: ] fhir: ] ]; fhir: fhir: fhir: fhir: # . One of these 2 fhir: ] fhir: ] ], ...; fhir: fhir: # . One of these 2 fhir: ] fhir: ] ]; fhir: fhir: fhir: fhir: fhir: ], ...;fhir:productCategory [ Coding ] ; # 0..1 organ | tissue | fluid | cells | biologicalAgent fhir:productCode [ CodeableConcept ] ; # 0..1 A code that identifies the kind of this biologically derived product fhir:parent ( [ Reference(BiologicallyDerivedProduct) ] ... ) ; # 0..* The parent biologically-derived product fhir:request ( [ Reference(ServiceRequest) ] ... ) ; # 0..* Request to obtain and/or infuse this product fhir:identifier ( [ Identifier ] ... ) ; # 0..* Instance identifier fhir:biologicalSourceEvent [ Identifier ] ; # 0..1 An identifier that supports traceability to the event during which material in this product from one or more biological entities was obtained or pooled fhir:processingFacility ( [ Reference(Organization) ] ... ) ; # 0..* Processing facilities responsible for the labeling and distribution of this biologically derived product fhir:division [ string ] ; # 0..1 A unique identifier for an aliquot of a product fhir:productStatus [ Coding ] ; # 0..1 available | unavailable fhir:expirationDate [ dateTime ] ; # 0..1 Date, and where relevant time, of expiration fhir:collection [ # 0..1 How this product was collected fhir:collector [ Reference(Practitioner|PractitionerRole) ] ; # 0..1 Individual performing collection fhir:source [ Reference(Organization|Patient) ] ; # 0..1 The patient who underwent the medical procedure to collect the product or the organization that facilitated the collection # collected[x] : 0..1 Time of product collection. One of these 2 fhir:collected [ a fhir:dateTime ; dateTime ] fhir:collected [ a fhir:Period ; Period ] ] ; fhir:storageTempRequirements [ Range ] ; # 0..1 Product storage temperature requirements fhir:property ( [ # 0..* A property that is specific to this BiologicallyDerviedProduct instance fhir:type [ CodeableConcept ] ; # 1..1 Code that specifies the property # value[x] : 1..1 Property values. One of these 9 fhir:value [ a fhir:boolean ; boolean ] fhir:value [ a fhir:integer ; integer ] fhir:value [ a fhir:CodeableConcept ; CodeableConcept ] fhir:value [ a fhir:Period ; Period ] fhir:value [ a fhir:Quantity ; Quantity ] fhir:value [ a fhir:Range ; Range ] fhir:value [ a fhir:Ratio ; Ratio ] fhir:value [ a fhir:string ; string ] fhir:value [ a fhir:Attachment ; Attachment ] ] ... ) ; ]
Changes since R4
| BiologicallyDerivedProduct | |
| BiologicallyDerivedProduct.productCategory |
|
| BiologicallyDerivedProduct.biologicalSourceEvent |
|
| BiologicallyDerivedProduct.processingFacility |
|
| BiologicallyDerivedProduct.division |
|
| BiologicallyDerivedProduct.productStatus |
|
| BiologicallyDerivedProduct.expirationDate |
|
| BiologicallyDerivedProduct.storageTempRequirements |
|
| BiologicallyDerivedProduct.property |
|
| BiologicallyDerivedProduct.property.type |
|
| BiologicallyDerivedProduct.property.value[x] |
|
| BiologicallyDerivedProduct.status |
|
| BiologicallyDerivedProduct.quantity |
|
| BiologicallyDerivedProduct.processing |
|
| BiologicallyDerivedProduct.manipulation |
|
| BiologicallyDerivedProduct.storage |
|
See the Full Difference for further information
This analysis is available as XML or JSON .
Structure
| Name | Flags | Card. | Type |
Description
&
Constraints
|
|---|---|---|---|---|
|
TU | DomainResource |
Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension |
|
|
|
|
Binding: Biologically Derived Product Category ( Example ) |
|
|
0..1 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Σ | 0..* |
|
|
|
Σ | 0..1 |
|
|
|
0..* |
Reference
(
|
|
|
|
0..1 |
|
|
|
|
0..1 |
|
available
|
Binding: Biologically Derived Product Status ( Example ) |
|
|
0..1 |
|
|
|
|
0..1 | BackboneElement |
|
|
|
0..1 |
|
Individual
performing
collection
|
|
|
0..1 |
|
The
patient
who
underwent
the
medical
procedure
to
collect
the
product
or
the
organization
that
facilitated
the
collection
|
|
|
|
|
|
|
|
|
|
||
|
|
|
||
|
0..1 |
|
|
|
|
|
BackboneElement |
|
|
|
1..1 |
|
Code
that
specifies
the
property
Binding: Biologically Derived Product Property Type Codes ( Example ) |
|
|
1..1 |
|
Property
values
|
|
|
|
|
||
|
|
|
||
|
|
|||
|
|
|||
|
|
|||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
Documentation
for
this
format
|
||||
See the Extensions for this resource
XML Template
<<a href="biologicallyderivedproduct-definitions.html#BiologicallyDerivedProduct" title="A material substance originating from a biological entity intended to be transplanted or infused<BiologicallyDerivedProduct xmlns="http://hl7.org/fhir"><!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension -->
<</identifier> < <</productCode> < <</request> < <</parent><productCategory><!-- 0..1 Coding organ | tissue | fluid | cells | biologicalAgent --></productCategory> <productCode><!-- 0..1 CodeableConcept A code that identifies the kind of this biologically derived product --></productCode> <parent><!-- 0..* Reference(BiologicallyDerivedProduct) The parent biologically-derived product --></parent> <request><!-- 0..* Reference(ServiceRequest) Request to obtain and/or infuse this product --></request> <identifier><!-- 0..* Identifier Instance identifier --></identifier> <biologicalSourceEvent><!-- 0..1 Identifier An identifier that supports traceability to the event during which material in this product from one or more biological entities was obtained or pooled --></biologicalSourceEvent> <processingFacility><!-- 0..* Reference(Organization) Processing facilities responsible for the labeling and distribution of this biologically derived product --></processingFacility> <division value="[string]"/><!-- 0..1 A unique identifier for an aliquot of a product --> <productStatus><!-- 0..1 Coding available | unavailable --></productStatus> <expirationDate value="[dateTime]"/><!-- 0..1 Date, and where relevant time, of expiration --> <collection> <!-- 0..1 How this product was collected --> <collector><!-- 0..1 Reference(Practitioner|PractitionerRole) Individual performing collection --></collector><</source><source><!-- 0..1 Reference(Organization|Patient) The patient who underwent the medical procedure to collect the product or the organization that facilitated the collection --></source> <collected[x]><!-- 0..1 dateTime|Period Time of product collection --></collected[x]> </collection>< < <</procedure> <</additive> <</time[x]> </processing> < < <</time[x]> </manipulation> < < < < <</duration> </storage><storageTempRequirements><!-- 0..1 Range Product storage temperature requirements --></storageTempRequirements> <property> <!-- 0..* A property that is specific to this BiologicallyDerviedProduct instance --> <type><!-- 1..1 CodeableConcept Code that specifies the property --></type> <value[x]><!-- 1..1 boolean|integer|CodeableConcept|Period|Quantity|Range| Ratio|string|Attachment Property values --></value[x]> </property> </BiologicallyDerivedProduct>
JSON Template
{
"resourceType" : "<a href="biologicallyderivedproduct-definitions.html#BiologicallyDerivedProduct" title="A material substance originating from a biological entity intended to be transplanted or infused
"resourceType" : "BiologicallyDerivedProduct",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"
"
"
"
"
"
"
"productCategory" : { Coding }, // organ | tissue | fluid | cells | biologicalAgent
"productCode" : { CodeableConcept }, // A code that identifies the kind of this biologically derived product
"parent" : [{ Reference(BiologicallyDerivedProduct) }], // The parent biologically-derived product
"request" : [{ Reference(ServiceRequest) }], // Request to obtain and/or infuse this product
"identifier" : [{ Identifier }], // Instance identifier
"biologicalSourceEvent" : { Identifier }, // An identifier that supports traceability to the event during which material in this product from one or more biological entities was obtained or pooled
"processingFacility" : [{ Reference(Organization) }], // Processing facilities responsible for the labeling and distribution of this biologically derived product
"division" : "<string>", // A unique identifier for an aliquot of a product
"productStatus" : { Coding }, // available | unavailable
"expirationDate" : "<dateTime>", // Date, and where relevant time, of expiration
"collection" : { // How this product was collected
"collector" : { Reference(Practitioner|PractitionerRole) }, // Individual performing collection
"
"source" : { Reference(Organization|Patient) }, // The patient who underwent the medical procedure to collect the product or the organization that facilitated the collection
// collected[x]: Time of product collection. One of these 2:
">"
"collectedDateTime" : "<dateTime>",
"collectedPeriod" : { Period }
},
"
"
"
"
">"
" }
}],
"
"
">"
" }
},
"
"
"
"
"
"storageTempRequirements" : { Range }, // Product storage temperature requirements
"property" : [{ // A property that is specific to this BiologicallyDerviedProduct instance
"type" : { CodeableConcept }, // R! Code that specifies the property
// value[x]: Property values. One of these 9:
"valueBoolean" : <boolean>,
"valueInteger" : <integer>,
"valueCodeableConcept" : { CodeableConcept },
"valuePeriod" : { Period },
"valueQuantity" : { Quantity },
"valueRange" : { Range },
"valueRatio" : { Ratio },
"valueString" : "<string>",
"valueAttachment" : { Attachment }
}]
}
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> .![]()
[ a fhir:<a href="biologicallyderivedproduct-definitions.html#BiologicallyDerivedProduct" title="A material substance originating from a biological entity intended to be transplanted or infused[ 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 .modifierExtensionfhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: # . One of these 2 fhir: ] fhir: ] ]; fhir: fhir: fhir: fhir: # . One of these 2 fhir: ] fhir: ] ], ...; fhir: fhir: # . One of these 2 fhir: ] fhir: ] ]; fhir: fhir: fhir: fhir: fhir: ], ...;fhir:productCategory [ Coding ] ; # 0..1 organ | tissue | fluid | cells | biologicalAgent fhir:productCode [ CodeableConcept ] ; # 0..1 A code that identifies the kind of this biologically derived product fhir:parent ( [ Reference(BiologicallyDerivedProduct) ] ... ) ; # 0..* The parent biologically-derived product fhir:request ( [ Reference(ServiceRequest) ] ... ) ; # 0..* Request to obtain and/or infuse this product fhir:identifier ( [ Identifier ] ... ) ; # 0..* Instance identifier fhir:biologicalSourceEvent [ Identifier ] ; # 0..1 An identifier that supports traceability to the event during which material in this product from one or more biological entities was obtained or pooled fhir:processingFacility ( [ Reference(Organization) ] ... ) ; # 0..* Processing facilities responsible for the labeling and distribution of this biologically derived product fhir:division [ string ] ; # 0..1 A unique identifier for an aliquot of a product fhir:productStatus [ Coding ] ; # 0..1 available | unavailable fhir:expirationDate [ dateTime ] ; # 0..1 Date, and where relevant time, of expiration fhir:collection [ # 0..1 How this product was collected fhir:collector [ Reference(Practitioner|PractitionerRole) ] ; # 0..1 Individual performing collection fhir:source [ Reference(Organization|Patient) ] ; # 0..1 The patient who underwent the medical procedure to collect the product or the organization that facilitated the collection # collected[x] : 0..1 Time of product collection. One of these 2 fhir:collected [ a fhir:dateTime ; dateTime ] fhir:collected [ a fhir:Period ; Period ] ] ; fhir:storageTempRequirements [ Range ] ; # 0..1 Product storage temperature requirements fhir:property ( [ # 0..* A property that is specific to this BiologicallyDerviedProduct instance fhir:type [ CodeableConcept ] ; # 1..1 Code that specifies the property # value[x] : 1..1 Property values. One of these 9 fhir:value [ a fhir:boolean ; boolean ] fhir:value [ a fhir:integer ; integer ] fhir:value [ a fhir:CodeableConcept ; CodeableConcept ] fhir:value [ a fhir:Period ; Period ] fhir:value [ a fhir:Quantity ; Quantity ] fhir:value [ a fhir:Range ; Range ] fhir:value [ a fhir:Ratio ; Ratio ] fhir:value [ a fhir:string ; string ] fhir:value [ a fhir:Attachment ; Attachment ] ] ... ) ; ]
Changes since Release 4
| BiologicallyDerivedProduct | |
| BiologicallyDerivedProduct.productCategory |
|
| BiologicallyDerivedProduct.biologicalSourceEvent |
|
| BiologicallyDerivedProduct.processingFacility |
|
| BiologicallyDerivedProduct.division |
|
| BiologicallyDerivedProduct.productStatus |
|
| BiologicallyDerivedProduct.expirationDate |
|
| BiologicallyDerivedProduct.storageTempRequirements |
|
| BiologicallyDerivedProduct.property |
|
| BiologicallyDerivedProduct.property.type |
|
| BiologicallyDerivedProduct.property.value[x] |
|
| BiologicallyDerivedProduct.status |
|
| BiologicallyDerivedProduct.quantity |
|
| BiologicallyDerivedProduct.processing |
|
| BiologicallyDerivedProduct.manipulation |
|
| BiologicallyDerivedProduct.storage |
|
See the Full Difference for further information
This analysis is available as XML or JSON .
See
the
Profiles
&
Extensions
and
the
alternate
Additional
definitions:
Master
Definition
XML
+
JSON
,
XML
Schema
/
Schematron
+
JSON
Schema
,
ShEx
(for
Turtle
)
+
see
the
extensions
,
the
spreadsheet
version
&
the
dependency
analysis
| Path |
|
Type |
|
|---|---|---|---|
| BiologicallyDerivedProduct.productCategory | BiologicallyDerivedProductCategory |
|
Biologically Derived Product Category. |
| BiologicallyDerivedProduct.productCode | BiologicallyDerivedProductCodes | Example |
This value set enumerates ISBT 128 Product Description Codes© published by ICCBBA as a part of the ISBT 128 standard. These codes support characterization and classification of medical products of human origin inclusive of processing conditions such as additives, volumes and handling conditions. |
| BiologicallyDerivedProduct.productStatus | BiologicallyDerivedProductStatus |
|
Biologically Derived Product Status. |
| BiologicallyDerivedProduct.property.type | BiologicallyDerivedProductPropertyTypeCodes | Example |
This value set can enumerate ISBT 128 Codes published by ICCBBA as a part of the ISBT 128 standard. These example codes represent data elements defined in ST-027 ISBT 128 Dictionary of Standard Data Elements and are used to define data structure and format expectations for electronic exchange with the ISBT 128 standard. |
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 |
| biological-source-event | token | The biological source for the biologically derived product | BiologicallyDerivedProduct.biologicalSourceEvent | |
| code |
|
A code that identifies the kind of this biologically derived product (SNOMED CT code). | BiologicallyDerivedProduct.productCode | |
| collector | reference | Procedure request to obtain this biologically derived product. |
BiologicallyDerivedProduct.collection.collector
( Practitioner , PractitionerRole ) | |
| identifier | token | Identifier | BiologicallyDerivedProduct.identifier | |
| product-category | token | Broad category of this product. | BiologicallyDerivedProduct.productCategory | |
| product-status | token | Whether the product is currently available. | BiologicallyDerivedProduct.productStatus | |
| request | reference | Procedure request to obtain this biologically derived product. |
BiologicallyDerivedProduct.request
( ServiceRequest ) | |
| serial-number | token | Identifier | BiologicallyDerivedProduct.identifier |