SubstanceSpecification - FHIR Resource (r4)


This SubstanceSpecification Resource uses the FHIR API standard for access and structure.

Validate an SubstanceSpecification FHIR Resource (r4)



Resource Attributes

AttributeField is listTypeDescription
codetrueData Type# Property type e.g. viscosity, pH, isoelectric point
commentfalsestring# Textual comment about this record of a substance
descriptionfalsestring# Textual description of the substance
domainfalseCodeableConcept# If the substance applies to only human or veterinary use
identifierfalseIdentifier# Identifier by which this substance is known
moietytrueData Type# Moiety, for structural modifications
molecularWeighttrueSee SubstanceSpecification.structure.isotope.molecularWeight# The molecular weight or weight range (for proteins, polymers or nucleic acids)
nametrueData Type# Textual name for this moiety substance
nucleicAcidfalseReference# Data items specific to nucleic acids
polymerfalseReference# Data items specific to polymers
propertytrueData Type# General specifications for this substance, including how it is related to other substances
proteinfalseReference# Data items specific to proteins
referenceInformationfalseReference# General information detailing this substance
relationshiptrueData Type# A link between this substance and another, with details of the relationship
sourcetrueReference# Supporting literature
sourceMaterialfalseReference# Material or taxonomic/anatomical source for the substance
statusfalseCodeableConcept# Status of substance within the catalogue e.g. approved
structurefalseData Type# Structural information
typefalseCodeableConcept# High level categorization, e.g. polymer or nucleic acid

SubstanceSpecification Example

{
  "resourceType": "SubstanceSpecification",
  "id": "example",
  "text": {
    "status": "generated",
    "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p><b>Generated Narrative with Details</b></p><p><b>id</b>: example</p></div>"
  }
}

SubstanceSpecification Structure

{
  "resourceType" : "SubstanceSpecification",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : { Identifier }, // Identifier by which this substance is known
  "type" : { CodeableConcept }, // High level categorization, e.g. polymer or nucleic acid
  "status" : { CodeableConcept }, // Status of substance within the catalogue e.g. approved
  "domain" : { CodeableConcept }, // If the substance applies to only human or veterinary use
  "description" : "<string>", // Textual description of the substance
  "source" : [{ Reference(DocumentReference) }], // Supporting literature
  "comment" : "<string>", // Textual comment about this record of a 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
    // amount[x]: Quantitative value for this moiety. One of these 2:
    "amountQuantity" : { Quantity }
    "amountString" : "<string>"
  }],
  "property" : [{ // General specifications for this substance, including how it is related to other substances
    "category" : { CodeableConcept }, // A category for this property, e.g. Physical, Chemical, Enzymatic
    "code" : { CodeableConcept }, // Property type e.g. viscosity, pH, isoelectric point
    "parameters" : "<string>", // Parameters that were used in the measurement of a property (e.g. for viscosity: measured at 20C with a pH of 7.1)
    // definingSubstance[x]: 
      A substance upon which a defining property depends (e.g. for solubility: in water, in alcohol). One of these 2:
    "definingSubstanceReference" : { Reference(SubstanceSpecification|Substance) },
    "definingSubstanceCodeableConcept" : { CodeableConcept },
    // amount[x]: Quantitative value for this property. One of these 2:
    "amountQuantity" : { Quantity }
    "amountString" : "<string>"
  }],
  "referenceInformation" : { Reference(SubstanceReferenceInformation) }, // General information detailing this substance
  "structure" : { // Structural information
    "stereochemistry" : { CodeableConcept }, // Stereochemistry type
    "opticalActivity" : { CodeableConcept }, // Optical activity type
    "molecularFormula" : "<string>", // Molecular formula
    "molecularFormulaByMoiety" : "<string>", // Specified per moiety according to the Hill system, i.e. first C, then H, then alphabetical, each moiety separated by a dot
    "isotope" : [{ // Applicable for single substances that contain a radionuclide or a non-natural isotopic ratio
      "identifier" : { Identifier }, // Substance identifier for each non-natural or radioisotope
      "name" : { CodeableConcept }, // Substance name for each non-natural or radioisotope
      "substitution" : { CodeableConcept }, // The type of isotopic substitution present in a single substance
      "halfLife" : { Quantity }, // Half life - for a non-natural nuclide
      "molecularWeight" : { // The molecular weight or weight range (for proteins, polymers or nucleic acids)
        "method" : { CodeableConcept }, // The method by which the molecular weight was determined
        "type" : { CodeableConcept }, // Type of molecular weight such as exact, average (also known as. number average), weight average
        "amount" : { Quantity } // Used to capture quantitative values for a variety of elements. If only limits are given, the arithmetic mean would be the average. If only a single definite value for a given element is given, it would be captured in this field
      }
    }],
    "molecularWeight" : { Content as for SubstanceSpecification.structure.isotope.molecularWeight }, // The molecular weight or weight range (for proteins, polymers or nucleic acids)
    "source" : [{ Reference(DocumentReference) }], // Supporting literature
    "representation" : [{ // Molecular structural representation
      "type" : { CodeableConcept }, // The type of structure (e.g. Full, Partial, Representative)
      "representation" : "<string>", // The structural representation as text string in a format e.g. InChI, SMILES, MOLFILE, CDX
      "attachment" : { Attachment } // An attached file with the structural representation
    }]
  },
  "code" : [{ // Codes associated with the substance
    "code" : { CodeableConcept }, // The specific code
    "status" : { CodeableConcept }, // Status of the code assignment
    "statusDate" : "<dateTime>", // The date at which the code status is changed as part of the terminology maintenance
    "comment" : "<string>", // 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
    "status" : { CodeableConcept }, // The status of the name
    "preferred" : <boolean>, // If this is the preferred name for this substance
    "language" : [{ CodeableConcept }], // Language of the name
    "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 SubstanceSpecification.name }], // A synonym of this name
    "translation" : [{ Content as for SubstanceSpecification.name }], // A translation for this name
    "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
      "date" : "<dateTime>" // Date of official name change
    }],
    "source" : [{ Reference(DocumentReference) }] // Supporting literature
  }],
  "molecularWeight" : [{ Content as for SubstanceSpecification.structure.isotope.molecularWeight }], // The molecular weight or weight range (for proteins, polymers or nucleic acids)
  "relationship" : [{ // A link between this substance and another, with details of the relationship
    // substance[x]: A pointer to another substance, as a resource or just a representational code. One of these 2:
    "substanceReference" : { Reference(SubstanceSpecification) },
    "substanceCodeableConcept" : { CodeableConcept },
    "relationship" : { CodeableConcept }, // For example "salt to parent", "active moiety", "starting material"
    "isDefining" : <boolean>, // For example where an enzyme strongly bonds with a particular substance, this is a defining relationship for that enzyme, out of several possible substance relationships
    // amount[x]: 
      A numeric factor for the relationship, for instance to express that the salt of a substance has some percentage of the active substance in relation to some other. One of these 4:
    "amountQuantity" : { Quantity },
    "amountRange" : { Range },
    "amountRatio" : { Ratio },
    "amountString" : "<string>",
    "amountRatioLowLimit" : { Ratio }, // For use when the numeric
    "amountType" : { CodeableConcept }, // An operator for the amount, for example "average", "approximately", "less than"
    "source" : [{ Reference(DocumentReference) }] // Supporting literature
  }],
  "nucleicAcid" : { Reference(SubstanceNucleicAcid) }, // Data items specific to nucleic acids
  "polymer" : { Reference(SubstancePolymer) }, // Data items specific to polymers
  "protein" : { Reference(SubstanceProtein) }, // Data items specific to proteins
  "sourceMaterial" : { Reference(SubstanceSourceMaterial) } // Material or taxonomic/anatomical source for the substance
}

SubstanceSpecification Search Parameters

The following search parameters can be used to query SubstanceSpecification resources. Just submit them like so:

https://api.1up.health/fhir/r4/SubstanceSpecification?query-param=queryvalue
Search ParameterField TypeResource Fields Searched
codetextcode.code