Pharmaceutical Quality (Industry)
1.0.0-ballot - ballot International flag

This page is part of the Pharmaceutical Quality (Industry) (v1.0.0-ballot: STU1 Ballot 1) based on FHIR (HL7® FHIR® Standard) v5.0.0. . For a full list of available versions, see the Directory of published versions

Resource Profile: Substance - Drug

Official URL: http://hl7.org/fhir/uv/pharm-quality/StructureDefinition/Substance-drug-pq Version: 1.0.0-ballot
Active as of 2023-12-18 Computable Name: SubstanceDrugPq

This Substance profile represents identifying information about an actual batch of aubstance (an instance).

Usage:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from Substance

NameFlagsCard.TypeDescription & Constraintsdoco
.. Substance 0..*SubstanceA homogeneous material with a definite composition
... identifier S0..*IdentifierUnique identifier
... status S0..1codeactive | inactive | entered-in-error

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Substance 0..*SubstanceA homogeneous material with a definite composition
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... contained 0..*ResourceContained, inline Resources
... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
... instance ?!Σ1..1booleanIs this an instance of a substance or a kind of one
... status ?!SΣ0..1codeactive | inactive | entered-in-error
Binding: FHIRSubstanceStatus (required): A code to indicate if the substance is actively used.

... code Σ1..1CodeableReference(SubstanceDefinition)What substance this is
Binding: SubstanceCode (example): Substance codes.


doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Substance.statusrequiredFHIRSubstanceStatus
Substance.codeexampleSubstanceCode

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorSubstanceIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorSubstanceIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorSubstanceIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorSubstanceIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceSubstanceA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. Substance 0..*SubstanceA homogeneous material with a definite composition
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
... identifier SΣ0..*IdentifierUnique identifier
... instance ?!Σ1..1booleanIs this an instance of a substance or a kind of one
... status ?!SΣ0..1codeactive | inactive | entered-in-error
Binding: FHIRSubstanceStatus (required): A code to indicate if the substance is actively used.

... category Σ0..*CodeableConceptWhat class/type of substance this is
Binding: SubstanceCategoryCodes (extensible): Category or classification of substance.


... code Σ1..1CodeableReference(SubstanceDefinition)What substance this is
Binding: SubstanceCode (example): Substance codes.

... description Σ0..1markdownTextual description of the substance, comments
... expiry Σ0..1dateTimeWhen no longer valid to use
... quantity Σ0..1SimpleQuantityAmount of substance in the package
... ingredient Σ0..*BackboneElementComposition information about the substance
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... quantity Σ0..1RatioOptional amount (concentration)
.... substance[x] Σ1..1A component of the substance
Binding: SubstanceCode (example): Substance Ingredient codes.

..... substanceCodeableConceptCodeableConcept
..... substanceReferenceReference(Substance)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Substance.languagerequiredAllLanguages
Substance.statusrequiredFHIRSubstanceStatus
Substance.categoryextensibleSubstanceCategoryCodes
Substance.codeexampleSubstanceCode
Substance.ingredient.substance[x]exampleSubstanceCode

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorSubstanceIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorSubstanceIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorSubstanceIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorSubstanceIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceSubstanceA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from Substance

Summary

Must-Support: 2 elements

Differential View

This structure is derived from Substance

NameFlagsCard.TypeDescription & Constraintsdoco
.. Substance 0..*SubstanceA homogeneous material with a definite composition
... identifier S0..*IdentifierUnique identifier
... status S0..1codeactive | inactive | entered-in-error

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Substance 0..*SubstanceA homogeneous material with a definite composition
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... contained 0..*ResourceContained, inline Resources
... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
... instance ?!Σ1..1booleanIs this an instance of a substance or a kind of one
... status ?!SΣ0..1codeactive | inactive | entered-in-error
Binding: FHIRSubstanceStatus (required): A code to indicate if the substance is actively used.

... code Σ1..1CodeableReference(SubstanceDefinition)What substance this is
Binding: SubstanceCode (example): Substance codes.


doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Substance.statusrequiredFHIRSubstanceStatus
Substance.codeexampleSubstanceCode

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorSubstanceIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorSubstanceIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorSubstanceIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorSubstanceIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceSubstanceA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Substance 0..*SubstanceA homogeneous material with a definite composition
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
... identifier SΣ0..*IdentifierUnique identifier
... instance ?!Σ1..1booleanIs this an instance of a substance or a kind of one
... status ?!SΣ0..1codeactive | inactive | entered-in-error
Binding: FHIRSubstanceStatus (required): A code to indicate if the substance is actively used.

... category Σ0..*CodeableConceptWhat class/type of substance this is
Binding: SubstanceCategoryCodes (extensible): Category or classification of substance.


... code Σ1..1CodeableReference(SubstanceDefinition)What substance this is
Binding: SubstanceCode (example): Substance codes.

... description Σ0..1markdownTextual description of the substance, comments
... expiry Σ0..1dateTimeWhen no longer valid to use
... quantity Σ0..1SimpleQuantityAmount of substance in the package
... ingredient Σ0..*BackboneElementComposition information about the substance
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... quantity Σ0..1RatioOptional amount (concentration)
.... substance[x] Σ1..1A component of the substance
Binding: SubstanceCode (example): Substance Ingredient codes.

..... substanceCodeableConceptCodeableConcept
..... substanceReferenceReference(Substance)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Substance.languagerequiredAllLanguages
Substance.statusrequiredFHIRSubstanceStatus
Substance.categoryextensibleSubstanceCategoryCodes
Substance.codeexampleSubstanceCode
Substance.ingredient.substance[x]exampleSubstanceCode

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorSubstanceIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorSubstanceIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorSubstanceIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorSubstanceIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceSubstanceA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from Substance

Summary

Must-Support: 2 elements

 

Other representations of profile: CSV, Excel, Schematron