biologically derived products

Create Biologically Derived Product

post

/organizations/{organizationId}/fhir/4/BiologicallyDerivedProduct

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

Request

Headers


content-type*	string	application/json\|application/json+fhir	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Params


organizationId*	string\|string		id\|slug

Body


resourceType*			This is a BiologicallyDerivedProduct resource
id	id		The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
meta	Meta		The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
implicitRules	uri		A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
language	code		The base language in which the resource is written.
text	Narrative		A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
contained	array(ResourceList)		These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
extension	array(Extension)		May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
modifierExtension	array(Extension)		May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
identifier	array(Identifier)		This records identifiers associated with this biologically derived product instance that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).
productCategory		organ\|tissue\|fluid\|cells\|biologicalAgent	Broad category of this product.
productCode	CodeableConcept		A code that identifies the kind of this biologically derived product (SNOMED Ctcode).
status		available\|unavailable	Whether the product is currently available.
request	array(Reference)		Procedure request to obtain this biologically derived product.
quantity	integer		Number of discrete units within this product.
parent	array(Reference)		Parent product (if any).
collection	BiologicallyDerivedProduct_Collection		How this product was collected.
processing	array(BiologicallyDerivedProduct_Processing)		Any processing of the product during collection that does not change the fundamental nature of the product. For example adding anti-coagulants during the collection of Peripheral Blood Stem Cells.
manipulation	BiologicallyDerivedProduct_Manipulation		Any manipulation of product post-collection that is intended to alter the product. For example a buffy-coat enrichment or CD8 reduction of Peripheral Blood Stem Cells to make it more suitable for infusion.
storage	array(BiologicallyDerivedProduct_Storage)		Product storage.

Response

201 400 401 404

Patch Biologically Derived Product

patch

/organizations/{organizationId}/fhir/4/BiologicallyDerivedProduct/{resourceId}

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

Request

Headers


content-type*	string	application/json-patch+json	application/json-patch+json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Params


organizationId*	string\|string		id\|slug
resourceId*

Body


resourceType*			This is a BiologicallyDerivedProduct resource
id	id		The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
meta	Meta		The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
implicitRules	uri		A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
language	code		The base language in which the resource is written.
text	Narrative		A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
contained	array(ResourceList)		These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
extension	array(Extension)		May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
modifierExtension	array(Extension)		May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
identifier	array(Identifier)		This records identifiers associated with this biologically derived product instance that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).
productCategory		organ\|tissue\|fluid\|cells\|biologicalAgent	Broad category of this product.
productCode	CodeableConcept		A code that identifies the kind of this biologically derived product (SNOMED Ctcode).
status		available\|unavailable	Whether the product is currently available.
request	array(Reference)		Procedure request to obtain this biologically derived product.
quantity	integer		Number of discrete units within this product.
parent	array(Reference)		Parent product (if any).
collection	BiologicallyDerivedProduct_Collection		How this product was collected.
processing	array(BiologicallyDerivedProduct_Processing)		Any processing of the product during collection that does not change the fundamental nature of the product. For example adding anti-coagulants during the collection of Peripheral Blood Stem Cells.
manipulation	BiologicallyDerivedProduct_Manipulation		Any manipulation of product post-collection that is intended to alter the product. For example a buffy-coat enrichment or CD8 reduction of Peripheral Blood Stem Cells to make it more suitable for infusion.
storage	array(BiologicallyDerivedProduct_Storage)		Product storage.

Response

200 201 400 401 404 409

Read Biologically Derived Product

get

/organizations/{organizationId}/fhir/4/BiologicallyDerivedProduct/{resourceId}

Request

Headers


content-type*	string	application/json\|application/json+fhir	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Params


organizationId*	string\|string		id\|slug
resourceId*

Response

200 401 404

Read History Biologically Derived Product

get

/organizations/{organizationId}/fhir/4/BiologicallyDerivedProduct/{resourceId}/_history

Request

Headers


content-type*	string	application/json\|application/json+fhir	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Query params


_count	string
_since	string

Params


organizationId*	string\|string		id\|slug
resourceId*

Response

200 401 404

Read Version Biologically Derived Product

get

/organizations/{organizationId}/fhir/4/BiologicallyDerivedProduct/{resourceId}/_history/{versionId}

Request

Headers


content-type*	string	application/json\|application/json+fhir	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Params


organizationId*	string\|string	id\|slug
resourceId*
versionId*

Response

200 400 401 404

Remove Biologically Derived Product

delete

/organizations/{organizationId}/fhir/4/BiologicallyDerivedProduct/{resourceId}

Request

Headers


content-type*	string	application/json\|application/json+fhir	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Params


organizationId*	string\|string		id\|slug
resourceId*

Response

200 204 400 401 404 409

Search Get Biologically Derived Product

get

/organizations/{organizationId}/fhir/4/BiologicallyDerivedProduct

Request

Headers


content-type*	string	application/json\|application/json+fhir	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Query params


_id	string
_language	string

Params


organizationId*	string\|string		id\|slug

Response

200 401 404

Search History Biologically Derived Product

get

/organizations/{organizationId}/fhir/4/BiologicallyDerivedProduct/_history

Request

Headers


content-type*	string	application/json\|application/json+fhir	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Query params


_count	string
_since	string

Params


organizationId*	string\|string		id\|slug

Response

200 401 404

Search Post Biologically Derived Product

post

/organizations/{organizationId}/fhir/4/BiologicallyDerivedProduct/_search

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

Request

Headers


content-type*	string	application/json\|application/x-www-form-urlencoded	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Query params


_id	string
_language	string

Params


organizationId*	string\|string		id\|slug

Body


resourceType*			This is a BiologicallyDerivedProduct resource
id	id		The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
meta	Meta		The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
implicitRules	uri		A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
language	code		The base language in which the resource is written.
text	Narrative		A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
contained	array(ResourceList)		These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
extension	array(Extension)		May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
modifierExtension	array(Extension)		May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
identifier	array(Identifier)		This records identifiers associated with this biologically derived product instance that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).
productCategory		organ\|tissue\|fluid\|cells\|biologicalAgent	Broad category of this product.
productCode	CodeableConcept		A code that identifies the kind of this biologically derived product (SNOMED Ctcode).
status		available\|unavailable	Whether the product is currently available.
request	array(Reference)		Procedure request to obtain this biologically derived product.
quantity	integer		Number of discrete units within this product.
parent	array(Reference)		Parent product (if any).
collection	BiologicallyDerivedProduct_Collection		How this product was collected.
processing	array(BiologicallyDerivedProduct_Processing)		Any processing of the product during collection that does not change the fundamental nature of the product. For example adding anti-coagulants during the collection of Peripheral Blood Stem Cells.
manipulation	BiologicallyDerivedProduct_Manipulation		Any manipulation of product post-collection that is intended to alter the product. For example a buffy-coat enrichment or CD8 reduction of Peripheral Blood Stem Cells to make it more suitable for infusion.
storage	array(BiologicallyDerivedProduct_Storage)		Product storage.

Response

200 401 404

Update Biologically Derived Product

put

/organizations/{organizationId}/fhir/4/BiologicallyDerivedProduct/{resourceId}

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

Request

Headers


content-type*	string	application/json\|application/json+fhir	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Params


organizationId*	string\|string		id\|slug
resourceId*

Body


resourceType*			This is a BiologicallyDerivedProduct resource
id	id		The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
meta	Meta		The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
implicitRules	uri		A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
language	code		The base language in which the resource is written.
text	Narrative		A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
contained	array(ResourceList)		These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
extension	array(Extension)		May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
modifierExtension	array(Extension)		May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
identifier	array(Identifier)		This records identifiers associated with this biologically derived product instance that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).
productCategory		organ\|tissue\|fluid\|cells\|biologicalAgent	Broad category of this product.
productCode	CodeableConcept		A code that identifies the kind of this biologically derived product (SNOMED Ctcode).
status		available\|unavailable	Whether the product is currently available.
request	array(Reference)		Procedure request to obtain this biologically derived product.
quantity	integer		Number of discrete units within this product.
parent	array(Reference)		Parent product (if any).
collection	BiologicallyDerivedProduct_Collection		How this product was collected.
processing	array(BiologicallyDerivedProduct_Processing)		Any processing of the product during collection that does not change the fundamental nature of the product. For example adding anti-coagulants during the collection of Peripheral Blood Stem Cells.
manipulation	BiologicallyDerivedProduct_Manipulation		Any manipulation of product post-collection that is intended to alter the product. For example a buffy-coat enrichment or CD8 reduction of Peripheral Blood Stem Cells to make it more suitable for infusion.
storage	array(BiologicallyDerivedProduct_Storage)		Product storage.

Response

200 201 400 401 404 409