Release 5 Preview #2

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 R4B

11.19 Resource SubstanceDefinition - Content

Biomedical Research and Regulation Work GroupMaturity Level: 1 Trial UseSecurity Category: Anonymous Compartments: Not linked to any defined compartments

The detailed description of a substance, typically at a level beyond what is used for prescribing.

This resource is referenced by ClinicalUseIssue, Ingredient and itself.

This resource does not implement any patterns.

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. SubstanceDefinition ΣTUDomainResourceThe detailed description of a substance, typically at a level beyond what is used for prescribing
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
... identifier Σ0..1IdentifierIdentifier by which this substance is known
... version Σ0..1stringA business level identifier of the substance
... status Σ0..1CodeableConceptStatus of substance within the catalogue e.g. approved
... domain Σ0..1CodeableConceptIf the substance applies to only human or veterinary use
... description Σ0..1markdownTextual description of the substance
... source Σ0..*Reference(DocumentReference)Supporting literature
... note Σ0..*AnnotationTextual comment about this record of a substance
... manufacturer Σ0..*Reference(Organization)A company that makes this substance
... supplier Σ0..*Reference(Organization)A company that supplies this substance
... moiety Σ0..*BackboneElementMoiety, for structural modifications
.... role Σ0..1CodeableConceptRole that the moiety is playing
.... identifier Σ0..1IdentifierIdentifier by which this moiety substance is known
.... name Σ0..1stringTextual name for this moiety substance
.... stereochemistry Σ0..1CodeableConceptStereochemistry type
.... opticalActivity Σ0..1CodeableConceptOptical activity type
.... molecularFormula Σ0..1stringMolecular formula for this moiety of this substance, typically using the Hill system
.... amount[x] Σ0..1Quantitative value for this moiety
..... amountQuantityQuantity
..... amountStringstring
.... amountType Σ0..1CodeableConceptThe measurement type of the quantitative value
... property Σ0..*BackboneElementGeneral specifications for this substance, including how it is related to other substances
.... category Σ0..1CodeableConceptA category for this property, e.g. Physical, Chemical, Enzymatic
.... code Σ0..1CodeableConceptProperty type e.g. viscosity, pH, isoelectric point
.... parameters Σ0..1stringParameters that were used in the measurement of a property (e.g. for viscosity: measured at 20C with a pH of 7.1)
.... definingSubstance[x] Σ0..1A substance upon which a defining property depends (e.g. for solubility: in water, in alcohol)
..... definingSubstanceReferenceReference(SubstanceDefinition | Substance)
..... definingSubstanceCodeableConceptCodeableConcept
.... amount[x] Σ0..1Quantitative value for this property
..... amountQuantityQuantity
..... amountStringstring
.... referenceRange Σ0..1RangeRange of typical values
.... source Σ0..*Reference(DocumentReference)Supporting literature
... referenceInformation Σ0..1Reference(SubstanceReferenceInformation)General information detailing this substance
... structure Σ0..1BackboneElementStructural information
.... stereochemistry Σ0..1CodeableConceptStereochemistry type
.... opticalActivity Σ0..1CodeableConceptOptical activity type
.... molecularFormula Σ0..1stringMolecular formula of this substance, typically using the Hill system
.... molecularFormulaByMoiety Σ0..1stringSpecified per moiety according to the Hill system, i.e. first C, then H, then alphabetical, each moiety separated by a dot
.... isotope Σ0..*BackboneElementApplicable for single substances that contain a radionuclide or a non-natural isotopic ratio
..... identifier Σ0..1IdentifierSubstance identifier for each non-natural or radioisotope
..... name Σ0..1CodeableConceptSubstance name for each non-natural or radioisotope
..... substitution Σ0..1CodeableConceptThe type of isotopic substitution present in a single substance
..... halfLife Σ0..1QuantityHalf life - for a non-natural nuclide
..... molecularWeight Σ0..1BackboneElementThe molecular weight or weight range (for proteins, polymers or nucleic acids)
...... method Σ0..1CodeableConceptThe method by which the molecular weight was determined
...... type Σ0..1CodeableConceptType of molecular weight such as exact, average (also known as. number average), weight average
...... amount Σ0..1QuantityUsed 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
.... molecularWeight Σ0..1see molecularWeightThe molecular weight or weight range (for proteins, polymers or nucleic acids)
.... technique Σ0..*CodeableConceptThe method used to elucidate the structure or characterization of the drug substance. Examples: X-ray, HPLC, NMR, Peptide mapping, Ligand binding assay
.... sourceDocument Σ0..*Reference(DocumentReference)Supporting literature about the source of information
.... representation Σ0..*BackboneElementMolecular structural representation
..... type Σ0..1CodeableConceptThe type of structure (e.g. Full, Partial, Representative)
..... representation Σ0..1stringThe structural representation as text string in a standard format e.g. InChI, SMILES, MOLFILE, CDX, SDF, PDB, mmCIF
..... format Σ0..1CodeableConceptThe format of the representation e.g. InChI, SMILES, MOLFILE, CDX, SDF, PDB, mmCIF
..... attachment Σ0..1AttachmentAn attached file with the structural representation
... code Σ0..*BackboneElementCodes associated with the substance
.... code Σ0..1CodeableConceptThe specific code
.... status Σ0..1CodeableConceptStatus of the code assignment, for example 'provisional', 'approved'
.... statusDate Σ0..1dateTimeThe date at which the code status is changed as part of the terminology maintenance
.... note Σ0..*AnnotationAny comment can be provided in this field, if necessary
.... source Σ0..*Reference(DocumentReference)Supporting literature
... name Σ0..*BackboneElementNames applicable to this substance
.... name Σ1..1stringThe actual name
.... type Σ0..1CodeableConceptName type, for example 'systematic', 'scientific, 'brand'
.... status Σ0..1CodeableConceptThe status of the name, for example 'current', 'proposed'
.... preferred Σ0..1booleanIf this is the preferred name for this substance
.... language Σ0..*CodeableConceptHuman language that the name is written in
.... domain Σ0..*CodeableConceptThe use context of this name for example if there is a different name a drug active ingredient as opposed to a food colour additive
.... jurisdiction Σ0..*CodeableConceptThe jurisdiction where this name applies
.... synonym Σ0..*see nameA synonym of this particular name, by which the substance is also known
.... translation Σ0..*see nameA translation for this name into another human language
.... official Σ0..*BackboneElementDetails of the official nature of this name
..... authority Σ0..1CodeableConceptWhich authority uses this official name
..... status Σ0..1CodeableConceptThe status of the official name, for example 'provisional', 'approved'
..... date Σ0..1dateTimeDate of official name change
.... source Σ0..*Reference(DocumentReference)Supporting literature
... molecularWeight Σ0..*see molecularWeightThe molecular weight or weight range (for proteins, polymers or nucleic acids)
... relationship Σ0..*BackboneElementA link between this substance and another, with details of the relationship
.... substanceDefinition[x] Σ0..1A pointer to another substance, as a resource or just a representational code
..... substanceDefinitionReferenceReference(SubstanceDefinition)
..... substanceDefinitionCodeableConceptCodeableConcept
.... type Σ0..1CodeableConceptFor example "salt to parent", "active moiety", "starting material", "polymorph"
.... isDefining Σ0..1booleanFor example where an enzyme strongly bonds with a particular substance, this is a defining relationship for that enzyme, out of several possible substance relationships
.... amount[x] Σ0..1A numeric factor for the relationship, for instance to express that the salt of a substance has some percentage of the active substance in relation to some other
..... amountQuantityQuantity
..... amountRangeRange
..... amountRatioRatio
..... amountStringstring
.... amountRatioHighLimit Σ0..1RatioFor use when the numeric has an uncertain range
.... amountType Σ0..1CodeableConceptAn operator for the amount, for example "average", "approximately", "less than"
.... source Σ0..*Reference(DocumentReference)Supporting literature
... nucleicAcid Σ0..1Reference(SubstanceNucleicAcid)Data items specific to nucleic acids
... polymer Σ0..1Reference(SubstancePolymer)Data items specific to polymers
... protein Σ0..1Reference(SubstanceProtein)Data items specific to proteins
... sourceMaterial Σ0..1Reference(SubstanceSourceMaterial)Material or taxonomic/anatomical source for the substance

doco Documentation for this format

UML Diagram (Legend)

SubstanceDefinition (DomainResource)Identifier by which this substance is knownidentifier : Identifier [0..1]A business level identifier of the substanceversion : string [0..1]Status of substance within the catalogue e.g. approvedstatus : CodeableConcept [0..1]High level categorization, e.g. polymer or nucleic acid, or food, chemical, biologicalcategory : CodeableConcept [0..1]If the substance applies to only human or veterinary usedomain : CodeableConcept [0..1]Textual description of the substancedescription : markdown [0..1]Supporting literaturesource : Reference [0..*] « DocumentReference »Textual comment about this record of a substancenote : Annotation [0..*]A company that makes this substancemanufacturer : Reference [0..*] « Organization »A company that supplies this substancesupplier : Reference [0..*] « Organization »General information detailing this substancereferenceInformation : Reference [0..1] « SubstanceReferenceInformation »Data items specific to nucleic acidsnucleicAcid : Reference [0..1] « SubstanceNucleicAcid »Data items specific to polymerspolymer : Reference [0..1] « SubstancePolymer »Data items specific to proteinsprotein : Reference [0..1] « SubstanceProtein »Material or taxonomic/anatomical source for the substancesourceMaterial : Reference [0..1] « SubstanceSourceMaterial »MoietyRole that the moiety is playingrole : CodeableConcept [0..1]Identifier by which this moiety substance is knownidentifier : Identifier [0..1]Textual name for this moiety substancename : string [0..1]Stereochemistry typestereochemistry : CodeableConcept [0..1]Optical activity typeopticalActivity : CodeableConcept [0..1]Molecular formula for this moiety of this substance, typically using the Hill systemmolecularFormula : string [0..1]Quantitative value for this moietyamount[x] : DataType [0..1] « Quantity|string »The measurement type of the quantitative valueamountType : CodeableConcept [0..1]PropertyA category for this property, e.g. Physical, Chemical, Enzymaticcategory : CodeableConcept [0..1]Property type e.g. viscosity, pH, isoelectric pointcode : CodeableConcept [0..1]Parameters that were used in the measurement of a property (e.g. for viscosity: measured at 20C with a pH of 7.1)parameters : string [0..1]A substance upon which a defining property depends (e.g. for solubility: in water, in alcohol)definingSubstance[x] : DataType [0..1] « Reference( SubstanceDefinition|Substance)|CodeableConcept »Quantitative value for this propertyamount[x] : DataType [0..1] « Quantity|string »Range of typical valuesreferenceRange : Range [0..1]Supporting literaturesource : Reference [0..*] « DocumentReference »StructureStereochemistry typestereochemistry : CodeableConcept [0..1]Optical activity typeopticalActivity : CodeableConcept [0..1]Molecular formula of this substance, typically using the Hill systemmolecularFormula : string [0..1]Specified per moiety according to the Hill system, i.e. first C, then H, then alphabetical, each moiety separated by a dotmolecularFormulaByMoiety : string [0..1]The method used to elucidate the structure or characterization of the drug substance. Examples: X-ray, HPLC, NMR, Peptide mapping, Ligand binding assaytechnique : CodeableConcept [0..*]Supporting literature about the source of informationsourceDocument : Reference [0..*] « DocumentReference »IsotopeSubstance identifier for each non-natural or radioisotopeidentifier : Identifier [0..1]Substance name for each non-natural or radioisotopename : CodeableConcept [0..1]The type of isotopic substitution present in a single substancesubstitution : CodeableConcept [0..1]Half life - for a non-natural nuclidehalfLife : Quantity [0..1]MolecularWeightThe method by which the molecular weight was determinedmethod : CodeableConcept [0..1]Type of molecular weight such as exact, average (also known as. number average), weight averagetype : CodeableConcept [0..1]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 fieldamount : Quantity [0..1]RepresentationThe type of structure (e.g. Full, Partial, Representative)type : CodeableConcept [0..1]The structural representation as text string in a standard format e.g. InChI, SMILES, MOLFILE, CDX, SDF, PDB, mmCIFrepresentation : string [0..1]The format of the representation e.g. InChI, SMILES, MOLFILE, CDX, SDF, PDB, mmCIFformat : CodeableConcept [0..1]An attached file with the structural representationattachment : Attachment [0..1]codeThe specific codecode : CodeableConcept [0..1]Status of the code assignment, for example 'provisional', 'approved'status : CodeableConcept [0..1]The date at which the code status is changed as part of the terminology maintenancestatusDate : dateTime [0..1]Any comment can be provided in this field, if necessarynote : Annotation [0..*]Supporting literaturesource : Reference [0..*] « DocumentReference »NameThe actual namename : string [1..1]Name type, for example 'systematic', 'scientific, 'brand'type : CodeableConcept [0..1]The status of the name, for example 'current', 'proposed'status : CodeableConcept [0..1]If this is the preferred name for this substancepreferred : boolean [0..1]Human language that the name is written inlanguage : CodeableConcept [0..*]The use context of this name for example if there is a different name a drug active ingredient as opposed to a food colour additivedomain : CodeableConcept [0..*]The jurisdiction where this name appliesjurisdiction : CodeableConcept [0..*]Supporting literaturesource : Reference [0..*] « DocumentReference »OfficialWhich authority uses this official nameauthority : CodeableConcept [0..1]The status of the official name, for example 'provisional', 'approved'status : CodeableConcept [0..1]Date of official name changedate : dateTime [0..1]RelationshipA pointer to another substance, as a resource or just a representational codesubstanceDefinition[x] : DataType [0..1] « Reference( SubstanceDefinition)|CodeableConcept »For example "salt to parent", "active moiety", "starting material", "polymorph"type : CodeableConcept [0..1]For example where an enzyme strongly bonds with a particular substance, this is a defining relationship for that enzyme, out of several possible substance relationshipsisDefining : boolean [0..1]A numeric factor for the relationship, for instance to express that the salt of a substance has some percentage of the active substance in relation to some otheramount[x] : DataType [0..1] « Quantity|Range|Ratio|string »For use when the numeric has an uncertain rangeamountRatioHighLimit : Ratio [0..1]An operator for the amount, for example "average", "approximately", "less than"amountType : CodeableConcept [0..1]Supporting literaturesource : Reference [0..*] « DocumentReference »Moiety, for structural modificationsmoiety[0..*]General specifications for this substance, including how it is related to other substancesproperty[0..*]The molecular weight or weight range (for proteins, polymers or nucleic acids)molecularWeight[0..1]Applicable for single substances that contain a radionuclide or a non-natural isotopic ratioisotope[0..*]The molecular weight or weight range (for proteins, polymers or nucleic acids)molecularWeight[0..1]Molecular structural representationrepresentation[0..*]Structural informationstructure[0..1]Codes associated with the substancecode[0..*]A synonym of this particular name, by which the substance is also knownsynonym[0..*]A translation for this name into another human languagetranslation[0..*]Details of the official nature of this nameofficial[0..*]Names applicable to this substancename[0..*]The molecular weight or weight range (for proteins, polymers or nucleic acids)molecularWeight[0..*]A link between this substance and another, with details of the relationshiprelationship[0..*]

XML Template

<SubstanceDefinition xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <identifier><!-- 0..1 Identifier Identifier by which this substance is known --></identifier>
 <version value="[string]"/><!-- 0..1 A business level identifier of the substance -->
 <status><!-- 0..1 CodeableConcept Status of substance within the catalogue e.g. approved --></status>
 <category><!-- 0..1 CodeableConcept High level categorization, e.g. polymer or nucleic acid, or food, chemical, biological --></category>
 <domain><!-- 0..1 CodeableConcept If the substance applies to only human or veterinary use --></domain>
 <description value="[markdown]"/><!-- 0..1 Textual description of the substance -->
 <source><!-- 0..* Reference(DocumentReference) Supporting literature --></source>
 <note><!-- 0..* Annotation Textual comment about this record of a substance --></note>
 <manufacturer><!-- 0..* Reference(Organization) A company that makes this substance --></manufacturer>
 <supplier><!-- 0..* Reference(Organization) A company that supplies this substance --></supplier>
 <moiety>  <!-- 0..* Moiety, for structural modifications -->
  <role><!-- 0..1 CodeableConcept Role that the moiety is playing --></role>
  <identifier><!-- 0..1 Identifier Identifier by which this moiety substance is known --></identifier>
  <name value="[string]"/><!-- 0..1 Textual name for this moiety substance -->
  <stereochemistry><!-- 0..1 CodeableConcept Stereochemistry type --></stereochemistry>
  <opticalActivity><!-- 0..1 CodeableConcept Optical activity type --></opticalActivity>
  <molecularFormula value="[string]"/><!-- 0..1 Molecular formula for this moiety of this substance, typically using the Hill system -->
  <amount[x]><!-- 0..1 Quantity|string Quantitative value for this moiety --></amount[x]>
  <amountType><!-- 0..1 CodeableConcept The measurement type of the quantitative value --></amountType>
 </moiety>
 <property>  <!-- 0..* General specifications for this substance, including how it is related to other substances -->
  <category><!-- 0..1 CodeableConcept A category for this property, e.g. Physical, Chemical, Enzymatic --></category>
  <code><!-- 0..1 CodeableConcept Property type e.g. viscosity, pH, isoelectric point --></code>
  <parameters value="[string]"/><!-- 0..1 Parameters that were used in the measurement of a property (e.g. for viscosity: measured at 20C with a pH of 7.1) -->
  <definingSubstance[x]><!-- 0..1 Reference(Substance|SubstanceDefinition)|
    CodeableConcept A substance upon which a defining property depends (e.g. for solubility: in water, in alcohol) --></definingSubstance[x]>
  <amount[x]><!-- 0..1 Quantity|string Quantitative value for this property --></amount[x]>
  <referenceRange><!-- 0..1 Range Range of typical values --></referenceRange>
  <source><!-- 0..* Reference(DocumentReference) Supporting literature --></source>
 </property>
 <referenceInformation><!-- 0..1 Reference(SubstanceReferenceInformation) General information detailing this substance --></referenceInformation>
 <structure>  <!-- 0..1 Structural information -->
  <stereochemistry><!-- 0..1 CodeableConcept Stereochemistry type --></stereochemistry>
  <opticalActivity><!-- 0..1 CodeableConcept Optical activity type --></opticalActivity>
  <molecularFormula value="[string]"/><!-- 0..1 Molecular formula of this substance, typically using the Hill system -->
  <molecularFormulaByMoiety value="[string]"/><!-- 0..1 Specified per moiety according to the Hill system, i.e. first C, then H, then alphabetical, each moiety separated by a dot -->
  <isotope>  <!-- 0..* Applicable for single substances that contain a radionuclide or a non-natural isotopic ratio -->
   <identifier><!-- 0..1 Identifier Substance identifier for each non-natural or radioisotope --></identifier>
   <name><!-- 0..1 CodeableConcept Substance name for each non-natural or radioisotope --></name>
   <substitution><!-- 0..1 CodeableConcept The type of isotopic substitution present in a single substance --></substitution>
   <halfLife><!-- 0..1 Quantity Half life - for a non-natural nuclide --></halfLife>
   <molecularWeight>  <!-- 0..1 The molecular weight or weight range (for proteins, polymers or nucleic acids) -->
    <method><!-- 0..1 CodeableConcept The method by which the molecular weight was determined --></method>
    <type><!-- 0..1 CodeableConcept Type of molecular weight such as exact, average (also known as. number average), weight average --></type>
    <amount><!-- 0..1 Quantity 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 --></amount>
   </molecularWeight>
  </isotope>
  <molecularWeight><!-- 0..1 Content as for SubstanceDefinition.structure.isotope.molecularWeight The molecular weight or weight range (for proteins, polymers or nucleic acids) --></molecularWeight>
  <technique><!-- 0..* CodeableConcept The method used to elucidate the structure or characterization of the drug substance. Examples: X-ray, HPLC, NMR, Peptide mapping, Ligand binding assay --></technique>
  <sourceDocument><!-- 0..* Reference(DocumentReference) Supporting literature about the source of information --></sourceDocument>
  <representation>  <!-- 0..* Molecular structural representation -->
   <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>
  </representation>
 </structure>
 <code>  <!-- 0..* Codes associated with the substance -->
  <code><!-- 0..1 CodeableConcept The specific code --></code>
  <status><!-- 0..1 CodeableConcept Status of the code assignment, for example 'provisional', 'approved' --></status>
  <statusDate value="[dateTime]"/><!-- 0..1 The date at which the code status is changed as part of the terminology maintenance -->
  <note><!-- 0..* Annotation Any comment can be provided in this field, if necessary --></note>
  <source><!-- 0..* Reference(DocumentReference) Supporting literature --></source>
 </code>
 <name>  <!-- 0..* Names applicable to this substance -->
  <name value="[string]"/><!-- 1..1 The actual name -->
  <type><!-- 0..1 CodeableConcept Name type, for example 'systematic',  'scientific, 'brand' --></type>
  <status><!-- 0..1 CodeableConcept The status of the name, for example 'current', 'proposed' --></status>
  <preferred value="[boolean]"/><!-- 0..1 If this is the preferred name for this substance -->
  <language><!-- 0..* CodeableConcept Human language that the name is written in --></language>
  <domain><!-- 0..* CodeableConcept The use context of this name for example if there is a different name a drug active ingredient as opposed to a food colour additive --></domain>
  <jurisdiction><!-- 0..* CodeableConcept The jurisdiction where this name applies --></jurisdiction>
  <synonym><!-- 0..* Content as for SubstanceDefinition.name A synonym of this particular name, by which the substance is also known --></synonym>
  <translation><!-- 0..* Content as for SubstanceDefinition.name A translation for this name into another human language --></translation>
  <official>  <!-- 0..* Details of the official nature of this name -->
   <authority><!-- 0..1 CodeableConcept Which authority uses this official name --></authority>
   <status><!-- 0..1 CodeableConcept The status of the official name, for example 'provisional', 'approved' --></status>
   <date value="[dateTime]"/><!-- 0..1 Date of official name change -->
  </official>
  <source><!-- 0..* Reference(DocumentReference) Supporting literature --></source>
 </name>
 <molecularWeight><!-- 0..* Content as for SubstanceDefinition.structure.isotope.molecularWeight The molecular weight or weight range (for proteins, polymers or nucleic acids) --></molecularWeight>
 <relationship>  <!-- 0..* A link between this substance and another, with details of the relationship -->
  <substanceDefinition[x]><!-- 0..1 Reference(SubstanceDefinition)|
    CodeableConcept A pointer to another substance, as a resource or just a representational code --></substanceDefinition[x]>
  <type><!-- 0..1 CodeableConcept For example "salt to parent", "active moiety", "starting material", "polymorph" --></type>
  <isDefining value="[boolean]"/><!-- 0..1 For example where an enzyme strongly bonds with a particular substance, this is a defining relationship for that enzyme, out of several possible substance relationships -->
  <amount[x]><!-- 0..1 Quantity|Range|Ratio|string A numeric factor for the relationship, for instance to express that the salt of a substance has some percentage of the active substance in relation to some other --></amount[x]>
  <amountRatioHighLimit><!-- 0..1 Ratio For use when the numeric has an uncertain range --></amountRatioHighLimit>
  <amountType><!-- 0..1 CodeableConcept An operator for the amount, for example "average", "approximately", "less than" --></amountType>
  <source><!-- 0..* Reference(DocumentReference) Supporting literature --></source>
 </relationship>
 <nucleicAcid><!-- 0..1 Reference(SubstanceNucleicAcid) Data items specific to nucleic acids --></nucleicAcid>
 <polymer><!-- 0..1 Reference(SubstancePolymer) Data items specific to polymers --></polymer>
 <protein><!-- 0..1 Reference(SubstanceProtein) Data items specific to proteins --></protein>
 <sourceMaterial><!-- 0..1 Reference(SubstanceSourceMaterial) Material or taxonomic/anatomical source for the substance --></sourceMaterial>
</SubstanceDefinition>

JSON Template

{doco
  "resourceType" : "SubstanceDefinition",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : { Identifier }, // Identifier by which this substance is known
  "version" : "<string>", // A business level identifier of the substance
  "status" : { CodeableConcept }, // Status of substance within the catalogue e.g. approved
  "category" : { CodeableConcept }, // High level categorization, e.g. polymer or nucleic acid, or food, chemical, biological
  "domain" : { CodeableConcept }, // If the substance applies to only human or veterinary use
  "description" : "<markdown>", // Textual description of the substance
  "source" : [{ Reference(DocumentReference) }], // Supporting literature
  "note" : [{ Annotation }], // Textual comment about this record of a substance
  "manufacturer" : [{ Reference(Organization) }], // A company that makes this substance
  "supplier" : [{ Reference(Organization) }], // A company that supplies this substance
  "moiety" : [{ // Moiety, for structural modifications
    "role" : { CodeableConcept }, // Role that the moiety is playing
    "identifier" : { Identifier }, // Identifier by which this moiety substance is known
    "name" : "<string>", // Textual name for this moiety substance
    "stereochemistry" : { CodeableConcept }, // Stereochemistry type
    "opticalActivity" : { CodeableConcept }, // Optical activity type
    "molecularFormula" : "<string>", // Molecular formula for this moiety of this substance, typically using the Hill system
    // amount[x]: Quantitative value for this moiety. One of these 2:
    "amountQuantity" : { Quantity },
    "amountString" : "<string>",
    "amountType" : { CodeableConcept } // The measurement type of the quantitative value
  }],
  "property" : [{ // General specifications for this substance, including how it is related to other substances
    "category" : { CodeableConcept }, // A category for this property, e.g. Physical, Chemical, Enzymatic
    "code" : { CodeableConcept }, // Property type e.g. viscosity, pH, isoelectric point
    "parameters" : "<string>", // Parameters that were used in the measurement of a property (e.g. for viscosity: measured at 20C with a pH of 7.1)
    // definingSubstance[x]: 
      A substance upon which a defining property depends (e.g. for solubility: in water, in alcohol). One of these 2:
    "definingSubstanceReference" : { Reference(Substance|SubstanceDefinition) },
    "definingSubstanceCodeableConcept" : { CodeableConcept },
    // amount[x]: Quantitative value for this property. One of these 2:
    "amountQuantity" : { Quantity },
    "amountString" : "<string>",
    "referenceRange" : { Range }, // Range of typical values
    "source" : [{ Reference(DocumentReference) }] // Supporting literature
  }],
  "referenceInformation" : { Reference(SubstanceReferenceInformation) }, // General information detailing this substance
  "structure" : { // Structural information
    "stereochemistry" : { CodeableConcept }, // Stereochemistry type
    "opticalActivity" : { CodeableConcept }, // Optical activity type
    "molecularFormula" : "<string>", // Molecular formula of this substance, typically using the Hill system
    "molecularFormulaByMoiety" : "<string>", // Specified per moiety according to the Hill system, i.e. first C, then H, then alphabetical, each moiety separated by a dot
    "isotope" : [{ // Applicable for single substances that contain a radionuclide or a non-natural isotopic ratio
      "identifier" : { Identifier }, // Substance identifier for each non-natural or radioisotope
      "name" : { CodeableConcept }, // Substance name for each non-natural or radioisotope
      "substitution" : { CodeableConcept }, // The type of isotopic substitution present in a single substance
      "halfLife" : { Quantity }, // Half life - for a non-natural nuclide
      "molecularWeight" : { // The molecular weight or weight range (for proteins, polymers or nucleic acids)
        "method" : { CodeableConcept }, // The method by which the molecular weight was determined
        "type" : { CodeableConcept }, // Type of molecular weight such as exact, average (also known as. number average), weight average
        "amount" : { Quantity } // 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
      }
    }],
    "molecularWeight" : { Content as for SubstanceDefinition.structure.isotope.molecularWeight }, // The molecular weight or weight range (for proteins, polymers or nucleic acids)
    "technique" : [{ CodeableConcept }], // The method used to elucidate the structure or characterization of the drug substance. Examples: X-ray, HPLC, NMR, Peptide mapping, Ligand binding assay
    "sourceDocument" : [{ Reference(DocumentReference) }], // Supporting literature about the source of information
    "representation" : [{ // Molecular structural representation
      "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
    }]
  },
  "code" : [{ // Codes associated with the substance
    "code" : { CodeableConcept }, // The specific code
    "status" : { CodeableConcept }, // Status of the code assignment, for example 'provisional', 'approved'
    "statusDate" : "<dateTime>", // The date at which the code status is changed as part of the terminology maintenance
    "note" : [{ Annotation }], // Any comment can be provided in this field, if necessary
    "source" : [{ Reference(DocumentReference) }] // Supporting literature
  }],
  "name" : [{ // Names applicable to this substance
    "name" : "<string>", // R!  The actual name
    "type" : { CodeableConcept }, // Name type, for example 'systematic',  'scientific, 'brand'
    "status" : { CodeableConcept }, // The status of the name, for example 'current', 'proposed'
    "preferred" : <boolean>, // If this is the preferred name for this substance
    "language" : [{ CodeableConcept }], // Human language that the name is written in
    "domain" : [{ CodeableConcept }], // The use context of this name for example if there is a different name a drug active ingredient as opposed to a food colour additive
    "jurisdiction" : [{ CodeableConcept }], // The jurisdiction where this name applies
    "synonym" : [{ Content as for SubstanceDefinition.name }], // A synonym of this particular name, by which the substance is also known
    "translation" : [{ Content as for SubstanceDefinition.name }], // A translation for this name into another human language
    "official" : [{ // Details of the official nature of this name
      "authority" : { CodeableConcept }, // Which authority uses this official name
      "status" : { CodeableConcept }, // The status of the official name, for example 'provisional', 'approved'
      "date" : "<dateTime>" // Date of official name change
    }],
    "source" : [{ Reference(DocumentReference) }] // Supporting literature
  }],
  "molecularWeight" : [{ Content as for SubstanceDefinition.structure.isotope.molecularWeight }], // The molecular weight or weight range (for proteins, polymers or nucleic acids)
  "relationship" : [{ // A link between this substance and another, with details of the relationship
    // substanceDefinition[x]: 
      A pointer to another substance, as a resource or just a representational code. One of these 2:
    "substanceDefinitionReference" : { Reference(SubstanceDefinition) },
    "substanceDefinitionCodeableConcept" : { CodeableConcept },
    "type" : { CodeableConcept }, // For example "salt to parent", "active moiety", "starting material", "polymorph"
    "isDefining" : <boolean>, // For example where an enzyme strongly bonds with a particular substance, this is a defining relationship for that enzyme, out of several possible substance relationships
    // amount[x]: 
      A numeric factor for the relationship, for instance to express that the salt of a substance has some percentage of the active substance in relation to some other. One of these 4:
    "amountQuantity" : { Quantity },
    "amountRange" : { Range },
    "amountRatio" : { Ratio },
    "amountString" : "<string>",
    "amountRatioHighLimit" : { Ratio }, // For use when the numeric has an uncertain range
    "amountType" : { CodeableConcept }, // An operator for the amount, for example "average", "approximately", "less than"
    "source" : [{ Reference(DocumentReference) }] // Supporting literature
  }],
  "nucleicAcid" : { Reference(SubstanceNucleicAcid) }, // Data items specific to nucleic acids
  "polymer" : { Reference(SubstancePolymer) }, // Data items specific to polymers
  "protein" : { Reference(SubstanceProtein) }, // Data items specific to proteins
  "sourceMaterial" : { Reference(SubstanceSourceMaterial) } // Material or taxonomic/anatomical source for the substance
}

Turtle Template

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


[ a fhir:SubstanceDefinition;
  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:SubstanceDefinition.identifier [ Identifier ]; # 0..1 Identifier by which this substance is known
  fhir:SubstanceDefinition.version [ string ]; # 0..1 A business level identifier of the substance
  fhir:SubstanceDefinition.status [ CodeableConcept ]; # 0..1 Status of substance within the catalogue e.g. approved
  fhir:SubstanceDefinition.category [ CodeableConcept ]; # 0..1 High level categorization, e.g. polymer or nucleic acid, or food, chemical, biological
  fhir:SubstanceDefinition.domain [ CodeableConcept ]; # 0..1 If the substance applies to only human or veterinary use
  fhir:SubstanceDefinition.description [ markdown ]; # 0..1 Textual description of the substance
  fhir:SubstanceDefinition.source [ Reference(DocumentReference) ], ... ; # 0..* Supporting literature
  fhir:SubstanceDefinition.note [ Annotation ], ... ; # 0..* Textual comment about this record of a substance
  fhir:SubstanceDefinition.manufacturer [ Reference(Organization) ], ... ; # 0..* A company that makes this substance
  fhir:SubstanceDefinition.supplier [ Reference(Organization) ], ... ; # 0..* A company that supplies this substance
  fhir:SubstanceDefinition.moiety [ # 0..* Moiety, for structural modifications
    fhir:SubstanceDefinition.moiety.role [ CodeableConcept ]; # 0..1 Role that the moiety is playing
    fhir:SubstanceDefinition.moiety.identifier [ Identifier ]; # 0..1 Identifier by which this moiety substance is known
    fhir:SubstanceDefinition.moiety.name [ string ]; # 0..1 Textual name for this moiety substance
    fhir:SubstanceDefinition.moiety.stereochemistry [ CodeableConcept ]; # 0..1 Stereochemistry type
    fhir:SubstanceDefinition.moiety.opticalActivity [ CodeableConcept ]; # 0..1 Optical activity type
    fhir:SubstanceDefinition.moiety.molecularFormula [ string ]; # 0..1 Molecular formula for this moiety of this substance, typically using the Hill system
    # SubstanceDefinition.moiety.amount[x] : 0..1 Quantitative value for this moiety. One of these 2
      fhir:SubstanceDefinition.moiety.amountQuantity [ Quantity ]
      fhir:SubstanceDefinition.moiety.amountString [ string ]
    fhir:SubstanceDefinition.moiety.amountType [ CodeableConcept ]; # 0..1 The measurement type of the quantitative value
  ], ...;
  fhir:SubstanceDefinition.property [ # 0..* General specifications for this substance, including how it is related to other substances
    fhir:SubstanceDefinition.property.category [ CodeableConcept ]; # 0..1 A category for this property, e.g. Physical, Chemical, Enzymatic
    fhir:SubstanceDefinition.property.code [ CodeableConcept ]; # 0..1 Property type e.g. viscosity, pH, isoelectric point
    fhir:SubstanceDefinition.property.parameters [ string ]; # 0..1 Parameters that were used in the measurement of a property (e.g. for viscosity: measured at 20C with a pH of 7.1)
    # SubstanceDefinition.property.definingSubstance[x] : 0..1 A substance upon which a defining property depends (e.g. for solubility: in water, in alcohol). One of these 2
      fhir:SubstanceDefinition.property.definingSubstanceReference [ Reference(Substance|SubstanceDefinition) ]
      fhir:SubstanceDefinition.property.definingSubstanceCodeableConcept [ CodeableConcept ]
    # SubstanceDefinition.property.amount[x] : 0..1 Quantitative value for this property. One of these 2
      fhir:SubstanceDefinition.property.amountQuantity [ Quantity ]
      fhir:SubstanceDefinition.property.amountString [ string ]
    fhir:SubstanceDefinition.property.referenceRange [ Range ]; # 0..1 Range of typical values
    fhir:SubstanceDefinition.property.source [ Reference(DocumentReference) ], ... ; # 0..* Supporting literature
  ], ...;
  fhir:SubstanceDefinition.referenceInformation [ Reference(SubstanceReferenceInformation) ]; # 0..1 General information detailing this substance
  fhir:SubstanceDefinition.structure [ # 0..1 Structural information
    fhir:SubstanceDefinition.structure.stereochemistry [ CodeableConcept ]; # 0..1 Stereochemistry type
    fhir:SubstanceDefinition.structure.opticalActivity [ CodeableConcept ]; # 0..1 Optical activity type
    fhir:SubstanceDefinition.structure.molecularFormula [ string ]; # 0..1 Molecular formula of this substance, typically using the Hill system
    fhir:SubstanceDefinition.structure.molecularFormulaByMoiety [ string ]; # 0..1 Specified per moiety according to the Hill system, i.e. first C, then H, then alphabetical, each moiety separated by a dot
    fhir:SubstanceDefinition.structure.isotope [ # 0..* Applicable for single substances that contain a radionuclide or a non-natural isotopic ratio
      fhir:SubstanceDefinition.structure.isotope.identifier [ Identifier ]; # 0..1 Substance identifier for each non-natural or radioisotope
      fhir:SubstanceDefinition.structure.isotope.name [ CodeableConcept ]; # 0..1 Substance name for each non-natural or radioisotope
      fhir:SubstanceDefinition.structure.isotope.substitution [ CodeableConcept ]; # 0..1 The type of isotopic substitution present in a single substance
      fhir:SubstanceDefinition.structure.isotope.halfLife [ Quantity ]; # 0..1 Half life - for a non-natural nuclide
      fhir:SubstanceDefinition.structure.isotope.molecularWeight [ # 0..1 The molecular weight or weight range (for proteins, polymers or nucleic acids)
        fhir:SubstanceDefinition.structure.isotope.molecularWeight.method [ CodeableConcept ]; # 0..1 The method by which the molecular weight was determined
        fhir:SubstanceDefinition.structure.isotope.molecularWeight.type [ CodeableConcept ]; # 0..1 Type of molecular weight such as exact, average (also known as. number average), weight average
        fhir:SubstanceDefinition.structure.isotope.molecularWeight.amount [ Quantity ]; # 0..1 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
      ];
    ], ...;
    fhir:SubstanceDefinition.structure.molecularWeight [ See SubstanceDefinition.structure.isotope.molecularWeight ]; # 0..1 The molecular weight or weight range (for proteins, polymers or nucleic acids)
    fhir:SubstanceDefinition.structure.technique [ CodeableConcept ], ... ; # 0..* The method used to elucidate the structure or characterization of the drug substance. Examples: X-ray, HPLC, NMR, Peptide mapping, Ligand binding assay
    fhir:SubstanceDefinition.structure.sourceDocument [ Reference(DocumentReference) ], ... ; # 0..* Supporting literature about the source of information
    fhir:SubstanceDefinition.structure.representation [ # 0..* Molecular structural representation
      fhir:SubstanceDefinition.structure.representation.type [ CodeableConcept ]; # 0..1 The type of structure (e.g. Full, Partial, Representative)
      fhir:SubstanceDefinition.structure.representation.representation [ string ]; # 0..1 The structural representation as text string in a standard format e.g. InChI, SMILES, MOLFILE, CDX, SDF, PDB, mmCIF
      fhir:SubstanceDefinition.structure.representation.format [ CodeableConcept ]; # 0..1 The format of the representation e.g. InChI, SMILES, MOLFILE, CDX, SDF, PDB, mmCIF
      fhir:SubstanceDefinition.structure.representation.attachment [ Attachment ]; # 0..1 An attached file with the structural representation
    ], ...;
  ];
  fhir:SubstanceDefinition.code [ # 0..* Codes associated with the substance
    fhir:SubstanceDefinition.code.code [ CodeableConcept ]; # 0..1 The specific code
    fhir:SubstanceDefinition.code.status [ CodeableConcept ]; # 0..1 Status of the code assignment, for example 'provisional', 'approved'
    fhir:SubstanceDefinition.code.statusDate [ dateTime ]; # 0..1 The date at which the code status is changed as part of the terminology maintenance
    fhir:SubstanceDefinition.code.note [ Annotation ], ... ; # 0..* Any comment can be provided in this field, if necessary
    fhir:SubstanceDefinition.code.source [ Reference(DocumentReference) ], ... ; # 0..* Supporting literature
  ], ...;
  fhir:SubstanceDefinition.name [ # 0..* Names applicable to this substance
    fhir:SubstanceDefinition.name.name [ string ]; # 1..1 The actual name
    fhir:SubstanceDefinition.name.type [ CodeableConcept ]; # 0..1 Name type, for example 'systematic',  'scientific, 'brand'
    fhir:SubstanceDefinition.name.status [ CodeableConcept ]; # 0..1 The status of the name, for example 'current', 'proposed'
    fhir:SubstanceDefinition.name.preferred [ boolean ]; # 0..1 If this is the preferred name for this substance
    fhir:SubstanceDefinition.name.language [ CodeableConcept ], ... ; # 0..* Human language that the name is written in
    fhir:SubstanceDefinition.name.domain [ CodeableConcept ], ... ; # 0..* The use context of this name for example if there is a different name a drug active ingredient as opposed to a food colour additive
    fhir:SubstanceDefinition.name.jurisdiction [ CodeableConcept ], ... ; # 0..* The jurisdiction where this name applies
    fhir:SubstanceDefinition.name.synonym [ See SubstanceDefinition.name ], ... ; # 0..* A synonym of this particular name, by which the substance is also known
    fhir:SubstanceDefinition.name.translation [ See SubstanceDefinition.name ], ... ; # 0..* A translation for this name into another human language
    fhir:SubstanceDefinition.name.official [ # 0..* Details of the official nature of this name
      fhir:SubstanceDefinition.name.official.authority [ CodeableConcept ]; # 0..1 Which authority uses this official name
      fhir:SubstanceDefinition.name.official.status [ CodeableConcept ]; # 0..1 The status of the official name, for example 'provisional', 'approved'
      fhir:SubstanceDefinition.name.official.date [ dateTime ]; # 0..1 Date of official name change
    ], ...;
    fhir:SubstanceDefinition.name.source [ Reference(DocumentReference) ], ... ; # 0..* Supporting literature
  ], ...;
  fhir:SubstanceDefinition.molecularWeight [ See SubstanceDefinition.structure.isotope.molecularWeight ], ... ; # 0..* The molecular weight or weight range (for proteins, polymers or nucleic acids)
  fhir:SubstanceDefinition.relationship [ # 0..* A link between this substance and another, with details of the relationship
    # SubstanceDefinition.relationship.substanceDefinition[x] : 0..1 A pointer to another substance, as a resource or just a representational code. One of these 2
      fhir:SubstanceDefinition.relationship.substanceDefinitionReference [ Reference(SubstanceDefinition) ]
      fhir:SubstanceDefinition.relationship.substanceDefinitionCodeableConcept [ CodeableConcept ]
    fhir:SubstanceDefinition.relationship.type [ CodeableConcept ]; # 0..1 For example "salt to parent", "active moiety", "starting material", "polymorph"
    fhir:SubstanceDefinition.relationship.isDefining [ boolean ]; # 0..1 For example where an enzyme strongly bonds with a particular substance, this is a defining relationship for that enzyme, out of several possible substance relationships
    # SubstanceDefinition.relationship.amount[x] : 0..1 A numeric factor for the relationship, for instance to express that the salt of a substance has some percentage of the active substance in relation to some other. One of these 4
      fhir:SubstanceDefinition.relationship.amountQuantity [ Quantity ]
      fhir:SubstanceDefinition.relationship.amountRange [ Range ]
      fhir:SubstanceDefinition.relationship.amountRatio [ Ratio ]
      fhir:SubstanceDefinition.relationship.amountString [ string ]
    fhir:SubstanceDefinition.relationship.amountRatioHighLimit [ Ratio ]; # 0..1 For use when the numeric has an uncertain range
    fhir:SubstanceDefinition.relationship.amountType [ CodeableConcept ]; # 0..1 An operator for the amount, for example "average", "approximately", "less than"
    fhir:SubstanceDefinition.relationship.source [ Reference(DocumentReference) ], ... ; # 0..* Supporting literature
  ], ...;
  fhir:SubstanceDefinition.nucleicAcid [ Reference(SubstanceNucleicAcid) ]; # 0..1 Data items specific to nucleic acids
  fhir:SubstanceDefinition.polymer [ Reference(SubstancePolymer) ]; # 0..1 Data items specific to polymers
  fhir:SubstanceDefinition.protein [ Reference(SubstanceProtein) ]; # 0..1 Data items specific to proteins
  fhir:SubstanceDefinition.sourceMaterial [ Reference(SubstanceSourceMaterial) ]; # 0..1 Material or taxonomic/anatomical source for the substance
]

Changes since R3

This resource did not exist in Release 2

This analysis is available as XML or JSON.

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. SubstanceDefinition ΣTUDomainResourceThe detailed description of a substance, typically at a level beyond what is used for prescribing
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
... identifier Σ0..1IdentifierIdentifier by which this substance is known
... version Σ0..1stringA business level identifier of the substance
... status Σ0..1CodeableConceptStatus of substance within the catalogue e.g. approved
... domain Σ0..1CodeableConceptIf the substance applies to only human or veterinary use
... description Σ0..1markdownTextual description of the substance
... source Σ0..*Reference(DocumentReference)Supporting literature
... note Σ0..*AnnotationTextual comment about this record of a substance
... manufacturer Σ0..*Reference(Organization)A company that makes this substance
... supplier Σ0..*Reference(Organization)A company that supplies this substance
... moiety Σ0..*BackboneElementMoiety, for structural modifications
.... role Σ0..1CodeableConceptRole that the moiety is playing
.... identifier Σ0..1IdentifierIdentifier by which this moiety substance is known
.... name Σ0..1stringTextual name for this moiety substance
.... stereochemistry Σ0..1CodeableConceptStereochemistry type
.... opticalActivity Σ0..1CodeableConceptOptical activity type
.... molecularFormula Σ0..1stringMolecular formula for this moiety of this substance, typically using the Hill system
.... amount[x] Σ0..1Quantitative value for this moiety
..... amountQuantityQuantity
..... amountStringstring
.... amountType Σ0..1CodeableConceptThe measurement type of the quantitative value
... property Σ0..*BackboneElementGeneral specifications for this substance, including how it is related to other substances
.... category Σ0..1CodeableConceptA category for this property, e.g. Physical, Chemical, Enzymatic
.... code Σ0..1CodeableConceptProperty type e.g. viscosity, pH, isoelectric point
.... parameters Σ0..1stringParameters that were used in the measurement of a property (e.g. for viscosity: measured at 20C with a pH of 7.1)
.... definingSubstance[x] Σ0..1A substance upon which a defining property depends (e.g. for solubility: in water, in alcohol)
..... definingSubstanceReferenceReference(SubstanceDefinition | Substance)
..... definingSubstanceCodeableConceptCodeableConcept
.... amount[x] Σ0..1Quantitative value for this property
..... amountQuantityQuantity
..... amountStringstring
.... referenceRange Σ0..1RangeRange of typical values
.... source Σ0..*Reference(DocumentReference)Supporting literature
... referenceInformation Σ0..1Reference(SubstanceReferenceInformation)General information detailing this substance
... structure Σ0..1BackboneElementStructural information
.... stereochemistry Σ0..1CodeableConceptStereochemistry type
.... opticalActivity Σ0..1CodeableConceptOptical activity type
.... molecularFormula Σ0..1stringMolecular formula of this substance, typically using the Hill system
.... molecularFormulaByMoiety Σ0..1stringSpecified per moiety according to the Hill system, i.e. first C, then H, then alphabetical, each moiety separated by a dot
.... isotope Σ0..*BackboneElementApplicable for single substances that contain a radionuclide or a non-natural isotopic ratio
..... identifier Σ0..1IdentifierSubstance identifier for each non-natural or radioisotope
..... name Σ0..1CodeableConceptSubstance name for each non-natural or radioisotope
..... substitution Σ0..1CodeableConceptThe type of isotopic substitution present in a single substance
..... halfLife Σ0..1QuantityHalf life - for a non-natural nuclide
..... molecularWeight Σ0..1BackboneElementThe molecular weight or weight range (for proteins, polymers or nucleic acids)
...... method Σ0..1CodeableConceptThe method by which the molecular weight was determined
...... type Σ0..1CodeableConceptType of molecular weight such as exact, average (also known as. number average), weight average
...... amount Σ0..1QuantityUsed 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
.... molecularWeight Σ0..1see molecularWeightThe molecular weight or weight range (for proteins, polymers or nucleic acids)
.... technique Σ0..*CodeableConceptThe method used to elucidate the structure or characterization of the drug substance. Examples: X-ray, HPLC, NMR, Peptide mapping, Ligand binding assay
.... sourceDocument Σ0..*Reference(DocumentReference)Supporting literature about the source of information
.... representation Σ0..*BackboneElementMolecular structural representation
..... type Σ0..1CodeableConceptThe type of structure (e.g. Full, Partial, Representative)
..... representation Σ0..1stringThe structural representation as text string in a standard format e.g. InChI, SMILES, MOLFILE, CDX, SDF, PDB, mmCIF
..... format Σ0..1CodeableConceptThe format of the representation e.g. InChI, SMILES, MOLFILE, CDX, SDF, PDB, mmCIF
..... attachment Σ0..1AttachmentAn attached file with the structural representation
... code Σ0..*BackboneElementCodes associated with the substance
.... code Σ0..1CodeableConceptThe specific code
.... status Σ0..1CodeableConceptStatus of the code assignment, for example 'provisional', 'approved'
.... statusDate Σ0..1dateTimeThe date at which the code status is changed as part of the terminology maintenance
.... note Σ0..*AnnotationAny comment can be provided in this field, if necessary
.... source Σ0..*Reference(DocumentReference)Supporting literature
... name Σ0..*BackboneElementNames applicable to this substance
.... name Σ1..1stringThe actual name
.... type Σ0..1CodeableConceptName type, for example 'systematic', 'scientific, 'brand'
.... status Σ0..1CodeableConceptThe status of the name, for example 'current', 'proposed'
.... preferred Σ0..1booleanIf this is the preferred name for this substance
.... language Σ0..*CodeableConceptHuman language that the name is written in
.... domain Σ0..*CodeableConceptThe use context of this name for example if there is a different name a drug active ingredient as opposed to a food colour additive
.... jurisdiction Σ0..*CodeableConceptThe jurisdiction where this name applies
.... synonym Σ0..*see nameA synonym of this particular name, by which the substance is also known
.... translation Σ0..*see nameA translation for this name into another human language
.... official Σ0..*BackboneElementDetails of the official nature of this name
..... authority Σ0..1CodeableConceptWhich authority uses this official name
..... status Σ0..1CodeableConceptThe status of the official name, for example 'provisional', 'approved'
..... date Σ0..1dateTimeDate of official name change
.... source Σ0..*Reference(DocumentReference)Supporting literature
... molecularWeight Σ0..*see molecularWeightThe molecular weight or weight range (for proteins, polymers or nucleic acids)
... relationship Σ0..*BackboneElementA link between this substance and another, with details of the relationship
.... substanceDefinition[x] Σ0..1A pointer to another substance, as a resource or just a representational code
..... substanceDefinitionReferenceReference(SubstanceDefinition)
..... substanceDefinitionCodeableConceptCodeableConcept
.... type Σ0..1CodeableConceptFor example "salt to parent", "active moiety", "starting material", "polymorph"
.... isDefining Σ0..1booleanFor example where an enzyme strongly bonds with a particular substance, this is a defining relationship for that enzyme, out of several possible substance relationships
.... amount[x] Σ0..1A numeric factor for the relationship, for instance to express that the salt of a substance has some percentage of the active substance in relation to some other
..... amountQuantityQuantity
..... amountRangeRange
..... amountRatioRatio
..... amountStringstring
.... amountRatioHighLimit Σ0..1RatioFor use when the numeric has an uncertain range
.... amountType Σ0..1CodeableConceptAn operator for the amount, for example "average", "approximately", "less than"
.... source Σ0..*Reference(DocumentReference)Supporting literature
... nucleicAcid Σ0..1Reference(SubstanceNucleicAcid)Data items specific to nucleic acids
... polymer Σ0..1Reference(SubstancePolymer)Data items specific to polymers
... protein Σ0..1Reference(SubstanceProtein)Data items specific to proteins
... sourceMaterial Σ0..1Reference(SubstanceSourceMaterial)Material or taxonomic/anatomical source for the substance

doco Documentation for this format

UML Diagram (Legend)

SubstanceDefinition (DomainResource)Identifier by which this substance is knownidentifier : Identifier [0..1]A business level identifier of the substanceversion : string [0..1]Status of substance within the catalogue e.g. approvedstatus : CodeableConcept [0..1]High level categorization, e.g. polymer or nucleic acid, or food, chemical, biologicalcategory : CodeableConcept [0..1]If the substance applies to only human or veterinary usedomain : CodeableConcept [0..1]Textual description of the substancedescription : markdown [0..1]Supporting literaturesource : Reference [0..*] « DocumentReference »Textual comment about this record of a substancenote : Annotation [0..*]A company that makes this substancemanufacturer : Reference [0..*] « Organization »A company that supplies this substancesupplier : Reference [0..*] « Organization »General information detailing this substancereferenceInformation : Reference [0..1] « SubstanceReferenceInformation »Data items specific to nucleic acidsnucleicAcid : Reference [0..1] « SubstanceNucleicAcid »Data items specific to polymerspolymer : Reference [0..1] « SubstancePolymer »Data items specific to proteinsprotein : Reference [0..1] « SubstanceProtein »Material or taxonomic/anatomical source for the substancesourceMaterial : Reference [0..1] « SubstanceSourceMaterial »MoietyRole that the moiety is playingrole : CodeableConcept [0..1]Identifier by which this moiety substance is knownidentifier : Identifier [0..1]Textual name for this moiety substancename : string [0..1]Stereochemistry typestereochemistry : CodeableConcept [0..1]Optical activity typeopticalActivity : CodeableConcept [0..1]Molecular formula for this moiety of this substance, typically using the Hill systemmolecularFormula : string [0..1]Quantitative value for this moietyamount[x] : DataType [0..1] « Quantity|string »The measurement type of the quantitative valueamountType : CodeableConcept [0..1]PropertyA category for this property, e.g. Physical, Chemical, Enzymaticcategory : CodeableConcept [0..1]Property type e.g. viscosity, pH, isoelectric pointcode : CodeableConcept [0..1]Parameters that were used in the measurement of a property (e.g. for viscosity: measured at 20C with a pH of 7.1)parameters : string [0..1]A substance upon which a defining property depends (e.g. for solubility: in water, in alcohol)definingSubstance[x] : DataType [0..1] « Reference( SubstanceDefinition|Substance)|CodeableConcept »Quantitative value for this propertyamount[x] : DataType [0..1] « Quantity|string »Range of typical valuesreferenceRange : Range [0..1]Supporting literaturesource : Reference [0..*] « DocumentReference »StructureStereochemistry typestereochemistry : CodeableConcept [0..1]Optical activity typeopticalActivity : CodeableConcept [0..1]Molecular formula of this substance, typically using the Hill systemmolecularFormula : string [0..1]Specified per moiety according to the Hill system, i.e. first C, then H, then alphabetical, each moiety separated by a dotmolecularFormulaByMoiety : string [0..1]The method used to elucidate the structure or characterization of the drug substance. Examples: X-ray, HPLC, NMR, Peptide mapping, Ligand binding assaytechnique : CodeableConcept [0..*]Supporting literature about the source of informationsourceDocument : Reference [0..*] « DocumentReference »IsotopeSubstance identifier for each non-natural or radioisotopeidentifier : Identifier [0..1]Substance name for each non-natural or radioisotopename : CodeableConcept [0..1]The type of isotopic substitution present in a single substancesubstitution : CodeableConcept [0..1]Half life - for a non-natural nuclidehalfLife : Quantity [0..1]MolecularWeightThe method by which the molecular weight was determinedmethod : CodeableConcept [0..1]Type of molecular weight such as exact, average (also known as. number average), weight averagetype : CodeableConcept [0..1]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 fieldamount : Quantity [0..1]RepresentationThe type of structure (e.g. Full, Partial, Representative)type : CodeableConcept [0..1]The structural representation as text string in a standard format e.g. InChI, SMILES, MOLFILE, CDX, SDF, PDB, mmCIFrepresentation : string [0..1]The format of the representation e.g. InChI, SMILES, MOLFILE, CDX, SDF, PDB, mmCIFformat : CodeableConcept [0..1]An attached file with the structural representationattachment : Attachment [0..1]codeThe specific codecode : CodeableConcept [0..1]Status of the code assignment, for example 'provisional', 'approved'status : CodeableConcept [0..1]The date at which the code status is changed as part of the terminology maintenancestatusDate : dateTime [0..1]Any comment can be provided in this field, if necessarynote : Annotation [0..*]Supporting literaturesource : Reference [0..*] « DocumentReference »NameThe actual namename : string [1..1]Name type, for example 'systematic', 'scientific, 'brand'type : CodeableConcept [0..1]The status of the name, for example 'current', 'proposed'status : CodeableConcept [0..1]If this is the preferred name for this substancepreferred : boolean [0..1]Human language that the name is written inlanguage : CodeableConcept [0..*]The use context of this name for example if there is a different name a drug active ingredient as opposed to a food colour additivedomain : CodeableConcept [0..*]The jurisdiction where this name appliesjurisdiction : CodeableConcept [0..*]Supporting literaturesource : Reference [0..*] « DocumentReference »OfficialWhich authority uses this official nameauthority : CodeableConcept [0..1]The status of the official name, for example 'provisional', 'approved'status : CodeableConcept [0..1]Date of official name changedate : dateTime [0..1]RelationshipA pointer to another substance, as a resource or just a representational codesubstanceDefinition[x] : DataType [0..1] « Reference( SubstanceDefinition)|CodeableConcept »For example "salt to parent", "active moiety", "starting material", "polymorph"type : CodeableConcept [0..1]For example where an enzyme strongly bonds with a particular substance, this is a defining relationship for that enzyme, out of several possible substance relationshipsisDefining : boolean [0..1]A numeric factor for the relationship, for instance to express that the salt of a substance has some percentage of the active substance in relation to some otheramount[x] : DataType [0..1] « Quantity|Range|Ratio|string »For use when the numeric has an uncertain rangeamountRatioHighLimit : Ratio [0..1]An operator for the amount, for example "average", "approximately", "less than"amountType : CodeableConcept [0..1]Supporting literaturesource : Reference [0..*] « DocumentReference »Moiety, for structural modificationsmoiety[0..*]General specifications for this substance, including how it is related to other substancesproperty[0..*]The molecular weight or weight range (for proteins, polymers or nucleic acids)molecularWeight[0..1]Applicable for single substances that contain a radionuclide or a non-natural isotopic ratioisotope[0..*]The molecular weight or weight range (for proteins, polymers or nucleic acids)molecularWeight[0..1]Molecular structural representationrepresentation[0..*]Structural informationstructure[0..1]Codes associated with the substancecode[0..*]A synonym of this particular name, by which the substance is also knownsynonym[0..*]A translation for this name into another human languagetranslation[0..*]Details of the official nature of this nameofficial[0..*]Names applicable to this substancename[0..*]The molecular weight or weight range (for proteins, polymers or nucleic acids)molecularWeight[0..*]A link between this substance and another, with details of the relationshiprelationship[0..*]

XML Template

<SubstanceDefinition xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <identifier><!-- 0..1 Identifier Identifier by which this substance is known --></identifier>
 <version value="[string]"/><!-- 0..1 A business level identifier of the substance -->
 <status><!-- 0..1 CodeableConcept Status of substance within the catalogue e.g. approved --></status>
 <category><!-- 0..1 CodeableConcept High level categorization, e.g. polymer or nucleic acid, or food, chemical, biological --></category>
 <domain><!-- 0..1 CodeableConcept If the substance applies to only human or veterinary use --></domain>
 <description value="[markdown]"/><!-- 0..1 Textual description of the substance -->
 <source><!-- 0..* Reference(DocumentReference) Supporting literature --></source>
 <note><!-- 0..* Annotation Textual comment about this record of a substance --></note>
 <manufacturer><!-- 0..* Reference(Organization) A company that makes this substance --></manufacturer>
 <supplier><!-- 0..* Reference(Organization) A company that supplies this substance --></supplier>
 <moiety>  <!-- 0..* Moiety, for structural modifications -->
  <role><!-- 0..1 CodeableConcept Role that the moiety is playing --></role>
  <identifier><!-- 0..1 Identifier Identifier by which this moiety substance is known --></identifier>
  <name value="[string]"/><!-- 0..1 Textual name for this moiety substance -->
  <stereochemistry><!-- 0..1 CodeableConcept Stereochemistry type --></stereochemistry>
  <opticalActivity><!-- 0..1 CodeableConcept Optical activity type --></opticalActivity>
  <molecularFormula value="[string]"/><!-- 0..1 Molecular formula for this moiety of this substance, typically using the Hill system -->
  <amount[x]><!-- 0..1 Quantity|string Quantitative value for this moiety --></amount[x]>
  <amountType><!-- 0..1 CodeableConcept The measurement type of the quantitative value --></amountType>
 </moiety>
 <property>  <!-- 0..* General specifications for this substance, including how it is related to other substances -->
  <category><!-- 0..1 CodeableConcept A category for this property, e.g. Physical, Chemical, Enzymatic --></category>
  <code><!-- 0..1 CodeableConcept Property type e.g. viscosity, pH, isoelectric point --></code>
  <parameters value="[string]"/><!-- 0..1 Parameters that were used in the measurement of a property (e.g. for viscosity: measured at 20C with a pH of 7.1) -->
  <definingSubstance[x]><!-- 0..1 Reference(Substance|SubstanceDefinition)|
    CodeableConcept A substance upon which a defining property depends (e.g. for solubility: in water, in alcohol) --></definingSubstance[x]>
  <amount[x]><!-- 0..1 Quantity|string Quantitative value for this property --></amount[x]>
  <referenceRange><!-- 0..1 Range Range of typical values --></referenceRange>
  <source><!-- 0..* Reference(DocumentReference) Supporting literature --></source>
 </property>
 <referenceInformation><!-- 0..1 Reference(SubstanceReferenceInformation) General information detailing this substance --></referenceInformation>
 <structure>  <!-- 0..1 Structural information -->
  <stereochemistry><!-- 0..1 CodeableConcept Stereochemistry type --></stereochemistry>
  <opticalActivity><!-- 0..1 CodeableConcept Optical activity type --></opticalActivity>
  <molecularFormula value="[string]"/><!-- 0..1 Molecular formula of this substance, typically using the Hill system -->
  <molecularFormulaByMoiety value="[string]"/><!-- 0..1 Specified per moiety according to the Hill system, i.e. first C, then H, then alphabetical, each moiety separated by a dot -->
  <isotope>  <!-- 0..* Applicable for single substances that contain a radionuclide or a non-natural isotopic ratio -->
   <identifier><!-- 0..1 Identifier Substance identifier for each non-natural or radioisotope --></identifier>
   <name><!-- 0..1 CodeableConcept Substance name for each non-natural or radioisotope --></name>
   <substitution><!-- 0..1 CodeableConcept The type of isotopic substitution present in a single substance --></substitution>
   <halfLife><!-- 0..1 Quantity Half life - for a non-natural nuclide --></halfLife>
   <molecularWeight>  <!-- 0..1 The molecular weight or weight range (for proteins, polymers or nucleic acids) -->
    <method><!-- 0..1 CodeableConcept The method by which the molecular weight was determined --></method>
    <type><!-- 0..1 CodeableConcept Type of molecular weight such as exact, average (also known as. number average), weight average --></type>
    <amount><!-- 0..1 Quantity 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 --></amount>
   </molecularWeight>
  </isotope>
  <molecularWeight><!-- 0..1 Content as for SubstanceDefinition.structure.isotope.molecularWeight The molecular weight or weight range (for proteins, polymers or nucleic acids) --></molecularWeight>
  <technique><!-- 0..* CodeableConcept The method used to elucidate the structure or characterization of the drug substance. Examples: X-ray, HPLC, NMR, Peptide mapping, Ligand binding assay --></technique>
  <sourceDocument><!-- 0..* Reference(DocumentReference) Supporting literature about the source of information --></sourceDocument>
  <representation>  <!-- 0..* Molecular structural representation -->
   <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>
  </representation>
 </structure>
 <code>  <!-- 0..* Codes associated with the substance -->
  <code><!-- 0..1 CodeableConcept The specific code --></code>
  <status><!-- 0..1 CodeableConcept Status of the code assignment, for example 'provisional', 'approved' --></status>
  <statusDate value="[dateTime]"/><!-- 0..1 The date at which the code status is changed as part of the terminology maintenance -->
  <note><!-- 0..* Annotation Any comment can be provided in this field, if necessary --></note>
  <source><!-- 0..* Reference(DocumentReference) Supporting literature --></source>
 </code>
 <name>  <!-- 0..* Names applicable to this substance -->
  <name value="[string]"/><!-- 1..1 The actual name -->
  <type><!-- 0..1 CodeableConcept Name type, for example 'systematic',  'scientific, 'brand' --></type>
  <status><!-- 0..1 CodeableConcept The status of the name, for example 'current', 'proposed' --></status>
  <preferred value="[boolean]"/><!-- 0..1 If this is the preferred name for this substance -->
  <language><!-- 0..* CodeableConcept Human language that the name is written in --></language>
  <domain><!-- 0..* CodeableConcept The use context of this name for example if there is a different name a drug active ingredient as opposed to a food colour additive --></domain>
  <jurisdiction><!-- 0..* CodeableConcept The jurisdiction where this name applies --></jurisdiction>
  <synonym><!-- 0..* Content as for SubstanceDefinition.name A synonym of this particular name, by which the substance is also known --></synonym>
  <translation><!-- 0..* Content as for SubstanceDefinition.name A translation for this name into another human language --></translation>
  <official>  <!-- 0..* Details of the official nature of this name -->
   <authority><!-- 0..1 CodeableConcept Which authority uses this official name --></authority>
   <status><!-- 0..1 CodeableConcept The status of the official name, for example 'provisional', 'approved' --></status>
   <date value="[dateTime]"/><!-- 0..1 Date of official name change -->
  </official>
  <source><!-- 0..* Reference(DocumentReference) Supporting literature --></source>
 </name>
 <molecularWeight><!-- 0..* Content as for SubstanceDefinition.structure.isotope.molecularWeight The molecular weight or weight range (for proteins, polymers or nucleic acids) --></molecularWeight>
 <relationship>  <!-- 0..* A link between this substance and another, with details of the relationship -->
  <substanceDefinition[x]><!-- 0..1 Reference(SubstanceDefinition)|
    CodeableConcept A pointer to another substance, as a resource or just a representational code --></substanceDefinition[x]>
  <type><!-- 0..1 CodeableConcept For example "salt to parent", "active moiety", "starting material", "polymorph" --></type>
  <isDefining value="[boolean]"/><!-- 0..1 For example where an enzyme strongly bonds with a particular substance, this is a defining relationship for that enzyme, out of several possible substance relationships -->
  <amount[x]><!-- 0..1 Quantity|Range|Ratio|string A numeric factor for the relationship, for instance to express that the salt of a substance has some percentage of the active substance in relation to some other --></amount[x]>
  <amountRatioHighLimit><!-- 0..1 Ratio For use when the numeric has an uncertain range --></amountRatioHighLimit>
  <amountType><!-- 0..1 CodeableConcept An operator for the amount, for example "average", "approximately", "less than" --></amountType>
  <source><!-- 0..* Reference(DocumentReference) Supporting literature --></source>
 </relationship>
 <nucleicAcid><!-- 0..1 Reference(SubstanceNucleicAcid) Data items specific to nucleic acids --></nucleicAcid>
 <polymer><!-- 0..1 Reference(SubstancePolymer) Data items specific to polymers --></polymer>
 <protein><!-- 0..1 Reference(SubstanceProtein) Data items specific to proteins --></protein>
 <sourceMaterial><!-- 0..1 Reference(SubstanceSourceMaterial) Material or taxonomic/anatomical source for the substance --></sourceMaterial>
</SubstanceDefinition>

JSON Template

{doco
  "resourceType" : "SubstanceDefinition",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : { Identifier }, // Identifier by which this substance is known
  "version" : "<string>", // A business level identifier of the substance
  "status" : { CodeableConcept }, // Status of substance within the catalogue e.g. approved
  "category" : { CodeableConcept }, // High level categorization, e.g. polymer or nucleic acid, or food, chemical, biological
  "domain" : { CodeableConcept }, // If the substance applies to only human or veterinary use
  "description" : "<markdown>", // Textual description of the substance
  "source" : [{ Reference(DocumentReference) }], // Supporting literature
  "note" : [{ Annotation }], // Textual comment about this record of a substance
  "manufacturer" : [{ Reference(Organization) }], // A company that makes this substance
  "supplier" : [{ Reference(Organization) }], // A company that supplies this substance
  "moiety" : [{ // Moiety, for structural modifications
    "role" : { CodeableConcept }, // Role that the moiety is playing
    "identifier" : { Identifier }, // Identifier by which this moiety substance is known
    "name" : "<string>", // Textual name for this moiety substance
    "stereochemistry" : { CodeableConcept }, // Stereochemistry type
    "opticalActivity" : { CodeableConcept }, // Optical activity type
    "molecularFormula" : "<string>", // Molecular formula for this moiety of this substance, typically using the Hill system
    // amount[x]: Quantitative value for this moiety. One of these 2:
    "amountQuantity" : { Quantity },
    "amountString" : "<string>",
    "amountType" : { CodeableConcept } // The measurement type of the quantitative value
  }],
  "property" : [{ // General specifications for this substance, including how it is related to other substances
    "category" : { CodeableConcept }, // A category for this property, e.g. Physical, Chemical, Enzymatic
    "code" : { CodeableConcept }, // Property type e.g. viscosity, pH, isoelectric point
    "parameters" : "<string>", // Parameters that were used in the measurement of a property (e.g. for viscosity: measured at 20C with a pH of 7.1)
    // definingSubstance[x]: 
      A substance upon which a defining property depends (e.g. for solubility: in water, in alcohol). One of these 2:
    "definingSubstanceReference" : { Reference(Substance|SubstanceDefinition) },
    "definingSubstanceCodeableConcept" : { CodeableConcept },
    // amount[x]: Quantitative value for this property. One of these 2:
    "amountQuantity" : { Quantity },
    "amountString" : "<string>",
    "referenceRange" : { Range }, // Range of typical values
    "source" : [{ Reference(DocumentReference) }] // Supporting literature
  }],
  "referenceInformation" : { Reference(SubstanceReferenceInformation) }, // General information detailing this substance
  "structure" : { // Structural information
    "stereochemistry" : { CodeableConcept }, // Stereochemistry type
    "opticalActivity" : { CodeableConcept }, // Optical activity type
    "molecularFormula" : "<string>", // Molecular formula of this substance, typically using the Hill system
    "molecularFormulaByMoiety" : "<string>", // Specified per moiety according to the Hill system, i.e. first C, then H, then alphabetical, each moiety separated by a dot
    "isotope" : [{ // Applicable for single substances that contain a radionuclide or a non-natural isotopic ratio
      "identifier" : { Identifier }, // Substance identifier for each non-natural or radioisotope
      "name" : { CodeableConcept }, // Substance name for each non-natural or radioisotope
      "substitution" : { CodeableConcept }, // The type of isotopic substitution present in a single substance
      "halfLife" : { Quantity }, // Half life - for a non-natural nuclide
      "molecularWeight" : { // The molecular weight or weight range (for proteins, polymers or nucleic acids)
        "method" : { CodeableConcept }, // The method by which the molecular weight was determined
        "type" : { CodeableConcept }, // Type of molecular weight such as exact, average (also known as. number average), weight average
        "amount" : { Quantity } // 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
      }
    }],
    "molecularWeight" : { Content as for SubstanceDefinition.structure.isotope.molecularWeight }, // The molecular weight or weight range (for proteins, polymers or nucleic acids)
    "technique" : [{ CodeableConcept }], // The method used to elucidate the structure or characterization of the drug substance. Examples: X-ray, HPLC, NMR, Peptide mapping, Ligand binding assay
    "sourceDocument" : [{ Reference(DocumentReference) }], // Supporting literature about the source of information
    "representation" : [{ // Molecular structural representation
      "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
    }]
  },
  "code" : [{ // Codes associated with the substance
    "code" : { CodeableConcept }, // The specific code
    "status" : { CodeableConcept }, // Status of the code assignment, for example 'provisional', 'approved'
    "statusDate" : "<dateTime>", // The date at which the code status is changed as part of the terminology maintenance
    "note" : [{ Annotation }], // Any comment can be provided in this field, if necessary
    "source" : [{ Reference(DocumentReference) }] // Supporting literature
  }],
  "name" : [{ // Names applicable to this substance
    "name" : "<string>", // R!  The actual name
    "type" : { CodeableConcept }, // Name type, for example 'systematic',  'scientific, 'brand'
    "status" : { CodeableConcept }, // The status of the name, for example 'current', 'proposed'
    "preferred" : <boolean>, // If this is the preferred name for this substance
    "language" : [{ CodeableConcept }], // Human language that the name is written in
    "domain" : [{ CodeableConcept }], // The use context of this name for example if there is a different name a drug active ingredient as opposed to a food colour additive
    "jurisdiction" : [{ CodeableConcept }], // The jurisdiction where this name applies
    "synonym" : [{ Content as for SubstanceDefinition.name }], // A synonym of this particular name, by which the substance is also known
    "translation" : [{ Content as for SubstanceDefinition.name }], // A translation for this name into another human language
    "official" : [{ // Details of the official nature of this name
      "authority" : { CodeableConcept }, // Which authority uses this official name
      "status" : { CodeableConcept }, // The status of the official name, for example 'provisional', 'approved'
      "date" : "<dateTime>" // Date of official name change
    }],
    "source" : [{ Reference(DocumentReference) }] // Supporting literature
  }],
  "molecularWeight" : [{ Content as for SubstanceDefinition.structure.isotope.molecularWeight }], // The molecular weight or weight range (for proteins, polymers or nucleic acids)
  "relationship" : [{ // A link between this substance and another, with details of the relationship
    // substanceDefinition[x]: 
      A pointer to another substance, as a resource or just a representational code. One of these 2:
    "substanceDefinitionReference" : { Reference(SubstanceDefinition) },
    "substanceDefinitionCodeableConcept" : { CodeableConcept },
    "type" : { CodeableConcept }, // For example "salt to parent", "active moiety", "starting material", "polymorph"
    "isDefining" : <boolean>, // For example where an enzyme strongly bonds with a particular substance, this is a defining relationship for that enzyme, out of several possible substance relationships
    // amount[x]: 
      A numeric factor for the relationship, for instance to express that the salt of a substance has some percentage of the active substance in relation to some other. One of these 4:
    "amountQuantity" : { Quantity },
    "amountRange" : { Range },
    "amountRatio" : { Ratio },
    "amountString" : "<string>",
    "amountRatioHighLimit" : { Ratio }, // For use when the numeric has an uncertain range
    "amountType" : { CodeableConcept }, // An operator for the amount, for example "average", "approximately", "less than"
    "source" : [{ Reference(DocumentReference) }] // Supporting literature
  }],
  "nucleicAcid" : { Reference(SubstanceNucleicAcid) }, // Data items specific to nucleic acids
  "polymer" : { Reference(SubstancePolymer) }, // Data items specific to polymers
  "protein" : { Reference(SubstanceProtein) }, // Data items specific to proteins
  "sourceMaterial" : { Reference(SubstanceSourceMaterial) } // Material or taxonomic/anatomical source for the substance
}

Turtle Template

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


[ a fhir:SubstanceDefinition;
  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:SubstanceDefinition.identifier [ Identifier ]; # 0..1 Identifier by which this substance is known
  fhir:SubstanceDefinition.version [ string ]; # 0..1 A business level identifier of the substance
  fhir:SubstanceDefinition.status [ CodeableConcept ]; # 0..1 Status of substance within the catalogue e.g. approved
  fhir:SubstanceDefinition.category [ CodeableConcept ]; # 0..1 High level categorization, e.g. polymer or nucleic acid, or food, chemical, biological
  fhir:SubstanceDefinition.domain [ CodeableConcept ]; # 0..1 If the substance applies to only human or veterinary use
  fhir:SubstanceDefinition.description [ markdown ]; # 0..1 Textual description of the substance
  fhir:SubstanceDefinition.source [ Reference(DocumentReference) ], ... ; # 0..* Supporting literature
  fhir:SubstanceDefinition.note [ Annotation ], ... ; # 0..* Textual comment about this record of a substance
  fhir:SubstanceDefinition.manufacturer [ Reference(Organization) ], ... ; # 0..* A company that makes this substance
  fhir:SubstanceDefinition.supplier [ Reference(Organization) ], ... ; # 0..* A company that supplies this substance
  fhir:SubstanceDefinition.moiety [ # 0..* Moiety, for structural modifications
    fhir:SubstanceDefinition.moiety.role [ CodeableConcept ]; # 0..1 Role that the moiety is playing
    fhir:SubstanceDefinition.moiety.identifier [ Identifier ]; # 0..1 Identifier by which this moiety substance is known
    fhir:SubstanceDefinition.moiety.name [ string ]; # 0..1 Textual name for this moiety substance
    fhir:SubstanceDefinition.moiety.stereochemistry [ CodeableConcept ]; # 0..1 Stereochemistry type
    fhir:SubstanceDefinition.moiety.opticalActivity [ CodeableConcept ]; # 0..1 Optical activity type
    fhir:SubstanceDefinition.moiety.molecularFormula [ string ]; # 0..1 Molecular formula for this moiety of this substance, typically using the Hill system
    # SubstanceDefinition.moiety.amount[x] : 0..1 Quantitative value for this moiety. One of these 2
      fhir:SubstanceDefinition.moiety.amountQuantity [ Quantity ]
      fhir:SubstanceDefinition.moiety.amountString [ string ]
    fhir:SubstanceDefinition.moiety.amountType [ CodeableConcept ]; # 0..1 The measurement type of the quantitative value
  ], ...;
  fhir:SubstanceDefinition.property [ # 0..* General specifications for this substance, including how it is related to other substances
    fhir:SubstanceDefinition.property.category [ CodeableConcept ]; # 0..1 A category for this property, e.g. Physical, Chemical, Enzymatic
    fhir:SubstanceDefinition.property.code [ CodeableConcept ]; # 0..1 Property type e.g. viscosity, pH, isoelectric point
    fhir:SubstanceDefinition.property.parameters [ string ]; # 0..1 Parameters that were used in the measurement of a property (e.g. for viscosity: measured at 20C with a pH of 7.1)
    # SubstanceDefinition.property.definingSubstance[x] : 0..1 A substance upon which a defining property depends (e.g. for solubility: in water, in alcohol). One of these 2
      fhir:SubstanceDefinition.property.definingSubstanceReference [ Reference(Substance|SubstanceDefinition) ]
      fhir:SubstanceDefinition.property.definingSubstanceCodeableConcept [ CodeableConcept ]
    # SubstanceDefinition.property.amount[x] : 0..1 Quantitative value for this property. One of these 2
      fhir:SubstanceDefinition.property.amountQuantity [ Quantity ]
      fhir:SubstanceDefinition.property.amountString [ string ]
    fhir:SubstanceDefinition.property.referenceRange [ Range ]; # 0..1 Range of typical values
    fhir:SubstanceDefinition.property.source [ Reference(DocumentReference) ], ... ; # 0..* Supporting literature
  ], ...;
  fhir:SubstanceDefinition.referenceInformation [ Reference(SubstanceReferenceInformation) ]; # 0..1 General information detailing this substance
  fhir:SubstanceDefinition.structure [ # 0..1 Structural information
    fhir:SubstanceDefinition.structure.stereochemistry [ CodeableConcept ]; # 0..1 Stereochemistry type
    fhir:SubstanceDefinition.structure.opticalActivity [ CodeableConcept ]; # 0..1 Optical activity type
    fhir:SubstanceDefinition.structure.molecularFormula [ string ]; # 0..1 Molecular formula of this substance, typically using the Hill system
    fhir:SubstanceDefinition.structure.molecularFormulaByMoiety [ string ]; # 0..1 Specified per moiety according to the Hill system, i.e. first C, then H, then alphabetical, each moiety separated by a dot
    fhir:SubstanceDefinition.structure.isotope [ # 0..* Applicable for single substances that contain a radionuclide or a non-natural isotopic ratio
      fhir:SubstanceDefinition.structure.isotope.identifier [ Identifier ]; # 0..1 Substance identifier for each non-natural or radioisotope
      fhir:SubstanceDefinition.structure.isotope.name [ CodeableConcept ]; # 0..1 Substance name for each non-natural or radioisotope
      fhir:SubstanceDefinition.structure.isotope.substitution [ CodeableConcept ]; # 0..1 The type of isotopic substitution present in a single substance
      fhir:SubstanceDefinition.structure.isotope.halfLife [ Quantity ]; # 0..1 Half life - for a non-natural nuclide
      fhir:SubstanceDefinition.structure.isotope.molecularWeight [ # 0..1 The molecular weight or weight range (for proteins, polymers or nucleic acids)
        fhir:SubstanceDefinition.structure.isotope.molecularWeight.method [ CodeableConcept ]; # 0..1 The method by which the molecular weight was determined
        fhir:SubstanceDefinition.structure.isotope.molecularWeight.type [ CodeableConcept ]; # 0..1 Type of molecular weight such as exact, average (also known as. number average), weight average
        fhir:SubstanceDefinition.structure.isotope.molecularWeight.amount [ Quantity ]; # 0..1 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
      ];
    ], ...;
    fhir:SubstanceDefinition.structure.molecularWeight [ See SubstanceDefinition.structure.isotope.molecularWeight ]; # 0..1 The molecular weight or weight range (for proteins, polymers or nucleic acids)
    fhir:SubstanceDefinition.structure.technique [ CodeableConcept ], ... ; # 0..* The method used to elucidate the structure or characterization of the drug substance. Examples: X-ray, HPLC, NMR, Peptide mapping, Ligand binding assay
    fhir:SubstanceDefinition.structure.sourceDocument [ Reference(DocumentReference) ], ... ; # 0..* Supporting literature about the source of information
    fhir:SubstanceDefinition.structure.representation [ # 0..* Molecular structural representation
      fhir:SubstanceDefinition.structure.representation.type [ CodeableConcept ]; # 0..1 The type of structure (e.g. Full, Partial, Representative)
      fhir:SubstanceDefinition.structure.representation.representation [ string ]; # 0..1 The structural representation as text string in a standard format e.g. InChI, SMILES, MOLFILE, CDX, SDF, PDB, mmCIF
      fhir:SubstanceDefinition.structure.representation.format [ CodeableConcept ]; # 0..1 The format of the representation e.g. InChI, SMILES, MOLFILE, CDX, SDF, PDB, mmCIF
      fhir:SubstanceDefinition.structure.representation.attachment [ Attachment ]; # 0..1 An attached file with the structural representation
    ], ...;
  ];
  fhir:SubstanceDefinition.code [ # 0..* Codes associated with the substance
    fhir:SubstanceDefinition.code.code [ CodeableConcept ]; # 0..1 The specific code
    fhir:SubstanceDefinition.code.status [ CodeableConcept ]; # 0..1 Status of the code assignment, for example 'provisional', 'approved'
    fhir:SubstanceDefinition.code.statusDate [ dateTime ]; # 0..1 The date at which the code status is changed as part of the terminology maintenance
    fhir:SubstanceDefinition.code.note [ Annotation ], ... ; # 0..* Any comment can be provided in this field, if necessary
    fhir:SubstanceDefinition.code.source [ Reference(DocumentReference) ], ... ; # 0..* Supporting literature
  ], ...;
  fhir:SubstanceDefinition.name [ # 0..* Names applicable to this substance
    fhir:SubstanceDefinition.name.name [ string ]; # 1..1 The actual name
    fhir:SubstanceDefinition.name.type [ CodeableConcept ]; # 0..1 Name type, for example 'systematic',  'scientific, 'brand'
    fhir:SubstanceDefinition.name.status [ CodeableConcept ]; # 0..1 The status of the name, for example 'current', 'proposed'
    fhir:SubstanceDefinition.name.preferred [ boolean ]; # 0..1 If this is the preferred name for this substance
    fhir:SubstanceDefinition.name.language [ CodeableConcept ], ... ; # 0..* Human language that the name is written in
    fhir:SubstanceDefinition.name.domain [ CodeableConcept ], ... ; # 0..* The use context of this name for example if there is a different name a drug active ingredient as opposed to a food colour additive
    fhir:SubstanceDefinition.name.jurisdiction [ CodeableConcept ], ... ; # 0..* The jurisdiction where this name applies
    fhir:SubstanceDefinition.name.synonym [ See SubstanceDefinition.name ], ... ; # 0..* A synonym of this particular name, by which the substance is also known
    fhir:SubstanceDefinition.name.translation [ See SubstanceDefinition.name ], ... ; # 0..* A translation for this name into another human language
    fhir:SubstanceDefinition.name.official [ # 0..* Details of the official nature of this name
      fhir:SubstanceDefinition.name.official.authority [ CodeableConcept ]; # 0..1 Which authority uses this official name
      fhir:SubstanceDefinition.name.official.status [ CodeableConcept ]; # 0..1 The status of the official name, for example 'provisional', 'approved'
      fhir:SubstanceDefinition.name.official.date [ dateTime ]; # 0..1 Date of official name change
    ], ...;
    fhir:SubstanceDefinition.name.source [ Reference(DocumentReference) ], ... ; # 0..* Supporting literature
  ], ...;
  fhir:SubstanceDefinition.molecularWeight [ See SubstanceDefinition.structure.isotope.molecularWeight ], ... ; # 0..* The molecular weight or weight range (for proteins, polymers or nucleic acids)
  fhir:SubstanceDefinition.relationship [ # 0..* A link between this substance and another, with details of the relationship
    # SubstanceDefinition.relationship.substanceDefinition[x] : 0..1 A pointer to another substance, as a resource or just a representational code. One of these 2
      fhir:SubstanceDefinition.relationship.substanceDefinitionReference [ Reference(SubstanceDefinition) ]
      fhir:SubstanceDefinition.relationship.substanceDefinitionCodeableConcept [ CodeableConcept ]
    fhir:SubstanceDefinition.relationship.type [ CodeableConcept ]; # 0..1 For example "salt to parent", "active moiety", "starting material", "polymorph"
    fhir:SubstanceDefinition.relationship.isDefining [ boolean ]; # 0..1 For example where an enzyme strongly bonds with a particular substance, this is a defining relationship for that enzyme, out of several possible substance relationships
    # SubstanceDefinition.relationship.amount[x] : 0..1 A numeric factor for the relationship, for instance to express that the salt of a substance has some percentage of the active substance in relation to some other. One of these 4
      fhir:SubstanceDefinition.relationship.amountQuantity [ Quantity ]
      fhir:SubstanceDefinition.relationship.amountRange [ Range ]
      fhir:SubstanceDefinition.relationship.amountRatio [ Ratio ]
      fhir:SubstanceDefinition.relationship.amountString [ string ]
    fhir:SubstanceDefinition.relationship.amountRatioHighLimit [ Ratio ]; # 0..1 For use when the numeric has an uncertain range
    fhir:SubstanceDefinition.relationship.amountType [ CodeableConcept ]; # 0..1 An operator for the amount, for example "average", "approximately", "less than"
    fhir:SubstanceDefinition.relationship.source [ Reference(DocumentReference) ], ... ; # 0..* Supporting literature
  ], ...;
  fhir:SubstanceDefinition.nucleicAcid [ Reference(SubstanceNucleicAcid) ]; # 0..1 Data items specific to nucleic acids
  fhir:SubstanceDefinition.polymer [ Reference(SubstancePolymer) ]; # 0..1 Data items specific to polymers
  fhir:SubstanceDefinition.protein [ Reference(SubstanceProtein) ]; # 0..1 Data items specific to proteins
  fhir:SubstanceDefinition.sourceMaterial [ Reference(SubstanceSourceMaterial) ]; # 0..1 Material or taxonomic/anatomical source for the substance
]

Changes since Release 3

This resource did not exist in Release 2

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

Search parameters for this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.

NameTypeDescriptionExpressionIn Common
categorytokenHigh level categorization, e.g. polymer or nucleic acid, or food, chemical, biologicalSubstanceDefinition.category
codetokenThe specific codeSubstanceDefinition.code.code
domaintokenIf the substance applies to only human or veterinary useSubstanceDefinition.domain
identifiertokenIdentifier by which this substance is knownSubstanceDefinition.identifier
name NstringThe actual nameSubstanceDefinition.name.name