Skip to main content

Substance

PropertyValue
Publisher
NameSubstance
URLhttp://hl7.org/fhir/StructureDefinition/Substance
Statusdraft
Description
Abstractfalse

Structure

PathCardinalityTypeDescription
Substance0..*SubstanceA homogeneous material with a definite composition.
Substance.id0..1http://hl7.org/fhirpath/System.StringThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Substance.meta0..1MetaThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
Substance.implicitRules0..1uriA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
Substance.language0..1codeThe base language in which the resource is written.
Substance.text0..1NarrativeA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Substance.contained0..*ResourceThese resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
Substance.extension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Substance.modifierExtension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Substance.identifier0..*IdentifierUnique identifier for the substance.
Substance.status0..1codeA code to indicate if the substance is actively used.
Substance.category0..*CodeableConceptA code that classifies the general type of substance. This is used for searching, sorting and display purposes.
Substance.code1..1CodeableConceptA code (or set of codes) that identify this substance.
Substance.description0..1stringA description of the substance - its appearance, handling requirements, and other usage notes.
Substance.instance0..*BackboneElementSubstance may be used to describe a kind of substance, or a specific package/container of the substance: an instance.
Substance.instance.id0..1http://hl7.org/fhirpath/System.StringUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Substance.instance.extension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Substance.instance.modifierExtension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Substance.instance.identifier0..1IdentifierIdentifier associated with the package/container (usually a label affixed directly).
Substance.instance.expiry0..1dateTimeWhen the substance is no longer valid to use. For some substances, a single arbitrary date is used for expiry.
Substance.instance.quantity0..1QuantityThe amount of the substance.
Substance.ingredient0..*BackboneElementA substance can be composed of other substances.
Substance.ingredient.id0..1http://hl7.org/fhirpath/System.StringUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Substance.ingredient.extension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Substance.ingredient.modifierExtension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Substance.ingredient.quantity0..1RatioThe amount of the ingredient in the substance - a concentration ratio.
Substance.ingredient.substance[x]1..1CodeableConceptAnother substance that is a component of this substance.

Search Parameters

NameTypeDescriptionExpression
_textstringSearch on the narrative of the resource
_contentstringSearch on the entire content of the resource
_idtokenLogical id of this artifactResource.id
_lastUpdateddateWhen the resource version last changedResource.meta.lastUpdated
_profileuriProfiles this resource claims to conform toResource.meta.profile
_querytokenA custom search profile that describes a specific defined query operation
_securitytokenSecurity Labels applied to this resourceResource.meta.security
_sourceuriIdentifies where the resource comes fromResource.meta.source
_tagtokenTags applied to this resourceResource.meta.tag
categorytokenThe category of the substanceSubstance.category
codetokenThe code of the substance or ingredientSubstance.code / (Substance.ingredient.substance.ofType(CodeableConcept))
container-identifiertokenIdentifier of the package/containerSubstance.instance.identifier
expirydateExpiry date of package or container of substanceSubstance.instance.expiry
identifiertokenUnique identifier for the substanceSubstance.identifier
quantityquantityAmount of substance in the packageSubstance.instance.quantity
statustokenactive / inactive / entered-in-errorSubstance.status
substance-referencereferenceA component of the substance(Substance.ingredient.substance.ofType(Reference))
_iguhealth-version-seqnumberThe version sequence of the resourceResource.meta.extension.where(url='https://iguhealth.app/version-sequence').value
_iguhealth-authorreferenceThe author of the resourceResource.meta.extension.where(url='https://iguhealth.app/author').value