Release 4 5 Preview #2
This page is part of the FHIR Specification (v4.0.1: R4 - Mixed Normative and STU ). This is the current published version in it's permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

11.22 11.20 Resource SubstancePolymer - Content

Biomedical Research and Regulation Work Group Maturity Level : 0   Trial Use Security Category : Anonymous Compartments : Not linked to any defined compartments

Todo. Properties of a substance specific to it being a polymer.

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

This resource is referenced by SubstanceSpecification SubstanceDefinition .

This resource does not implement any patterns.

Structure

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

doco Documentation for this format

UML Diagram ( Legend )

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

XML Template

<SubstancePolymer xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <</class>
 <</geometry>
 <</copolymerConnectivity>
 <

 <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>
  <
   <</material>
   <</type>
   <
   <</amount>

  <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>
 <
  <
  <
  <</repeatUnitAmountType>
  <
   <</orientationOfPolymerisation>
   <
   <</amount>
   <
    <</degree>
    <</amount>

 <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>
   <
    <</type>
    <
    <</attachment>

   <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

{doco
  "resourceType" : "",

  "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/> .doco
[ a 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:
  fhir:
  fhir:
  fhir:

  fhir:SubstancePolymer.identifier [ Identifier ]; # 0..1 A business idenfier for this polymer, but typically this is handled by a SubstanceDefinition identifier
  fhir:SubstancePolymer.class [ CodeableConcept ]; # 0..1 Overall type of the polymer
  fhir:SubstancePolymer.geometry [ CodeableConcept ]; # 0..1 Polymer geometry, e.g. linear, branched, cross-linked, network or dendritic
  fhir:SubstancePolymer.copolymerConnectivity [ CodeableConcept ], ... ; # 0..* Descrtibes the copolymer sequence type (polymer connectivity)
  fhir:SubstancePolymer.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:SubstancePolymer.monomerSet [ # 0..* Todo
    fhir:
    fhir:
      fhir:
      fhir:
      fhir:
      fhir:

    fhir:SubstancePolymer.monomerSet.ratioType [ CodeableConcept ]; # 0..1 Captures the type of ratio to the entire polymer, e.g. Monomer/Polymer ratio, SRU/Polymer Ratio
    fhir:SubstancePolymer.monomerSet.startingMaterial [ # 0..* The starting materials - monomer(s) used in the synthesis of the polymer
      fhir:SubstancePolymer.monomerSet.startingMaterial.code [ CodeableConcept ]; # 0..1 The type of substance for this starting material
      fhir:SubstancePolymer.monomerSet.startingMaterial.category [ CodeableConcept ]; # 0..1 Substance high level category, e.g. chemical substance
      fhir:SubstancePolymer.monomerSet.startingMaterial.isDefining [ boolean ]; # 0..1 Used to specify whether the attribute described is a defining element for the unique identification of the polymer
      fhir:SubstancePolymer.monomerSet.startingMaterial.amount [ Quantity ]; # 0..1 A percentage

    ], ...;
  ], ...;
  fhir:
    fhir:
    fhir:
    fhir:
    fhir:
      fhir:
      fhir:
      fhir:
      fhir:
        fhir:
        fhir:

  fhir:SubstancePolymer.repeat [ # 0..* Specifies and quantifies the repeated units and their configuration
    fhir:SubstancePolymer.repeat.averageMolecularFormula [ string ]; # 0..1 A representation of an (average) molecular formula from a polymer
    fhir:SubstancePolymer.repeat.repeatUnitAmountType [ CodeableConcept ]; # 0..1 How the quantitative amount of Structural Repeat Units is captured (e.g. Exact, Numeric, Average)
    fhir:SubstancePolymer.repeat.repeatUnit [ # 0..* An SRU - Structural Repeat Unit
      fhir:SubstancePolymer.repeat.repeatUnit.unit [ string ]; # 0..1 Structural repeat units are essential elements for defining polymers
      fhir:SubstancePolymer.repeat.repeatUnit.orientation [ CodeableConcept ]; # 0..1 The orientation of the polymerisation, e.g. head-tail, head-head, random
      fhir:SubstancePolymer.repeat.repeatUnit.amount [ integer ]; # 0..1 Number of repeats of this unit
      fhir:SubstancePolymer.repeat.repeatUnit.degreeOfPolymerisation [ # 0..* Applies to homopolymer and block co-polymers where the degree of polymerisation within a block can be described
        fhir:SubstancePolymer.repeat.repeatUnit.degreeOfPolymerisation.type [ CodeableConcept ]; # 0..1 The type of the degree of polymerisation shall be described, e.g. SRU/Polymer Ratio
        fhir:SubstancePolymer.repeat.repeatUnit.degreeOfPolymerisation.average [ integer ]; # 0..1 An average amount of polymerisation
        fhir:SubstancePolymer.repeat.repeatUnit.degreeOfPolymerisation.low [ integer ]; # 0..1 A low expected limit of the amount
        fhir:SubstancePolymer.repeat.repeatUnit.degreeOfPolymerisation.high [ integer ]; # 0..1 A high expected limit of the amount

      ], ...;
      fhir:
        fhir:
        fhir:
        fhir:

      fhir:SubstancePolymer.repeat.repeatUnit.structuralRepresentation [ # 0..* A graphical structure for this SRU
        fhir:SubstancePolymer.repeat.repeatUnit.structuralRepresentation.type [ CodeableConcept ]; # 0..1 The type of structure (e.g. Full, Partial, Representative)
        fhir:SubstancePolymer.repeat.repeatUnit.structuralRepresentation.representation [ string ]; # 0..1 The structural representation as text string in a standard format e.g. InChI, SMILES, MOLFILE, CDX, SDF, PDB, mmCIF
        fhir:SubstancePolymer.repeat.repeatUnit.structuralRepresentation.format [ CodeableConcept ]; # 0..1 The format of the representation e.g. InChI, SMILES, MOLFILE, CDX, SDF, PDB, mmCIF
        fhir:SubstancePolymer.repeat.repeatUnit.structuralRepresentation.attachment [ Attachment ]; # 0..1 An attached file with the structural representation

      ], ...;
    ], ...;
  ], ...;
]

Changes since R3

SubstancePolymer
SubstancePolymer.identifier
  • Added Element
SubstancePolymer.modification
  • Max Cardinality changed from * to 1
SubstancePolymer.monomerSet.startingMaterial.code
  • Added Element
SubstancePolymer.monomerSet.startingMaterial.category
  • Added Element
SubstancePolymer.monomerSet.startingMaterial.amount
  • Type changed from SubstanceAmount to Quantity
SubstancePolymer.repeat.repeatUnit.unit
  • Added Element
SubstancePolymer.repeat.repeatUnit.orientation
  • Added Element
SubstancePolymer.repeat.repeatUnit.amount
  • Type changed from SubstanceAmount to integer
SubstancePolymer.repeat.repeatUnit.degreeOfPolymerisation.type
  • Added Element
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.monomerSet.startingMaterial.material
  • deleted
SubstancePolymer.monomerSet.startingMaterial.type
  • deleted
SubstancePolymer.repeat.numberOfUnits
  • deleted
SubstancePolymer.repeat.repeatUnit.orientationOfPolymerisation
  • deleted
SubstancePolymer.repeat.repeatUnit.repeatUnit
  • deleted
SubstancePolymer.repeat.repeatUnit.degreeOfPolymerisation.degree
  • deleted
SubstancePolymer.repeat.repeatUnit.degreeOfPolymerisation.amount
  • deleted

This resource did not exist in Release 2 See the Full Difference for further information

This analysis is available as XML or JSON .

Structure

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

doco Documentation for this format

UML Diagram ( Legend )

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

XML Template

<SubstancePolymer xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <</class>
 <</geometry>
 <</copolymerConnectivity>
 <

 <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>
  <
   <</material>
   <</type>
   <
   <</amount>

  <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>
 <
  <
  <
  <</repeatUnitAmountType>
  <
   <</orientationOfPolymerisation>
   <
   <</amount>
   <
    <</degree>
    <</amount>

 <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>
   <
    <</type>
    <
    <</attachment>

   <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

{doco
  "resourceType" : "",

  "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/> .doco
[ a 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:
  fhir:
  fhir:
  fhir:

  fhir:SubstancePolymer.identifier [ Identifier ]; # 0..1 A business idenfier for this polymer, but typically this is handled by a SubstanceDefinition identifier
  fhir:SubstancePolymer.class [ CodeableConcept ]; # 0..1 Overall type of the polymer
  fhir:SubstancePolymer.geometry [ CodeableConcept ]; # 0..1 Polymer geometry, e.g. linear, branched, cross-linked, network or dendritic
  fhir:SubstancePolymer.copolymerConnectivity [ CodeableConcept ], ... ; # 0..* Descrtibes the copolymer sequence type (polymer connectivity)
  fhir:SubstancePolymer.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:SubstancePolymer.monomerSet [ # 0..* Todo
    fhir:
    fhir:
      fhir:
      fhir:
      fhir:
      fhir:

    fhir:SubstancePolymer.monomerSet.ratioType [ CodeableConcept ]; # 0..1 Captures the type of ratio to the entire polymer, e.g. Monomer/Polymer ratio, SRU/Polymer Ratio
    fhir:SubstancePolymer.monomerSet.startingMaterial [ # 0..* The starting materials - monomer(s) used in the synthesis of the polymer
      fhir:SubstancePolymer.monomerSet.startingMaterial.code [ CodeableConcept ]; # 0..1 The type of substance for this starting material
      fhir:SubstancePolymer.monomerSet.startingMaterial.category [ CodeableConcept ]; # 0..1 Substance high level category, e.g. chemical substance
      fhir:SubstancePolymer.monomerSet.startingMaterial.isDefining [ boolean ]; # 0..1 Used to specify whether the attribute described is a defining element for the unique identification of the polymer
      fhir:SubstancePolymer.monomerSet.startingMaterial.amount [ Quantity ]; # 0..1 A percentage

    ], ...;
  ], ...;
  fhir:
    fhir:
    fhir:
    fhir:
    fhir:
      fhir:
      fhir:
      fhir:
      fhir:
        fhir:
        fhir:

  fhir:SubstancePolymer.repeat [ # 0..* Specifies and quantifies the repeated units and their configuration
    fhir:SubstancePolymer.repeat.averageMolecularFormula [ string ]; # 0..1 A representation of an (average) molecular formula from a polymer
    fhir:SubstancePolymer.repeat.repeatUnitAmountType [ CodeableConcept ]; # 0..1 How the quantitative amount of Structural Repeat Units is captured (e.g. Exact, Numeric, Average)
    fhir:SubstancePolymer.repeat.repeatUnit [ # 0..* An SRU - Structural Repeat Unit
      fhir:SubstancePolymer.repeat.repeatUnit.unit [ string ]; # 0..1 Structural repeat units are essential elements for defining polymers
      fhir:SubstancePolymer.repeat.repeatUnit.orientation [ CodeableConcept ]; # 0..1 The orientation of the polymerisation, e.g. head-tail, head-head, random
      fhir:SubstancePolymer.repeat.repeatUnit.amount [ integer ]; # 0..1 Number of repeats of this unit
      fhir:SubstancePolymer.repeat.repeatUnit.degreeOfPolymerisation [ # 0..* Applies to homopolymer and block co-polymers where the degree of polymerisation within a block can be described
        fhir:SubstancePolymer.repeat.repeatUnit.degreeOfPolymerisation.type [ CodeableConcept ]; # 0..1 The type of the degree of polymerisation shall be described, e.g. SRU/Polymer Ratio
        fhir:SubstancePolymer.repeat.repeatUnit.degreeOfPolymerisation.average [ integer ]; # 0..1 An average amount of polymerisation
        fhir:SubstancePolymer.repeat.repeatUnit.degreeOfPolymerisation.low [ integer ]; # 0..1 A low expected limit of the amount
        fhir:SubstancePolymer.repeat.repeatUnit.degreeOfPolymerisation.high [ integer ]; # 0..1 A high expected limit of the amount

      ], ...;
      fhir:
        fhir:
        fhir:
        fhir:

      fhir:SubstancePolymer.repeat.repeatUnit.structuralRepresentation [ # 0..* A graphical structure for this SRU
        fhir:SubstancePolymer.repeat.repeatUnit.structuralRepresentation.type [ CodeableConcept ]; # 0..1 The type of structure (e.g. Full, Partial, Representative)
        fhir:SubstancePolymer.repeat.repeatUnit.structuralRepresentation.representation [ string ]; # 0..1 The structural representation as text string in a standard format e.g. InChI, SMILES, MOLFILE, CDX, SDF, PDB, mmCIF
        fhir:SubstancePolymer.repeat.repeatUnit.structuralRepresentation.format [ CodeableConcept ]; # 0..1 The format of the representation e.g. InChI, SMILES, MOLFILE, CDX, SDF, PDB, mmCIF
        fhir:SubstancePolymer.repeat.repeatUnit.structuralRepresentation.attachment [ Attachment ]; # 0..1 An attached file with the structural representation

      ], ...;
    ], ...;
  ], ...;
]

Changes since Release 3

SubstancePolymer
SubstancePolymer.identifier
  • Added Element
SubstancePolymer.modification
  • Max Cardinality changed from * to 1
SubstancePolymer.monomerSet.startingMaterial.code
  • Added Element
SubstancePolymer.monomerSet.startingMaterial.category
  • Added Element
SubstancePolymer.monomerSet.startingMaterial.amount
  • Type changed from SubstanceAmount to Quantity
SubstancePolymer.repeat.repeatUnit.unit
  • Added Element
SubstancePolymer.repeat.repeatUnit.orientation
  • Added Element
SubstancePolymer.repeat.repeatUnit.amount
  • Type changed from SubstanceAmount to integer
SubstancePolymer.repeat.repeatUnit.degreeOfPolymerisation.type
  • Added Element
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.monomerSet.startingMaterial.material
  • deleted
SubstancePolymer.monomerSet.startingMaterial.type
  • deleted
SubstancePolymer.repeat.numberOfUnits
  • deleted
SubstancePolymer.repeat.repeatUnit.orientationOfPolymerisation
  • deleted
SubstancePolymer.repeat.repeatUnit.repeatUnit
  • deleted
SubstancePolymer.repeat.repeatUnit.degreeOfPolymerisation.degree
  • deleted
SubstancePolymer.repeat.repeatUnit.degreeOfPolymerisation.amount
  • deleted

This resource did not exist in Release 2 See the Full Difference for further information

This analysis is available as XML or JSON .

 

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