STU 2 Ballot

This page is part of the Quality Improvement Core Framework (v1.6.0: STU 2 Ballot) based on FHIR (HL7® FHIR® Standard) v1.6.0. The current version which supersedes this version is 7.0.2. For a full list of available versions, see the Directory of published versions

D.4.1 StructureDefinition: qicore-substance

D.4.1.1 Formal Views of Profile Content

The official URL for this profile is:

http://hl7.org/fhir/qicore/StructureDefinition/qicore-substance

This profile was published on Tue Mar 17 00:00:00 AEDT 2015 as a draft by Health Level Seven International (Clinical Quality Information - QICore).

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

This structure is derived from Substance

Summary

Must-Support: 4 elements

Structures

This structure refers to these other structures:

NameFlagsCard.TypeDescription & Constraintsdoco
.. Substance I0..*A homogeneous material with a definite composition
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
... 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
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
... text I0..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 ∑0..*IdentifierUnique identifier
... category ∑0..*CodeableConceptWhat class/type of substance this is
Binding: Substance Category Codes (extensible)
... code S1..1CodeableConceptWhat substance this is
Binding: Substance Code (example)
... description ∑0..1stringTextual description of the substance, comments
... instance 0..*BackboneElementIf this describes a specific package/container of the substance
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!∑0..*ExtensionExtensions that cannot be ignored
.... identifier ∑0..1IdentifierIdentifier of the package/container
.... expiry ∑0..1dateTimeWhen no longer valid to use
.... quantity S0..1SimpleQuantityAmount of substance in the package
... ingredient 0..*BackboneElementComposition information about the substance
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!∑0..*ExtensionExtensions that cannot be ignored
.... quantity S0..1RatioOptional amount (concentration)
.... substanceReference S1..1Reference(Profile qicore-substance)A component of the substance
Binding: Substance Code (example)

doco Documentation for this format

yet to be done: Xml template

yet to be done: Json template

This structure is derived from StructureDefinition.

Summary

Must-Support: 4 elements

Structures

This structure refers to these other structures:

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Substance I0..*A homogeneous material with a definite composition
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
... 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
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
... text I0..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 ∑0..*IdentifierUnique identifier
... category ∑0..*CodeableConceptWhat class/type of substance this is
Binding: Substance Category Codes (extensible)
... code S1..1CodeableConceptWhat substance this is
Binding: Substance Code (example)
... description ∑0..1stringTextual description of the substance, comments
... instance 0..*BackboneElementIf this describes a specific package/container of the substance
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!∑0..*ExtensionExtensions that cannot be ignored
.... identifier ∑0..1IdentifierIdentifier of the package/container
.... expiry ∑0..1dateTimeWhen no longer valid to use
.... quantity S0..1SimpleQuantityAmount of substance in the package
... ingredient 0..*BackboneElementComposition information about the substance
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!∑0..*ExtensionExtensions that cannot be ignored
.... quantity S0..1RatioOptional amount (concentration)
.... substanceReference S1..1Reference(Profile qicore-substance)A component of the substance
Binding: Substance Code (example)

doco Documentation for this format

XML Template

yet to be done: Xml template

JSON Template

yet to be done: Json template

 

D.4.1.2 Terminology Bindings

Terminology Bindings

PathNameConformanceValueSet
Substance.languageCommon LanguagesextensibleCommon Languages
Substance.categorySubstance Category CodesextensibleSubstance Category Codes
Substance.codeSubstance CodeexampleSubstance Code
Substance.ingredient.substanceReferenceSubstance CodeexampleSubstance Code

D.4.1.3 Constraints

Constraints

IdPathDetailsRequirements
dom-2SubstanceIf the resource is contained in another resource, it SHALL NOT contain nested Resources
XPath: not(parent::f:contained and f:contained)
dom-1SubstanceIf the resource is contained in another resource, it SHALL NOT contain any narrative
XPath: not(parent::f:contained and f:text)
dom-4SubstanceIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
XPath: not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))
dom-3SubstanceIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
XPath: not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))
.