Skip to main content

SubstanceDefinition

The detailed description of a substance, typically at a level beyond what is used for prescribing. If the element is present, it must have either a @value, an @id, or extensions

type SubstanceDefinition implements Resource {
  identifier: [Identifier]
  version: String
  status: CodeableConcept
  classification: [CodeableConcept]
  domain: CodeableConcept
  grade: [CodeableConcept]
  description: String
  informationSource: [Reference]
  note: [Annotation]
  manufacturer: [Reference]
  supplier: [Reference]
  moiety: [SubstanceDefinitionMoiety]
  property: [SubstanceDefinitionProperty]
  molecularWeight: [SubstanceDefinitionMolecularWeight]
  structure: SubstanceDefinitionStructure
  code: [SubstanceDefinitionCode]
  name: [SubstanceDefinitionName]
  relationship: [SubstanceDefinitionRelationship]
  sourceMaterial: SubstanceDefinitionSourceMaterial
  text: Narrative
  contained: [Resource]
  extension: [Extension]
  modifierExtension: [Extension]
  id: String
  meta: Meta
  implicitRules: Uri
  language: String
}

Fields​

SubstanceDefinition.identifier ● [Identifier] list object​

Identifier by which this substance is known.

SubstanceDefinition.version ● String scalar​

A business level version identifier of the substance.

SubstanceDefinition.status ● CodeableConcept object​

Status of substance within the catalogue e.g. active, retired.

SubstanceDefinition.classification ● [CodeableConcept] list object​

A 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.domain ● CodeableConcept object​

If the substance applies to human or veterinary use.

SubstanceDefinition.grade ● [CodeableConcept] list object​

The quality standard, established benchmark, to which substance complies (e.g. USP/NF, Ph. Eur, JP, BP, Company Standard).

SubstanceDefinition.description ● String scalar​

Textual description of the substance.

SubstanceDefinition.informationSource ● [Reference] list object​

Supporting literature.

SubstanceDefinition.note ● [Annotation] list object​

Textual comment about the substance s catalogue or registry record.

SubstanceDefinition.manufacturer ● [Reference] list object​

The entity that creates, makes, produces or fabricates the substance. This is a set of potential manufacturers but is not necessarily comprehensive.

SubstanceDefinition.supplier ● [Reference] list object​

An entity that is the source for the substance. It may be different from the manufacturer. Supplier is synonymous to a distributor.

SubstanceDefinition.moiety ● [SubstanceDefinitionMoiety] list object​

Moiety, for structural modifications.

SubstanceDefinition.property ● [SubstanceDefinitionProperty] list object​

General specifications for this substance.

SubstanceDefinition.molecularWeight ● [SubstanceDefinitionMolecularWeight] list object​

The molecular weight or weight range (for proteins, polymers or nucleic acids).

SubstanceDefinition.structure ● SubstanceDefinitionStructure object​

Structural information.

SubstanceDefinition.code ● [SubstanceDefinitionCode] list object​

Codes associated with the substance.

SubstanceDefinition.name ● [SubstanceDefinitionName] list object​

Names applicable to this substance.

SubstanceDefinition.relationship ● [SubstanceDefinitionRelationship] list object​

A link between this substance and another, with details of the relationship.

SubstanceDefinition.sourceMaterial ● SubstanceDefinitionSourceMaterial object​

Material or taxonomic/anatomical source for the substance.

SubstanceDefinition.text ● Narrative object​

A 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.contained ● [Resource] list interface​

These 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.extension ● [Extension] list object​

May 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.modifierExtension ● [Extension] list object​

May 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.id ● String scalar​

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

SubstanceDefinition.meta ● Meta object​

The 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.implicitRules ● Uri scalar​

A 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.language ● String scalar​

The base language in which the resource is written.

Interfaces​

Resource interface​

This is the base resource type for everything.

Returned By​

SubstanceDefinition query ● SubstanceDefinitionCreate mutation ● SubstanceDefinitionList query ● SubstanceDefinitionUpdate mutation