This page is part of the FHIR Specification (v4.4.0: R5 Preview #2). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions
. Page versions: R5 R4
Biomedical Research and Regulation Work Group | Maturity Level: 0 | Trial Use | Security Category: Anonymous | Compartments: Not linked to any defined compartments |
Todo.
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 SubstanceDefinition.
This resource does not implement any patterns.
Structure
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 Todo --></identifier> <class><!-- 0..1 CodeableConcept Todo --></class> <geometry><!-- 0..1 CodeableConcept Todo --></geometry> <copolymerConnectivity><!-- 0..* CodeableConcept Todo --></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 Todo --></ratioType> <startingMaterial> <!-- 0..* Todo --> <code><!-- 0..1 CodeableConcept Todo --></code> <category><!-- 0..1 CodeableConcept Todo --></category> <isDefining value="[boolean]"/><!-- 0..1 Todo --> <amount><!-- 0..1 SubstanceAmount Todo --></amount> </startingMaterial> </monomerSet> <repeat> <!-- 0..* Todo --> <numberOfUnits value="[integer]"/><!-- 0..1 Todo --> <averageMolecularFormula value="[string]"/><!-- 0..1 Todo --> <repeatUnitAmountType><!-- 0..1 CodeableConcept Todo --></repeatUnitAmountType> <repeatUnit> <!-- 0..* Todo --> <unit value="[string]"/><!-- 0..1 Todo --> <orientation><!-- 0..1 CodeableConcept Todo --></orientation> <amount><!-- 0..1 SubstanceAmount Todo --></amount> <degreeOfPolymerisation> <!-- 0..* Todo --> <degree><!-- 0..1 CodeableConcept Todo --></degree> <amount><!-- 0..1 SubstanceAmount Todo --></amount> </degreeOfPolymerisation> <structuralRepresentation> <!-- 0..* Todo --> <type><!-- 0..1 CodeableConcept Todo --></type> <representation value="[string]"/><!-- 0..1 Todo --> <format><!-- 0..1 CodeableConcept Todo --></format> <attachment><!-- 0..1 Attachment Todo --></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 }, // Todo
"class" : { CodeableConcept }, // Todo
"geometry" : { CodeableConcept }, // Todo
"copolymerConnectivity" : [{ CodeableConcept }], // Todo
"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 }, // Todo
"startingMaterial" : [{ // Todo
"code" : { CodeableConcept }, // Todo
"category" : { CodeableConcept }, // Todo
"isDefining" : <boolean>, // Todo
"amount" : { SubstanceAmount } // Todo
}]
}],
"repeat" : [{ // Todo
"numberOfUnits" : <integer>, // Todo
"averageMolecularFormula" : "<string>", // Todo
"repeatUnitAmountType" : { CodeableConcept }, // Todo
"repeatUnit" : [{ // Todo
"unit" : "<string>", // Todo
"orientation" : { CodeableConcept }, // Todo
"amount" : { SubstanceAmount }, // Todo
"degreeOfPolymerisation" : [{ // Todo
"degree" : { CodeableConcept }, // Todo
"amount" : { SubstanceAmount } // Todo
}],
"structuralRepresentation" : [{ // Todo
"type" : { CodeableConcept }, // Todo
"representation" : "<string>", // Todo
"format" : { CodeableConcept }, // Todo
"attachment" : { Attachment } // Todo
}]
}]
}]
}
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:SubstancePolymer.identifier [ Identifier ]; # 0..1 Todo fhir:SubstancePolymer.class [ CodeableConcept ]; # 0..1 Todo fhir:SubstancePolymer.geometry [ CodeableConcept ]; # 0..1 Todo fhir:SubstancePolymer.copolymerConnectivity [ CodeableConcept ], ... ; # 0..* Todo 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:SubstancePolymer.monomerSet.ratioType [ CodeableConcept ]; # 0..1 Todo fhir:SubstancePolymer.monomerSet.startingMaterial [ # 0..* Todo fhir:SubstancePolymer.monomerSet.startingMaterial.code [ CodeableConcept ]; # 0..1 Todo fhir:SubstancePolymer.monomerSet.startingMaterial.category [ CodeableConcept ]; # 0..1 Todo fhir:SubstancePolymer.monomerSet.startingMaterial.isDefining [ boolean ]; # 0..1 Todo fhir:SubstancePolymer.monomerSet.startingMaterial.amount [ SubstanceAmount ]; # 0..1 Todo ], ...; ], ...; fhir:SubstancePolymer.repeat [ # 0..* Todo fhir:SubstancePolymer.repeat.numberOfUnits [ integer ]; # 0..1 Todo fhir:SubstancePolymer.repeat.averageMolecularFormula [ string ]; # 0..1 Todo fhir:SubstancePolymer.repeat.repeatUnitAmountType [ CodeableConcept ]; # 0..1 Todo fhir:SubstancePolymer.repeat.repeatUnit [ # 0..* Todo fhir:SubstancePolymer.repeat.repeatUnit.unit [ string ]; # 0..1 Todo fhir:SubstancePolymer.repeat.repeatUnit.orientation [ CodeableConcept ]; # 0..1 Todo fhir:SubstancePolymer.repeat.repeatUnit.amount [ SubstanceAmount ]; # 0..1 Todo fhir:SubstancePolymer.repeat.repeatUnit.degreeOfPolymerisation [ # 0..* Todo fhir:SubstancePolymer.repeat.repeatUnit.degreeOfPolymerisation.degree [ CodeableConcept ]; # 0..1 Todo fhir:SubstancePolymer.repeat.repeatUnit.degreeOfPolymerisation.amount [ SubstanceAmount ]; # 0..1 Todo ], ...; fhir:SubstancePolymer.repeat.repeatUnit.structuralRepresentation [ # 0..* Todo fhir:SubstancePolymer.repeat.repeatUnit.structuralRepresentation.type [ CodeableConcept ]; # 0..1 Todo fhir:SubstancePolymer.repeat.repeatUnit.structuralRepresentation.representation [ string ]; # 0..1 Todo fhir:SubstancePolymer.repeat.repeatUnit.structuralRepresentation.format [ CodeableConcept ]; # 0..1 Todo fhir:SubstancePolymer.repeat.repeatUnit.structuralRepresentation.attachment [ Attachment ]; # 0..1 Todo ], ...; ], ...; ], ...; ]
Changes since R3
| SubstancePolymer | |
| SubstancePolymer.identifier |
|
| SubstancePolymer.modification |
|
| SubstancePolymer.monomerSet.startingMaterial.code |
|
| SubstancePolymer.monomerSet.startingMaterial.category |
|
| SubstancePolymer.repeat.repeatUnit.unit |
|
| SubstancePolymer.repeat.repeatUnit.orientation |
|
| SubstancePolymer.repeat.repeatUnit.structuralRepresentation.format |
|
| SubstancePolymer.monomerSet.startingMaterial.material |
|
| SubstancePolymer.monomerSet.startingMaterial.type |
|
| SubstancePolymer.repeat.repeatUnit.orientationOfPolymerisation |
|
| SubstancePolymer.repeat.repeatUnit.repeatUnit |
|
See the Full Difference for further information
Structure
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 Todo --></identifier> <class><!-- 0..1 CodeableConcept Todo --></class> <geometry><!-- 0..1 CodeableConcept Todo --></geometry> <copolymerConnectivity><!-- 0..* CodeableConcept Todo --></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 Todo --></ratioType> <startingMaterial> <!-- 0..* Todo --> <code><!-- 0..1 CodeableConcept Todo --></code> <category><!-- 0..1 CodeableConcept Todo --></category> <isDefining value="[boolean]"/><!-- 0..1 Todo --> <amount><!-- 0..1 SubstanceAmount Todo --></amount> </startingMaterial> </monomerSet> <repeat> <!-- 0..* Todo --> <numberOfUnits value="[integer]"/><!-- 0..1 Todo --> <averageMolecularFormula value="[string]"/><!-- 0..1 Todo --> <repeatUnitAmountType><!-- 0..1 CodeableConcept Todo --></repeatUnitAmountType> <repeatUnit> <!-- 0..* Todo --> <unit value="[string]"/><!-- 0..1 Todo --> <orientation><!-- 0..1 CodeableConcept Todo --></orientation> <amount><!-- 0..1 SubstanceAmount Todo --></amount> <degreeOfPolymerisation> <!-- 0..* Todo --> <degree><!-- 0..1 CodeableConcept Todo --></degree> <amount><!-- 0..1 SubstanceAmount Todo --></amount> </degreeOfPolymerisation> <structuralRepresentation> <!-- 0..* Todo --> <type><!-- 0..1 CodeableConcept Todo --></type> <representation value="[string]"/><!-- 0..1 Todo --> <format><!-- 0..1 CodeableConcept Todo --></format> <attachment><!-- 0..1 Attachment Todo --></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 }, // Todo
"class" : { CodeableConcept }, // Todo
"geometry" : { CodeableConcept }, // Todo
"copolymerConnectivity" : [{ CodeableConcept }], // Todo
"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 }, // Todo
"startingMaterial" : [{ // Todo
"code" : { CodeableConcept }, // Todo
"category" : { CodeableConcept }, // Todo
"isDefining" : <boolean>, // Todo
"amount" : { SubstanceAmount } // Todo
}]
}],
"repeat" : [{ // Todo
"numberOfUnits" : <integer>, // Todo
"averageMolecularFormula" : "<string>", // Todo
"repeatUnitAmountType" : { CodeableConcept }, // Todo
"repeatUnit" : [{ // Todo
"unit" : "<string>", // Todo
"orientation" : { CodeableConcept }, // Todo
"amount" : { SubstanceAmount }, // Todo
"degreeOfPolymerisation" : [{ // Todo
"degree" : { CodeableConcept }, // Todo
"amount" : { SubstanceAmount } // Todo
}],
"structuralRepresentation" : [{ // Todo
"type" : { CodeableConcept }, // Todo
"representation" : "<string>", // Todo
"format" : { CodeableConcept }, // Todo
"attachment" : { Attachment } // Todo
}]
}]
}]
}
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:SubstancePolymer.identifier [ Identifier ]; # 0..1 Todo fhir:SubstancePolymer.class [ CodeableConcept ]; # 0..1 Todo fhir:SubstancePolymer.geometry [ CodeableConcept ]; # 0..1 Todo fhir:SubstancePolymer.copolymerConnectivity [ CodeableConcept ], ... ; # 0..* Todo 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:SubstancePolymer.monomerSet.ratioType [ CodeableConcept ]; # 0..1 Todo fhir:SubstancePolymer.monomerSet.startingMaterial [ # 0..* Todo fhir:SubstancePolymer.monomerSet.startingMaterial.code [ CodeableConcept ]; # 0..1 Todo fhir:SubstancePolymer.monomerSet.startingMaterial.category [ CodeableConcept ]; # 0..1 Todo fhir:SubstancePolymer.monomerSet.startingMaterial.isDefining [ boolean ]; # 0..1 Todo fhir:SubstancePolymer.monomerSet.startingMaterial.amount [ SubstanceAmount ]; # 0..1 Todo ], ...; ], ...; fhir:SubstancePolymer.repeat [ # 0..* Todo fhir:SubstancePolymer.repeat.numberOfUnits [ integer ]; # 0..1 Todo fhir:SubstancePolymer.repeat.averageMolecularFormula [ string ]; # 0..1 Todo fhir:SubstancePolymer.repeat.repeatUnitAmountType [ CodeableConcept ]; # 0..1 Todo fhir:SubstancePolymer.repeat.repeatUnit [ # 0..* Todo fhir:SubstancePolymer.repeat.repeatUnit.unit [ string ]; # 0..1 Todo fhir:SubstancePolymer.repeat.repeatUnit.orientation [ CodeableConcept ]; # 0..1 Todo fhir:SubstancePolymer.repeat.repeatUnit.amount [ SubstanceAmount ]; # 0..1 Todo fhir:SubstancePolymer.repeat.repeatUnit.degreeOfPolymerisation [ # 0..* Todo fhir:SubstancePolymer.repeat.repeatUnit.degreeOfPolymerisation.degree [ CodeableConcept ]; # 0..1 Todo fhir:SubstancePolymer.repeat.repeatUnit.degreeOfPolymerisation.amount [ SubstanceAmount ]; # 0..1 Todo ], ...; fhir:SubstancePolymer.repeat.repeatUnit.structuralRepresentation [ # 0..* Todo fhir:SubstancePolymer.repeat.repeatUnit.structuralRepresentation.type [ CodeableConcept ]; # 0..1 Todo fhir:SubstancePolymer.repeat.repeatUnit.structuralRepresentation.representation [ string ]; # 0..1 Todo fhir:SubstancePolymer.repeat.repeatUnit.structuralRepresentation.format [ CodeableConcept ]; # 0..1 Todo fhir:SubstancePolymer.repeat.repeatUnit.structuralRepresentation.attachment [ Attachment ]; # 0..1 Todo ], ...; ], ...; ], ...; ]
Changes since Release 3
| SubstancePolymer | |
| SubstancePolymer.identifier |
|
| SubstancePolymer.modification |
|
| SubstancePolymer.monomerSet.startingMaterial.code |
|
| SubstancePolymer.monomerSet.startingMaterial.category |
|
| SubstancePolymer.repeat.repeatUnit.unit |
|
| SubstancePolymer.repeat.repeatUnit.orientation |
|
| SubstancePolymer.repeat.repeatUnit.structuralRepresentation.format |
|
| SubstancePolymer.monomerSet.startingMaterial.material |
|
| SubstancePolymer.monomerSet.startingMaterial.type |
|
| SubstancePolymer.repeat.repeatUnit.orientationOfPolymerisation |
|
| SubstancePolymer.repeat.repeatUnit.repeatUnit |
|
See the Full Difference for further information
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