R4 Ballot #1 (Mixed Normative/Trial use)
FoundationThis page is part of the FHIR Specification (v3.3.0: R4 Ballot 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 
| Modeling and Methodology Work Group | Maturity Level: N/A | Ballot Status: Informative |
StructureDefinition for SubstanceMoiety
{
"resourceType": "StructureDefinition",
"id": "SubstanceMoiety",
"meta": {
"lastUpdated": "2018-04-03T12:05:46.262+10:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-ballot-status",
"valueString": "Draft"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/SubstanceMoiety",
"name": "SubstanceMoiety",
"status": "draft",
"date": "2018-04-03T12:05:46+10:00",
"publisher": "HL7 FHIR Standard",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
}
]
}
],
"description": "Base StructureDefinition for SubstanceMoiety Type: Chemical substances are a single substance type whose primary defining element is the molecular structure. Chemical substances shall be defined on the basis of their complete covalent molecular structure; the presence of a salt (counter-ion) and/or solvates (water, alcohols) is also captured. Purity, grade, physical form or particle size are not taken into account in the definition of a chemical substance or in the assignment of a Substance ID.",
"fhirVersion": "3.3.0",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM Mapping"
}
],
"kind": "complex-type",
"abstract": false,
"type": "SubstanceMoiety",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/BackboneElement",
"derivation": "specialization",
"snapshot": {
"element": [
{
"id": "SubstanceMoiety",
"path": "SubstanceMoiety",
"short": "Chemical substances are a single substance type whose primary defining element is the molecular structure. Chemical substances shall be defined on the basis of their complete covalent molecular structure; the presence of a salt (counter-ion) and/or solvates (water, alcohols) is also captured. Purity, grade, physical form or particle size are not taken into account in the definition of a chemical substance or in the assignment of a Substance ID",
"definition": "Chemical substances are a single substance type whose primary defining element is the molecular structure. Chemical substances shall be defined on the basis of their complete covalent molecular structure; the presence of a salt (counter-ion) and/or solvates (water, alcohols) is also captured. Purity, grade, physical form or particle size are not taken into account in the definition of a chemical substance or in the assignment of a Substance ID.",
"min": 0,
"max": "*",
"base": {
"path": "SubstanceMoiety",
"min": 0,
"max": "*"
},
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "SubstanceMoiety.id",
"path": "SubstanceMoiety.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "SubstanceMoiety.extension",
"path": "SubstanceMoiety.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"rules": "open"
},
"short": "Additional content defined by implementations",
"definition": "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.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "SubstanceMoiety.modifierExtension",
"path": "SubstanceMoiety.modifierExtension",
"short": "Extensions that cannot be ignored",
"definition": "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. 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.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"isModifierReason": "modifierExtension is reserved for use where modifier extensions must be used",
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "SubstanceMoiety.role",
"path": "SubstanceMoiety.role",
"short": "The role of the moiety should be specified if there is a specific role the moiety is playing",
"definition": "The role of the moiety should be specified if there is a specific role the moiety is playing.",
"min": 0,
"max": "1",
"base": {
"path": "SubstanceMoiety.role",
"min": 0,
"max": "1"
},
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"isSummary": true
},
{
"id": "SubstanceMoiety.identifier",
"path": "SubstanceMoiety.identifier",
"short": "The unique identifier assigned to the substance representing the moiety based on the ISO 11238 substance controlled vocabulary",
"definition": "The unique identifier assigned to the substance representing the moiety based on the ISO 11238 substance controlled vocabulary.",
"min": 0,
"max": "1",
"base": {
"path": "SubstanceMoiety.identifier",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Identifier"
}
],
"isModifier": false,
"isSummary": true
},
{
"id": "SubstanceMoiety.name",
"path": "SubstanceMoiety.name",
"short": "The name of the moiety shall be provided",
"definition": "The name of the moiety shall be provided.",
"min": 0,
"max": "1",
"base": {
"path": "SubstanceMoiety.name",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"isModifier": false,
"isSummary": true
},
{
"id": "SubstanceMoiety.stereochemistry",
"path": "SubstanceMoiety.stereochemistry",
"short": "Stereochemistry shall be captured as described in 4.7.1",
"definition": "Stereochemistry shall be captured as described in 4.7.1.",
"min": 0,
"max": "1",
"base": {
"path": "SubstanceMoiety.stereochemistry",
"min": 0,
"max": "1"
},
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"isSummary": true
},
{
"id": "SubstanceMoiety.opticalActivity",
"path": "SubstanceMoiety.opticalActivity",
"short": "Optical activity shall be captured as described in 4.7.2",
"definition": "Optical activity shall be captured as described in 4.7.2.",
"min": 0,
"max": "1",
"base": {
"path": "SubstanceMoiety.opticalActivity",
"min": 0,
"max": "1"
},
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"isSummary": true
},
{
"id": "SubstanceMoiety.molecularFormula",
"path": "SubstanceMoiety.molecularFormula",
"short": "Molecular formula shall be captured as described in 4.7.3",
"definition": "Molecular formula shall be captured as described in 4.7.3.",
"min": 0,
"max": "1",
"base": {
"path": "SubstanceMoiety.molecularFormula",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"isModifier": false,
"isSummary": true
},
{
"id": "SubstanceMoiety.amount",
"path": "SubstanceMoiety.amount",
"short": "Used to capture quantitative values for a variety of elements. If only limits are given, the arithmetic mean would be the average. If only a single definite value for a given element is given, it would be captured in this field",
"definition": "Used to capture quantitative values for a variety of elements. If only limits are given, the arithmetic mean would be the average. If only a single definite value for a given element is given, it would be captured in this field.",
"min": 0,
"max": "1",
"base": {
"path": "SubstanceMoiety.amount",
"min": 0,
"max": "1"
},
"type": [
{
"code": "SubstanceAmount"
}
],
"isModifier": false,
"isSummary": true
}
]
},
"differential": {
"element": [
{
"id": "SubstanceMoiety",
"path": "SubstanceMoiety",
"short": "Chemical substances are a single substance type whose primary defining element is the molecular structure. Chemical substances shall be defined on the basis of their complete covalent molecular structure; the presence of a salt (counter-ion) and/or solvates (water, alcohols) is also captured. Purity, grade, physical form or particle size are not taken into account in the definition of a chemical substance or in the assignment of a Substance ID",
"definition": "Chemical substances are a single substance type whose primary defining element is the molecular structure. Chemical substances shall be defined on the basis of their complete covalent molecular structure; the presence of a salt (counter-ion) and/or solvates (water, alcohols) is also captured. Purity, grade, physical form or particle size are not taken into account in the definition of a chemical substance or in the assignment of a Substance ID.",
"min": 0,
"max": "*"
},
{
"id": "SubstanceMoiety.role",
"path": "SubstanceMoiety.role",
"short": "The role of the moiety should be specified if there is a specific role the moiety is playing",
"definition": "The role of the moiety should be specified if there is a specific role the moiety is playing.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true
},
{
"id": "SubstanceMoiety.identifier",
"path": "SubstanceMoiety.identifier",
"short": "The unique identifier assigned to the substance representing the moiety based on the ISO 11238 substance controlled vocabulary",
"definition": "The unique identifier assigned to the substance representing the moiety based on the ISO 11238 substance controlled vocabulary.",
"min": 0,
"max": "1",
"type": [
{
"code": "Identifier"
}
],
"isSummary": true
},
{
"id": "SubstanceMoiety.name",
"path": "SubstanceMoiety.name",
"short": "The name of the moiety shall be provided",
"definition": "The name of the moiety shall be provided.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"id": "SubstanceMoiety.stereochemistry",
"path": "SubstanceMoiety.stereochemistry",
"short": "Stereochemistry shall be captured as described in 4.7.1",
"definition": "Stereochemistry shall be captured as described in 4.7.1.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true
},
{
"id": "SubstanceMoiety.opticalActivity",
"path": "SubstanceMoiety.opticalActivity",
"short": "Optical activity shall be captured as described in 4.7.2",
"definition": "Optical activity shall be captured as described in 4.7.2.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true
},
{
"id": "SubstanceMoiety.molecularFormula",
"path": "SubstanceMoiety.molecularFormula",
"short": "Molecular formula shall be captured as described in 4.7.3",
"definition": "Molecular formula shall be captured as described in 4.7.3.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"id": "SubstanceMoiety.amount",
"path": "SubstanceMoiety.amount",
"short": "Used to capture quantitative values for a variety of elements. If only limits are given, the arithmetic mean would be the average. If only a single definite value for a given element is given, it would be captured in this field",
"definition": "Used to capture quantitative values for a variety of elements. If only limits are given, the arithmetic mean would be the average. If only a single definite value for a given element is given, it would be captured in this field.",
"min": 0,
"max": "1",
"type": [
{
"code": "SubstanceAmount"
}
],
"isSummary": true
}
]
}
}
Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.
®© HL7.org 2011+. FHIR Mixed Nomative/Trial Use Ballot (v3.3.0-13671) generated on Tue, Apr 3, 2018 12:13+1000. QA Page
Links: Search |
Version History |
Table of Contents |
Credits |
Compare to DSTU3 |
|
Propose a change