This is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions
Biomedical Research and Regulation Work Group | Maturity Level: 1 | Trial Use | Security Category: Anonymous | Compartments: No defined compartments |
The detailed description of a substance, typically at a level beyond what is used for prescribing.
For an overview of this resource and others in the Medication Definition domain, also see the module page
SubstanceDefinition is used for rich descriptions of substances, of any type, to support the detailed definition of medications, and in particular their ingredients (see Ingredient) and manufacturing.
This is a definitional resource describing types of substances, to a varying degree of specificity. It can cover the substance in the abstract (properties that this substance always has), or a particular variety of it, such as one manufacturer's version, or a certain presentation (e.g. "granulated"). However it is always a type and does not represent an actual physical instance of a substance. By contrast the Substance resource can act as either a concise definition (a subset of SubstanceDefinition) or as an instance (an actual batch).
SubstanceDefinition is not generally used directly to represent an ingredient, nor as a product that is given to a patient. When acting as an ingredient, the Ingredient resource gives the context necessary (strength, role etc.) and, within it, uses this resource to describe the substance. Any substance that is to be used as medication would be considered a medicinal product (even a plain one such as water) and as such would be described using MedicinalProductDefinition or for a concise summary suitable for day-to-day prescribing, Medication.
This resource is undergoing review for which elements are core and which may be suitable as extensions.
Implementer feedback is welcome on the issue tracker or chat.fhir.org .
Structure
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
SubstanceDefinition | TU | DomainResource | The 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..* | Identifier | Identifier by which this substance is known | ||||
version | Σ | 0..1 | string | A business level version identifier of the substance | ||||
status | Σ | 0..1 | CodeableConcept | Status of substance within the catalogue e.g. active, retired Binding: PublicationStatus (Preferred) | ||||
classification | Σ | 0..* | CodeableConcept | A categorization, high level e.g. polymer or nucleic acid, or food, chemical, biological, or lower e.g. polymer linear or branch chain, or type of impurity | ||||
domain | Σ | 0..1 | CodeableConcept | If the substance applies to human or veterinary use Binding: Medicinal Product Domain (Example) | ||||
grade | Σ | 0..* | CodeableConcept | The quality standard, established benchmark, to which substance complies (e.g. USP/NF, BP) Binding: Substance Grade (Example) | ||||
description | Σ | 0..1 | markdown | Textual description of the substance | ||||
informationSource | Σ | 0..* | Reference(Citation) | Supporting literature | ||||
note | Σ | 0..* | Annotation | Textual comment about the substance's catalogue or registry record | ||||
manufacturer | Σ | 0..* | Reference(Organization) | The entity that creates, makes, produces or fabricates the substance | ||||
supplier | Σ | 0..* | Reference(Organization) | An entity that is the source for the substance. It may be different from the manufacturer | ||||
moiety | Σ | 0..* | BackboneElement | Moiety, for structural modifications | ||||
role | Σ | 0..1 | CodeableConcept | Role that the moiety is playing | ||||
identifier | Σ | 0..1 | Identifier | Identifier by which this moiety substance is known | ||||
name | Σ | 0..1 | string | Textual name for this moiety substance | ||||
stereochemistry | Σ | 0..1 | CodeableConcept | Stereochemistry type Binding: Stereochemistry (Example) | ||||
opticalActivity | Σ | 0..1 | CodeableConcept | Optical activity type Binding: Optical Activity (Example) | ||||
molecularFormula | Σ | 0..1 | string | Molecular formula for this moiety (e.g. with the Hill system) | ||||
amount[x] | Σ | 0..1 | Quantitative value for this moiety | |||||
amountQuantity | Quantity | |||||||
amountString | string | |||||||
measurementType | Σ | 0..1 | CodeableConcept | The measurement type of the quantitative value Binding: Substance Amount Type (Example) | ||||
characterization | Σ | 0..* | BackboneElement | General specifications for this substance | ||||
technique | Σ | 0..1 | CodeableConcept | The method used to find the characterization e.g. HPLC Binding: Structure Technique (Example) | ||||
form | Σ | 0..1 | CodeableConcept | Describes the nature of the chemical entity and explains, for instance, whether this is a base or a salt form Binding: Substance Form (Example) | ||||
description | Σ | 0..1 | markdown | The description or justification in support of the interpretation of the data file | ||||
file | Σ | 0..* | Attachment | The data produced by the analytical instrument or a pictorial representation of that data. Examples: a JCAMP, JDX, or ADX file, or a chromatogram or spectrum analysis | ||||
property | Σ | 0..* | BackboneElement | General specifications for this substance | ||||
type | Σ | 1..1 | CodeableConcept | A code expressing the type of property Binding: Product Characteristic (Example) | ||||
value[x] | Σ | 0..1 | A value for the property | |||||
valueCodeableConcept | CodeableConcept | |||||||
valueQuantity | Quantity | |||||||
valueDate | date | |||||||
valueBoolean | boolean | |||||||
valueAttachment | Attachment | |||||||
referenceInformation | Σ | 0..1 | Reference(SubstanceReferenceInformation) | General information detailing this substance | ||||
molecularWeight | Σ | 0..* | BackboneElement | The average mass of a molecule of a compound | ||||
method | Σ | 0..1 | CodeableConcept | The method by which the weight was determined Binding: Weight Method (Example) | ||||
type | Σ | 0..1 | CodeableConcept | Type of molecular weight e.g. exact, average, weight average Binding: Weight Type (Example) | ||||
amount | Σ | 1..1 | Quantity | Used to capture quantitative values for a variety of elements | ||||
structure | Σ | 0..1 | BackboneElement | Structural information | ||||
stereochemistry | Σ | 0..1 | CodeableConcept | Stereochemistry type Binding: Stereochemistry (Example) | ||||
opticalActivity | Σ | 0..1 | CodeableConcept | Optical activity type Binding: Optical Activity (Example) | ||||
molecularFormula | Σ | 0..1 | string | An expression which states the number and type of atoms present in a molecule of a substance | ||||
molecularFormulaByMoiety | Σ | 0..1 | string | Specified per moiety according to the Hill system | ||||
molecularWeight | Σ | 0..1 | see molecularWeight | The molecular weight or weight range | ||||
technique | Σ | 0..* | CodeableConcept | The method used to find the structure e.g. X-ray, NMR Binding: Structure Technique (Example) | ||||
sourceDocument | Σ | 0..* | Reference(DocumentReference) | Source of information for the structure | ||||
representation | Σ | 0..* | BackboneElement | A depiction of the structure of the substance | ||||
type | Σ | 0..1 | CodeableConcept | The kind of structural representation (e.g. full, partial) Binding: Substance Representation Type (Example) | ||||
representation | Σ | 0..1 | string | The structural representation as a text string in a standard format | ||||
format | Σ | 0..1 | CodeableConcept | The format of the representation e.g. InChI, SMILES, MOLFILE (note: not the physical file format) Binding: Substance Representation Format (Example) | ||||
document | Σ | 0..1 | Reference(DocumentReference) | An attachment with the structural representation e.g. a structure graphic or AnIML file | ||||
code | Σ | 0..* | BackboneElement | Codes associated with the substance | ||||
code | Σ | 0..1 | CodeableConcept | The specific code | ||||
status | Σ | 0..1 | CodeableConcept | Status of the code assignment, for example 'provisional', 'approved' Binding: PublicationStatus (Preferred) | ||||
statusDate | Σ | 0..1 | dateTime | The date at which the code status was changed | ||||
note | Σ | 0..* | Annotation | Any comment can be provided in this field | ||||
source | Σ | 0..* | Reference(DocumentReference) | Supporting literature | ||||
name | Σ | 0..* | BackboneElement | Names applicable to this substance | ||||
name | Σ | 1..1 | string | The actual name | ||||
type | Σ | 0..1 | CodeableConcept | Name type e.g. 'systematic', 'scientific, 'brand' Binding: Substance Name Type (Example) | ||||
status | Σ | 0..1 | CodeableConcept | The status of the name e.g. 'current', 'proposed' Binding: PublicationStatus (Preferred) | ||||
preferred | Σ | 0..1 | boolean | If this is the preferred name for this substance | ||||
language | Σ | 0..* | CodeableConcept | Human language that the name is written in Binding: All Languages (Required)
| ||||
domain | Σ | 0..* | CodeableConcept | The use context of this name e.g. as an active ingredient or as a food colour additive Binding: Substance Name Domain (Example) | ||||
jurisdiction | Σ | 0..* | CodeableConcept | The jurisdiction where this name applies Binding: Jurisdiction ValueSet (Example) | ||||
synonym | Σ | 0..* | see name | A synonym of this particular name, by which the substance is also known | ||||
translation | Σ | 0..* | see name | A translation for this name into another human language | ||||
official | Σ | 0..* | BackboneElement | Details of the official nature of this name | ||||
authority | Σ | 0..1 | CodeableConcept | Which authority uses this official name Binding: Substance Name Authority (Preferred) | ||||
status | Σ | 0..1 | CodeableConcept | The status of the official name, for example 'draft', 'active' Binding: PublicationStatus (Preferred) | ||||
date | Σ | 0..1 | dateTime | Date of official name change | ||||
source | Σ | 0..* | Reference(DocumentReference) | Supporting literature | ||||
relationship | Σ | 0..* | BackboneElement | A link between this substance and another | ||||
substanceDefinition[x] | Σ | 0..1 | A pointer to another substance, as a resource or a representational code | |||||
substanceDefinitionReference | Reference(SubstanceDefinition) | |||||||
substanceDefinitionCodeableConcept | CodeableConcept | |||||||
type | Σ | 1..1 | CodeableConcept | For example "salt to parent", "active moiety" Binding: Substance Relationship Type (Example) | ||||
isDefining | Σ | 0..1 | boolean | For example where an enzyme strongly bonds with a particular substance, this is a defining relationship for that enzyme, out of several possible relationships | ||||
amount[x] | Σ | 0..1 | A numeric factor for the relationship, e.g. that a substance salt has some percentage of active substance in relation to some other | |||||
amountQuantity | Quantity | |||||||
amountRatio | Ratio | |||||||
amountString | string | |||||||
ratioHighLimitAmount | Σ | 0..1 | Ratio | For use when the numeric has an uncertain range | ||||
comparator | Σ | 0..1 | CodeableConcept | An operator for the amount, for example "average", "approximately", "less than" Binding: Substance Amount Type (Example) | ||||
source | Σ | 0..* | Reference(DocumentReference) | Supporting literature | ||||
nucleicAcid | Σ | 0..1 | Reference(SubstanceNucleicAcid) | Data items specific to nucleic acids | ||||
polymer | Σ | 0..1 | Reference(SubstancePolymer) | Data items specific to polymers | ||||
protein | Σ | 0..1 | Reference(SubstanceProtein) | Data items specific to proteins | ||||
sourceMaterial | Σ | 0..1 | BackboneElement | Material or taxonomic/anatomical source | ||||
type | Σ | 0..1 | CodeableConcept | Classification of the origin of the raw material. e.g. cat hair is an Animal source type Binding: Source Material Type (Example) | ||||
genus | Σ | 0..1 | CodeableConcept | The genus of an organism e.g. the Latin epithet of the plant/animal scientific name Binding: Source Material Genus (Example) | ||||
species | Σ | 0..1 | CodeableConcept | The species of an organism e.g. the Latin epithet of the species of the plant/animal Binding: Source Material Species (Example) | ||||
part | Σ | 0..1 | CodeableConcept | An anatomical origin of the source material within an organism Binding: Source Material Part (Example) | ||||
countryOfOrigin | Σ | 0..* | CodeableConcept | The country or countries where the material is harvested Binding: Country ValueSet (Required) | ||||
Documentation for this format |
See the Extensions for this resource
UML Diagram (Legend)
XML Template
<SubstanceDefinition xmlns="http://hl7.org/fhir"> <!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension --> <identifier><!-- 0..* Identifier Identifier by which this substance is known --></identifier> <version value="[string]"/><!-- 0..1 A business level version identifier of the substance --> <status><!-- 0..1 CodeableConcept Status of substance within the catalogue e.g. active, retired --></status> <classification><!-- 0..* CodeableConcept A categorization, high level e.g. polymer or nucleic acid, or food, chemical, biological, or lower e.g. polymer linear or branch chain, or type of impurity --></classification> <domain><!-- 0..1 CodeableConcept If the substance applies to human or veterinary use --></domain> <grade><!-- 0..* CodeableConcept The quality standard, established benchmark, to which substance complies (e.g. USP/NF, BP) --></grade> <description value="[markdown]"/><!-- 0..1 Textual description of the substance --> <informationSource><!-- 0..* Reference(Citation) Supporting literature --></informationSource> <note><!-- 0..* Annotation Textual comment about the substance's catalogue or registry record --></note> <manufacturer><!-- 0..* Reference(Organization) The entity that creates, makes, produces or fabricates the substance --></manufacturer> <supplier><!-- 0..* Reference(Organization) An entity that is the source for the substance. It may be different from the manufacturer --></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 (e.g. with the Hill system) --> <amount[x]><!-- 0..1 Quantity|string Quantitative value for this moiety --></amount[x]> <measurementType><!-- 0..1 CodeableConcept The measurement type of the quantitative value --></measurementType> </moiety> <characterization> <!-- 0..* General specifications for this substance --> <technique><!-- 0..1 CodeableConcept The method used to find the characterization e.g. HPLC --></technique> <form><!-- 0..1 CodeableConcept Describes the nature of the chemical entity and explains, for instance, whether this is a base or a salt form --></form> <description value="[markdown]"/><!-- 0..1 The description or justification in support of the interpretation of the data file --> <file><!-- 0..* Attachment The data produced by the analytical instrument or a pictorial representation of that data. Examples: a JCAMP, JDX, or ADX file, or a chromatogram or spectrum analysis --></file> </characterization> <property> <!-- 0..* General specifications for this substance --> <type><!-- 1..1 CodeableConcept A code expressing the type of property --></type> <value[x]><!-- 0..1 CodeableConcept|Quantity|date|boolean|Attachment A value for the property --></value[x]> </property> <referenceInformation><!-- 0..1 Reference(SubstanceReferenceInformation) General information detailing this substance --></referenceInformation> <molecularWeight> <!-- 0..* The average mass of a molecule of a compound --> <method><!-- 0..1 CodeableConcept The method by which the weight was determined --></method> <type><!-- 0..1 CodeableConcept Type of molecular weight e.g. exact, average, weight average --></type> <amount><!-- 1..1 Quantity Used to capture quantitative values for a variety of elements --></amount> </molecularWeight> <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 An expression which states the number and type of atoms present in a molecule of a substance --> <molecularFormulaByMoiety value="[string]"/><!-- 0..1 Specified per moiety according to the Hill system --> <molecularWeight><!-- 0..1 Content as for SubstanceDefinition.molecularWeight The molecular weight or weight range --></molecularWeight> <technique><!-- 0..* CodeableConcept The method used to find the structure e.g. X-ray, NMR --></technique> <sourceDocument><!-- 0..* Reference(DocumentReference) Source of information for the structure --></sourceDocument> <representation> <!-- 0..* A depiction of the structure of the substance --> <type><!-- 0..1 CodeableConcept The kind of structural representation (e.g. full, partial) --></type> <representation value="[string]"/><!-- 0..1 The structural representation as a text string in a standard format --> <format><!-- 0..1 CodeableConcept The format of the representation e.g. InChI, SMILES, MOLFILE (note: not the physical file format) --></format> <document><!-- 0..1 Reference(DocumentReference) An attachment with the structural representation e.g. a structure graphic or AnIML file --></document> </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 was changed --> <note><!-- 0..* Annotation Any comment can be provided in this field --></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 e.g. 'systematic', 'scientific, 'brand' --></type> <status><!-- 0..1 CodeableConcept The status of the name e.g. '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 e.g. as an active ingredient or as 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 'draft', 'active' --></status> <date value="[dateTime]"/><!-- 0..1 Date of official name change --> </official> <source><!-- 0..* Reference(DocumentReference) Supporting literature --></source> </name> <relationship> <!-- 0..* A link between this substance and another --> <substanceDefinition[x]><!-- 0..1 Reference(SubstanceDefinition)| CodeableConcept A pointer to another substance, as a resource or a representational code --></substanceDefinition[x]> <type><!-- 1..1 CodeableConcept For example "salt to parent", "active moiety" --></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 relationships --> <amount[x]><!-- 0..1 Quantity|Ratio|string A numeric factor for the relationship, e.g. that a substance salt has some percentage of active substance in relation to some other --></amount[x]> <ratioHighLimitAmount><!-- 0..1 Ratio For use when the numeric has an uncertain range --></ratioHighLimitAmount> <comparator><!-- 0..1 CodeableConcept An operator for the amount, for example "average", "approximately", "less than" --></comparator> <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 Material or taxonomic/anatomical source --> <type><!-- 0..1 CodeableConcept Classification of the origin of the raw material. e.g. cat hair is an Animal source type --></type> <genus><!-- 0..1 CodeableConcept The genus of an organism e.g. the Latin epithet of the plant/animal scientific name --></genus> <species><!-- 0..1 CodeableConcept The species of an organism e.g. the Latin epithet of the species of the plant/animal --></species> <part><!-- 0..1 CodeableConcept An anatomical origin of the source material within an organism --></part> <countryOfOrigin><!-- 0..* CodeableConcept The country or countries where the material is harvested --></countryOfOrigin> </sourceMaterial> </SubstanceDefinition>
JSON Template
{ "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 version identifier of the substance "status" : { CodeableConcept }, // Status of substance within the catalogue e.g. active, retired "classification" : [{ CodeableConcept }], // A categorization, high level e.g. polymer or nucleic acid, or food, chemical, biological, or lower e.g. polymer linear or branch chain, or type of impurity "domain" : { CodeableConcept }, // If the substance applies to human or veterinary use "grade" : [{ CodeableConcept }], // The quality standard, established benchmark, to which substance complies (e.g. USP/NF, BP) "description" : "<markdown>", // Textual description of the substance "informationSource" : [{ Reference(Citation) }], // Supporting literature "note" : [{ Annotation }], // Textual comment about the substance's catalogue or registry record "manufacturer" : [{ Reference(Organization) }], // The entity that creates, makes, produces or fabricates the substance "supplier" : [{ Reference(Organization) }], // An entity that is the source for the substance. It may be different from the manufacturer "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 (e.g. with the Hill system) // amount[x]: Quantitative value for this moiety. One of these 2: "amountQuantity" : { Quantity }, "amountString" : "<string>", "measurementType" : { CodeableConcept } // The measurement type of the quantitative value }], "characterization" : [{ // General specifications for this substance "technique" : { CodeableConcept }, // The method used to find the characterization e.g. HPLC "form" : { CodeableConcept }, // Describes the nature of the chemical entity and explains, for instance, whether this is a base or a salt form "description" : "<markdown>", // The description or justification in support of the interpretation of the data file "file" : [{ Attachment }] // The data produced by the analytical instrument or a pictorial representation of that data. Examples: a JCAMP, JDX, or ADX file, or a chromatogram or spectrum analysis }], "property" : [{ // General specifications for this substance "type" : { CodeableConcept }, // R! A code expressing the type of property // value[x]: A value for the property. One of these 5: "valueCodeableConcept" : { CodeableConcept }, "valueQuantity" : { Quantity }, "valueDate" : "<date>", "valueBoolean" : <boolean>, "valueAttachment" : { Attachment } }], "referenceInformation" : { Reference(SubstanceReferenceInformation) }, // General information detailing this substance "molecularWeight" : [{ // The average mass of a molecule of a compound "method" : { CodeableConcept }, // The method by which the weight was determined "type" : { CodeableConcept }, // Type of molecular weight e.g. exact, average, weight average "amount" : { Quantity } // R! Used to capture quantitative values for a variety of elements }], "structure" : { // Structural information "stereochemistry" : { CodeableConcept }, // Stereochemistry type "opticalActivity" : { CodeableConcept }, // Optical activity type "molecularFormula" : "<string>", // An expression which states the number and type of atoms present in a molecule of a substance "molecularFormulaByMoiety" : "<string>", // Specified per moiety according to the Hill system "molecularWeight" : { Content as for SubstanceDefinition.molecularWeight }, // The molecular weight or weight range "technique" : [{ CodeableConcept }], // The method used to find the structure e.g. X-ray, NMR "sourceDocument" : [{ Reference(DocumentReference) }], // Source of information for the structure "representation" : [{ // A depiction of the structure of the substance "type" : { CodeableConcept }, // The kind of structural representation (e.g. full, partial) "representation" : "<string>", // The structural representation as a text string in a standard format "format" : { CodeableConcept }, // The format of the representation e.g. InChI, SMILES, MOLFILE (note: not the physical file format) "document" : { Reference(DocumentReference) } // An attachment with the structural representation e.g. a structure graphic or AnIML file }] }, "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 was changed "note" : [{ Annotation }], // Any comment can be provided in this field "source" : [{ Reference(DocumentReference) }] // Supporting literature }], "name" : [{ // Names applicable to this substance "name" : "<string>", // R! The actual name "type" : { CodeableConcept }, // Name type e.g. 'systematic', 'scientific, 'brand' "status" : { CodeableConcept }, // The status of the name e.g. '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 e.g. as an active ingredient or as 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 'draft', 'active' "date" : "<dateTime>" // Date of official name change }], "source" : [{ Reference(DocumentReference) }] // Supporting literature }], "relationship" : [{ // A link between this substance and another // substanceDefinition[x]: A pointer to another substance, as a resource or a representational code. One of these 2: "substanceDefinitionReference" : { Reference(SubstanceDefinition) }, "substanceDefinitionCodeableConcept" : { CodeableConcept }, "type" : { CodeableConcept }, // R! For example "salt to parent", "active moiety" "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 relationships // amount[x]: A numeric factor for the relationship, e.g. that a substance salt has some percentage of active substance in relation to some other. One of these 3: "amountQuantity" : { Quantity }, "amountRatio" : { Ratio }, "amountString" : "<string>", "ratioHighLimitAmount" : { Ratio }, // For use when the numeric has an uncertain range "comparator" : { 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" : { // Material or taxonomic/anatomical source "type" : { CodeableConcept }, // Classification of the origin of the raw material. e.g. cat hair is an Animal source type "genus" : { CodeableConcept }, // The genus of an organism e.g. the Latin epithet of the plant/animal scientific name "species" : { CodeableConcept }, // The species of an organism e.g. the Latin epithet of the species of the plant/animal "part" : { CodeableConcept }, // An anatomical origin of the source material within an organism "countryOfOrigin" : [{ CodeableConcept }] // The country or countries where the material is harvested } }
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> . [ 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:identifier ( [ Identifier ] ... ) ; # 0..* Identifier by which this substance is known fhir:version [ string ] ; # 0..1 A business level version identifier of the substance fhir:status [ CodeableConcept ] ; # 0..1 Status of substance within the catalogue e.g. active, retired fhir:classification ( [ CodeableConcept ] ... ) ; # 0..* A categorization, high level e.g. polymer or nucleic acid, or food, chemical, biological, or lower e.g. polymer linear or branch chain, or type of impurity fhir:domain [ CodeableConcept ] ; # 0..1 If the substance applies to human or veterinary use fhir:grade ( [ CodeableConcept ] ... ) ; # 0..* The quality standard, established benchmark, to which substance complies (e.g. USP/NF, BP) fhir:description [ markdown ] ; # 0..1 Textual description of the substance fhir:informationSource ( [ Reference(Citation) ] ... ) ; # 0..* Supporting literature fhir:note ( [ Annotation ] ... ) ; # 0..* Textual comment about the substance's catalogue or registry record fhir:manufacturer ( [ Reference(Organization) ] ... ) ; # 0..* The entity that creates, makes, produces or fabricates the substance fhir:supplier ( [ Reference(Organization) ] ... ) ; # 0..* An entity that is the source for the substance. It may be different from the manufacturer fhir:moiety ( [ # 0..* Moiety, for structural modifications fhir:role [ CodeableConcept ] ; # 0..1 Role that the moiety is playing fhir:identifier [ Identifier ] ; # 0..1 Identifier by which this moiety substance is known fhir:name [ string ] ; # 0..1 Textual name for this moiety substance fhir:stereochemistry [ CodeableConcept ] ; # 0..1 Stereochemistry type fhir:opticalActivity [ CodeableConcept ] ; # 0..1 Optical activity type fhir:molecularFormula [ string ] ; # 0..1 Molecular formula for this moiety (e.g. with the Hill system) # amount[x] : 0..1 Quantitative value for this moiety. One of these 2 fhir:amount [ a fhir:Quantity ; Quantity ] fhir:amount [ a fhir:string ; string ] fhir:measurementType [ CodeableConcept ] ; # 0..1 The measurement type of the quantitative value ] ... ) ; fhir:characterization ( [ # 0..* General specifications for this substance fhir:technique [ CodeableConcept ] ; # 0..1 The method used to find the characterization e.g. HPLC fhir:form [ CodeableConcept ] ; # 0..1 Describes the nature of the chemical entity and explains, for instance, whether this is a base or a salt form fhir:description [ markdown ] ; # 0..1 The description or justification in support of the interpretation of the data file fhir:file ( [ Attachment ] ... ) ; # 0..* The data produced by the analytical instrument or a pictorial representation of that data. Examples: a JCAMP, JDX, or ADX file, or a chromatogram or spectrum analysis ] ... ) ; fhir:property ( [ # 0..* General specifications for this substance fhir:type [ CodeableConcept ] ; # 1..1 A code expressing the type of property # value[x] : 0..1 A value for the property. One of these 5 fhir:value [ a fhir:CodeableConcept ; CodeableConcept ] fhir:value [ a fhir:Quantity ; Quantity ] fhir:value [ a fhir:date ; date ] fhir:value [ a fhir:boolean ; boolean ] fhir:value [ a fhir:Attachment ; Attachment ] ] ... ) ; fhir:referenceInformation [ Reference(SubstanceReferenceInformation) ] ; # 0..1 General information detailing this substance fhir:molecularWeight ( [ # 0..* The average mass of a molecule of a compound fhir:method [ CodeableConcept ] ; # 0..1 The method by which the weight was determined fhir:type [ CodeableConcept ] ; # 0..1 Type of molecular weight e.g. exact, average, weight average fhir:amount [ Quantity ] ; # 1..1 Used to capture quantitative values for a variety of elements ] ... ) ; fhir:structure [ # 0..1 Structural information fhir:stereochemistry [ CodeableConcept ] ; # 0..1 Stereochemistry type fhir:opticalActivity [ CodeableConcept ] ; # 0..1 Optical activity type fhir:molecularFormula [ string ] ; # 0..1 An expression which states the number and type of atoms present in a molecule of a substance fhir:molecularFormulaByMoiety [ string ] ; # 0..1 Specified per moiety according to the Hill system fhir:molecularWeight [ See SubstanceDefinition.molecularWeight ] ; # 0..1 The molecular weight or weight range fhir:technique ( [ CodeableConcept ] ... ) ; # 0..* The method used to find the structure e.g. X-ray, NMR fhir:sourceDocument ( [ Reference(DocumentReference) ] ... ) ; # 0..* Source of information for the structure fhir:representation ( [ # 0..* A depiction of the structure of the substance fhir:type [ CodeableConcept ] ; # 0..1 The kind of structural representation (e.g. full, partial) fhir:representation [ string ] ; # 0..1 The structural representation as a text string in a standard format fhir:format [ CodeableConcept ] ; # 0..1 The format of the representation e.g. InChI, SMILES, MOLFILE (note: not the physical file format) fhir:document [ Reference(DocumentReference) ] ; # 0..1 An attachment with the structural representation e.g. a structure graphic or AnIML file ] ... ) ; ] ; fhir:code ( [ # 0..* Codes associated with the substance fhir:code [ CodeableConcept ] ; # 0..1 The specific code fhir:status [ CodeableConcept ] ; # 0..1 Status of the code assignment, for example 'provisional', 'approved' fhir:statusDate [ dateTime ] ; # 0..1 The date at which the code status was changed fhir:note ( [ Annotation ] ... ) ; # 0..* Any comment can be provided in this field fhir:source ( [ Reference(DocumentReference) ] ... ) ; # 0..* Supporting literature ] ... ) ; fhir:name ( [ # 0..* Names applicable to this substance fhir:name [ string ] ; # 1..1 The actual name fhir:type [ CodeableConcept ] ; # 0..1 Name type e.g. 'systematic', 'scientific, 'brand' fhir:status [ CodeableConcept ] ; # 0..1 The status of the name e.g. 'current', 'proposed' fhir:preferred [ boolean ] ; # 0..1 If this is the preferred name for this substance fhir:language ( [ CodeableConcept ] ... ) ; # 0..* Human language that the name is written in fhir:domain ( [ CodeableConcept ] ... ) ; # 0..* The use context of this name e.g. as an active ingredient or as a food colour additive fhir:jurisdiction ( [ CodeableConcept ] ... ) ; # 0..* The jurisdiction where this name applies fhir:synonym ( [ See SubstanceDefinition.name ] ... ) ; # 0..* A synonym of this particular name, by which the substance is also known fhir:translation ( [ See SubstanceDefinition.name ] ... ) ; # 0..* A translation for this name into another human language fhir:official ( [ # 0..* Details of the official nature of this name fhir:authority [ CodeableConcept ] ; # 0..1 Which authority uses this official name fhir:status [ CodeableConcept ] ; # 0..1 The status of the official name, for example 'draft', 'active' fhir:date [ dateTime ] ; # 0..1 Date of official name change ] ... ) ; fhir:source ( [ Reference(DocumentReference) ] ... ) ; # 0..* Supporting literature ] ... ) ; fhir:relationship ( [ # 0..* A link between this substance and another # substanceDefinition[x] : 0..1 A pointer to another substance, as a resource or a representational code. One of these 2 fhir:substanceDefinition [ a fhir:Reference ; Reference(SubstanceDefinition) ] fhir:substanceDefinition [ a fhir:CodeableConcept ; CodeableConcept ] fhir:type [ CodeableConcept ] ; # 1..1 For example "salt to parent", "active moiety" fhir: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 relationships # amount[x] : 0..1 A numeric factor for the relationship, e.g. that a substance salt has some percentage of active substance in relation to some other. One of these 3 fhir:amount [ a fhir:Quantity ; Quantity ] fhir:amount [ a fhir:Ratio ; Ratio ] fhir:amount [ a fhir:string ; string ] fhir:ratioHighLimitAmount [ Ratio ] ; # 0..1 For use when the numeric has an uncertain range fhir:comparator [ CodeableConcept ] ; # 0..1 An operator for the amount, for example "average", "approximately", "less than" fhir:source ( [ Reference(DocumentReference) ] ... ) ; # 0..* Supporting literature ] ... ) ; fhir:nucleicAcid [ Reference(SubstanceNucleicAcid) ] ; # 0..1 Data items specific to nucleic acids fhir:polymer [ Reference(SubstancePolymer) ] ; # 0..1 Data items specific to polymers fhir:protein [ Reference(SubstanceProtein) ] ; # 0..1 Data items specific to proteins fhir:sourceMaterial [ # 0..1 Material or taxonomic/anatomical source fhir:type [ CodeableConcept ] ; # 0..1 Classification of the origin of the raw material. e.g. cat hair is an Animal source type fhir:genus [ CodeableConcept ] ; # 0..1 The genus of an organism e.g. the Latin epithet of the plant/animal scientific name fhir:species [ CodeableConcept ] ; # 0..1 The species of an organism e.g. the Latin epithet of the species of the plant/animal fhir:part [ CodeableConcept ] ; # 0..1 An anatomical origin of the source material within an organism fhir:countryOfOrigin ( [ CodeableConcept ] ... ) ; # 0..* The country or countries where the material is harvested ] ; ]
Changes from both R4 and R4B
This resource did not exist in Release R4
See the Full Difference for further information
This analysis is available for R4 as XML or JSON and for R4B as XML or JSON.
Structure
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
SubstanceDefinition | TU | DomainResource | The 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..* | Identifier | Identifier by which this substance is known | ||||
version | Σ | 0..1 | string | A business level version identifier of the substance | ||||
status | Σ | 0..1 | CodeableConcept | Status of substance within the catalogue e.g. active, retired Binding: PublicationStatus (Preferred) | ||||
classification | Σ | 0..* | CodeableConcept | A categorization, high level e.g. polymer or nucleic acid, or food, chemical, biological, or lower e.g. polymer linear or branch chain, or type of impurity | ||||
domain | Σ | 0..1 | CodeableConcept | If the substance applies to human or veterinary use Binding: Medicinal Product Domain (Example) | ||||
grade | Σ | 0..* | CodeableConcept | The quality standard, established benchmark, to which substance complies (e.g. USP/NF, BP) Binding: Substance Grade (Example) | ||||
description | Σ | 0..1 | markdown | Textual description of the substance | ||||
informationSource | Σ | 0..* | Reference(Citation) | Supporting literature | ||||
note | Σ | 0..* | Annotation | Textual comment about the substance's catalogue or registry record | ||||
manufacturer | Σ | 0..* | Reference(Organization) | The entity that creates, makes, produces or fabricates the substance | ||||
supplier | Σ | 0..* | Reference(Organization) | An entity that is the source for the substance. It may be different from the manufacturer | ||||
moiety | Σ | 0..* | BackboneElement | Moiety, for structural modifications | ||||
role | Σ | 0..1 | CodeableConcept | Role that the moiety is playing | ||||
identifier | Σ | 0..1 | Identifier | Identifier by which this moiety substance is known | ||||
name | Σ | 0..1 | string | Textual name for this moiety substance | ||||
stereochemistry | Σ | 0..1 | CodeableConcept | Stereochemistry type Binding: Stereochemistry (Example) | ||||
opticalActivity | Σ | 0..1 | CodeableConcept | Optical activity type Binding: Optical Activity (Example) | ||||
molecularFormula | Σ | 0..1 | string | Molecular formula for this moiety (e.g. with the Hill system) | ||||
amount[x] | Σ | 0..1 | Quantitative value for this moiety | |||||
amountQuantity | Quantity | |||||||
amountString | string | |||||||
measurementType | Σ | 0..1 | CodeableConcept | The measurement type of the quantitative value Binding: Substance Amount Type (Example) | ||||
characterization | Σ | 0..* | BackboneElement | General specifications for this substance | ||||
technique | Σ | 0..1 | CodeableConcept | The method used to find the characterization e.g. HPLC Binding: Structure Technique (Example) | ||||
form | Σ | 0..1 | CodeableConcept | Describes the nature of the chemical entity and explains, for instance, whether this is a base or a salt form Binding: Substance Form (Example) | ||||
description | Σ | 0..1 | markdown | The description or justification in support of the interpretation of the data file | ||||
file | Σ | 0..* | Attachment | The data produced by the analytical instrument or a pictorial representation of that data. Examples: a JCAMP, JDX, or ADX file, or a chromatogram or spectrum analysis | ||||
property | Σ | 0..* | BackboneElement | General specifications for this substance | ||||
type | Σ | 1..1 | CodeableConcept | A code expressing the type of property Binding: Product Characteristic (Example) | ||||
value[x] | Σ | 0..1 | A value for the property | |||||
valueCodeableConcept | CodeableConcept | |||||||
valueQuantity | Quantity | |||||||
valueDate | date | |||||||
valueBoolean | boolean | |||||||
valueAttachment | Attachment | |||||||
referenceInformation | Σ | 0..1 | Reference(SubstanceReferenceInformation) | General information detailing this substance | ||||
molecularWeight | Σ | 0..* | BackboneElement | The average mass of a molecule of a compound | ||||
method | Σ | 0..1 | CodeableConcept | The method by which the weight was determined Binding: Weight Method (Example) | ||||
type | Σ | 0..1 | CodeableConcept | Type of molecular weight e.g. exact, average, weight average Binding: Weight Type (Example) | ||||
amount | Σ | 1..1 | Quantity | Used to capture quantitative values for a variety of elements | ||||
structure | Σ | 0..1 | BackboneElement | Structural information | ||||
stereochemistry | Σ | 0..1 | CodeableConcept | Stereochemistry type Binding: Stereochemistry (Example) | ||||
opticalActivity | Σ | 0..1 | CodeableConcept | Optical activity type Binding: Optical Activity (Example) | ||||
molecularFormula | Σ | 0..1 | string | An expression which states the number and type of atoms present in a molecule of a substance | ||||
molecularFormulaByMoiety | Σ | 0..1 | string | Specified per moiety according to the Hill system | ||||
molecularWeight | Σ | 0..1 | see molecularWeight | The molecular weight or weight range | ||||
technique | Σ | 0..* | CodeableConcept | The method used to find the structure e.g. X-ray, NMR Binding: Structure Technique (Example) | ||||
sourceDocument | Σ | 0..* | Reference(DocumentReference) | Source of information for the structure | ||||
representation | Σ | 0..* | BackboneElement | A depiction of the structure of the substance | ||||
type | Σ | 0..1 | CodeableConcept | The kind of structural representation (e.g. full, partial) Binding: Substance Representation Type (Example) | ||||
representation | Σ | 0..1 | string | The structural representation as a text string in a standard format | ||||
format | Σ | 0..1 | CodeableConcept | The format of the representation e.g. InChI, SMILES, MOLFILE (note: not the physical file format) Binding: Substance Representation Format (Example) | ||||
document | Σ | 0..1 | Reference(DocumentReference) | An attachment with the structural representation e.g. a structure graphic or AnIML file | ||||
code | Σ | 0..* | BackboneElement | Codes associated with the substance | ||||
code | Σ | 0..1 | CodeableConcept | The specific code | ||||
status | Σ | 0..1 | CodeableConcept | Status of the code assignment, for example 'provisional', 'approved' Binding: PublicationStatus (Preferred) | ||||
statusDate | Σ | 0..1 | dateTime | The date at which the code status was changed | ||||
note | Σ | 0..* | Annotation | Any comment can be provided in this field | ||||
source | Σ | 0..* | Reference(DocumentReference) | Supporting literature | ||||
name | Σ | 0..* | BackboneElement | Names applicable to this substance | ||||
name | Σ | 1..1 | string | The actual name | ||||
type | Σ | 0..1 | CodeableConcept | Name type e.g. 'systematic', 'scientific, 'brand' Binding: Substance Name Type (Example) | ||||
status | Σ | 0..1 | CodeableConcept | The status of the name e.g. 'current', 'proposed' Binding: PublicationStatus (Preferred) | ||||
preferred | Σ | 0..1 | boolean | If this is the preferred name for this substance | ||||
language | Σ | 0..* | CodeableConcept | Human language that the name is written in Binding: All Languages (Required)
| ||||
domain | Σ | 0..* | CodeableConcept | The use context of this name e.g. as an active ingredient or as a food colour additive Binding: Substance Name Domain (Example) | ||||
jurisdiction | Σ | 0..* | CodeableConcept | The jurisdiction where this name applies Binding: Jurisdiction ValueSet (Example) | ||||
synonym | Σ | 0..* | see name | A synonym of this particular name, by which the substance is also known | ||||
translation | Σ | 0..* | see name | A translation for this name into another human language | ||||
official | Σ | 0..* | BackboneElement | Details of the official nature of this name | ||||
authority | Σ | 0..1 | CodeableConcept | Which authority uses this official name Binding: Substance Name Authority (Preferred) | ||||
status | Σ | 0..1 | CodeableConcept | The status of the official name, for example 'draft', 'active' Binding: PublicationStatus (Preferred) | ||||
date | Σ | 0..1 | dateTime | Date of official name change | ||||
source | Σ | 0..* | Reference(DocumentReference) | Supporting literature | ||||
relationship | Σ | 0..* | BackboneElement | A link between this substance and another | ||||
substanceDefinition[x] | Σ | 0..1 | A pointer to another substance, as a resource or a representational code | |||||
substanceDefinitionReference | Reference(SubstanceDefinition) | |||||||
substanceDefinitionCodeableConcept | CodeableConcept | |||||||
type | Σ | 1..1 | CodeableConcept | For example "salt to parent", "active moiety" Binding: Substance Relationship Type (Example) | ||||
isDefining | Σ | 0..1 | boolean | For example where an enzyme strongly bonds with a particular substance, this is a defining relationship for that enzyme, out of several possible relationships | ||||
amount[x] | Σ | 0..1 | A numeric factor for the relationship, e.g. that a substance salt has some percentage of active substance in relation to some other | |||||
amountQuantity | Quantity | |||||||
amountRatio | Ratio | |||||||
amountString | string | |||||||
ratioHighLimitAmount | Σ | 0..1 | Ratio | For use when the numeric has an uncertain range | ||||
comparator | Σ | 0..1 | CodeableConcept | An operator for the amount, for example "average", "approximately", "less than" Binding: Substance Amount Type (Example) | ||||
source | Σ | 0..* | Reference(DocumentReference) | Supporting literature | ||||
nucleicAcid | Σ | 0..1 | Reference(SubstanceNucleicAcid) | Data items specific to nucleic acids | ||||
polymer | Σ | 0..1 | Reference(SubstancePolymer) | Data items specific to polymers | ||||
protein | Σ | 0..1 | Reference(SubstanceProtein) | Data items specific to proteins | ||||
sourceMaterial | Σ | 0..1 | BackboneElement | Material or taxonomic/anatomical source | ||||
type | Σ | 0..1 | CodeableConcept | Classification of the origin of the raw material. e.g. cat hair is an Animal source type Binding: Source Material Type (Example) | ||||
genus | Σ | 0..1 | CodeableConcept | The genus of an organism e.g. the Latin epithet of the plant/animal scientific name Binding: Source Material Genus (Example) | ||||
species | Σ | 0..1 | CodeableConcept | The species of an organism e.g. the Latin epithet of the species of the plant/animal Binding: Source Material Species (Example) | ||||
part | Σ | 0..1 | CodeableConcept | An anatomical origin of the source material within an organism Binding: Source Material Part (Example) | ||||
countryOfOrigin | Σ | 0..* | CodeableConcept | The country or countries where the material is harvested Binding: Country ValueSet (Required) | ||||
Documentation for this format |
See the Extensions for this resource
XML Template
<SubstanceDefinition xmlns="http://hl7.org/fhir"> <!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension --> <identifier><!-- 0..* Identifier Identifier by which this substance is known --></identifier> <version value="[string]"/><!-- 0..1 A business level version identifier of the substance --> <status><!-- 0..1 CodeableConcept Status of substance within the catalogue e.g. active, retired --></status> <classification><!-- 0..* CodeableConcept A categorization, high level e.g. polymer or nucleic acid, or food, chemical, biological, or lower e.g. polymer linear or branch chain, or type of impurity --></classification> <domain><!-- 0..1 CodeableConcept If the substance applies to human or veterinary use --></domain> <grade><!-- 0..* CodeableConcept The quality standard, established benchmark, to which substance complies (e.g. USP/NF, BP) --></grade> <description value="[markdown]"/><!-- 0..1 Textual description of the substance --> <informationSource><!-- 0..* Reference(Citation) Supporting literature --></informationSource> <note><!-- 0..* Annotation Textual comment about the substance's catalogue or registry record --></note> <manufacturer><!-- 0..* Reference(Organization) The entity that creates, makes, produces or fabricates the substance --></manufacturer> <supplier><!-- 0..* Reference(Organization) An entity that is the source for the substance. It may be different from the manufacturer --></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 (e.g. with the Hill system) --> <amount[x]><!-- 0..1 Quantity|string Quantitative value for this moiety --></amount[x]> <measurementType><!-- 0..1 CodeableConcept The measurement type of the quantitative value --></measurementType> </moiety> <characterization> <!-- 0..* General specifications for this substance --> <technique><!-- 0..1 CodeableConcept The method used to find the characterization e.g. HPLC --></technique> <form><!-- 0..1 CodeableConcept Describes the nature of the chemical entity and explains, for instance, whether this is a base or a salt form --></form> <description value="[markdown]"/><!-- 0..1 The description or justification in support of the interpretation of the data file --> <file><!-- 0..* Attachment The data produced by the analytical instrument or a pictorial representation of that data. Examples: a JCAMP, JDX, or ADX file, or a chromatogram or spectrum analysis --></file> </characterization> <property> <!-- 0..* General specifications for this substance --> <type><!-- 1..1 CodeableConcept A code expressing the type of property --></type> <value[x]><!-- 0..1 CodeableConcept|Quantity|date|boolean|Attachment A value for the property --></value[x]> </property> <referenceInformation><!-- 0..1 Reference(SubstanceReferenceInformation) General information detailing this substance --></referenceInformation> <molecularWeight> <!-- 0..* The average mass of a molecule of a compound --> <method><!-- 0..1 CodeableConcept The method by which the weight was determined --></method> <type><!-- 0..1 CodeableConcept Type of molecular weight e.g. exact, average, weight average --></type> <amount><!-- 1..1 Quantity Used to capture quantitative values for a variety of elements --></amount> </molecularWeight> <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 An expression which states the number and type of atoms present in a molecule of a substance --> <molecularFormulaByMoiety value="[string]"/><!-- 0..1 Specified per moiety according to the Hill system --> <molecularWeight><!-- 0..1 Content as for SubstanceDefinition.molecularWeight The molecular weight or weight range --></molecularWeight> <technique><!-- 0..* CodeableConcept The method used to find the structure e.g. X-ray, NMR --></technique> <sourceDocument><!-- 0..* Reference(DocumentReference) Source of information for the structure --></sourceDocument> <representation> <!-- 0..* A depiction of the structure of the substance --> <type><!-- 0..1 CodeableConcept The kind of structural representation (e.g. full, partial) --></type> <representation value="[string]"/><!-- 0..1 The structural representation as a text string in a standard format --> <format><!-- 0..1 CodeableConcept The format of the representation e.g. InChI, SMILES, MOLFILE (note: not the physical file format) --></format> <document><!-- 0..1 Reference(DocumentReference) An attachment with the structural representation e.g. a structure graphic or AnIML file --></document> </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 was changed --> <note><!-- 0..* Annotation Any comment can be provided in this field --></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 e.g. 'systematic', 'scientific, 'brand' --></type> <status><!-- 0..1 CodeableConcept The status of the name e.g. '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 e.g. as an active ingredient or as 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 'draft', 'active' --></status> <date value="[dateTime]"/><!-- 0..1 Date of official name change --> </official> <source><!-- 0..* Reference(DocumentReference) Supporting literature --></source> </name> <relationship> <!-- 0..* A link between this substance and another --> <substanceDefinition[x]><!-- 0..1 Reference(SubstanceDefinition)| CodeableConcept A pointer to another substance, as a resource or a representational code --></substanceDefinition[x]> <type><!-- 1..1 CodeableConcept For example "salt to parent", "active moiety" --></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 relationships --> <amount[x]><!-- 0..1 Quantity|Ratio|string A numeric factor for the relationship, e.g. that a substance salt has some percentage of active substance in relation to some other --></amount[x]> <ratioHighLimitAmount><!-- 0..1 Ratio For use when the numeric has an uncertain range --></ratioHighLimitAmount> <comparator><!-- 0..1 CodeableConcept An operator for the amount, for example "average", "approximately", "less than" --></comparator> <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 Material or taxonomic/anatomical source --> <type><!-- 0..1 CodeableConcept Classification of the origin of the raw material. e.g. cat hair is an Animal source type --></type> <genus><!-- 0..1 CodeableConcept The genus of an organism e.g. the Latin epithet of the plant/animal scientific name --></genus> <species><!-- 0..1 CodeableConcept The species of an organism e.g. the Latin epithet of the species of the plant/animal --></species> <part><!-- 0..1 CodeableConcept An anatomical origin of the source material within an organism --></part> <countryOfOrigin><!-- 0..* CodeableConcept The country or countries where the material is harvested --></countryOfOrigin> </sourceMaterial> </SubstanceDefinition>
JSON Template
{ "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 version identifier of the substance "status" : { CodeableConcept }, // Status of substance within the catalogue e.g. active, retired "classification" : [{ CodeableConcept }], // A categorization, high level e.g. polymer or nucleic acid, or food, chemical, biological, or lower e.g. polymer linear or branch chain, or type of impurity "domain" : { CodeableConcept }, // If the substance applies to human or veterinary use "grade" : [{ CodeableConcept }], // The quality standard, established benchmark, to which substance complies (e.g. USP/NF, BP) "description" : "<markdown>", // Textual description of the substance "informationSource" : [{ Reference(Citation) }], // Supporting literature "note" : [{ Annotation }], // Textual comment about the substance's catalogue or registry record "manufacturer" : [{ Reference(Organization) }], // The entity that creates, makes, produces or fabricates the substance "supplier" : [{ Reference(Organization) }], // An entity that is the source for the substance. It may be different from the manufacturer "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 (e.g. with the Hill system) // amount[x]: Quantitative value for this moiety. One of these 2: "amountQuantity" : { Quantity }, "amountString" : "<string>", "measurementType" : { CodeableConcept } // The measurement type of the quantitative value }], "characterization" : [{ // General specifications for this substance "technique" : { CodeableConcept }, // The method used to find the characterization e.g. HPLC "form" : { CodeableConcept }, // Describes the nature of the chemical entity and explains, for instance, whether this is a base or a salt form "description" : "<markdown>", // The description or justification in support of the interpretation of the data file "file" : [{ Attachment }] // The data produced by the analytical instrument or a pictorial representation of that data. Examples: a JCAMP, JDX, or ADX file, or a chromatogram or spectrum analysis }], "property" : [{ // General specifications for this substance "type" : { CodeableConcept }, // R! A code expressing the type of property // value[x]: A value for the property. One of these 5: "valueCodeableConcept" : { CodeableConcept }, "valueQuantity" : { Quantity }, "valueDate" : "<date>", "valueBoolean" : <boolean>, "valueAttachment" : { Attachment } }], "referenceInformation" : { Reference(SubstanceReferenceInformation) }, // General information detailing this substance "molecularWeight" : [{ // The average mass of a molecule of a compound "method" : { CodeableConcept }, // The method by which the weight was determined "type" : { CodeableConcept }, // Type of molecular weight e.g. exact, average, weight average "amount" : { Quantity } // R! Used to capture quantitative values for a variety of elements }], "structure" : { // Structural information "stereochemistry" : { CodeableConcept }, // Stereochemistry type "opticalActivity" : { CodeableConcept }, // Optical activity type "molecularFormula" : "<string>", // An expression which states the number and type of atoms present in a molecule of a substance "molecularFormulaByMoiety" : "<string>", // Specified per moiety according to the Hill system "molecularWeight" : { Content as for SubstanceDefinition.molecularWeight }, // The molecular weight or weight range "technique" : [{ CodeableConcept }], // The method used to find the structure e.g. X-ray, NMR "sourceDocument" : [{ Reference(DocumentReference) }], // Source of information for the structure "representation" : [{ // A depiction of the structure of the substance "type" : { CodeableConcept }, // The kind of structural representation (e.g. full, partial) "representation" : "<string>", // The structural representation as a text string in a standard format "format" : { CodeableConcept }, // The format of the representation e.g. InChI, SMILES, MOLFILE (note: not the physical file format) "document" : { Reference(DocumentReference) } // An attachment with the structural representation e.g. a structure graphic or AnIML file }] }, "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 was changed "note" : [{ Annotation }], // Any comment can be provided in this field "source" : [{ Reference(DocumentReference) }] // Supporting literature }], "name" : [{ // Names applicable to this substance "name" : "<string>", // R! The actual name "type" : { CodeableConcept }, // Name type e.g. 'systematic', 'scientific, 'brand' "status" : { CodeableConcept }, // The status of the name e.g. '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 e.g. as an active ingredient or as 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 'draft', 'active' "date" : "<dateTime>" // Date of official name change }], "source" : [{ Reference(DocumentReference) }] // Supporting literature }], "relationship" : [{ // A link between this substance and another // substanceDefinition[x]: A pointer to another substance, as a resource or a representational code. One of these 2: "substanceDefinitionReference" : { Reference(SubstanceDefinition) }, "substanceDefinitionCodeableConcept" : { CodeableConcept }, "type" : { CodeableConcept }, // R! For example "salt to parent", "active moiety" "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 relationships // amount[x]: A numeric factor for the relationship, e.g. that a substance salt has some percentage of active substance in relation to some other. One of these 3: "amountQuantity" : { Quantity }, "amountRatio" : { Ratio }, "amountString" : "<string>", "ratioHighLimitAmount" : { Ratio }, // For use when the numeric has an uncertain range "comparator" : { 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" : { // Material or taxonomic/anatomical source "type" : { CodeableConcept }, // Classification of the origin of the raw material. e.g. cat hair is an Animal source type "genus" : { CodeableConcept }, // The genus of an organism e.g. the Latin epithet of the plant/animal scientific name "species" : { CodeableConcept }, // The species of an organism e.g. the Latin epithet of the species of the plant/animal "part" : { CodeableConcept }, // An anatomical origin of the source material within an organism "countryOfOrigin" : [{ CodeableConcept }] // The country or countries where the material is harvested } }
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> . [ 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:identifier ( [ Identifier ] ... ) ; # 0..* Identifier by which this substance is known fhir:version [ string ] ; # 0..1 A business level version identifier of the substance fhir:status [ CodeableConcept ] ; # 0..1 Status of substance within the catalogue e.g. active, retired fhir:classification ( [ CodeableConcept ] ... ) ; # 0..* A categorization, high level e.g. polymer or nucleic acid, or food, chemical, biological, or lower e.g. polymer linear or branch chain, or type of impurity fhir:domain [ CodeableConcept ] ; # 0..1 If the substance applies to human or veterinary use fhir:grade ( [ CodeableConcept ] ... ) ; # 0..* The quality standard, established benchmark, to which substance complies (e.g. USP/NF, BP) fhir:description [ markdown ] ; # 0..1 Textual description of the substance fhir:informationSource ( [ Reference(Citation) ] ... ) ; # 0..* Supporting literature fhir:note ( [ Annotation ] ... ) ; # 0..* Textual comment about the substance's catalogue or registry record fhir:manufacturer ( [ Reference(Organization) ] ... ) ; # 0..* The entity that creates, makes, produces or fabricates the substance fhir:supplier ( [ Reference(Organization) ] ... ) ; # 0..* An entity that is the source for the substance. It may be different from the manufacturer fhir:moiety ( [ # 0..* Moiety, for structural modifications fhir:role [ CodeableConcept ] ; # 0..1 Role that the moiety is playing fhir:identifier [ Identifier ] ; # 0..1 Identifier by which this moiety substance is known fhir:name [ string ] ; # 0..1 Textual name for this moiety substance fhir:stereochemistry [ CodeableConcept ] ; # 0..1 Stereochemistry type fhir:opticalActivity [ CodeableConcept ] ; # 0..1 Optical activity type fhir:molecularFormula [ string ] ; # 0..1 Molecular formula for this moiety (e.g. with the Hill system) # amount[x] : 0..1 Quantitative value for this moiety. One of these 2 fhir:amount [ a fhir:Quantity ; Quantity ] fhir:amount [ a fhir:string ; string ] fhir:measurementType [ CodeableConcept ] ; # 0..1 The measurement type of the quantitative value ] ... ) ; fhir:characterization ( [ # 0..* General specifications for this substance fhir:technique [ CodeableConcept ] ; # 0..1 The method used to find the characterization e.g. HPLC fhir:form [ CodeableConcept ] ; # 0..1 Describes the nature of the chemical entity and explains, for instance, whether this is a base or a salt form fhir:description [ markdown ] ; # 0..1 The description or justification in support of the interpretation of the data file fhir:file ( [ Attachment ] ... ) ; # 0..* The data produced by the analytical instrument or a pictorial representation of that data. Examples: a JCAMP, JDX, or ADX file, or a chromatogram or spectrum analysis ] ... ) ; fhir:property ( [ # 0..* General specifications for this substance fhir:type [ CodeableConcept ] ; # 1..1 A code expressing the type of property # value[x] : 0..1 A value for the property. One of these 5 fhir:value [ a fhir:CodeableConcept ; CodeableConcept ] fhir:value [ a fhir:Quantity ; Quantity ] fhir:value [ a fhir:date ; date ] fhir:value [ a fhir:boolean ; boolean ] fhir:value [ a fhir:Attachment ; Attachment ] ] ... ) ; fhir:referenceInformation [ Reference(SubstanceReferenceInformation) ] ; # 0..1 General information detailing this substance fhir:molecularWeight ( [ # 0..* The average mass of a molecule of a compound fhir:method [ CodeableConcept ] ; # 0..1 The method by which the weight was determined fhir:type [ CodeableConcept ] ; # 0..1 Type of molecular weight e.g. exact, average, weight average fhir:amount [ Quantity ] ; # 1..1 Used to capture quantitative values for a variety of elements ] ... ) ; fhir:structure [ # 0..1 Structural information fhir:stereochemistry [ CodeableConcept ] ; # 0..1 Stereochemistry type fhir:opticalActivity [ CodeableConcept ] ; # 0..1 Optical activity type fhir:molecularFormula [ string ] ; # 0..1 An expression which states the number and type of atoms present in a molecule of a substance fhir:molecularFormulaByMoiety [ string ] ; # 0..1 Specified per moiety according to the Hill system fhir:molecularWeight [ See SubstanceDefinition.molecularWeight ] ; # 0..1 The molecular weight or weight range fhir:technique ( [ CodeableConcept ] ... ) ; # 0..* The method used to find the structure e.g. X-ray, NMR fhir:sourceDocument ( [ Reference(DocumentReference) ] ... ) ; # 0..* Source of information for the structure fhir:representation ( [ # 0..* A depiction of the structure of the substance fhir:type [ CodeableConcept ] ; # 0..1 The kind of structural representation (e.g. full, partial) fhir:representation [ string ] ; # 0..1 The structural representation as a text string in a standard format fhir:format [ CodeableConcept ] ; # 0..1 The format of the representation e.g. InChI, SMILES, MOLFILE (note: not the physical file format) fhir:document [ Reference(DocumentReference) ] ; # 0..1 An attachment with the structural representation e.g. a structure graphic or AnIML file ] ... ) ; ] ; fhir:code ( [ # 0..* Codes associated with the substance fhir:code [ CodeableConcept ] ; # 0..1 The specific code fhir:status [ CodeableConcept ] ; # 0..1 Status of the code assignment, for example 'provisional', 'approved' fhir:statusDate [ dateTime ] ; # 0..1 The date at which the code status was changed fhir:note ( [ Annotation ] ... ) ; # 0..* Any comment can be provided in this field fhir:source ( [ Reference(DocumentReference) ] ... ) ; # 0..* Supporting literature ] ... ) ; fhir:name ( [ # 0..* Names applicable to this substance fhir:name [ string ] ; # 1..1 The actual name fhir:type [ CodeableConcept ] ; # 0..1 Name type e.g. 'systematic', 'scientific, 'brand' fhir:status [ CodeableConcept ] ; # 0..1 The status of the name e.g. 'current', 'proposed' fhir:preferred [ boolean ] ; # 0..1 If this is the preferred name for this substance fhir:language ( [ CodeableConcept ] ... ) ; # 0..* Human language that the name is written in fhir:domain ( [ CodeableConcept ] ... ) ; # 0..* The use context of this name e.g. as an active ingredient or as a food colour additive fhir:jurisdiction ( [ CodeableConcept ] ... ) ; # 0..* The jurisdiction where this name applies fhir:synonym ( [ See SubstanceDefinition.name ] ... ) ; # 0..* A synonym of this particular name, by which the substance is also known fhir:translation ( [ See SubstanceDefinition.name ] ... ) ; # 0..* A translation for this name into another human language fhir:official ( [ # 0..* Details of the official nature of this name fhir:authority [ CodeableConcept ] ; # 0..1 Which authority uses this official name fhir:status [ CodeableConcept ] ; # 0..1 The status of the official name, for example 'draft', 'active' fhir:date [ dateTime ] ; # 0..1 Date of official name change ] ... ) ; fhir:source ( [ Reference(DocumentReference) ] ... ) ; # 0..* Supporting literature ] ... ) ; fhir:relationship ( [ # 0..* A link between this substance and another # substanceDefinition[x] : 0..1 A pointer to another substance, as a resource or a representational code. One of these 2 fhir:substanceDefinition [ a fhir:Reference ; Reference(SubstanceDefinition) ] fhir:substanceDefinition [ a fhir:CodeableConcept ; CodeableConcept ] fhir:type [ CodeableConcept ] ; # 1..1 For example "salt to parent", "active moiety" fhir: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 relationships # amount[x] : 0..1 A numeric factor for the relationship, e.g. that a substance salt has some percentage of active substance in relation to some other. One of these 3 fhir:amount [ a fhir:Quantity ; Quantity ] fhir:amount [ a fhir:Ratio ; Ratio ] fhir:amount [ a fhir:string ; string ] fhir:ratioHighLimitAmount [ Ratio ] ; # 0..1 For use when the numeric has an uncertain range fhir:comparator [ CodeableConcept ] ; # 0..1 An operator for the amount, for example "average", "approximately", "less than" fhir:source ( [ Reference(DocumentReference) ] ... ) ; # 0..* Supporting literature ] ... ) ; fhir:nucleicAcid [ Reference(SubstanceNucleicAcid) ] ; # 0..1 Data items specific to nucleic acids fhir:polymer [ Reference(SubstancePolymer) ] ; # 0..1 Data items specific to polymers fhir:protein [ Reference(SubstanceProtein) ] ; # 0..1 Data items specific to proteins fhir:sourceMaterial [ # 0..1 Material or taxonomic/anatomical source fhir:type [ CodeableConcept ] ; # 0..1 Classification of the origin of the raw material. e.g. cat hair is an Animal source type fhir:genus [ CodeableConcept ] ; # 0..1 The genus of an organism e.g. the Latin epithet of the plant/animal scientific name fhir:species [ CodeableConcept ] ; # 0..1 The species of an organism e.g. the Latin epithet of the species of the plant/animal fhir:part [ CodeableConcept ] ; # 0..1 An anatomical origin of the source material within an organism fhir:countryOfOrigin ( [ CodeableConcept ] ... ) ; # 0..* The country or countries where the material is harvested ] ; ]
Changes from both R4 and R4B
This resource did not exist in Release R4
See the Full Difference for further information
This analysis is available for R4 as XML or JSON and for R4B as XML or JSON.
Additional definitions: Master Definition XML + JSON, XML Schema/Schematron + JSON Schema, ShEx (for Turtle) + see the extensions, the spreadsheet version & the dependency analysis
Path | ValueSet | Type | Documentation |
---|---|---|---|
SubstanceDefinition.status | PublicationStatus | Preferred | The lifecycle status of an artifact. |
SubstanceDefinition.domain | MedicinalProductDomain | Example | Applicable domain for this product (e.g. human, veterinary) |
SubstanceDefinition.grade | SubstanceGrade | Example | The quality standard, established benchmark, to which a substance complies. |
SubstanceDefinition.moiety.stereochemistry | Stereochemistry (a valid code from Substance Stereochemistry) | Example | The optical rotation type of a substance. |
SubstanceDefinition.moiety.opticalActivity | OpticalActivity (a valid code from Substance Optical Activity) | Example | The optical rotation type of a substance. |
SubstanceDefinition.moiety.measurementType | SubstanceAmountType | Example | The relationship between two substance types. |
SubstanceDefinition.characterization.technique | StructureTechnique (a valid code from Substance Structure Technique) | Example | The method used to elucidate the structure or characterization of the drug substance. |
SubstanceDefinition.characterization.form | SubstanceForm | Example | The substance form, whether it is the base form or a salt. |
SubstanceDefinition.property.type | ProductCharacteristic | Example | This value set includes all observable entity codes from SNOMED CT - provided as an exemplar value set. |
SubstanceDefinition.molecularWeight.method | WeightMethod (a valid code from Substance Weight Method) | Example | The method by which the substance weight was measured. |
SubstanceDefinition.molecularWeight.type | WeightType (a valid code from Substance Weight Type) | Example | The type of substance weight measurement. |
SubstanceDefinition.structure.stereochemistry | Stereochemistry (a valid code from Substance Stereochemistry) | Example | The optical rotation type of a substance. |
SubstanceDefinition.structure.opticalActivity | OpticalActivity (a valid code from Substance Optical Activity) | Example | The optical rotation type of a substance. |
SubstanceDefinition.structure.technique | StructureTechnique (a valid code from Substance Structure Technique) | Example | The method used to elucidate the structure or characterization of the drug substance. |
SubstanceDefinition.structure.representation.type | SubstanceRepresentationType | Example | The type of a name given to a substance. |
SubstanceDefinition.structure.representation.format | SubstanceRepresentationFormat | Example | A format of a substance representation. |
SubstanceDefinition.code.status | PublicationStatus | Preferred | The lifecycle status of an artifact. |
SubstanceDefinition.name.type | SubstanceNameType | Example | The type of a name given to a substance. |
SubstanceDefinition.name.status | PublicationStatus | Preferred | The lifecycle status of an artifact. |
SubstanceDefinition.name.language | AllLanguages (a valid code from Tags for the Identification of Languages ) | Required | This value set includes all possible codes from BCP-47 (see http://tools.ietf.org/html/bcp47) |
Common Languages | starter | ||
SubstanceDefinition.name.domain | SubstanceNameDomain | Example | The use context of a substance name for example if there is a different name when used as a drug active ingredient as opposed to a food colour additive. |
SubstanceDefinition.name.jurisdiction | JurisdictionValueSet | Example | This value set defines a base set of codes for country, country subdivision and region for indicating where a resource is intended to be used. Note: The codes for countries and country subdivisions are taken from ISO 3166 while the codes for "supra-national" regions are from UN Standard country or area codes for statistical use (M49) . |
SubstanceDefinition.name.official.authority | SubstanceNameAuthority | Preferred | An authority that officates substance names. |
SubstanceDefinition.name.official.status | PublicationStatus | Preferred | The lifecycle status of an artifact. |
SubstanceDefinition.relationship.type | SubstanceRelationshipType | Example | The relationship between two substance types. |
SubstanceDefinition.relationship.comparator | SubstanceAmountType | Example | The relationship between two substance types. |
SubstanceDefinition.sourceMaterial.type | SourceMaterialType (a valid code from Substance Source Material Type) | Example | A classification that provides the origin of the substance raw material. |
SubstanceDefinition.sourceMaterial.genus | SourceMaterialGenus (a valid code from Substance Source Material Genus) | Example | The genus of an organism, typically referring to the Latin epithet of the genus element of the plant/animal scientific name. |
SubstanceDefinition.sourceMaterial.species | SourceMaterialSpecies (a valid code from Substance Source Material Species) | Example | A species of origin a substance raw material. |
SubstanceDefinition.sourceMaterial.part | SourceMaterialPart (a valid code from Substance Source Material Part) | Example | An anatomical origin of the source material within an organism. |
SubstanceDefinition.sourceMaterial.countryOfOrigin | CountryValueSet (a valid code from ISO 3166-1 Codes for the representation of names of countries and their subdivisions — Part 1: Country code ) | Required | This value set defines a base set of codes for countries. Note: The codes for countries are taken from ISO 3166 . |
Search parameters for this resource. See also the full list of search parameters for this resource, and check the Extensions registry for search parameters on extensions related to this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.
Name | Type | Description | Expression | In Common |
classification | token | High or low level categorization, e.g. polymer vs. nucleic acid or linear vs. branch chain | SubstanceDefinition.classification | |
code | token | The specific code | SubstanceDefinition.code.code | |
domain | token | If the substance applies to only human or veterinary use | SubstanceDefinition.domain | |
identifier | token | Identifier by which this substance is known | SubstanceDefinition.identifier | |
name | string | The actual name | SubstanceDefinition.name.name |