FHIR CI-Build
AdministrationThis is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions 
| Orders and Observations Work Group | Maturity Level: 2 | Trial Use | Security Category: Patient | Compartments: No 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.
This is a base resource that represents a material substance originating from a biological entity intended to be clinically applied (e.g., transplanted, infused, grafted) to another (possibly the same) biological entity. Examples include:
The following boundaries need to be considered:
Structure
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  BiologicallyDerivedProduct |
TU | DomainResource | This resource reflects an instance of a biologically derived product Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | |
  productCategory |
0..* | CodeableConcept | A category or classification of the product Binding: Biologically Derived Product Category (Example) | |
| productCode |
0..1 | CodeableConcept | A code that identifies the kind of this biologically derived product Binding: Biologically Derived Product Codes (Example) | |
 parent |
0..* | Reference(BiologicallyDerivedProduct) | The parent biologically-derived product | |
| request |
0..* | Reference(ServiceRequest) | Request to obtain and/or infuse this product | |
| identifier |
Σ | 0..* | Identifier | Instance 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 |
| processingFacility |
0..* | Reference(Organization) | Processing facilities responsible for the labeling and distribution of this biologically derived product | |
 division |
0..1 | string | A unique identifier for an aliquot of a product | |
| productStatus |
0..1 | Coding | available | unavailable | processed | applied | discarded Binding: Biologically Derived Product Status (Example) | |
| expirationDate |
0..1 | dateTime | Date, and where relevant time, of expiration | |
  collection |
0..1 | BackboneElement | How this product was collected | |
 collector |
0..1 | Reference(Practitioner | PractitionerRole) | Individual performing collection | |
| source |
0..1 | Reference(Patient | Organization) | 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 | ||
| collectedDateTime |
dateTime | |||
 collectedPeriod |
Period | |||
| procedure |
0..1 | Reference(Procedure) | The procedure involved in the collection | |
| storageTempRequirements |
0..1 | Range | Product storage temperature requirements | |
 property |
0..* | BackboneElement | A property that is specific to this BiologicallyDerviedProduct instance | |
 type |
1..1 | CodeableConcept | Code that specifies the property Binding: Biologically Derived Product Property Type Codes (Example) | |
| value[x] |
1..1 | Property values | ||
| valueBoolean |
boolean | |||
| valueInteger |
integer | |||
| valueCodeableConcept |
CodeableConcept | |||
| valuePeriod |
Period | |||
| valueQuantity |
Quantity | |||
| valueRange |
Range | |||
| valueRatio |
Ratio | |||
| valueString |
string | |||
| valueAttachment |
Attachment | |||
| Documentation for this format | ||||
See the Extensions for this resource
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 --> <productCategory><!-- 0..* CodeableConcept A category or classification of the product --></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 | processed | applied | discarded --></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><!-- 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]> <procedure><!-- 0..1 Reference(Procedure) The procedure involved in the collection --></procedure> </collection> <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" : "BiologicallyDerivedProduct",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"productCategory" : [{ CodeableConcept }], // A category or classification of the product
"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 | processed | applied | discarded
"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 },
"procedure" : { Reference(Procedure) } // The procedure involved in the collection
},
"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/> .
Changes from both R4 and R4B
| BiologicallyDerivedProduct | |
| BiologicallyDerivedProduct.productCategory |
|
| BiologicallyDerivedProduct.biologicalSourceEvent |
|
| BiologicallyDerivedProduct.processingFacility |
|
| BiologicallyDerivedProduct.division |
|
| BiologicallyDerivedProduct.productStatus |
|
| BiologicallyDerivedProduct.expirationDate |
|
| BiologicallyDerivedProduct.collection.procedure |
|
| 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 for R4 as XML or JSON and for R4B as XML or JSON.
Structure
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| BiologicallyDerivedProduct |
TU | DomainResource | This resource reflects an instance of a biologically derived product Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | |
| productCategory |
0..* | CodeableConcept | A category or classification of the product Binding: Biologically Derived Product Category (Example) | |
| productCode |
0..1 | CodeableConcept | A code that identifies the kind of this biologically derived product Binding: Biologically Derived Product Codes (Example) | |
| parent |
0..* | Reference(BiologicallyDerivedProduct) | The parent biologically-derived product | |
| request |
0..* | Reference(ServiceRequest) | Request to obtain and/or infuse this product | |
| identifier |
Σ | 0..* | Identifier | Instance 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 |
| processingFacility |
0..* | Reference(Organization) | Processing facilities responsible for the labeling and distribution of this biologically derived product | |
| division |
0..1 | string | A unique identifier for an aliquot of a product | |
| productStatus |
0..1 | Coding | available | unavailable | processed | applied | discarded Binding: Biologically Derived Product Status (Example) | |
| expirationDate |
0..1 | dateTime | Date, and where relevant time, of expiration | |
| collection |
0..1 | BackboneElement | How this product was collected | |
| collector |
0..1 | Reference(Practitioner | PractitionerRole) | Individual performing collection | |
| source |
0..1 | Reference(Patient | Organization) | 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 | ||
| collectedDateTime |
dateTime | |||
| collectedPeriod |
Period | |||
| procedure |
0..1 | Reference(Procedure) | The procedure involved in the collection | |
| storageTempRequirements |
0..1 | Range | Product storage temperature requirements | |
| property |
0..* | BackboneElement | A property that is specific to this BiologicallyDerviedProduct instance | |
| type |
1..1 | CodeableConcept | Code that specifies the property Binding: Biologically Derived Product Property Type Codes (Example) | |
| value[x] |
1..1 | Property values | ||
| valueBoolean |
boolean | |||
| valueInteger |
integer | |||
| valueCodeableConcept |
CodeableConcept | |||
| valuePeriod |
Period | |||
| valueQuantity |
Quantity | |||
| valueRange |
Range | |||
| valueRatio |
Ratio | |||
| valueString |
string | |||
| valueAttachment |
Attachment | |||
| Documentation for this format | ||||
See the Extensions for this resource
XML Template
<BiologicallyDerivedProduct xmlns="http://hl7.org/fhir">
JSON Template
{
"resourceType" : "BiologicallyDerivedProduct",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"productCategory" : [{ CodeableConcept }], // A category or classification of the product
"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 | processed | applied | discarded
"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 },
"procedure" : { Reference(Procedure) } // The procedure involved in the collection
},
"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/> .
Changes from both R4 and R4B
| BiologicallyDerivedProduct | |
| BiologicallyDerivedProduct.productCategory |
|
| BiologicallyDerivedProduct.biologicalSourceEvent |
|
| BiologicallyDerivedProduct.processingFacility |
|
| BiologicallyDerivedProduct.division |
|
| BiologicallyDerivedProduct.productStatus |
|
| BiologicallyDerivedProduct.expirationDate |
|
| BiologicallyDerivedProduct.collection.procedure |
|
| 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 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
| Path | ValueSet | Type | Documentation |
|---|---|---|---|
| BiologicallyDerivedProduct.productCategory | BiologicallyDerivedProductCategory | Example | 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 | Example | 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 | token | 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 |
FHIR ®© HL7.org 2011+. FHIR R6 hl7.fhir.core#6.0.0-ballot2 generated on Tue, Nov 12, 2024 03:28+0000.
Links: Search |
Version History |
Contents |
Glossary |
QA |
Compare to R5 |
|
Propose a change