This page is part of the FHIR Specification v4.3.0-snapshot1: R4B Snapshot to support the Jan 2022 Connectathon. About the R4B version of FHIR. The current officially released version is 4.3.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B
Biomedical Research and Regulation Work Group | Maturity Level: 1 | Trial Use | Security Category: Anonymous | Compartments: Not linked to any defined compartments |
The detailed description of a substance, typically at a level beyond what is used for prescribing.
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 .
This resource is referenced by ClinicalUseDefinition, Ingredient, MedicinalProductDefinition, PlanDefinition, RegulatedAuthorization and itself.
This resource does not implement any patterns.
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 identifier of the substance |
status | Σ | 0..1 | CodeableConcept | Status of substance within the catalogue e.g. approved |
classification | Σ | 0..* | CodeableConcept | 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) |
domain | Σ | 0..1 | CodeableConcept | If the substance applies to only human or veterinary use |
grade | Σ | 0..* | CodeableConcept | The quality standard, established benchmark, to which substance complies (e.g. USP/NF, Ph. Eur, JP, BP, Company Standard) |
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) | A company that makes this substance |
supplier | Σ | 0..* | Reference(Organization) | A company that supplies this substance |
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 |
opticalActivity | Σ | 0..1 | CodeableConcept | Optical activity type |
molecularFormula | Σ | 0..1 | string | Molecular formula for this moiety of this substance, typically using the Hill system |
amount[x] | Σ | 0..1 | Quantitative value for this moiety | |
amountQuantity | Quantity | |||
amountString | string | |||
amountType | Σ | 0..1 | CodeableConcept | The measurement type of the quantitative value |
property | Σ | 0..* | BackboneElement | General specifications for this substance |
type | Σ | 1..1 | CodeableConcept | A code expressing the type of characteristic |
value[x] | Σ | 0..1 | A value for the characteristic | |
valueCodeableConcept | CodeableConcept | |||
valueQuantity | Quantity | |||
valueDate | date | |||
valueBoolean | boolean | |||
valueAttachment | Attachment | |||
molecularWeight | Σ | 0..* | BackboneElement | The molecular weight or weight range (for proteins, polymers or nucleic acids) |
method | Σ | 0..1 | CodeableConcept | The method by which the molecular weight was determined |
type | Σ | 0..1 | CodeableConcept | Type of molecular weight such as exact, average (also known as. number average), weight average |
amount | Σ | 1..1 | Quantity | Used to capture quantitative values for a variety of elements. If only limits are given, the arithmetic mean would be the average. If only a single definite value for a given element is given, it would be captured in this field |
structure | Σ | 0..1 | BackboneElement | Structural information |
stereochemistry | Σ | 0..1 | CodeableConcept | Stereochemistry type |
opticalActivity | Σ | 0..1 | CodeableConcept | Optical activity type |
molecularFormula | Σ | 0..1 | string | Molecular formula of this substance, typically using the Hill system |
molecularFormulaByMoiety | Σ | 0..1 | string | Specified per moiety according to the Hill system, i.e. first C, then H, then alphabetical, each moiety separated by a dot |
molecularWeight | Σ | 0..1 | see molecularWeight | The molecular weight or weight range (for proteins, polymers or nucleic acids) |
technique | Σ | 0..* | CodeableConcept | The method used to elucidate the structure or characterization of the drug substance. Examples: X-ray, HPLC, NMR, Peptide mapping, Ligand binding assay |
sourceDocument | Σ | 0..* | Reference(DocumentReference) | Supporting literature about the source of information |
representation | Σ | 0..* | BackboneElement | A depiction of the structure or characterization of the substance |
type | Σ | 0..1 | CodeableConcept | The kind of structural representation (e.g. full, partial) or the technique used to derive the analytical characterization of the substance (e.g. x-ray, HPLC, NMR, peptide mapping, ligand binding assay, etc.) |
representation | Σ | 0..1 | string | The structural representation or characterization as a text string in a standard format |
format | Σ | 0..1 | CodeableConcept | The 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 |
document | Σ | 0..1 | Reference(DocumentReference) | An attached file with the structural representation or characterization e.g. a molecular structure graphic of the substance, a JCAMP 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' |
statusDate | Σ | 0..1 | dateTime | The date at which the code status is changed as part of the terminology maintenance |
note | Σ | 0..* | Annotation | Any comment can be provided in this field, if necessary |
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, for example 'systematic', 'scientific, 'brand' |
status | Σ | 0..1 | CodeableConcept | The status of the name, for example 'current', 'proposed' |
preferred | Σ | 0..1 | boolean | If this is the preferred name for this substance |
language | Σ | 0..* | CodeableConcept | Human language that the name is written in |
domain | Σ | 0..* | CodeableConcept | The use context of this name for example if there is a different name a drug active ingredient as opposed to a food colour additive |
jurisdiction | Σ | 0..* | CodeableConcept | The jurisdiction where this name applies |
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 |
status | Σ | 0..1 | CodeableConcept | The status of the official name, for example 'provisional', 'approved' |
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, with details of the relationship |
substanceDefinition[x] | Σ | 0..1 | A pointer to another substance, as a resource or just a representational code | |
substanceDefinitionReference | Reference(SubstanceDefinition) | |||
substanceDefinitionCodeableConcept | CodeableConcept | |||
type | Σ | 1..1 | CodeableConcept | For example "salt to parent", "active moiety", "starting material", "polymorph", "impurity of" |
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 substance relationships |
amount[x] | Σ | 0..1 | A numeric factor for the relationship, for instance to express that the salt of a substance has some percentage of the active substance in relation to some other | |
amountQuantity | Quantity | |||
amountRatio | Ratio | |||
amountString | string | |||
amountRatioHighLimit | Σ | 0..1 | Ratio | For use when the numeric has an uncertain range |
amountType | Σ | 0..1 | CodeableConcept | An operator for the amount, for example "average", "approximately", "less than" |
source | Σ | 0..* | Reference(DocumentReference) | Supporting literature |
sourceMaterial | Σ | 0..1 | BackboneElement | Material or taxonomic/anatomical source for the substance |
type | Σ | 0..1 | CodeableConcept | A classification that provides the origin of the raw material. Example: cat hair would be an Animal source type |
genus | Σ | 0..1 | CodeableConcept | The genus of an organism, typically referring to the Latin epithet of the genus element of the plant/animal scientific name |
species | Σ | 0..1 | CodeableConcept | The species of an organism, typically referring to the Latin epithet of the species of the plant/animal |
part | Σ | 0..1 | CodeableConcept | An anatomical origin of the source material within an organism |
countryOfOrigin | Σ | 0..* | CodeableConcept | The country or countries where the material is harvested |
Documentation for this format |
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 identifier of the substance --> <status><!-- 0..1 CodeableConcept Status of substance within the catalogue e.g. approved --></status> <classification><!-- 0..* CodeableConcept 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) --></classification> <domain><!-- 0..1 CodeableConcept If the substance applies to only human or veterinary use --></domain> <grade><!-- 0..* CodeableConcept The quality standard, established benchmark, to which substance complies (e.g. USP/NF, Ph. Eur, JP, BP, Company Standard) --></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) A company that makes this substance --></manufacturer> <supplier><!-- 0..* Reference(Organization) A company that supplies this substance --></supplier> <moiety> <!-- 0..* Moiety, for structural modifications --> <role><!-- 0..1 CodeableConcept Role that the moiety is playing --></role> <identifier><!-- 0..1 Identifier Identifier by which this moiety substance is known --></identifier> <name value="[string]"/><!-- 0..1 Textual name for this moiety substance --> <stereochemistry><!-- 0..1 CodeableConcept Stereochemistry type --></stereochemistry> <opticalActivity><!-- 0..1 CodeableConcept Optical activity type --></opticalActivity> <molecularFormula value="[string]"/><!-- 0..1 Molecular formula for this moiety of this substance, typically using the Hill system --> <amount[x]><!-- 0..1 Quantity|string Quantitative value for this moiety --></amount[x]> <amountType><!-- 0..1 CodeableConcept The measurement type of the quantitative value --></amountType> </moiety> <property> <!-- 0..* General specifications for this substance --> <type><!-- 1..1 CodeableConcept A code expressing the type of characteristic --></type> <value[x]><!-- 0..1 CodeableConcept|Quantity|date|boolean|Attachment A value for the characteristic --></value[x]> </property> <molecularWeight> <!-- 0..* The molecular weight or weight range (for proteins, polymers or nucleic acids) --> <method><!-- 0..1 CodeableConcept The method by which the molecular weight was determined --></method> <type><!-- 0..1 CodeableConcept Type of molecular weight such as exact, average (also known as. number average), weight average --></type> <amount><!-- 1..1 Quantity Used to capture quantitative values for a variety of elements. If only limits are given, the arithmetic mean would be the average. If only a single definite value for a given element is given, it would be captured in this field --></amount> </molecularWeight> <structure> <!-- 0..1 Structural information --> <stereochemistry><!-- 0..1 CodeableConcept Stereochemistry type --></stereochemistry> <opticalActivity><!-- 0..1 CodeableConcept Optical activity type --></opticalActivity> <molecularFormula value="[string]"/><!-- 0..1 Molecular formula of this substance, typically using the Hill system --> <molecularFormulaByMoiety value="[string]"/><!-- 0..1 Specified per moiety according to the Hill system, i.e. first C, then H, then alphabetical, each moiety separated by a dot --> <molecularWeight><!-- 0..1 Content as for SubstanceDefinition.molecularWeight The molecular weight or weight range (for proteins, polymers or nucleic acids) --></molecularWeight> <technique><!-- 0..* CodeableConcept The method used to elucidate the structure or characterization of the drug substance. Examples: X-ray, HPLC, NMR, Peptide mapping, Ligand binding assay --></technique> <sourceDocument><!-- 0..* Reference(DocumentReference) Supporting literature about the source of information --></sourceDocument> <representation> <!-- 0..* A depiction of the structure or characterization of the substance --> <type><!-- 0..1 CodeableConcept The kind of structural representation (e.g. full, partial) or the technique used to derive the analytical characterization of the substance (e.g. x-ray, HPLC, NMR, peptide mapping, ligand binding assay, etc.) --></type> <representation value="[string]"/><!-- 0..1 The structural representation or characterization as a text string in a standard format --> <format><!-- 0..1 CodeableConcept The 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 --></format> <document><!-- 0..1 Reference(DocumentReference) An attached file with the structural representation or characterization e.g. a molecular structure graphic of the substance, a JCAMP 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 is changed as part of the terminology maintenance --> <note><!-- 0..* Annotation Any comment can be provided in this field, if necessary --></note> <source><!-- 0..* Reference(DocumentReference) Supporting literature --></source> </code> <name> <!-- 0..* Names applicable to this substance --> <name value="[string]"/><!-- 1..1 The actual name --> <type><!-- 0..1 CodeableConcept Name type, for example 'systematic', 'scientific, 'brand' --></type> <status><!-- 0..1 CodeableConcept The status of the name, for example 'current', 'proposed' --></status> <preferred value="[boolean]"/><!-- 0..1 If this is the preferred name for this substance --> <language><!-- 0..* CodeableConcept Human language that the name is written in --></language> <domain><!-- 0..* CodeableConcept The use context of this name for example if there is a different name a drug active ingredient as opposed to a food colour additive --></domain> <jurisdiction><!-- 0..* CodeableConcept The jurisdiction where this name applies --></jurisdiction> <synonym><!-- 0..* Content as for SubstanceDefinition.name A synonym of this particular name, by which the substance is also known --></synonym> <translation><!-- 0..* Content as for SubstanceDefinition.name A translation for this name into another human language --></translation> <official> <!-- 0..* Details of the official nature of this name --> <authority><!-- 0..1 CodeableConcept Which authority uses this official name --></authority> <status><!-- 0..1 CodeableConcept The status of the official name, for example 'provisional', 'approved' --></status> <date value="[dateTime]"/><!-- 0..1 Date of official name change --> </official> <source><!-- 0..* Reference(DocumentReference) Supporting literature --></source> </name> <relationship> <!-- 0..* A link between this substance and another, with details of the relationship --> <substanceDefinition[x]><!-- 0..1 Reference(SubstanceDefinition)| CodeableConcept A pointer to another substance, as a resource or just a representational code --></substanceDefinition[x]> <type><!-- 1..1 CodeableConcept For example "salt to parent", "active moiety", "starting material", "polymorph", "impurity of" --></type> <isDefining value="[boolean]"/><!-- 0..1 For example where an enzyme strongly bonds with a particular substance, this is a defining relationship for that enzyme, out of several possible substance relationships --> <amount[x]><!-- 0..1 Quantity|Ratio|string A numeric factor for the relationship, for instance to express that the salt of a substance has some percentage of the active substance in relation to some other --></amount[x]> <amountRatioHighLimit><!-- 0..1 Ratio For use when the numeric has an uncertain range --></amountRatioHighLimit> <amountType><!-- 0..1 CodeableConcept An operator for the amount, for example "average", "approximately", "less than" --></amountType> <source><!-- 0..* Reference(DocumentReference) Supporting literature --></source> </relationship> <sourceMaterial> <!-- 0..1 Material or taxonomic/anatomical source for the substance --> <type><!-- 0..1 CodeableConcept A classification that provides the origin of the raw material. Example: cat hair would be an Animal source type --></type> <genus><!-- 0..1 CodeableConcept The genus of an organism, typically referring to the Latin epithet of the genus element of the plant/animal scientific name --></genus> <species><!-- 0..1 CodeableConcept The species of an organism, typically referring to 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 identifier of the substance "status" : { CodeableConcept }, // Status of substance within the catalogue e.g. approved "classification" : [{ CodeableConcept }], // 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) "domain" : { CodeableConcept }, // If the substance applies to only human or veterinary use "grade" : [{ CodeableConcept }], // The quality standard, established benchmark, to which substance complies (e.g. USP/NF, Ph. Eur, JP, BP, Company Standard) "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) }], // A company that makes this substance "supplier" : [{ Reference(Organization) }], // A company that supplies this substance "moiety" : [{ // Moiety, for structural modifications "role" : { CodeableConcept }, // Role that the moiety is playing "identifier" : { Identifier }, // Identifier by which this moiety substance is known "name" : "<string>", // Textual name for this moiety substance "stereochemistry" : { CodeableConcept }, // Stereochemistry type "opticalActivity" : { CodeableConcept }, // Optical activity type "molecularFormula" : "<string>", // Molecular formula for this moiety of this substance, typically using the Hill system // amount[x]: Quantitative value for this moiety. One of these 2: "amountQuantity" : { Quantity }, "amountString" : "<string>", "amountType" : { CodeableConcept } // The measurement type of the quantitative value }], "property" : [{ // General specifications for this substance "type" : { CodeableConcept }, // R! A code expressing the type of characteristic // value[x]: A value for the characteristic. One of these 5: "valueCodeableConcept" : { CodeableConcept } "valueQuantity" : { Quantity } "valueDate" : "<date>" "valueBoolean" : <boolean> "valueAttachment" : { Attachment } }], "molecularWeight" : [{ // The molecular weight or weight range (for proteins, polymers or nucleic acids) "method" : { CodeableConcept }, // The method by which the molecular weight was determined "type" : { CodeableConcept }, // Type of molecular weight such as exact, average (also known as. number average), weight average "amount" : { Quantity } // R! Used to capture quantitative values for a variety of elements. If only limits are given, the arithmetic mean would be the average. If only a single definite value for a given element is given, it would be captured in this field }], "structure" : { // Structural information "stereochemistry" : { CodeableConcept }, // Stereochemistry type "opticalActivity" : { CodeableConcept }, // Optical activity type "molecularFormula" : "<string>", // Molecular formula of this substance, typically using the Hill system "molecularFormulaByMoiety" : "<string>", // Specified per moiety according to the Hill system, i.e. first C, then H, then alphabetical, each moiety separated by a dot "molecularWeight" : { Content as for SubstanceDefinition.molecularWeight }, // The molecular weight or weight range (for proteins, polymers or nucleic acids) "technique" : [{ CodeableConcept }], // The method used to elucidate the structure or characterization of the drug substance. Examples: X-ray, HPLC, NMR, Peptide mapping, Ligand binding assay "sourceDocument" : [{ Reference(DocumentReference) }], // Supporting literature about the source of information "representation" : [{ // A depiction of the structure or characterization of the substance "type" : { CodeableConcept }, // The kind of structural representation (e.g. full, partial) or the technique used to derive the analytical characterization of the substance (e.g. x-ray, HPLC, NMR, peptide mapping, ligand binding assay, etc.) "representation" : "<string>", // The structural representation or characterization as a text string in a standard format "format" : { CodeableConcept }, // The 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 "document" : { Reference(DocumentReference) } // An attached file with the structural representation or characterization e.g. a molecular structure graphic of the substance, a JCAMP 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 is changed as part of the terminology maintenance "note" : [{ Annotation }], // Any comment can be provided in this field, if necessary "source" : [{ Reference(DocumentReference) }] // Supporting literature }], "name" : [{ // Names applicable to this substance "name" : "<string>", // R! The actual name "type" : { CodeableConcept }, // Name type, for example 'systematic', 'scientific, 'brand' "status" : { CodeableConcept }, // The status of the name, for example 'current', 'proposed' "preferred" : <boolean>, // If this is the preferred name for this substance "language" : [{ CodeableConcept }], // Human language that the name is written in "domain" : [{ CodeableConcept }], // The use context of this name for example if there is a different name a drug active ingredient as opposed to a food colour additive "jurisdiction" : [{ CodeableConcept }], // The jurisdiction where this name applies "synonym" : [{ Content as for SubstanceDefinition.name }], // A synonym of this particular name, by which the substance is also known "translation" : [{ Content as for SubstanceDefinition.name }], // A translation for this name into another human language "official" : [{ // Details of the official nature of this name "authority" : { CodeableConcept }, // Which authority uses this official name "status" : { CodeableConcept }, // The status of the official name, for example 'provisional', 'approved' "date" : "<dateTime>" // Date of official name change }], "source" : [{ Reference(DocumentReference) }] // Supporting literature }], "relationship" : [{ // A link between this substance and another, with details of the relationship // substanceDefinition[x]: A pointer to another substance, as a resource or just a representational code. One of these 2: "substanceDefinitionReference" : { Reference(SubstanceDefinition) }, "substanceDefinitionCodeableConcept" : { CodeableConcept }, "type" : { CodeableConcept }, // R! For example "salt to parent", "active moiety", "starting material", "polymorph", "impurity of" "isDefining" : <boolean>, // For example where an enzyme strongly bonds with a particular substance, this is a defining relationship for that enzyme, out of several possible substance relationships // amount[x]: A numeric factor for the relationship, for instance to express that the salt of a substance has some percentage of the active substance in relation to some other. One of these 3: "amountQuantity" : { Quantity }, "amountRatio" : { Ratio }, "amountString" : "<string>", "amountRatioHighLimit" : { Ratio }, // For use when the numeric has an uncertain range "amountType" : { CodeableConcept }, // An operator for the amount, for example "average", "approximately", "less than" "source" : [{ Reference(DocumentReference) }] // Supporting literature }], "sourceMaterial" : { // Material or taxonomic/anatomical source for the substance "type" : { CodeableConcept }, // A classification that provides the origin of the raw material. Example: cat hair would be an Animal source type "genus" : { CodeableConcept }, // The genus of an organism, typically referring to the Latin epithet of the genus element of the plant/animal scientific name "species" : { CodeableConcept }, // The species of an organism, typically referring to 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:SubstanceDefinition.identifier [ Identifier ], ... ; # 0..* Identifier by which this substance is known fhir:SubstanceDefinition.version [ string ]; # 0..1 A business level identifier of the substance fhir:SubstanceDefinition.status [ CodeableConcept ]; # 0..1 Status of substance within the catalogue e.g. approved fhir:SubstanceDefinition.classification [ CodeableConcept ], ... ; # 0..* 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) fhir:SubstanceDefinition.domain [ CodeableConcept ]; # 0..1 If the substance applies to only human or veterinary use fhir:SubstanceDefinition.grade [ CodeableConcept ], ... ; # 0..* The quality standard, established benchmark, to which substance complies (e.g. USP/NF, Ph. Eur, JP, BP, Company Standard) fhir:SubstanceDefinition.description [ markdown ]; # 0..1 Textual description of the substance fhir:SubstanceDefinition.informationSource [ Reference(Citation) ], ... ; # 0..* Supporting literature fhir:SubstanceDefinition.note [ Annotation ], ... ; # 0..* Textual comment about the substance's catalogue or registry record fhir:SubstanceDefinition.manufacturer [ Reference(Organization) ], ... ; # 0..* A company that makes this substance fhir:SubstanceDefinition.supplier [ Reference(Organization) ], ... ; # 0..* A company that supplies this substance fhir:SubstanceDefinition.moiety [ # 0..* Moiety, for structural modifications fhir:SubstanceDefinition.moiety.role [ CodeableConcept ]; # 0..1 Role that the moiety is playing fhir:SubstanceDefinition.moiety.identifier [ Identifier ]; # 0..1 Identifier by which this moiety substance is known fhir:SubstanceDefinition.moiety.name [ string ]; # 0..1 Textual name for this moiety substance fhir:SubstanceDefinition.moiety.stereochemistry [ CodeableConcept ]; # 0..1 Stereochemistry type fhir:SubstanceDefinition.moiety.opticalActivity [ CodeableConcept ]; # 0..1 Optical activity type fhir:SubstanceDefinition.moiety.molecularFormula [ string ]; # 0..1 Molecular formula for this moiety of this substance, typically using the Hill system # SubstanceDefinition.moiety.amount[x] : 0..1 Quantitative value for this moiety. One of these 2 fhir:SubstanceDefinition.moiety.amountQuantity [ Quantity ] fhir:SubstanceDefinition.moiety.amountString [ string ] fhir:SubstanceDefinition.moiety.amountType [ CodeableConcept ]; # 0..1 The measurement type of the quantitative value ], ...; fhir:SubstanceDefinition.property [ # 0..* General specifications for this substance fhir:SubstanceDefinition.property.type [ CodeableConcept ]; # 1..1 A code expressing the type of characteristic # SubstanceDefinition.property.value[x] : 0..1 A value for the characteristic. One of these 5 fhir:SubstanceDefinition.property.valueCodeableConcept [ CodeableConcept ] fhir:SubstanceDefinition.property.valueQuantity [ Quantity ] fhir:SubstanceDefinition.property.valueDate [ date ] fhir:SubstanceDefinition.property.valueBoolean [ boolean ] fhir:SubstanceDefinition.property.valueAttachment [ Attachment ] ], ...; fhir:SubstanceDefinition.molecularWeight [ # 0..* The molecular weight or weight range (for proteins, polymers or nucleic acids) fhir:SubstanceDefinition.molecularWeight.method [ CodeableConcept ]; # 0..1 The method by which the molecular weight was determined fhir:SubstanceDefinition.molecularWeight.type [ CodeableConcept ]; # 0..1 Type of molecular weight such as exact, average (also known as. number average), weight average fhir:SubstanceDefinition.molecularWeight.amount [ Quantity ]; # 1..1 Used to capture quantitative values for a variety of elements. If only limits are given, the arithmetic mean would be the average. If only a single definite value for a given element is given, it would be captured in this field ], ...; fhir:SubstanceDefinition.structure [ # 0..1 Structural information fhir:SubstanceDefinition.structure.stereochemistry [ CodeableConcept ]; # 0..1 Stereochemistry type fhir:SubstanceDefinition.structure.opticalActivity [ CodeableConcept ]; # 0..1 Optical activity type fhir:SubstanceDefinition.structure.molecularFormula [ string ]; # 0..1 Molecular formula of this substance, typically using the Hill system fhir:SubstanceDefinition.structure.molecularFormulaByMoiety [ string ]; # 0..1 Specified per moiety according to the Hill system, i.e. first C, then H, then alphabetical, each moiety separated by a dot fhir:SubstanceDefinition.structure.molecularWeight [ See SubstanceDefinition.molecularWeight ]; # 0..1 The molecular weight or weight range (for proteins, polymers or nucleic acids) fhir:SubstanceDefinition.structure.technique [ CodeableConcept ], ... ; # 0..* The method used to elucidate the structure or characterization of the drug substance. Examples: X-ray, HPLC, NMR, Peptide mapping, Ligand binding assay fhir:SubstanceDefinition.structure.sourceDocument [ Reference(DocumentReference) ], ... ; # 0..* Supporting literature about the source of information fhir:SubstanceDefinition.structure.representation [ # 0..* A depiction of the structure or characterization of the substance fhir:SubstanceDefinition.structure.representation.type [ CodeableConcept ]; # 0..1 The kind of structural representation (e.g. full, partial) or the technique used to derive the analytical characterization of the substance (e.g. x-ray, HPLC, NMR, peptide mapping, ligand binding assay, etc.) fhir:SubstanceDefinition.structure.representation.representation [ string ]; # 0..1 The structural representation or characterization as a text string in a standard format fhir:SubstanceDefinition.structure.representation.format [ CodeableConcept ]; # 0..1 The 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 fhir:SubstanceDefinition.structure.representation.document [ Reference(DocumentReference) ]; # 0..1 An attached file with the structural representation or characterization e.g. a molecular structure graphic of the substance, a JCAMP or AnIML file ], ...; ]; fhir:SubstanceDefinition.code [ # 0..* Codes associated with the substance fhir:SubstanceDefinition.code.code [ CodeableConcept ]; # 0..1 The specific code fhir:SubstanceDefinition.code.status [ CodeableConcept ]; # 0..1 Status of the code assignment, for example 'provisional', 'approved' fhir:SubstanceDefinition.code.statusDate [ dateTime ]; # 0..1 The date at which the code status is changed as part of the terminology maintenance fhir:SubstanceDefinition.code.note [ Annotation ], ... ; # 0..* Any comment can be provided in this field, if necessary fhir:SubstanceDefinition.code.source [ Reference(DocumentReference) ], ... ; # 0..* Supporting literature ], ...; fhir:SubstanceDefinition.name [ # 0..* Names applicable to this substance fhir:SubstanceDefinition.name.name [ string ]; # 1..1 The actual name fhir:SubstanceDefinition.name.type [ CodeableConcept ]; # 0..1 Name type, for example 'systematic', 'scientific, 'brand' fhir:SubstanceDefinition.name.status [ CodeableConcept ]; # 0..1 The status of the name, for example 'current', 'proposed' fhir:SubstanceDefinition.name.preferred [ boolean ]; # 0..1 If this is the preferred name for this substance fhir:SubstanceDefinition.name.language [ CodeableConcept ], ... ; # 0..* Human language that the name is written in fhir:SubstanceDefinition.name.domain [ CodeableConcept ], ... ; # 0..* The use context of this name for example if there is a different name a drug active ingredient as opposed to a food colour additive fhir:SubstanceDefinition.name.jurisdiction [ CodeableConcept ], ... ; # 0..* The jurisdiction where this name applies fhir:SubstanceDefinition.name.synonym [ See SubstanceDefinition.name ], ... ; # 0..* A synonym of this particular name, by which the substance is also known fhir:SubstanceDefinition.name.translation [ See SubstanceDefinition.name ], ... ; # 0..* A translation for this name into another human language fhir:SubstanceDefinition.name.official [ # 0..* Details of the official nature of this name fhir:SubstanceDefinition.name.official.authority [ CodeableConcept ]; # 0..1 Which authority uses this official name fhir:SubstanceDefinition.name.official.status [ CodeableConcept ]; # 0..1 The status of the official name, for example 'provisional', 'approved' fhir:SubstanceDefinition.name.official.date [ dateTime ]; # 0..1 Date of official name change ], ...; fhir:SubstanceDefinition.name.source [ Reference(DocumentReference) ], ... ; # 0..* Supporting literature ], ...; fhir:SubstanceDefinition.relationship [ # 0..* A link between this substance and another, with details of the relationship # SubstanceDefinition.relationship.substanceDefinition[x] : 0..1 A pointer to another substance, as a resource or just a representational code. One of these 2 fhir:SubstanceDefinition.relationship.substanceDefinitionReference [ Reference(SubstanceDefinition) ] fhir:SubstanceDefinition.relationship.substanceDefinitionCodeableConcept [ CodeableConcept ] fhir:SubstanceDefinition.relationship.type [ CodeableConcept ]; # 1..1 For example "salt to parent", "active moiety", "starting material", "polymorph", "impurity of" fhir:SubstanceDefinition.relationship.isDefining [ boolean ]; # 0..1 For example where an enzyme strongly bonds with a particular substance, this is a defining relationship for that enzyme, out of several possible substance relationships # SubstanceDefinition.relationship.amount[x] : 0..1 A numeric factor for the relationship, for instance to express that the salt of a substance has some percentage of the active substance in relation to some other. One of these 3 fhir:SubstanceDefinition.relationship.amountQuantity [ Quantity ] fhir:SubstanceDefinition.relationship.amountRatio [ Ratio ] fhir:SubstanceDefinition.relationship.amountString [ string ] fhir:SubstanceDefinition.relationship.amountRatioHighLimit [ Ratio ]; # 0..1 For use when the numeric has an uncertain range fhir:SubstanceDefinition.relationship.amountType [ CodeableConcept ]; # 0..1 An operator for the amount, for example "average", "approximately", "less than" fhir:SubstanceDefinition.relationship.source [ Reference(DocumentReference) ], ... ; # 0..* Supporting literature ], ...; fhir:SubstanceDefinition.sourceMaterial [ # 0..1 Material or taxonomic/anatomical source for the substance fhir:SubstanceDefinition.sourceMaterial.type [ CodeableConcept ]; # 0..1 A classification that provides the origin of the raw material. Example: cat hair would be an Animal source type fhir:SubstanceDefinition.sourceMaterial.genus [ CodeableConcept ]; # 0..1 The genus of an organism, typically referring to the Latin epithet of the genus element of the plant/animal scientific name fhir:SubstanceDefinition.sourceMaterial.species [ CodeableConcept ]; # 0..1 The species of an organism, typically referring to the Latin epithet of the species of the plant/animal fhir:SubstanceDefinition.sourceMaterial.part [ CodeableConcept ]; # 0..1 An anatomical origin of the source material within an organism fhir:SubstanceDefinition.sourceMaterial.countryOfOrigin [ CodeableConcept ], ... ; # 0..* The country or countries where the material is harvested ]; ]
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 identifier of the substance |
status | Σ | 0..1 | CodeableConcept | Status of substance within the catalogue e.g. approved |
classification | Σ | 0..* | CodeableConcept | 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) |
domain | Σ | 0..1 | CodeableConcept | If the substance applies to only human or veterinary use |
grade | Σ | 0..* | CodeableConcept | The quality standard, established benchmark, to which substance complies (e.g. USP/NF, Ph. Eur, JP, BP, Company Standard) |
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) | A company that makes this substance |
supplier | Σ | 0..* | Reference(Organization) | A company that supplies this substance |
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 |
opticalActivity | Σ | 0..1 | CodeableConcept | Optical activity type |
molecularFormula | Σ | 0..1 | string | Molecular formula for this moiety of this substance, typically using the Hill system |
amount[x] | Σ | 0..1 | Quantitative value for this moiety | |
amountQuantity | Quantity | |||
amountString | string | |||
amountType | Σ | 0..1 | CodeableConcept | The measurement type of the quantitative value |
property | Σ | 0..* | BackboneElement | General specifications for this substance |
type | Σ | 1..1 | CodeableConcept | A code expressing the type of characteristic |
value[x] | Σ | 0..1 | A value for the characteristic | |
valueCodeableConcept | CodeableConcept | |||
valueQuantity | Quantity | |||
valueDate | date | |||
valueBoolean | boolean | |||
valueAttachment | Attachment | |||
molecularWeight | Σ | 0..* | BackboneElement | The molecular weight or weight range (for proteins, polymers or nucleic acids) |
method | Σ | 0..1 | CodeableConcept | The method by which the molecular weight was determined |
type | Σ | 0..1 | CodeableConcept | Type of molecular weight such as exact, average (also known as. number average), weight average |
amount | Σ | 1..1 | Quantity | Used to capture quantitative values for a variety of elements. If only limits are given, the arithmetic mean would be the average. If only a single definite value for a given element is given, it would be captured in this field |
structure | Σ | 0..1 | BackboneElement | Structural information |
stereochemistry | Σ | 0..1 | CodeableConcept | Stereochemistry type |
opticalActivity | Σ | 0..1 | CodeableConcept | Optical activity type |
molecularFormula | Σ | 0..1 | string | Molecular formula of this substance, typically using the Hill system |
molecularFormulaByMoiety | Σ | 0..1 | string | Specified per moiety according to the Hill system, i.e. first C, then H, then alphabetical, each moiety separated by a dot |
molecularWeight | Σ | 0..1 | see molecularWeight | The molecular weight or weight range (for proteins, polymers or nucleic acids) |
technique | Σ | 0..* | CodeableConcept | The method used to elucidate the structure or characterization of the drug substance. Examples: X-ray, HPLC, NMR, Peptide mapping, Ligand binding assay |
sourceDocument | Σ | 0..* | Reference(DocumentReference) | Supporting literature about the source of information |
representation | Σ | 0..* | BackboneElement | A depiction of the structure or characterization of the substance |
type | Σ | 0..1 | CodeableConcept | The kind of structural representation (e.g. full, partial) or the technique used to derive the analytical characterization of the substance (e.g. x-ray, HPLC, NMR, peptide mapping, ligand binding assay, etc.) |
representation | Σ | 0..1 | string | The structural representation or characterization as a text string in a standard format |
format | Σ | 0..1 | CodeableConcept | The 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 |
document | Σ | 0..1 | Reference(DocumentReference) | An attached file with the structural representation or characterization e.g. a molecular structure graphic of the substance, a JCAMP 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' |
statusDate | Σ | 0..1 | dateTime | The date at which the code status is changed as part of the terminology maintenance |
note | Σ | 0..* | Annotation | Any comment can be provided in this field, if necessary |
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, for example 'systematic', 'scientific, 'brand' |
status | Σ | 0..1 | CodeableConcept | The status of the name, for example 'current', 'proposed' |
preferred | Σ | 0..1 | boolean | If this is the preferred name for this substance |
language | Σ | 0..* | CodeableConcept | Human language that the name is written in |
domain | Σ | 0..* | CodeableConcept | The use context of this name for example if there is a different name a drug active ingredient as opposed to a food colour additive |
jurisdiction | Σ | 0..* | CodeableConcept | The jurisdiction where this name applies |
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 |
status | Σ | 0..1 | CodeableConcept | The status of the official name, for example 'provisional', 'approved' |
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, with details of the relationship |
substanceDefinition[x] | Σ | 0..1 | A pointer to another substance, as a resource or just a representational code | |
substanceDefinitionReference | Reference(SubstanceDefinition) | |||
substanceDefinitionCodeableConcept | CodeableConcept | |||
type | Σ | 1..1 | CodeableConcept | For example "salt to parent", "active moiety", "starting material", "polymorph", "impurity of" |
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 substance relationships |
amount[x] | Σ | 0..1 | A numeric factor for the relationship, for instance to express that the salt of a substance has some percentage of the active substance in relation to some other | |
amountQuantity | Quantity | |||
amountRatio | Ratio | |||
amountString | string | |||
amountRatioHighLimit | Σ | 0..1 | Ratio | For use when the numeric has an uncertain range |
amountType | Σ | 0..1 | CodeableConcept | An operator for the amount, for example "average", "approximately", "less than" |
source | Σ | 0..* | Reference(DocumentReference) | Supporting literature |
sourceMaterial | Σ | 0..1 | BackboneElement | Material or taxonomic/anatomical source for the substance |
type | Σ | 0..1 | CodeableConcept | A classification that provides the origin of the raw material. Example: cat hair would be an Animal source type |
genus | Σ | 0..1 | CodeableConcept | The genus of an organism, typically referring to the Latin epithet of the genus element of the plant/animal scientific name |
species | Σ | 0..1 | CodeableConcept | The species of an organism, typically referring to the Latin epithet of the species of the plant/animal |
part | Σ | 0..1 | CodeableConcept | An anatomical origin of the source material within an organism |
countryOfOrigin | Σ | 0..* | CodeableConcept | The country or countries where the material is harvested |
Documentation for this format |
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 identifier of the substance --> <status><!-- 0..1 CodeableConcept Status of substance within the catalogue e.g. approved --></status> <classification><!-- 0..* CodeableConcept 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) --></classification> <domain><!-- 0..1 CodeableConcept If the substance applies to only human or veterinary use --></domain> <grade><!-- 0..* CodeableConcept The quality standard, established benchmark, to which substance complies (e.g. USP/NF, Ph. Eur, JP, BP, Company Standard) --></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) A company that makes this substance --></manufacturer> <supplier><!-- 0..* Reference(Organization) A company that supplies this substance --></supplier> <moiety> <!-- 0..* Moiety, for structural modifications --> <role><!-- 0..1 CodeableConcept Role that the moiety is playing --></role> <identifier><!-- 0..1 Identifier Identifier by which this moiety substance is known --></identifier> <name value="[string]"/><!-- 0..1 Textual name for this moiety substance --> <stereochemistry><!-- 0..1 CodeableConcept Stereochemistry type --></stereochemistry> <opticalActivity><!-- 0..1 CodeableConcept Optical activity type --></opticalActivity> <molecularFormula value="[string]"/><!-- 0..1 Molecular formula for this moiety of this substance, typically using the Hill system --> <amount[x]><!-- 0..1 Quantity|string Quantitative value for this moiety --></amount[x]> <amountType><!-- 0..1 CodeableConcept The measurement type of the quantitative value --></amountType> </moiety> <property> <!-- 0..* General specifications for this substance --> <type><!-- 1..1 CodeableConcept A code expressing the type of characteristic --></type> <value[x]><!-- 0..1 CodeableConcept|Quantity|date|boolean|Attachment A value for the characteristic --></value[x]> </property> <molecularWeight> <!-- 0..* The molecular weight or weight range (for proteins, polymers or nucleic acids) --> <method><!-- 0..1 CodeableConcept The method by which the molecular weight was determined --></method> <type><!-- 0..1 CodeableConcept Type of molecular weight such as exact, average (also known as. number average), weight average --></type> <amount><!-- 1..1 Quantity Used to capture quantitative values for a variety of elements. If only limits are given, the arithmetic mean would be the average. If only a single definite value for a given element is given, it would be captured in this field --></amount> </molecularWeight> <structure> <!-- 0..1 Structural information --> <stereochemistry><!-- 0..1 CodeableConcept Stereochemistry type --></stereochemistry> <opticalActivity><!-- 0..1 CodeableConcept Optical activity type --></opticalActivity> <molecularFormula value="[string]"/><!-- 0..1 Molecular formula of this substance, typically using the Hill system --> <molecularFormulaByMoiety value="[string]"/><!-- 0..1 Specified per moiety according to the Hill system, i.e. first C, then H, then alphabetical, each moiety separated by a dot --> <molecularWeight><!-- 0..1 Content as for SubstanceDefinition.molecularWeight The molecular weight or weight range (for proteins, polymers or nucleic acids) --></molecularWeight> <technique><!-- 0..* CodeableConcept The method used to elucidate the structure or characterization of the drug substance. Examples: X-ray, HPLC, NMR, Peptide mapping, Ligand binding assay --></technique> <sourceDocument><!-- 0..* Reference(DocumentReference) Supporting literature about the source of information --></sourceDocument> <representation> <!-- 0..* A depiction of the structure or characterization of the substance --> <type><!-- 0..1 CodeableConcept The kind of structural representation (e.g. full, partial) or the technique used to derive the analytical characterization of the substance (e.g. x-ray, HPLC, NMR, peptide mapping, ligand binding assay, etc.) --></type> <representation value="[string]"/><!-- 0..1 The structural representation or characterization as a text string in a standard format --> <format><!-- 0..1 CodeableConcept The 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 --></format> <document><!-- 0..1 Reference(DocumentReference) An attached file with the structural representation or characterization e.g. a molecular structure graphic of the substance, a JCAMP 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 is changed as part of the terminology maintenance --> <note><!-- 0..* Annotation Any comment can be provided in this field, if necessary --></note> <source><!-- 0..* Reference(DocumentReference) Supporting literature --></source> </code> <name> <!-- 0..* Names applicable to this substance --> <name value="[string]"/><!-- 1..1 The actual name --> <type><!-- 0..1 CodeableConcept Name type, for example 'systematic', 'scientific, 'brand' --></type> <status><!-- 0..1 CodeableConcept The status of the name, for example 'current', 'proposed' --></status> <preferred value="[boolean]"/><!-- 0..1 If this is the preferred name for this substance --> <language><!-- 0..* CodeableConcept Human language that the name is written in --></language> <domain><!-- 0..* CodeableConcept The use context of this name for example if there is a different name a drug active ingredient as opposed to a food colour additive --></domain> <jurisdiction><!-- 0..* CodeableConcept The jurisdiction where this name applies --></jurisdiction> <synonym><!-- 0..* Content as for SubstanceDefinition.name A synonym of this particular name, by which the substance is also known --></synonym> <translation><!-- 0..* Content as for SubstanceDefinition.name A translation for this name into another human language --></translation> <official> <!-- 0..* Details of the official nature of this name --> <authority><!-- 0..1 CodeableConcept Which authority uses this official name --></authority> <status><!-- 0..1 CodeableConcept The status of the official name, for example 'provisional', 'approved' --></status> <date value="[dateTime]"/><!-- 0..1 Date of official name change --> </official> <source><!-- 0..* Reference(DocumentReference) Supporting literature --></source> </name> <relationship> <!-- 0..* A link between this substance and another, with details of the relationship --> <substanceDefinition[x]><!-- 0..1 Reference(SubstanceDefinition)| CodeableConcept A pointer to another substance, as a resource or just a representational code --></substanceDefinition[x]> <type><!-- 1..1 CodeableConcept For example "salt to parent", "active moiety", "starting material", "polymorph", "impurity of" --></type> <isDefining value="[boolean]"/><!-- 0..1 For example where an enzyme strongly bonds with a particular substance, this is a defining relationship for that enzyme, out of several possible substance relationships --> <amount[x]><!-- 0..1 Quantity|Ratio|string A numeric factor for the relationship, for instance to express that the salt of a substance has some percentage of the active substance in relation to some other --></amount[x]> <amountRatioHighLimit><!-- 0..1 Ratio For use when the numeric has an uncertain range --></amountRatioHighLimit> <amountType><!-- 0..1 CodeableConcept An operator for the amount, for example "average", "approximately", "less than" --></amountType> <source><!-- 0..* Reference(DocumentReference) Supporting literature --></source> </relationship> <sourceMaterial> <!-- 0..1 Material or taxonomic/anatomical source for the substance --> <type><!-- 0..1 CodeableConcept A classification that provides the origin of the raw material. Example: cat hair would be an Animal source type --></type> <genus><!-- 0..1 CodeableConcept The genus of an organism, typically referring to the Latin epithet of the genus element of the plant/animal scientific name --></genus> <species><!-- 0..1 CodeableConcept The species of an organism, typically referring to 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 identifier of the substance "status" : { CodeableConcept }, // Status of substance within the catalogue e.g. approved "classification" : [{ CodeableConcept }], // 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) "domain" : { CodeableConcept }, // If the substance applies to only human or veterinary use "grade" : [{ CodeableConcept }], // The quality standard, established benchmark, to which substance complies (e.g. USP/NF, Ph. Eur, JP, BP, Company Standard) "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) }], // A company that makes this substance "supplier" : [{ Reference(Organization) }], // A company that supplies this substance "moiety" : [{ // Moiety, for structural modifications "role" : { CodeableConcept }, // Role that the moiety is playing "identifier" : { Identifier }, // Identifier by which this moiety substance is known "name" : "<string>", // Textual name for this moiety substance "stereochemistry" : { CodeableConcept }, // Stereochemistry type "opticalActivity" : { CodeableConcept }, // Optical activity type "molecularFormula" : "<string>", // Molecular formula for this moiety of this substance, typically using the Hill system // amount[x]: Quantitative value for this moiety. One of these 2: "amountQuantity" : { Quantity }, "amountString" : "<string>", "amountType" : { CodeableConcept } // The measurement type of the quantitative value }], "property" : [{ // General specifications for this substance "type" : { CodeableConcept }, // R! A code expressing the type of characteristic // value[x]: A value for the characteristic. One of these 5: "valueCodeableConcept" : { CodeableConcept } "valueQuantity" : { Quantity } "valueDate" : "<date>" "valueBoolean" : <boolean> "valueAttachment" : { Attachment } }], "molecularWeight" : [{ // The molecular weight or weight range (for proteins, polymers or nucleic acids) "method" : { CodeableConcept }, // The method by which the molecular weight was determined "type" : { CodeableConcept }, // Type of molecular weight such as exact, average (also known as. number average), weight average "amount" : { Quantity } // R! Used to capture quantitative values for a variety of elements. If only limits are given, the arithmetic mean would be the average. If only a single definite value for a given element is given, it would be captured in this field }], "structure" : { // Structural information "stereochemistry" : { CodeableConcept }, // Stereochemistry type "opticalActivity" : { CodeableConcept }, // Optical activity type "molecularFormula" : "<string>", // Molecular formula of this substance, typically using the Hill system "molecularFormulaByMoiety" : "<string>", // Specified per moiety according to the Hill system, i.e. first C, then H, then alphabetical, each moiety separated by a dot "molecularWeight" : { Content as for SubstanceDefinition.molecularWeight }, // The molecular weight or weight range (for proteins, polymers or nucleic acids) "technique" : [{ CodeableConcept }], // The method used to elucidate the structure or characterization of the drug substance. Examples: X-ray, HPLC, NMR, Peptide mapping, Ligand binding assay "sourceDocument" : [{ Reference(DocumentReference) }], // Supporting literature about the source of information "representation" : [{ // A depiction of the structure or characterization of the substance "type" : { CodeableConcept }, // The kind of structural representation (e.g. full, partial) or the technique used to derive the analytical characterization of the substance (e.g. x-ray, HPLC, NMR, peptide mapping, ligand binding assay, etc.) "representation" : "<string>", // The structural representation or characterization as a text string in a standard format "format" : { CodeableConcept }, // The 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 "document" : { Reference(DocumentReference) } // An attached file with the structural representation or characterization e.g. a molecular structure graphic of the substance, a JCAMP 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 is changed as part of the terminology maintenance "note" : [{ Annotation }], // Any comment can be provided in this field, if necessary "source" : [{ Reference(DocumentReference) }] // Supporting literature }], "name" : [{ // Names applicable to this substance "name" : "<string>", // R! The actual name "type" : { CodeableConcept }, // Name type, for example 'systematic', 'scientific, 'brand' "status" : { CodeableConcept }, // The status of the name, for example 'current', 'proposed' "preferred" : <boolean>, // If this is the preferred name for this substance "language" : [{ CodeableConcept }], // Human language that the name is written in "domain" : [{ CodeableConcept }], // The use context of this name for example if there is a different name a drug active ingredient as opposed to a food colour additive "jurisdiction" : [{ CodeableConcept }], // The jurisdiction where this name applies "synonym" : [{ Content as for SubstanceDefinition.name }], // A synonym of this particular name, by which the substance is also known "translation" : [{ Content as for SubstanceDefinition.name }], // A translation for this name into another human language "official" : [{ // Details of the official nature of this name "authority" : { CodeableConcept }, // Which authority uses this official name "status" : { CodeableConcept }, // The status of the official name, for example 'provisional', 'approved' "date" : "<dateTime>" // Date of official name change }], "source" : [{ Reference(DocumentReference) }] // Supporting literature }], "relationship" : [{ // A link between this substance and another, with details of the relationship // substanceDefinition[x]: A pointer to another substance, as a resource or just a representational code. One of these 2: "substanceDefinitionReference" : { Reference(SubstanceDefinition) }, "substanceDefinitionCodeableConcept" : { CodeableConcept }, "type" : { CodeableConcept }, // R! For example "salt to parent", "active moiety", "starting material", "polymorph", "impurity of" "isDefining" : <boolean>, // For example where an enzyme strongly bonds with a particular substance, this is a defining relationship for that enzyme, out of several possible substance relationships // amount[x]: A numeric factor for the relationship, for instance to express that the salt of a substance has some percentage of the active substance in relation to some other. One of these 3: "amountQuantity" : { Quantity }, "amountRatio" : { Ratio }, "amountString" : "<string>", "amountRatioHighLimit" : { Ratio }, // For use when the numeric has an uncertain range "amountType" : { CodeableConcept }, // An operator for the amount, for example "average", "approximately", "less than" "source" : [{ Reference(DocumentReference) }] // Supporting literature }], "sourceMaterial" : { // Material or taxonomic/anatomical source for the substance "type" : { CodeableConcept }, // A classification that provides the origin of the raw material. Example: cat hair would be an Animal source type "genus" : { CodeableConcept }, // The genus of an organism, typically referring to the Latin epithet of the genus element of the plant/animal scientific name "species" : { CodeableConcept }, // The species of an organism, typically referring to 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:SubstanceDefinition.identifier [ Identifier ], ... ; # 0..* Identifier by which this substance is known fhir:SubstanceDefinition.version [ string ]; # 0..1 A business level identifier of the substance fhir:SubstanceDefinition.status [ CodeableConcept ]; # 0..1 Status of substance within the catalogue e.g. approved fhir:SubstanceDefinition.classification [ CodeableConcept ], ... ; # 0..* 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) fhir:SubstanceDefinition.domain [ CodeableConcept ]; # 0..1 If the substance applies to only human or veterinary use fhir:SubstanceDefinition.grade [ CodeableConcept ], ... ; # 0..* The quality standard, established benchmark, to which substance complies (e.g. USP/NF, Ph. Eur, JP, BP, Company Standard) fhir:SubstanceDefinition.description [ markdown ]; # 0..1 Textual description of the substance fhir:SubstanceDefinition.informationSource [ Reference(Citation) ], ... ; # 0..* Supporting literature fhir:SubstanceDefinition.note [ Annotation ], ... ; # 0..* Textual comment about the substance's catalogue or registry record fhir:SubstanceDefinition.manufacturer [ Reference(Organization) ], ... ; # 0..* A company that makes this substance fhir:SubstanceDefinition.supplier [ Reference(Organization) ], ... ; # 0..* A company that supplies this substance fhir:SubstanceDefinition.moiety [ # 0..* Moiety, for structural modifications fhir:SubstanceDefinition.moiety.role [ CodeableConcept ]; # 0..1 Role that the moiety is playing fhir:SubstanceDefinition.moiety.identifier [ Identifier ]; # 0..1 Identifier by which this moiety substance is known fhir:SubstanceDefinition.moiety.name [ string ]; # 0..1 Textual name for this moiety substance fhir:SubstanceDefinition.moiety.stereochemistry [ CodeableConcept ]; # 0..1 Stereochemistry type fhir:SubstanceDefinition.moiety.opticalActivity [ CodeableConcept ]; # 0..1 Optical activity type fhir:SubstanceDefinition.moiety.molecularFormula [ string ]; # 0..1 Molecular formula for this moiety of this substance, typically using the Hill system # SubstanceDefinition.moiety.amount[x] : 0..1 Quantitative value for this moiety. One of these 2 fhir:SubstanceDefinition.moiety.amountQuantity [ Quantity ] fhir:SubstanceDefinition.moiety.amountString [ string ] fhir:SubstanceDefinition.moiety.amountType [ CodeableConcept ]; # 0..1 The measurement type of the quantitative value ], ...; fhir:SubstanceDefinition.property [ # 0..* General specifications for this substance fhir:SubstanceDefinition.property.type [ CodeableConcept ]; # 1..1 A code expressing the type of characteristic # SubstanceDefinition.property.value[x] : 0..1 A value for the characteristic. One of these 5 fhir:SubstanceDefinition.property.valueCodeableConcept [ CodeableConcept ] fhir:SubstanceDefinition.property.valueQuantity [ Quantity ] fhir:SubstanceDefinition.property.valueDate [ date ] fhir:SubstanceDefinition.property.valueBoolean [ boolean ] fhir:SubstanceDefinition.property.valueAttachment [ Attachment ] ], ...; fhir:SubstanceDefinition.molecularWeight [ # 0..* The molecular weight or weight range (for proteins, polymers or nucleic acids) fhir:SubstanceDefinition.molecularWeight.method [ CodeableConcept ]; # 0..1 The method by which the molecular weight was determined fhir:SubstanceDefinition.molecularWeight.type [ CodeableConcept ]; # 0..1 Type of molecular weight such as exact, average (also known as. number average), weight average fhir:SubstanceDefinition.molecularWeight.amount [ Quantity ]; # 1..1 Used to capture quantitative values for a variety of elements. If only limits are given, the arithmetic mean would be the average. If only a single definite value for a given element is given, it would be captured in this field ], ...; fhir:SubstanceDefinition.structure [ # 0..1 Structural information fhir:SubstanceDefinition.structure.stereochemistry [ CodeableConcept ]; # 0..1 Stereochemistry type fhir:SubstanceDefinition.structure.opticalActivity [ CodeableConcept ]; # 0..1 Optical activity type fhir:SubstanceDefinition.structure.molecularFormula [ string ]; # 0..1 Molecular formula of this substance, typically using the Hill system fhir:SubstanceDefinition.structure.molecularFormulaByMoiety [ string ]; # 0..1 Specified per moiety according to the Hill system, i.e. first C, then H, then alphabetical, each moiety separated by a dot fhir:SubstanceDefinition.structure.molecularWeight [ See SubstanceDefinition.molecularWeight ]; # 0..1 The molecular weight or weight range (for proteins, polymers or nucleic acids) fhir:SubstanceDefinition.structure.technique [ CodeableConcept ], ... ; # 0..* The method used to elucidate the structure or characterization of the drug substance. Examples: X-ray, HPLC, NMR, Peptide mapping, Ligand binding assay fhir:SubstanceDefinition.structure.sourceDocument [ Reference(DocumentReference) ], ... ; # 0..* Supporting literature about the source of information fhir:SubstanceDefinition.structure.representation [ # 0..* A depiction of the structure or characterization of the substance fhir:SubstanceDefinition.structure.representation.type [ CodeableConcept ]; # 0..1 The kind of structural representation (e.g. full, partial) or the technique used to derive the analytical characterization of the substance (e.g. x-ray, HPLC, NMR, peptide mapping, ligand binding assay, etc.) fhir:SubstanceDefinition.structure.representation.representation [ string ]; # 0..1 The structural representation or characterization as a text string in a standard format fhir:SubstanceDefinition.structure.representation.format [ CodeableConcept ]; # 0..1 The 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 fhir:SubstanceDefinition.structure.representation.document [ Reference(DocumentReference) ]; # 0..1 An attached file with the structural representation or characterization e.g. a molecular structure graphic of the substance, a JCAMP or AnIML file ], ...; ]; fhir:SubstanceDefinition.code [ # 0..* Codes associated with the substance fhir:SubstanceDefinition.code.code [ CodeableConcept ]; # 0..1 The specific code fhir:SubstanceDefinition.code.status [ CodeableConcept ]; # 0..1 Status of the code assignment, for example 'provisional', 'approved' fhir:SubstanceDefinition.code.statusDate [ dateTime ]; # 0..1 The date at which the code status is changed as part of the terminology maintenance fhir:SubstanceDefinition.code.note [ Annotation ], ... ; # 0..* Any comment can be provided in this field, if necessary fhir:SubstanceDefinition.code.source [ Reference(DocumentReference) ], ... ; # 0..* Supporting literature ], ...; fhir:SubstanceDefinition.name [ # 0..* Names applicable to this substance fhir:SubstanceDefinition.name.name [ string ]; # 1..1 The actual name fhir:SubstanceDefinition.name.type [ CodeableConcept ]; # 0..1 Name type, for example 'systematic', 'scientific, 'brand' fhir:SubstanceDefinition.name.status [ CodeableConcept ]; # 0..1 The status of the name, for example 'current', 'proposed' fhir:SubstanceDefinition.name.preferred [ boolean ]; # 0..1 If this is the preferred name for this substance fhir:SubstanceDefinition.name.language [ CodeableConcept ], ... ; # 0..* Human language that the name is written in fhir:SubstanceDefinition.name.domain [ CodeableConcept ], ... ; # 0..* The use context of this name for example if there is a different name a drug active ingredient as opposed to a food colour additive fhir:SubstanceDefinition.name.jurisdiction [ CodeableConcept ], ... ; # 0..* The jurisdiction where this name applies fhir:SubstanceDefinition.name.synonym [ See SubstanceDefinition.name ], ... ; # 0..* A synonym of this particular name, by which the substance is also known fhir:SubstanceDefinition.name.translation [ See SubstanceDefinition.name ], ... ; # 0..* A translation for this name into another human language fhir:SubstanceDefinition.name.official [ # 0..* Details of the official nature of this name fhir:SubstanceDefinition.name.official.authority [ CodeableConcept ]; # 0..1 Which authority uses this official name fhir:SubstanceDefinition.name.official.status [ CodeableConcept ]; # 0..1 The status of the official name, for example 'provisional', 'approved' fhir:SubstanceDefinition.name.official.date [ dateTime ]; # 0..1 Date of official name change ], ...; fhir:SubstanceDefinition.name.source [ Reference(DocumentReference) ], ... ; # 0..* Supporting literature ], ...; fhir:SubstanceDefinition.relationship [ # 0..* A link between this substance and another, with details of the relationship # SubstanceDefinition.relationship.substanceDefinition[x] : 0..1 A pointer to another substance, as a resource or just a representational code. One of these 2 fhir:SubstanceDefinition.relationship.substanceDefinitionReference [ Reference(SubstanceDefinition) ] fhir:SubstanceDefinition.relationship.substanceDefinitionCodeableConcept [ CodeableConcept ] fhir:SubstanceDefinition.relationship.type [ CodeableConcept ]; # 1..1 For example "salt to parent", "active moiety", "starting material", "polymorph", "impurity of" fhir:SubstanceDefinition.relationship.isDefining [ boolean ]; # 0..1 For example where an enzyme strongly bonds with a particular substance, this is a defining relationship for that enzyme, out of several possible substance relationships # SubstanceDefinition.relationship.amount[x] : 0..1 A numeric factor for the relationship, for instance to express that the salt of a substance has some percentage of the active substance in relation to some other. One of these 3 fhir:SubstanceDefinition.relationship.amountQuantity [ Quantity ] fhir:SubstanceDefinition.relationship.amountRatio [ Ratio ] fhir:SubstanceDefinition.relationship.amountString [ string ] fhir:SubstanceDefinition.relationship.amountRatioHighLimit [ Ratio ]; # 0..1 For use when the numeric has an uncertain range fhir:SubstanceDefinition.relationship.amountType [ CodeableConcept ]; # 0..1 An operator for the amount, for example "average", "approximately", "less than" fhir:SubstanceDefinition.relationship.source [ Reference(DocumentReference) ], ... ; # 0..* Supporting literature ], ...; fhir:SubstanceDefinition.sourceMaterial [ # 0..1 Material or taxonomic/anatomical source for the substance fhir:SubstanceDefinition.sourceMaterial.type [ CodeableConcept ]; # 0..1 A classification that provides the origin of the raw material. Example: cat hair would be an Animal source type fhir:SubstanceDefinition.sourceMaterial.genus [ CodeableConcept ]; # 0..1 The genus of an organism, typically referring to the Latin epithet of the genus element of the plant/animal scientific name fhir:SubstanceDefinition.sourceMaterial.species [ CodeableConcept ]; # 0..1 The species of an organism, typically referring to the Latin epithet of the species of the plant/animal fhir:SubstanceDefinition.sourceMaterial.part [ CodeableConcept ]; # 0..1 An anatomical origin of the source material within an organism fhir:SubstanceDefinition.sourceMaterial.countryOfOrigin [ CodeableConcept ], ... ; # 0..* The country or countries where the material is harvested ]; ]
See the Profiles & Extensions and the alternate definitions: Master Definition XML + JSON, XML Schema/Schematron + JSON Schema, ShEx (for Turtle) + see the extensions & the dependency analysis
Search parameters for 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 N | string | The actual name | SubstanceDefinition.name.name |