Skip to main content

SubstanceDefinition

PropertyValue
Publisher
NameSubstanceDefinition
URLhttp://hl7.org/fhir/StructureDefinition/SubstanceDefinition
Statusdraft
Description
Abstractfalse

Structure

PathCardinalityTypeDescription
SubstanceDefinition0..*SubstanceDefinitionThe detailed description of a substance, typically at a level beyond what is used for prescribing.
SubstanceDefinition.id0..1http://hl7.org/fhirpath/System.StringThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
SubstanceDefinition.meta0..1MetaThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
SubstanceDefinition.implicitRules0..1uriA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
SubstanceDefinition.language0..1codeThe base language in which the resource is written.
SubstanceDefinition.text0..1NarrativeA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
SubstanceDefinition.contained0..*ResourceThese resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
SubstanceDefinition.extension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
SubstanceDefinition.modifierExtension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
SubstanceDefinition.identifier0..*IdentifierIdentifier by which this substance is known.
SubstanceDefinition.version0..1stringA business level version identifier of the substance.
SubstanceDefinition.status0..1CodeableConceptStatus of substance within the catalogue e.g. active, retired.
SubstanceDefinition.classification0..*CodeableConceptA high level categorization, e.g. polymer or nucleic acid, or food, chemical, biological, or a lower level such as the general types of polymer (linear or branch chain) or type of impurity (process related or contaminant).
SubstanceDefinition.domain0..1CodeableConceptIf the substance applies to human or veterinary use.
SubstanceDefinition.grade0..*CodeableConceptThe quality standard, established benchmark, to which substance complies (e.g. USP/NF, Ph. Eur, JP, BP, Company Standard).
SubstanceDefinition.description0..1markdownTextual description of the substance.
SubstanceDefinition.informationSource0..*ReferenceSupporting literature.
SubstanceDefinition.note0..*AnnotationTextual comment about the substance's catalogue or registry record.
SubstanceDefinition.manufacturer0..*ReferenceThe entity that creates, makes, produces or fabricates the substance. This is a set of potential manufacturers but is not necessarily comprehensive.
SubstanceDefinition.supplier0..*ReferenceAn entity that is the source for the substance. It may be different from the manufacturer. Supplier is synonymous to a distributor.
SubstanceDefinition.moiety0..*BackboneElementMoiety, for structural modifications.
SubstanceDefinition.moiety.id0..1http://hl7.org/fhirpath/System.StringUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
SubstanceDefinition.moiety.extension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
SubstanceDefinition.moiety.modifierExtension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
SubstanceDefinition.moiety.role0..1CodeableConceptRole that the moiety is playing.
SubstanceDefinition.moiety.identifier0..1IdentifierIdentifier by which this moiety substance is known.
SubstanceDefinition.moiety.name0..1stringTextual name for this moiety substance.
SubstanceDefinition.moiety.stereochemistry0..1CodeableConceptStereochemistry type.
SubstanceDefinition.moiety.opticalActivity0..1CodeableConceptOptical activity type.
SubstanceDefinition.moiety.molecularFormula0..1stringMolecular formula for this moiety of this substance, typically using the Hill system.
SubstanceDefinition.moiety.amount[x]0..1QuantityQuantitative value for this moiety.
SubstanceDefinition.moiety.measurementType0..1CodeableConceptThe measurement type of the quantitative value. In capturing the actual relative amounts of substances or molecular fragments it may be necessary to indicate whether the amount refers to, for example, a mole ratio or weight ratio.
SubstanceDefinition.property0..*BackboneElementGeneral specifications for this substance.
SubstanceDefinition.property.id0..1http://hl7.org/fhirpath/System.StringUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
SubstanceDefinition.property.extension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
SubstanceDefinition.property.modifierExtension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
SubstanceDefinition.property.type1..1CodeableConceptA code expressing the type of property.
SubstanceDefinition.property.value[x]0..1CodeableConceptA value for the property.
SubstanceDefinition.molecularWeight0..*BackboneElementThe molecular weight or weight range (for proteins, polymers or nucleic acids).
SubstanceDefinition.molecularWeight.id0..1http://hl7.org/fhirpath/System.StringUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
SubstanceDefinition.molecularWeight.extension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
SubstanceDefinition.molecularWeight.modifierExtension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
SubstanceDefinition.molecularWeight.method0..1CodeableConceptThe method by which the molecular weight was determined.
SubstanceDefinition.molecularWeight.type0..1CodeableConceptType of molecular weight such as exact, average (also known as. number average), weight average.
SubstanceDefinition.molecularWeight.amount1..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.
SubstanceDefinition.structure0..1BackboneElementStructural information.
SubstanceDefinition.structure.id0..1http://hl7.org/fhirpath/System.StringUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
SubstanceDefinition.structure.extension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
SubstanceDefinition.structure.modifierExtension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
SubstanceDefinition.structure.stereochemistry0..1CodeableConceptStereochemistry type.
SubstanceDefinition.structure.opticalActivity0..1CodeableConceptOptical activity type.
SubstanceDefinition.structure.molecularFormula0..1stringMolecular formula of this substance, typically using the Hill system.
SubstanceDefinition.structure.molecularFormulaByMoiety0..1stringSpecified per moiety according to the Hill system, i.e. first C, then H, then alphabetical, each moiety separated by a dot.
SubstanceDefinition.structure.molecularWeight0..1SubstanceDefinitionThe molecular weight or weight range (for proteins, polymers or nucleic acids).
SubstanceDefinition.structure.technique0..*CodeableConceptThe method used to elucidate the structure or characterization of the drug substance. Examples: X-ray, HPLC, NMR, Peptide mapping, Ligand binding assay.
SubstanceDefinition.structure.sourceDocument0..*ReferenceThe source of information about the structure.
SubstanceDefinition.structure.representation0..*BackboneElementA depiction of the structure or characterization of the substance.
SubstanceDefinition.structure.representation.id0..1http://hl7.org/fhirpath/System.StringUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
SubstanceDefinition.structure.representation.extension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
SubstanceDefinition.structure.representation.modifierExtension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
SubstanceDefinition.structure.representation.type0..1CodeableConceptThe kind of structural representation (e.g. full, partial).
SubstanceDefinition.structure.representation.representation0..1stringThe structural representation or characterization as a text string in a standard format.
SubstanceDefinition.structure.representation.format0..1CodeableConceptThe format of the representation e.g. InChI, SMILES, MOLFILE, CDX, SDF, PDB, mmCIF. The logical content type rather than the physical file format of a document.
SubstanceDefinition.structure.representation.document0..1ReferenceAn attached file with the structural representation or characterization e.g. a molecular structure graphic of the substance, a JCAMP or AnIML file.
SubstanceDefinition.code0..*BackboneElementCodes associated with the substance.
SubstanceDefinition.code.id0..1http://hl7.org/fhirpath/System.StringUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
SubstanceDefinition.code.extension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
SubstanceDefinition.code.modifierExtension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
SubstanceDefinition.code.code0..1CodeableConceptThe specific code.
SubstanceDefinition.code.status0..1CodeableConceptStatus of the code assignment, for example 'provisional', 'approved'.
SubstanceDefinition.code.statusDate0..1dateTimeThe date at which the code status was changed as part of the terminology maintenance.
SubstanceDefinition.code.note0..*AnnotationAny comment can be provided in this field, if necessary.
SubstanceDefinition.code.source0..*ReferenceSupporting literature.
SubstanceDefinition.name0..*BackboneElementNames applicable to this substance.
SubstanceDefinition.name.id0..1http://hl7.org/fhirpath/System.StringUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
SubstanceDefinition.name.extension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
SubstanceDefinition.name.modifierExtension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
SubstanceDefinition.name.name1..1stringThe actual name.
SubstanceDefinition.name.type0..1CodeableConceptName type, for example 'systematic', 'scientific, 'brand'.
SubstanceDefinition.name.status0..1CodeableConceptThe status of the name, for example 'current', 'proposed'.
SubstanceDefinition.name.preferred0..1booleanIf this is the preferred name for this substance.
SubstanceDefinition.name.language0..*CodeableConceptHuman language that the name is written in.
SubstanceDefinition.name.domain0..*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.
SubstanceDefinition.name.jurisdiction0..*CodeableConceptThe jurisdiction where this name applies.
SubstanceDefinition.name.synonym0..*SubstanceDefinitionA synonym of this particular name, by which the substance is also known.
SubstanceDefinition.name.translation0..*SubstanceDefinitionA translation for this name into another human language.
SubstanceDefinition.name.official0..*BackboneElementDetails of the official nature of this name.
SubstanceDefinition.name.official.id0..1http://hl7.org/fhirpath/System.StringUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
SubstanceDefinition.name.official.extension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
SubstanceDefinition.name.official.modifierExtension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
SubstanceDefinition.name.official.authority0..1CodeableConceptWhich authority uses this official name.
SubstanceDefinition.name.official.status0..1CodeableConceptThe status of the official name, for example 'draft', 'active', 'retired'.
SubstanceDefinition.name.official.date0..1dateTimeDate of the official name change.
SubstanceDefinition.name.source0..*ReferenceSupporting literature.
SubstanceDefinition.relationship0..*BackboneElementA link between this substance and another, with details of the relationship.
SubstanceDefinition.relationship.id0..1http://hl7.org/fhirpath/System.StringUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
SubstanceDefinition.relationship.extension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
SubstanceDefinition.relationship.modifierExtension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
SubstanceDefinition.relationship.substanceDefinition[x]0..1ReferenceA pointer to another substance, as a resource or just a representational code.
SubstanceDefinition.relationship.type1..1CodeableConceptFor example "salt to parent", "active moiety", "starting material", "polymorph", "impurity of".
SubstanceDefinition.relationship.isDefining0..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.
SubstanceDefinition.relationship.amount[x]0..1QuantityA 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.
SubstanceDefinition.relationship.ratioHighLimitAmount0..1RatioFor use when the numeric has an uncertain range.
SubstanceDefinition.relationship.comparator0..1CodeableConceptAn operator for the amount, for example "average", "approximately", "less than".
SubstanceDefinition.relationship.source0..*ReferenceSupporting literature.
SubstanceDefinition.sourceMaterial0..1BackboneElementMaterial or taxonomic/anatomical source for the substance.
SubstanceDefinition.sourceMaterial.id0..1http://hl7.org/fhirpath/System.StringUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
SubstanceDefinition.sourceMaterial.extension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
SubstanceDefinition.sourceMaterial.modifierExtension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
SubstanceDefinition.sourceMaterial.type0..1CodeableConceptA classification that provides the origin of the raw material. Example: cat hair would be an Animal source type.
SubstanceDefinition.sourceMaterial.genus0..1CodeableConceptThe genus of an organism, typically referring to the Latin epithet of the genus element of the plant/animal scientific name.
SubstanceDefinition.sourceMaterial.species0..1CodeableConceptThe species of an organism, typically referring to the Latin epithet of the species of the plant/animal.
SubstanceDefinition.sourceMaterial.part0..1CodeableConceptAn anatomical origin of the source material within an organism.
SubstanceDefinition.sourceMaterial.countryOfOrigin0..*CodeableConceptThe country or countries where the material is harvested.

Search Parameters

NameTypeDescriptionExpression
_textstringSearch on the narrative of the resource
_contentstringSearch on the entire content of the resource
_filtertokenFilter search parameter which supports a more sophisticated grammar for searching. See documentation for further details
_hasstringProvides limited support for reverse chaining - that is, selecting resources based on the properties of resources that refer to them (instead of chaining where resources can be selected based on the properties of resources that they refer to). See the FHIR search page for further documentation
_idtokenLogical id of this artifactResource.id
_lastUpdateddateWhen the resource version last changedResource.meta.lastUpdated
_liststringAll resources in nominated list (by id, Type/id, url or one of the magic List types)
_profileuriProfiles this resource claims to conform toResource.meta.profile
_querytokenA custom search profile that describes a specific defined query operation
_securitytokenSecurity Labels applied to this resourceResource.meta.security
_sourceuriIdentifies where the resource comes fromResource.meta.source
_tagtokenTags applied to this resourceResource.meta.tag
_textstringSearch on the narrative text (html) of the resource
_typetokenUsed when a search is performed in a context which doesn't limit the search to indicate which types are being searched. See the FHIR search page for further discussion
classificationtokenHigh or low level categorization, e.g. polymer vs. nucleic acid or linear vs. branch chainSubstanceDefinition.classification
codetokenThe specific codeSubstanceDefinition.code.code
domaintokenIf the substance applies to only human or veterinary useSubstanceDefinition.domain
identifiertokenIdentifier by which this substance is knownSubstanceDefinition.identifier
namestringThe actual nameSubstanceDefinition.name.name