Skip to main content

SubstanceDefinition

Trial Use 1 Specialized — Medication Definition

The detailed description of a substance, typically at a level beyond what is used for prescribing.

Endpoints

devhttps://api.sandbox.ovok.com/fhir/R5/SubstanceDefinition
InteractionMethodPath
ReadGET/fhir/R5/SubstanceDefinition/[id]
VreadGET/fhir/R5/SubstanceDefinition/[id]/_history/[vid]
UpdatePUT/fhir/R5/SubstanceDefinition/[id]
PatchPATCH/fhir/R5/SubstanceDefinition/[id]
DeleteDELETE/fhir/R5/SubstanceDefinition/[id]
CreatePOST/fhir/R5/SubstanceDefinition
SearchGET/fhir/R5/SubstanceDefinition?...
HistoryGET/fhir/R5/SubstanceDefinition/[id]/_history
Type-historyGET/fhir/R5/SubstanceDefinition/_history

Top-level elements

ElementType(s)CardinalityDescription
identifierIdentifier0..*Identifier by which this substance is known
versionstring0..1A business level version identifier of the substance
statusCodeableConcept0..1Status of substance within the catalogue e.g. active, retired
classificationCodeableConcept0..*A categorization, high level e.g. polymer or nucleic acid, or food, chemical, biological, or lower e.g. polymer linear or branch chain, or type of impurity
domainCodeableConcept0..1If the substance applies to human or veterinary use
gradeCodeableConcept0..*The quality standard, established benchmark, to which substance complies (e.g. USP/NF, BP)
descriptionmarkdown0..1Textual description of the substance
informationSourceReference0..*Supporting literature
noteAnnotation0..*Textual comment about the substance's catalogue or registry record
manufacturerReference0..*The entity that creates, makes, produces or fabricates the substance
supplierReference0..*An entity that is the source for the substance. It may be different from the manufacturer
moietyBackboneElement0..*Moiety, for structural modifications
characterizationBackboneElement0..*General specifications for this substance
propertyBackboneElement0..*General specifications for this substance
referenceInformationReference0..1General information detailing this substance
molecularWeightBackboneElement0..*The average mass of a molecule of a compound
structureBackboneElement0..1Structural information
codeBackboneElement0..*Codes associated with the substance
nameBackboneElement0..*Names applicable to this substance
relationshipBackboneElement0..*A link between this substance and another
nucleicAcidReference0..1Data items specific to nucleic acids
polymerReference0..1Data items specific to polymers
proteinReference0..1Data items specific to proteins
sourceMaterialBackboneElement0..1Material or taxonomic/anatomical source

Resource-specific search parameters

ParameterTypeDescription
classificationtokenHigh or low level categorization, e.g. polymer vs. nucleic acid or linear vs. branch chain
codetokenThe specific code
domaintokenIf the substance applies to only human or veterinary use
identifiertokenIdentifier by which this substance is known
namestringThe actual name

Reference