FHIR CI-Build

This is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions icon

15.10 Resource SubstancePolymer - Content

Biomedical Research and Regulation icon

Work Group

Maturity Level: 0

Trial Use

Security Category: Anonymous

Compartments: No defined compartments

Properties of a substance specific to it being a polymer.

15.10.1 Scope and Usage

For an overview of this resource and others in the Medication Definition domain, also see the module page

Note to Implementers: This resource is still undergoing development and review by the appropriate Workgroups. At this time, is considered only as a draft resource not suitable for production implementation.

15.10.2 References to this Resource

Resource References: SubstanceDefinition

Structure

Name	Flags	Card.	Type	Description & Constraints
SubstancePolymer	TU		DomainResource	Properties of a substance specific to it being a polymer Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
identifier	Σ	0..1	Identifier	A business idenfier for this polymer, but typically this is handled by a SubstanceDefinition identifier
class	Σ	0..1	CodeableConcept	Overall type of the polymer
geometry	Σ	0..1	CodeableConcept	Polymer geometry, e.g. linear, branched, cross-linked, network or dendritic
copolymerConnectivity	Σ	0..*	CodeableConcept	Descrtibes the copolymer sequence type (polymer connectivity)
modification	Σ	0..1	string	Todo - this is intended to connect to a repeating full modification structure, also used by Protein and Nucleic Acid . String is just a placeholder
monomerSet	Σ	0..*	BackboneElement	Todo
ratioType	Σ	0..1	CodeableConcept	Captures the type of ratio to the entire polymer, e.g. Monomer/Polymer ratio, SRU/Polymer Ratio
startingMaterial	Σ	0..*	BackboneElement	The starting materials - monomer(s) used in the synthesis of the polymer
code	Σ	0..1	CodeableConcept	The type of substance for this starting material
category	Σ	0..1	CodeableConcept	Substance high level category, e.g. chemical substance
isDefining	Σ	0..1	boolean	Used to specify whether the attribute described is a defining element for the unique identification of the polymer
amount	Σ	0..1	Quantity	A percentage
repeat	Σ	0..*	BackboneElement	Specifies and quantifies the repeated units and their configuration
averageMolecularFormula	Σ	0..1	string	A representation of an (average) molecular formula from a polymer
repeatUnitAmountType	Σ	0..1	CodeableConcept	How the quantitative amount of Structural Repeat Units is captured (e.g. Exact, Numeric, Average)
repeatUnit	Σ	0..*	BackboneElement	An SRU - Structural Repeat Unit
unit	Σ	0..1	string	Structural repeat units are essential elements for defining polymers
orientation	Σ	0..1	CodeableConcept	The orientation of the polymerisation, e.g. head-tail, head-head, random
amount	Σ	0..1	integer	Number of repeats of this unit
degreeOfPolymerisation	Σ	0..*	BackboneElement	Applies to homopolymer and block co-polymers where the degree of polymerisation within a block can be described
type	Σ	0..1	CodeableConcept	The type of the degree of polymerisation shall be described, e.g. SRU/Polymer Ratio
average	Σ	0..1	integer	An average amount of polymerisation
low	Σ	0..1	integer	A low expected limit of the amount
high	Σ	0..1	integer	A high expected limit of the amount
structuralRepresentation	Σ	0..*	BackboneElement	A graphical structure for this SRU
type	Σ	0..1	CodeableConcept	The type of structure (e.g. Full, Partial, Representative)
representation	Σ	0..1	string	The structural representation as text string in a standard format e.g. InChI, SMILES, MOLFILE, CDX, SDF, PDB, mmCIF
format	Σ	0..1	CodeableConcept	The format of the representation e.g. InChI, SMILES, MOLFILE, CDX, SDF, PDB, mmCIF
attachment	Σ	0..1	Attachment	An attached file with the structural representation
Documentation for this format

See the Extensions for this resource

UML Diagram (Legend)

XML Template

<SubstancePolymer xmlns="http://hl7.org/fhir"> 
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <identifier><!-- 0..1 Identifier A business idenfier for this polymer, but typically this is handled by a SubstanceDefinition identifier --></identifier>
 <class><!-- 0..1 CodeableConcept Overall type of the polymer --></class>
 <geometry><!-- 0..1 CodeableConcept Polymer geometry, e.g. linear, branched, cross-linked, network or dendritic --></geometry>
 <copolymerConnectivity><!-- 0..* CodeableConcept Descrtibes the copolymer sequence type (polymer connectivity) --></copolymerConnectivity>
 <modification value="[string]"/><!-- 0..1 Todo - this is intended to connect to a repeating full modification structure, also used by Protein and Nucleic Acid . String is just a placeholder -->
 <monomerSet>  <!-- 0..* Todo -->
  <ratioType><!-- 0..1 CodeableConcept Captures the type of ratio to the entire polymer, e.g. Monomer/Polymer ratio, SRU/Polymer Ratio --></ratioType>
  <startingMaterial>  <!-- 0..* The starting materials - monomer(s) used in the synthesis of the polymer -->
   <code><!-- 0..1 CodeableConcept The type of substance for this starting material --></code>
   <category><!-- 0..1 CodeableConcept Substance high level category, e.g. chemical substance --></category>
   <isDefining value="[boolean]"/><!-- 0..1 Used to specify whether the attribute described is a defining element for the unique identification of the polymer -->
   <amount><!-- 0..1 Quantity A percentage --></amount>
  </startingMaterial>
 </monomerSet>
 <repeat>  <!-- 0..* Specifies and quantifies the repeated units and their configuration -->
  <averageMolecularFormula value="[string]"/><!-- 0..1 A representation of an (average) molecular formula from a polymer -->
  <repeatUnitAmountType><!-- 0..1 CodeableConcept How the quantitative amount of Structural Repeat Units is captured (e.g. Exact, Numeric, Average) --></repeatUnitAmountType>
  <repeatUnit>  <!-- 0..* An SRU - Structural Repeat Unit -->
   <unit value="[string]"/><!-- 0..1 Structural repeat units are essential elements for defining polymers -->
   <orientation><!-- 0..1 CodeableConcept The orientation of the polymerisation, e.g. head-tail, head-head, random --></orientation>
   <amount value="[integer]"/><!-- 0..1 Number of repeats of this unit -->
   <degreeOfPolymerisation>  <!-- 0..* Applies to homopolymer and block co-polymers where the degree of polymerisation within a block can be described -->
    <type><!-- 0..1 CodeableConcept The type of the degree of polymerisation shall be described, e.g. SRU/Polymer Ratio --></type>
    <average value="[integer]"/><!-- 0..1 An average amount of polymerisation -->
    <low value="[integer]"/><!-- 0..1 A low expected limit of the amount -->
    <high value="[integer]"/><!-- 0..1 A high expected limit of the amount -->
   </degreeOfPolymerisation>
   <structuralRepresentation>  <!-- 0..* A graphical structure for this SRU -->
    <type><!-- 0..1 CodeableConcept The type of structure (e.g. Full, Partial, Representative) --></type>
    <representation value="[string]"/><!-- 0..1 The structural representation as text string in a standard format e.g. InChI, SMILES, MOLFILE, CDX, SDF, PDB, mmCIF -->
    <format><!-- 0..1 CodeableConcept The format of the representation e.g. InChI, SMILES, MOLFILE, CDX, SDF, PDB, mmCIF --></format>
    <attachment><!-- 0..1 Attachment An attached file with the structural representation --></attachment>
   </structuralRepresentation>
  </repeatUnit>
 </repeat>
</SubstancePolymer>

JSON Template

{
  "resourceType" : "SubstancePolymer",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : { Identifier }, // A business idenfier for this polymer, but typically this is handled by a SubstanceDefinition identifier
  "class" : { CodeableConcept }, // Overall type of the polymer
  "geometry" : { CodeableConcept }, // Polymer geometry, e.g. linear, branched, cross-linked, network or dendritic
  "copolymerConnectivity" : [{ CodeableConcept }], // Descrtibes the copolymer sequence type (polymer connectivity)
  "modification" : "<string>", // Todo - this is intended to connect to a repeating full modification structure, also used by Protein and Nucleic Acid . String is just a placeholder
  "monomerSet" : [{ // Todo
    "ratioType" : { CodeableConcept }, // Captures the type of ratio to the entire polymer, e.g. Monomer/Polymer ratio, SRU/Polymer Ratio
    "startingMaterial" : [{ // The starting materials - monomer(s) used in the synthesis of the polymer
      "code" : { CodeableConcept }, // The type of substance for this starting material
      "category" : { CodeableConcept }, // Substance high level category, e.g. chemical substance
      "isDefining" : <boolean>, // Used to specify whether the attribute described is a defining element for the unique identification of the polymer
      "amount" : { Quantity } // A percentage
    }]
  }],
  "repeat" : [{ // Specifies and quantifies the repeated units and their configuration
    "averageMolecularFormula" : "<string>", // A representation of an (average) molecular formula from a polymer
    "repeatUnitAmountType" : { CodeableConcept }, // How the quantitative amount of Structural Repeat Units is captured (e.g. Exact, Numeric, Average)
    "repeatUnit" : [{ // An SRU - Structural Repeat Unit
      "unit" : "<string>", // Structural repeat units are essential elements for defining polymers
      "orientation" : { CodeableConcept }, // The orientation of the polymerisation, e.g. head-tail, head-head, random
      "amount" : <integer>, // Number of repeats of this unit
      "degreeOfPolymerisation" : [{ // Applies to homopolymer and block co-polymers where the degree of polymerisation within a block can be described
        "type" : { CodeableConcept }, // The type of the degree of polymerisation shall be described, e.g. SRU/Polymer Ratio
        "average" : <integer>, // An average amount of polymerisation
        "low" : <integer>, // A low expected limit of the amount
        "high" : <integer> // A high expected limit of the amount
      }],
      "structuralRepresentation" : [{ // A graphical structure for this SRU
        "type" : { CodeableConcept }, // The type of structure (e.g. Full, Partial, Representative)
        "representation" : "<string>", // The structural representation as text string in a standard format e.g. InChI, SMILES, MOLFILE, CDX, SDF, PDB, mmCIF
        "format" : { CodeableConcept }, // The format of the representation e.g. InChI, SMILES, MOLFILE, CDX, SDF, PDB, mmCIF
        "attachment" : { Attachment } // An attached file with the structural representation
      }]
    }]
  }]
}

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .


[ a fhir:SubstancePolymer;
  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:identifier [ Identifier ] ; # 0..1 A business idenfier for this polymer, but typically this is handled by a SubstanceDefinition identifier
  fhir:class [ CodeableConcept ] ; # 0..1 Overall type of the polymer
  fhir:geometry [ CodeableConcept ] ; # 0..1 Polymer geometry, e.g. linear, branched, cross-linked, network or dendritic
  fhir:copolymerConnectivity  ( [ CodeableConcept ] ... ) ; # 0..* Descrtibes the copolymer sequence type (polymer connectivity)
  fhir:modification [ string ] ; # 0..1 Todo - this is intended to connect to a repeating full modification structure, also used by Protein and Nucleic Acid . String is just a placeholder
  fhir:monomerSet ( [ # 0..* Todo
    fhir:ratioType [ CodeableConcept ] ; # 0..1 Captures the type of ratio to the entire polymer, e.g. Monomer/Polymer ratio, SRU/Polymer Ratio
    fhir:startingMaterial ( [ # 0..* The starting materials - monomer(s) used in the synthesis of the polymer
      fhir:code [ CodeableConcept ] ; # 0..1 The type of substance for this starting material
      fhir:category [ CodeableConcept ] ; # 0..1 Substance high level category, e.g. chemical substance
      fhir:isDefining [ boolean ] ; # 0..1 Used to specify whether the attribute described is a defining element for the unique identification of the polymer
      fhir:amount [ Quantity ] ; # 0..1 A percentage
    ] ... ) ;
  ] ... ) ;
  fhir:repeat ( [ # 0..* Specifies and quantifies the repeated units and their configuration
    fhir:averageMolecularFormula [ string ] ; # 0..1 A representation of an (average) molecular formula from a polymer
    fhir:repeatUnitAmountType [ CodeableConcept ] ; # 0..1 How the quantitative amount of Structural Repeat Units is captured (e.g. Exact, Numeric, Average)
    fhir:repeatUnit ( [ # 0..* An SRU - Structural Repeat Unit
      fhir:unit [ string ] ; # 0..1 Structural repeat units are essential elements for defining polymers
      fhir:orientation [ CodeableConcept ] ; # 0..1 The orientation of the polymerisation, e.g. head-tail, head-head, random
      fhir:amount [ integer ] ; # 0..1 Number of repeats of this unit
      fhir:degreeOfPolymerisation ( [ # 0..* Applies to homopolymer and block co-polymers where the degree of polymerisation within a block can be described
        fhir:type [ CodeableConcept ] ; # 0..1 The type of the degree of polymerisation shall be described, e.g. SRU/Polymer Ratio
        fhir:average [ integer ] ; # 0..1 An average amount of polymerisation
        fhir:low [ integer ] ; # 0..1 A low expected limit of the amount
        fhir:high [ integer ] ; # 0..1 A high expected limit of the amount
      ] ... ) ;
      fhir:structuralRepresentation ( [ # 0..* A graphical structure for this SRU
        fhir:type [ CodeableConcept ] ; # 0..1 The type of structure (e.g. Full, Partial, Representative)
        fhir:representation [ string ] ; # 0..1 The structural representation as text string in a standard format e.g. InChI, SMILES, MOLFILE, CDX, SDF, PDB, mmCIF
        fhir:format [ CodeableConcept ] ; # 0..1 The format of the representation e.g. InChI, SMILES, MOLFILE, CDX, SDF, PDB, mmCIF
        fhir:attachment [ Attachment ] ; # 0..1 An attached file with the structural representation
      ] ... ) ;
    ] ... ) ;
  ] ... ) ;
]

Changes from both R4 and R4B

SubstancePolymer

SubstancePolymer.identifier

Added Element

SubstancePolymer.modification

Max Cardinality changed from * to 1

SubstancePolymer.monomerSet.startingMaterial.code

Renamed from material to code

SubstancePolymer.monomerSet.startingMaterial.category

Renamed from type to category

SubstancePolymer.monomerSet.startingMaterial.amount

Type changed from SubstanceAmount to Quantity

SubstancePolymer.repeat.repeatUnit.unit

Renamed from repeatUnit to unit

SubstancePolymer.repeat.repeatUnit.orientation

Renamed from orientationOfPolymerisation to orientation

SubstancePolymer.repeat.repeatUnit.amount

Type changed from SubstanceAmount to integer

SubstancePolymer.repeat.repeatUnit.degreeOfPolymerisation.type

Renamed from degree to type

SubstancePolymer.repeat.repeatUnit.degreeOfPolymerisation.average

Added Element

SubstancePolymer.repeat.repeatUnit.degreeOfPolymerisation.low

Added Element

SubstancePolymer.repeat.repeatUnit.degreeOfPolymerisation.high

Added Element

SubstancePolymer.repeat.repeatUnit.structuralRepresentation.format

Added Element

SubstancePolymer.repeat.numberOfUnits

Deleted (not needed because this is the count of RepeatUnit children)

SubstancePolymer.repeat.repeatUnit.degreeOfPolymerisation.amount

Deleted (split into low, high, average)

See the Full Difference for further information

This analysis is available for R4 as XML or JSON and for R4B as XML or JSON.