15.10.8 JSON Schema for SubstancePolymer

Biomedical Research and Regulation 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 SubstancePolymer, 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/SubstancePolymer",
  "$ref": "#/definitions/SubstancePolymer",
  "description": "see http://hl7.org/fhir/json.html#schema for information about the FHIR Json Schemas",
  "definitions": {
    "SubstancePolymer": {
      "description": "Properties of a substance specific to it being a polymer.",
      "properties": {
        "resourceType": {
          "description": "This is a SubstancePolymer resource",
          "const": "SubstancePolymer"
        },
        "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.",
          "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 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.",
          "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 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.\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"
        },
        "identifier": {
          "description": "A business idenfier for this polymer, but typically this is handled by a SubstanceDefinition identifier.",
          "$ref": "Identifier.schema.json#/definitions/Identifier"
        },
        "class": {
          "description": "Overall type of the polymer.",
          "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
        },
        "geometry": {
          "description": "Polymer geometry, e.g. linear, branched, cross-linked, network or dendritic.",
          "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
        },
        "copolymerConnectivity": {
          "description": "Descrtibes the copolymer sequence type (polymer connectivity).",
          "items": {
            "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
          },
          "type": "array"
        },
        "modification": {
          "description": "Todo - this is intended to connect to a repeating full modification structure, also used by Protein and Nucleic Acid . String is just a placeholder.",
          "$ref": "#/definitions/string"
        },
        "_modification": {
          "description": "Extensions for modification",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "monomerSet": {
          "description": "Todo.",
          "items": {
            "$ref": "#/definitions/SubstancePolymer_MonomerSet"
          },
          "type": "array"
        },
        "repeat": {
          "description": "Specifies and quantifies the repeated units and their configuration.",
          "items": {
            "$ref": "#/definitions/SubstancePolymer_Repeat"
          },
          "type": "array"
        }
      },
      "additionalProperties": false,
      "required": [
        "resourceType"
      ]
    },
    "SubstancePolymer_MonomerSet": {
      "description": "Properties of a substance specific to it being a polymer.",
      "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 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.",
          "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 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. 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"
        },
        "ratioType": {
          "description": "Captures the type of ratio to the entire polymer, e.g. Monomer/Polymer ratio, SRU/Polymer Ratio.",
          "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
        },
        "startingMaterial": {
          "description": "The starting materials - monomer(s) used in the synthesis of the polymer.",
          "items": {
            "$ref": "#/definitions/SubstancePolymer_StartingMaterial"
          },
          "type": "array"
        }
      },
      "additionalProperties": false
    },
    "SubstancePolymer_StartingMaterial": {
      "description": "Properties of a substance specific to it being a polymer.",
      "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 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.",
          "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 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. 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"
        },
        "code": {
          "description": "The type of substance for this starting material.",
          "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
        },
        "category": {
          "description": "Substance high level category, e.g. chemical substance.",
          "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
        },
        "isDefining": {
          "description": "Used to specify whether the attribute described is a defining element for the unique identification of the polymer.",
          "$ref": "#/definitions/boolean"
        },
        "_isDefining": {
          "description": "Extensions for isDefining",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "amount": {
          "description": "A percentage.",
          "$ref": "Quantity.schema.json#/definitions/Quantity"
        }
      },
      "additionalProperties": false
    },
    "SubstancePolymer_Repeat": {
      "description": "Properties of a substance specific to it being a polymer.",
      "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 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.",
          "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 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. 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"
        },
        "averageMolecularFormula": {
          "description": "A representation of an (average) molecular formula from a polymer.",
          "$ref": "#/definitions/string"
        },
        "_averageMolecularFormula": {
          "description": "Extensions for averageMolecularFormula",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "repeatUnitAmountType": {
          "description": "How the quantitative amount of Structural Repeat Units is captured (e.g. Exact, Numeric, Average).",
          "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
        },
        "repeatUnit": {
          "description": "An SRU - Structural Repeat Unit.",
          "items": {
            "$ref": "#/definitions/SubstancePolymer_RepeatUnit"
          },
          "type": "array"
        }
      },
      "additionalProperties": false
    },
    "SubstancePolymer_RepeatUnit": {
      "description": "Properties of a substance specific to it being a polymer.",
      "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 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.",
          "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 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. 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"
        },
        "unit": {
          "description": "Structural repeat units are essential elements for defining polymers.",
          "$ref": "#/definitions/string"
        },
        "_unit": {
          "description": "Extensions for unit",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "orientation": {
          "description": "The orientation of the polymerisation, e.g. head-tail, head-head, random.",
          "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
        },
        "amount": {
          "description": "Number of repeats of this unit.",
          "$ref": "#/definitions/integer"
        },
        "_amount": {
          "description": "Extensions for amount",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "degreeOfPolymerisation": {
          "description": "Applies to homopolymer and block co-polymers where the degree of polymerisation within a block can be described.",
          "items": {
            "$ref": "#/definitions/SubstancePolymer_DegreeOfPolymerisation"
          },
          "type": "array"
        },
        "structuralRepresentation": {
          "description": "A graphical structure for this SRU.",
          "items": {
            "$ref": "#/definitions/SubstancePolymer_StructuralRepresentation"
          },
          "type": "array"
        }
      },
      "additionalProperties": false
    },
    "SubstancePolymer_DegreeOfPolymerisation": {
      "description": "Properties of a substance specific to it being a polymer.",
      "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 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.",
          "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 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. 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": "The type of the degree of polymerisation shall be described, e.g. SRU/Polymer Ratio.",
          "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
        },
        "average": {
          "description": "An average amount of polymerisation.",
          "$ref": "#/definitions/integer"
        },
        "_average": {
          "description": "Extensions for average",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "low": {
          "description": "A low expected limit of the amount.",
          "$ref": "#/definitions/integer"
        },
        "_low": {
          "description": "Extensions for low",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "high": {
          "description": "A high expected limit of the amount.",
          "$ref": "#/definitions/integer"
        },
        "_high": {
          "description": "Extensions for high",
          "$ref": "Element.schema.json#/definitions/Element"
        }
      },
      "additionalProperties": false
    },
    "SubstancePolymer_StructuralRepresentation": {
      "description": "Properties of a substance specific to it being a polymer.",
      "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 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.",
          "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 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. 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": "The type of structure (e.g. Full, Partial, Representative).",
          "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
        },
        "representation": {
          "description": "The structural representation as text string in a standard format e.g. InChI, SMILES, MOLFILE, CDX, SDF, PDB, mmCIF.",
          "$ref": "#/definitions/string"
        },
        "_representation": {
          "description": "Extensions for representation",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "format": {
          "description": "The format of the representation e.g. InChI, SMILES, MOLFILE, CDX, SDF, PDB, mmCIF.",
          "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
        },
        "attachment": {
          "description": "An attached file with the structural representation.",
          "$ref": "Attachment.schema.json#/definitions/Attachment"
        }
      },
      "additionalProperties": false
    }
  }
}