Release 5 Snapshot #1
DiagnosticsThis page is part of the FHIR Specification (v5.0.0-snapshot1: R5 Snapshot #1). 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: 0 | 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:
This resource is referenced by itself, DiagnosticReport, Observation, PackagedProductDefinition, Procedure, RegulatedAuthorization, ResearchSubject and Specimen.
This resource does not implement any patterns.
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 | code | organ | tissue | fluid | cells | biologicalAgent BiologicallyDerivedProductCategory (Required) | |
 productCode | 0..1 | CodeableConcept | What this biologically derived product is BiologicallyDerivedProductCode (Example) | |
 parent | 0..* | Reference(BiologicallyDerivedProduct) | BiologicallyDerivedProduct parent | |
| request | 0..* | Reference(ServiceRequest) | Procedure request | |
| identifier | Σ | 0..* | Identifier | External ids for this item |
| biologicalSource | Σ | 0..1 | Identifier | An identifier that supports traceability to the biological entity that is the source of biological material in the product |
| processingFacility | 0..* | Reference(Organization) | Processing facility | |
| division | 0..1 | string | Description of division | |
| status | 0..1 | code | available | unavailable BiologicallyDerivedProductStatus (Required) | |
| expirationDate | 0..1 | dateTime | Date 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) | Who is product from | |
  collected[x] | 0..1 | Time of product collection | ||
 collectedDateTime | dateTime | |||
 collectedPeriod | Period | |||
| storageTempRequirements | 0..1 | Range | Product storage temp requirements | |
| property | 0..* | BackboneElement | A property that is specific to this BiologicallyDerviedProduct instance | |
| type | 1..1 | CodeableConcept | Code that specifies the property BiologicallyDerivedProductPropertyType (Example) | |
| value[x] | 1..1 | Property values | ||
| valueBoolean | boolean | |||
| valueInteger | integer | |||
| valueCodeableConcept | CodeableConcept | |||
| valueQuantity | Quantity | |||
| valueRange | Range | |||
| valueString | string | |||
| valueAttachment | Attachment | |||
| 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 --> <productCategory value="[code]"/><!-- 0..1 organ | tissue | fluid | cells | biologicalAgent --> <productCode><!-- 0..1 CodeableConcept What this biologically derived product is --></productCode> <parent><!-- 0..* Reference(BiologicallyDerivedProduct) BiologicallyDerivedProduct parent --></parent> <request><!-- 0..* Reference(ServiceRequest) Procedure request --></request> <identifier><!-- 0..* Identifier External ids for this item --></identifier> <biologicalSource><!-- 0..1 Identifier An identifier that supports traceability to the biological entity that is the source of biological material in the product --></biologicalSource> <processingFacility><!-- 0..* Reference(Organization) Processing facility --></processingFacility> <division value="[string]"/><!-- 0..1 Description of division --> <status value="[code]"/><!-- 0..1 available | unavailable --> <expirationDate value="[dateTime]"/><!-- 0..1 Date 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) Who is product from --></source> <collected[x]><!-- 0..1 dateTime|Period Time of product collection --></collected[x]> </collection> <storageTempRequirements><!-- 0..1 Range Product storage temp requirements --></storageTempRequirements> <property> <!-- 0..* A property that is specific to this BiologicallyDerviedProduct instance --> <type><!-- 1..1 CodeableConcept Code that specifies the property
JSON Template
{
"resourceType" : "BiologicallyDerivedProduct",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"productCategory" : "<code>", // organ | tissue | fluid | cells | biologicalAgent
"productCode" : { CodeableConcept }, // What this biologically derived product is
"parent" : [{ Reference(BiologicallyDerivedProduct) }], // BiologicallyDerivedProduct parent
"request" : [{ Reference(ServiceRequest) }], // Procedure request
"identifier" : [{ Identifier }], // External ids for this item
"biologicalSource" : { Identifier }, // An identifier that supports traceability to the biological entity that is the source of biological material in the product
"processingFacility" : [{ Reference(Organization) }], // Processing facility
"division" : "<string>", // Description of division
"status" : "<code>", // available | unavailable
"expirationDate" : "<dateTime>", // Date of expiration
"collection" : { // How this product was collected
"collector" : { Reference(Practitioner|PractitionerRole) }, // Individual performing collection
"source" : { Reference(Organization|Patient) }, // Who is product from
// collected[x]: Time of product collection. One of these 2:
"collectedDateTime" : "<dateTime>"
"collectedPeriod" : { Period }
},
"storageTempRequirements" : { Range }, // Product storage temp 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 7:
"valueBoolean" : <boolean>
"valueInteger" : <integer>
"valueCodeableConcept" : { CodeableConcept }
"valueQuantity" : { Quantity }
"valueRange" : { Range }
"valueString" : "<string>"
"valueAttachment" : { Attachment }
}]
}
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> .
Changes since R3
| BiologicallyDerivedProduct | |
| BiologicallyDerivedProduct.productCategory |
|
| BiologicallyDerivedProduct.biologicalSource |
|
| BiologicallyDerivedProduct.processingFacility |
|
| BiologicallyDerivedProduct.division |
|
| BiologicallyDerivedProduct.status |
|
| BiologicallyDerivedProduct.expirationDate |
|
| BiologicallyDerivedProduct.storageTempRequirements |
|
| BiologicallyDerivedProduct.property |
|
| BiologicallyDerivedProduct.property.type |
|
| BiologicallyDerivedProduct.property.value[x] |
|
| 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 | code | organ | tissue | fluid | cells | biologicalAgent BiologicallyDerivedProductCategory (Required) | |
| productCode | 0..1 | CodeableConcept | What this biologically derived product is BiologicallyDerivedProductCode (Example) | |
| parent | 0..* | Reference(BiologicallyDerivedProduct) | BiologicallyDerivedProduct parent | |
| request | 0..* | Reference(ServiceRequest) | Procedure request | |
| identifier | Σ | 0..* | Identifier | External ids for this item |
| biologicalSource | Σ | 0..1 | Identifier | An identifier that supports traceability to the biological entity that is the source of biological material in the product |
| processingFacility | 0..* | Reference(Organization) | Processing facility | |
| division | 0..1 | string | Description of division | |
| status | 0..1 | code | available | unavailable BiologicallyDerivedProductStatus (Required) | |
| expirationDate | 0..1 | dateTime | Date 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) | Who is product from | |
| collected[x] | 0..1 | Time of product collection | ||
| collectedDateTime | dateTime | |||
| collectedPeriod | Period | |||
| storageTempRequirements | 0..1 | Range | Product storage temp requirements | |
| property | 0..* | BackboneElement | A property that is specific to this BiologicallyDerviedProduct instance | |
| type | 1..1 | CodeableConcept | Code that specifies the property BiologicallyDerivedProductPropertyType (Example) | |
| value[x] | 1..1 | Property values | ||
| valueBoolean | boolean | |||
| valueInteger | integer | |||
| valueCodeableConcept | CodeableConcept | |||
| valueQuantity | Quantity | |||
| valueRange | Range | |||
| valueString | string | |||
| valueAttachment | Attachment | |||
| Documentation for this format | ||||
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" : "<code>", // organ | tissue | fluid | cells | biologicalAgent
"productCode" : { CodeableConcept }, // What this biologically derived product is
"parent" : [{ Reference(BiologicallyDerivedProduct) }], // BiologicallyDerivedProduct parent
"request" : [{ Reference(ServiceRequest) }], // Procedure request
"identifier" : [{ Identifier }], // External ids for this item
"biologicalSource" : { Identifier }, // An identifier that supports traceability to the biological entity that is the source of biological material in the product
"processingFacility" : [{ Reference(Organization) }], // Processing facility
"division" : "<string>", // Description of division
"status" : "<code>", // available | unavailable
"expirationDate" : "<dateTime>", // Date of expiration
"collection" : { // How this product was collected
"collector" : { Reference(Practitioner|PractitionerRole) }, // Individual performing collection
"source" : { Reference(Organization|Patient) }, // Who is product from
// collected[x]: Time of product collection. One of these 2:
"collectedDateTime" : "<dateTime>"
"collectedPeriod" : { Period }
},
"storageTempRequirements" : { Range }, // Product storage temp 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 7:
"valueBoolean" : <boolean>
"valueInteger" : <integer>
"valueCodeableConcept" : { CodeableConcept }
"valueQuantity" : { Quantity }
"valueRange" : { Range }
"valueString" : "<string>"
"valueAttachment" : { Attachment }
}]
}
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> .
Changes since Release 3
| BiologicallyDerivedProduct | |
| BiologicallyDerivedProduct.productCategory |
|
| BiologicallyDerivedProduct.biologicalSource |
|
| BiologicallyDerivedProduct.processingFacility |
|
| BiologicallyDerivedProduct.division |
|
| BiologicallyDerivedProduct.status |
|
| BiologicallyDerivedProduct.expirationDate |
|
| BiologicallyDerivedProduct.storageTempRequirements |
|
| BiologicallyDerivedProduct.property |
|
| BiologicallyDerivedProduct.property.type |
|
| BiologicallyDerivedProduct.property.value[x] |
|
| BiologicallyDerivedProduct.quantity |
|
| BiologicallyDerivedProduct.processing |
|
| BiologicallyDerivedProduct.manipulation |
|
| BiologicallyDerivedProduct.storage |
|
See the Full Difference for further information
See the Profiles & Extensions and the alternate definitions: Master Definition XML + JSON, XML Schema/Schematron + JSON Schema, ShEx (for Turtle) + see the extensions, the spreadsheet version & the dependency analysis a
| Path | Definition | Type | Reference |
|---|---|---|---|
| BiologicallyDerivedProduct.productCategory | Required | BiologicallyDerivedProductCategory | |
| BiologicallyDerivedProduct.productCode | Example | ?? | |
| BiologicallyDerivedProduct.status | Required | BiologicallyDerivedProductStatus | |
| BiologicallyDerivedProduct.property.type | Example | http://terminology.hl7.org/NamingSystem/ib |
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 | token | The biological source for the biologically derived product | BiologicallyDerivedProduct.biologicalSource |
FHIR ®© HL7.org 2011+. FHIR R5 Draft Ballot hl7.fhir.core#5.0.0-snapshot1 generated on Sun, Dec 19, 2021 08:19+1100.
Links: Search |
Version History |
Table of Contents |
QA Page |
Compare to R4 |
|
Propose a change