This page is part of the FHIR Specification (v5.0.0-ballot: FHIR R5 Ballot Preview). 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: 2 | 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.
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..1 | Coding | organ | tissue | fluid | cells | biologicalAgent BiologicallyDerivedProductCategory (Example) | |
productCode | 0..1 | CodeableConcept | A code that identifies the kind of this biologically derived product BiologicallyDerivedProductCodes (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 BiologicallyDerivedProductStatus (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 or entity providing the product | |
collected[x] | 0..1 | Time of product collection | ||
collectedDateTime | dateTime | |||
collectedPeriod | Period | |||
storageTempRequirements | 0..1 | Range | Product storage temperature requirements | |
property | 0..* | BackboneElement | A property that is specific to this BiologicallyDerviedProduct instance | |
type | 1..1 | Coding | Code that specifies the property BiologicallyDerivedProductPropertyTypeCodes (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..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><!-- 0..1 Reference(Organization|Patient) The patient or entity providing the product --></source> <collected[x]><!-- 0..1 dateTime|Period Time of product collection --></collected[x]> </collection> <storageTempRequirements><!-- 0..1 Range Product storage temperature requirements --></storageTempRequirements> <property> <!-- 0..* A property that is specific to this BiologicallyDerviedProduct instance --> <type><!-- 1..1 Coding 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" : { 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 or entity providing the product // 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" : { Coding }, // 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: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.productCategory [ Coding ]; # 0..1 organ | tissue | fluid | cells | biologicalAgent fhir:BiologicallyDerivedProduct.productCode [ CodeableConcept ]; # 0..1 A code that identifies the kind of this biologically derived product fhir:BiologicallyDerivedProduct.parent [ Reference(BiologicallyDerivedProduct) ], ... ; # 0..* The parent biologically-derived product fhir:BiologicallyDerivedProduct.request [ Reference(ServiceRequest) ], ... ; # 0..* Request to obtain and/or infuse this product fhir:BiologicallyDerivedProduct.identifier [ Identifier ], ... ; # 0..* Instance identifier fhir:BiologicallyDerivedProduct.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:BiologicallyDerivedProduct.processingFacility [ Reference(Organization) ], ... ; # 0..* Processing facilities responsible for the labeling and distribution of this biologically derived product fhir:BiologicallyDerivedProduct.division [ string ]; # 0..1 A unique identifier for an aliquot of a product fhir:BiologicallyDerivedProduct.productStatus [ Coding ]; # 0..1 available | unavailable fhir:BiologicallyDerivedProduct.expirationDate [ dateTime ]; # 0..1 Date, and where relevant time, of expiration fhir:BiologicallyDerivedProduct.collection [ # 0..1 How this product was collected fhir:BiologicallyDerivedProduct.collection.collector [ Reference(Practitioner|PractitionerRole) ]; # 0..1 Individual performing collection fhir:BiologicallyDerivedProduct.collection.source [ Reference(Organization|Patient) ]; # 0..1 The patient or entity providing the 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.storageTempRequirements [ Range ]; # 0..1 Product storage temperature requirements fhir:BiologicallyDerivedProduct.property [ # 0..* A property that is specific to this BiologicallyDerviedProduct instance fhir:BiologicallyDerivedProduct.property.type [ Coding ]; # 1..1 Code that specifies the property # BiologicallyDerivedProduct.property.value[x] : 1..1 Property values. One of these 9 fhir:BiologicallyDerivedProduct.property.valueBoolean [ boolean ] fhir:BiologicallyDerivedProduct.property.valueInteger [ integer ] fhir:BiologicallyDerivedProduct.property.valueCodeableConcept [ CodeableConcept ] fhir:BiologicallyDerivedProduct.property.valuePeriod [ Period ] fhir:BiologicallyDerivedProduct.property.valueQuantity [ Quantity ] fhir:BiologicallyDerivedProduct.property.valueRange [ Range ] fhir:BiologicallyDerivedProduct.property.valueRatio [ Ratio ] fhir:BiologicallyDerivedProduct.property.valueString [ string ] fhir:BiologicallyDerivedProduct.property.valueAttachment [ 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
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..1 | Coding | organ | tissue | fluid | cells | biologicalAgent BiologicallyDerivedProductCategory (Example) | |
productCode | 0..1 | CodeableConcept | A code that identifies the kind of this biologically derived product BiologicallyDerivedProductCodes (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 BiologicallyDerivedProductStatus (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 or entity providing the product | |
collected[x] | 0..1 | Time of product collection | ||
collectedDateTime | dateTime | |||
collectedPeriod | Period | |||
storageTempRequirements | 0..1 | Range | Product storage temperature requirements | |
property | 0..* | BackboneElement | A property that is specific to this BiologicallyDerviedProduct instance | |
type | 1..1 | Coding | Code that specifies the property BiologicallyDerivedProductPropertyTypeCodes (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"> <!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension --> <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><!-- 0..1 Reference(Organization|Patient) The patient or entity providing the product --></source> <collected[x]><!-- 0..1 dateTime|Period Time of product collection --></collected[x]> </collection> <storageTempRequirements><!-- 0..1 Range Product storage temperature requirements --></storageTempRequirements> <property> <!-- 0..* A property that is specific to this BiologicallyDerviedProduct instance --> <type><!-- 1..1 Coding 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" : { 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 or entity providing the product // 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" : { Coding }, // 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: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.productCategory [ Coding ]; # 0..1 organ | tissue | fluid | cells | biologicalAgent fhir:BiologicallyDerivedProduct.productCode [ CodeableConcept ]; # 0..1 A code that identifies the kind of this biologically derived product fhir:BiologicallyDerivedProduct.parent [ Reference(BiologicallyDerivedProduct) ], ... ; # 0..* The parent biologically-derived product fhir:BiologicallyDerivedProduct.request [ Reference(ServiceRequest) ], ... ; # 0..* Request to obtain and/or infuse this product fhir:BiologicallyDerivedProduct.identifier [ Identifier ], ... ; # 0..* Instance identifier fhir:BiologicallyDerivedProduct.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:BiologicallyDerivedProduct.processingFacility [ Reference(Organization) ], ... ; # 0..* Processing facilities responsible for the labeling and distribution of this biologically derived product fhir:BiologicallyDerivedProduct.division [ string ]; # 0..1 A unique identifier for an aliquot of a product fhir:BiologicallyDerivedProduct.productStatus [ Coding ]; # 0..1 available | unavailable fhir:BiologicallyDerivedProduct.expirationDate [ dateTime ]; # 0..1 Date, and where relevant time, of expiration fhir:BiologicallyDerivedProduct.collection [ # 0..1 How this product was collected fhir:BiologicallyDerivedProduct.collection.collector [ Reference(Practitioner|PractitionerRole) ]; # 0..1 Individual performing collection fhir:BiologicallyDerivedProduct.collection.source [ Reference(Organization|Patient) ]; # 0..1 The patient or entity providing the 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.storageTempRequirements [ Range ]; # 0..1 Product storage temperature requirements fhir:BiologicallyDerivedProduct.property [ # 0..* A property that is specific to this BiologicallyDerviedProduct instance fhir:BiologicallyDerivedProduct.property.type [ Coding ]; # 1..1 Code that specifies the property # BiologicallyDerivedProduct.property.value[x] : 1..1 Property values. One of these 9 fhir:BiologicallyDerivedProduct.property.valueBoolean [ boolean ] fhir:BiologicallyDerivedProduct.property.valueInteger [ integer ] fhir:BiologicallyDerivedProduct.property.valueCodeableConcept [ CodeableConcept ] fhir:BiologicallyDerivedProduct.property.valuePeriod [ Period ] fhir:BiologicallyDerivedProduct.property.valueQuantity [ Quantity ] fhir:BiologicallyDerivedProduct.property.valueRange [ Range ] fhir:BiologicallyDerivedProduct.property.valueRatio [ Ratio ] fhir:BiologicallyDerivedProduct.property.valueString [ string ] fhir:BiologicallyDerivedProduct.property.valueAttachment [ 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
Additional definitions: Master Definition XML + JSON, XML Schema/Schematron + JSON Schema, ShEx (for Turtle) + see the extensions, the spreadsheet version & the dependency analysis
Path | Definition | Type | Reference |
---|---|---|---|
BiologicallyDerivedProduct.productCategory | Biologically Derived Product Category. | Example | BiologicallyDerivedProductCategory |
BiologicallyDerivedProduct.productCode | 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. | Example | BiologicallyDerivedProductCodes |
BiologicallyDerivedProduct.productStatus | Biologically Derived Product Status. | Example | BiologicallyDerivedProductStatus |
BiologicallyDerivedProduct.property.type | Example | http://hl7.org/fhir/ValueSet/biologicallyderivedproduct-property-type-codes |
Search parameters for 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 | |
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-code | token | A code that identifies the kind of this biologically derived product (SNOMED CT code). | BiologicallyDerivedProduct.productCode | |
product-status | token | Whether the product is currently available. | BiologicallyDerivedProduct.productStatus | |
request | reference | Procedure request to obtain this biologically derived product. | BiologicallyDerivedProduct.request (ServiceRequest) |