Standard Health Record FHIR Implementation Guide

SHR Substance Profile

 

The official URL for this profile is:

http://standardhealthrecord.org/fhir/StructureDefinition/shr-entity-Substance

Any matter of defined composition that has discrete existence, whose origin may be biological, mineral or chemical.

This profile builds on Substance.

This profile was published on Wed Dec 20 00:00:00 EST 2017 as a draft by The MITRE Corporation: Standard Health Record Collaborative.

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

Summary

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

SHR Mapping Source

This structure represents the following SHR mapping definition:

shr.entity.Substance maps to Substance:
  Type maps to code
  Ingredient maps to ingredient
  Ingredient.IngredientAmount maps to ingredient.quantity
  Ingredient.CodeableConcept maps to ingredient.substance[x]
  Ingredient.Substance maps to ingredient.substance[x]

NameFlagsCard.TypeDescription & Constraintsdoco
.. Substance SHR Substance Profile
... code Binding: Substance Code (preferred)
... ingredient
.... quantity SHR Ratio Profile
.... substance[x] CodeableConcept, Reference(SHR Substance Profile)
... shr-base-RelatedEncounter-extension 0..1Reference(SHR EncounterPerformed Profile)SHR RelatedEncounter Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-RelatedEncounter-extension
... shr-base-Author-extension 0..1(Complex)SHR Author Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-Author-extension
... shr-base-Informant-extension 0..1(Complex)SHR Informant Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-Informant-extension
... shr-core-Category-extension 0..*CodeableConceptSHR Category Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-core-Category-extension
.... valueCodeableConcept Binding: Substance Category Codes (extensible)
... shr-entity-ActiveFlagAsaCodeableConcept-extension 0..1CodeableConceptSHR ActiveFlagAsaCodeableConcept Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-entity-ActiveFlagAsaCodeableConcept-extension
.... valueCodeableConcept Binding: FHIRSubstanceStatus (required)
... shr-core-Details-extension 0..1stringSHR Details Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-core-Details-extension

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Substance I0..*SHR Substance Profile
... 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
... shr-base-RelatedEncounter-extension 0..1Reference(SHR EncounterPerformed Profile)SHR RelatedEncounter Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-RelatedEncounter-extension
... shr-base-Author-extension 0..1(Complex)SHR Author Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-Author-extension
... shr-base-Informant-extension 0..1(Complex)SHR Informant Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-Informant-extension
... shr-core-Category-extension 0..*CodeableConceptSHR Category Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-core-Category-extension
.... id 0..1stringxml:id (or equivalent in JSON)
.... url 1..1uri"http://standardhealthrecord.org/fhir/StructureDefinition/shr-core-Category-extension"
.... valueCodeableConcept 1..1CodeableConceptValue of extension
Binding: Substance Category Codes (extensible)
... shr-entity-ActiveFlagAsaCodeableConcept-extension 0..1CodeableConceptSHR ActiveFlagAsaCodeableConcept Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-entity-ActiveFlagAsaCodeableConcept-extension
.... id 0..1stringxml:id (or equivalent in JSON)
.... url 1..1uri"http://standardhealthrecord.org/fhir/StructureDefinition/shr-entity-ActiveFlagAsaCodeableConcept-extension"
.... valueCodeableConcept 1..1CodeableConceptValue of extension
Binding: FHIRSubstanceStatus (required)
... shr-core-Details-extension 0..1stringSHR Details Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-core-Details-extension
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierUnique identifier
... status Σ0..1codeactive | inactive | entered-in-error
Binding: FHIRSubstanceStatus (required)
... category Σ0..*CodeableConceptWhat class/type of substance this is
Binding: Substance Category Codes (extensible)
... code Σ1..1CodeableConceptWhat substance this is
Binding: Substance Code (preferred)
... description Σ0..1stringTextual description of the substance, comments
... instance ΣI0..*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 Σ0..1SimpleQuantityAmount of substance in the package
... ingredient ΣI0..*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 Σ0..1SHR Ratio ProfileOptional amount (concentration)
.... substance[x] Σ1..1CodeableConcept, Reference(SHR Substance Profile)A component of the substance
Binding: Substance Code (example)

doco Documentation for this format

Summary

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

SHR Mapping Source

This structure represents the following SHR mapping definition:

shr.entity.Substance maps to Substance:
  Type maps to code
  Ingredient maps to ingredient
  Ingredient.IngredientAmount maps to ingredient.quantity
  Ingredient.CodeableConcept maps to ingredient.substance[x]
  Ingredient.Substance maps to ingredient.substance[x]

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Substance SHR Substance Profile
... code Binding: Substance Code (preferred)
... ingredient
.... quantity SHR Ratio Profile
.... substance[x] CodeableConcept, Reference(SHR Substance Profile)
... shr-base-RelatedEncounter-extension 0..1Reference(SHR EncounterPerformed Profile)SHR RelatedEncounter Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-RelatedEncounter-extension
... shr-base-Author-extension 0..1(Complex)SHR Author Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-Author-extension
... shr-base-Informant-extension 0..1(Complex)SHR Informant Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-Informant-extension
... shr-core-Category-extension 0..*CodeableConceptSHR Category Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-core-Category-extension
.... valueCodeableConcept Binding: Substance Category Codes (extensible)
... shr-entity-ActiveFlagAsaCodeableConcept-extension 0..1CodeableConceptSHR ActiveFlagAsaCodeableConcept Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-entity-ActiveFlagAsaCodeableConcept-extension
.... valueCodeableConcept Binding: FHIRSubstanceStatus (required)
... shr-core-Details-extension 0..1stringSHR Details Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-core-Details-extension

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Substance I0..*SHR Substance Profile
... 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
... shr-base-RelatedEncounter-extension 0..1Reference(SHR EncounterPerformed Profile)SHR RelatedEncounter Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-RelatedEncounter-extension
... shr-base-Author-extension 0..1(Complex)SHR Author Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-Author-extension
... shr-base-Informant-extension 0..1(Complex)SHR Informant Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-Informant-extension
... shr-core-Category-extension 0..*CodeableConceptSHR Category Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-core-Category-extension
.... id 0..1stringxml:id (or equivalent in JSON)
.... url 1..1uri"http://standardhealthrecord.org/fhir/StructureDefinition/shr-core-Category-extension"
.... valueCodeableConcept 1..1CodeableConceptValue of extension
Binding: Substance Category Codes (extensible)
... shr-entity-ActiveFlagAsaCodeableConcept-extension 0..1CodeableConceptSHR ActiveFlagAsaCodeableConcept Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-entity-ActiveFlagAsaCodeableConcept-extension
.... id 0..1stringxml:id (or equivalent in JSON)
.... url 1..1uri"http://standardhealthrecord.org/fhir/StructureDefinition/shr-entity-ActiveFlagAsaCodeableConcept-extension"
.... valueCodeableConcept 1..1CodeableConceptValue of extension
Binding: FHIRSubstanceStatus (required)
... shr-core-Details-extension 0..1stringSHR Details Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-core-Details-extension
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierUnique identifier
... status Σ0..1codeactive | inactive | entered-in-error
Binding: FHIRSubstanceStatus (required)
... category Σ0..*CodeableConceptWhat class/type of substance this is
Binding: Substance Category Codes (extensible)
... code Σ1..1CodeableConceptWhat substance this is
Binding: Substance Code (preferred)
... description Σ0..1stringTextual description of the substance, comments
... instance ΣI0..*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 Σ0..1SimpleQuantityAmount of substance in the package
... ingredient ΣI0..*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 Σ0..1SHR Ratio ProfileOptional amount (concentration)
.... substance[x] Σ1..1CodeableConcept, Reference(SHR Substance Profile)A component of the substance
Binding: Substance Code (example)

doco Documentation for this format

Downloads: StructureDefinition: (XML, JSON, TTL), Schema: XML Schematron

 

Terminology Bindings

PathNameConformanceValueSet
Substance.languageCommon LanguagesextensibleCommon Languages
Substance.extension.valueCodeableConceptFHIRSubstanceStatusrequiredFHIRSubstanceStatus
Substance.extension.valueCodeableConceptFHIRSubstanceStatusrequiredFHIRSubstanceStatus
Substance.statusFHIRSubstanceStatusrequiredFHIRSubstanceStatus
Substance.categorySubstance Category CodesextensibleSubstance Category Codes
Substance.codeSubstance CodepreferredSubstance Code
Substance.ingredient.substance[x]Substance CodeexampleSubstance Code

 

Constraints

IdPathDetailsRequirements
dom-2SubstanceIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-1SubstanceIf the resource is contained in another resource, it SHALL NOT contain any narrative
: contained.text.empty()
dom-4SubstanceIf 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-3SubstanceIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
: contained.where(('#'+id in %resource.descendants().reference).not()).empty()
ele-1Substance.instanceAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ele-1Substance.ingredientAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())