8.26.11 JSON Schema for BiologicallyDerivedProduct

Orders and Observations Work Group

Maturity Level: N/A

Standards Status: Informative

Compartments: Not linked to any defined compartments

This is a representation of the json schema for BiologicallyDerivedProduct, which is just a part of the full JSON Schema.

{
  "$schema": "http://json-schema.org/draft-06/schema#",
  "id": "http://hl7.org/fhir/json-schema/BiologicallyDerivedProduct",
  "$ref": "#/definitions/BiologicallyDerivedProduct",
  "description": "see http://hl7.org/fhir/json.html#schema for information about the FHIR Json Schemas",
  "definitions": {
    "BiologicallyDerivedProduct": {
      "description": "This resource reflects an instance of a biologically derived product. A material substance originating from a biological entity intended to be transplanted or infused\ninto another (possibly the same) biological entity.",
      "properties": {
        "resourceType": {
          "description": "This is a BiologicallyDerivedProduct resource",
          "const": "BiologicallyDerivedProduct"
        },
        "id": {
          "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
          "$ref": "id.schema.json#/definitions/id"
        },
        "meta": {
          "description": "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.",
          "$ref": "Meta.schema.json#/definitions/Meta"
        },
        "implicitRules": {
          "description": "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.",
          "$ref": "#/definitions/uri"
        },
        "_implicitRules": {
          "description": "Extensions for implicitRules",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "language": {
          "description": "The base language in which the resource is written.",
          "$ref": "#/definitions/code"
        },
        "_language": {
          "description": "Extensions for language",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "text": {
          "description": "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.",
          "$ref": "Narrative.schema.json#/definitions/Narrative"
        },
        "contained": {
          "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.",
          "items": {
            "$ref": "ResourceList.schema.json#/definitions/ResourceList"
          },
          "type": "array"
        },
        "extension": {
          "description": "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 managable, 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.",
          "items": {
            "$ref": "Extension.schema.json#/definitions/Extension"
          },
          "type": "array"
        },
        "modifierExtension": {
          "description": "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\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
          "items": {
            "$ref": "Extension.schema.json#/definitions/Extension"
          },
          "type": "array"
        },
        "productCategory": {
          "description": "Broad category of this product.",
          "$ref": "Coding.schema.json#/definitions/Coding"
        },
        "productCode": {
          "description": "A codified value that systematically supports characterization and classification of medical products of human origin inclusive of processing conditions such as additives, volumes and handling conditions.",
          "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
        },
        "parent": {
          "description": "Parent product (if any) for this biologically-derived product.",
          "items": {
            "$ref": "Reference.schema.json#/definitions/Reference"
          },
          "type": "array"
        },
        "request": {
          "description": "Request to obtain and/or infuse this biologically derived product.",
          "items": {
            "$ref": "Reference.schema.json#/definitions/Reference"
          },
          "type": "array"
        },
        "identifier": {
          "description": "Unique instance identifiers assigned to a biologically derived product. Note: This is a business identifier, not a resource identifier.",
          "items": {
            "$ref": "Identifier.schema.json#/definitions/Identifier"
          },
          "type": "array"
        },
        "biologicalSourceEvent": {
          "description": "An identifier that supports traceability to the event during which material in this product from one or more biological entities was obtained or pooled.",
          "$ref": "Identifier.schema.json#/definitions/Identifier"
        },
        "processingFacility": {
          "description": "Processing facilities responsible for the labeling and distribution of this biologically derived product.",
          "items": {
            "$ref": "Reference.schema.json#/definitions/Reference"
          },
          "type": "array"
        },
        "division": {
          "description": "A unique identifier for an aliquot of a product.  Used to distinguish individual aliquots of a product carrying the same biologicalSource and productCode identifiers.",
          "$ref": "#/definitions/string"
        },
        "_division": {
          "description": "Extensions for division",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "productStatus": {
          "description": "Whether the product is currently available.",
          "$ref": "Coding.schema.json#/definitions/Coding"
        },
        "expirationDate": {
          "description": "Date, and where relevant time, of expiration.",
          "$ref": "#/definitions/dateTime"
        },
        "_expirationDate": {
          "description": "Extensions for expirationDate",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "collection": {
          "description": "How this product was collected.",
          "$ref": "#/definitions/BiologicallyDerivedProduct_Collection"
        },
        "storageTempRequirements": {
          "description": "The temperature requirements for storage of the biologically-derived product.",
          "$ref": "Range.schema.json#/definitions/Range"
        },
        "property": {
          "description": "A property that is specific to this BiologicallyDerviedProduct instance.",
          "items": {
            "$ref": "#/definitions/BiologicallyDerivedProduct_Property"
          },
          "type": "array"
        }
      },
      "type": "object",
      "additionalProperties": false,
      "required": [
        "resourceType"
      ]
    },
    "BiologicallyDerivedProduct_Collection": {
      "description": "This resource reflects an instance of a biologically derived product. A material substance originating from a biological entity intended to be transplanted or infused\ninto another (possibly the same) biological entity.",
      "properties": {
        "id": {
          "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
          "$ref": "string.schema.json#/definitions/string"
        },
        "extension": {
          "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, 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.",
          "items": {
            "$ref": "Extension.schema.json#/definitions/Extension"
          },
          "type": "array"
        },
        "modifierExtension": {
          "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, 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. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
          "items": {
            "$ref": "Extension.schema.json#/definitions/Extension"
          },
          "type": "array"
        },
        "collector": {
          "description": "Healthcare professional who is performing the collection.",
          "$ref": "Reference.schema.json#/definitions/Reference"
        },
        "source": {
          "description": "The patient or entity, such as a hospital or vendor in the case of a processed/manipulated/manufactured product, providing the product.",
          "$ref": "Reference.schema.json#/definitions/Reference"
        },
        "collectedDateTime": {
          "description": "Time of product collection.",
          "pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]{1,9})?)?)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)?)?)?$",
          "type": "string"
        },
        "_collectedDateTime": {
          "description": "Extensions for collectedDateTime",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "collectedPeriod": {
          "description": "Time of product collection.",
          "$ref": "Period.schema.json#/definitions/Period"
        }
      },
      "type": "object",
      "additionalProperties": false
    },
    "BiologicallyDerivedProduct_Property": {
      "description": "This resource reflects an instance of a biologically derived product. A material substance originating from a biological entity intended to be transplanted or infused\ninto another (possibly the same) biological entity.",
      "properties": {
        "id": {
          "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
          "$ref": "string.schema.json#/definitions/string"
        },
        "extension": {
          "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, 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.",
          "items": {
            "$ref": "Extension.schema.json#/definitions/Extension"
          },
          "type": "array"
        },
        "modifierExtension": {
          "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, 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. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
          "items": {
            "$ref": "Extension.schema.json#/definitions/Extension"
          },
          "type": "array"
        },
        "type": {
          "description": "Code that specifies the property. It should reference an established coding system.",
          "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
        },
        "valueBoolean": {
          "description": "Property values.",
          "pattern": "^true|false$",
          "type": "boolean"
        },
        "_valueBoolean": {
          "description": "Extensions for valueBoolean",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "valueInteger": {
          "description": "Property values.",
          "pattern": "^[0]|[-+]?[1-9][0-9]*$",
          "type": "number"
        },
        "_valueInteger": {
          "description": "Extensions for valueInteger",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "valueCodeableConcept": {
          "description": "Property values.",
          "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
        },
        "valuePeriod": {
          "description": "Property values.",
          "$ref": "Period.schema.json#/definitions/Period"
        },
        "valueQuantity": {
          "description": "Property values.",
          "$ref": "Quantity.schema.json#/definitions/Quantity"
        },
        "valueRange": {
          "description": "Property values.",
          "$ref": "Range.schema.json#/definitions/Range"
        },
        "valueRatio": {
          "description": "Property values.",
          "$ref": "Ratio.schema.json#/definitions/Ratio"
        },
        "valueString": {
          "description": "Property values.",
          "pattern": "^[ \\r\\n\\t\\S]+$",
          "type": "string"
        },
        "_valueString": {
          "description": "Extensions for valueString",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "valueAttachment": {
          "description": "Property values.",
          "$ref": "Attachment.schema.json#/definitions/Attachment"
        }
      },
      "type": "object",
      "additionalProperties": false,
      "required": [
        "type"
      ]
    }
  }
}