CodeX Implementation Guide: ICAREdata v0.1.2

CodeX Implementation Guide: ICAREdata v0.1.2 FHIR Profiles - Local Development build (v0.1.2). See the Directory of published versions

Substance

 

The official URL for this profile is:

http://mcodeinitiative.org/codex/us/icare/StructureDefinition/obf-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 Nov 06 00:00:00 CST 2019 as a draft by The MITRE Corporation.

Summary

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Mapping Source

This structure represents the following mapping definition:

obf.Substance maps to Substance:
  Language maps to language
  ImplicitRules maps to implicitRules
  Metadata.VersionId maps to meta.versionId
  Metadata.SourceSystem maps to meta.extension
  Metadata.Profile maps to meta.profile
  Metadata.LastUpdated maps to meta.lastUpdated
  Metadata.SecurityLabel maps to meta.security
  Metadata.Tag maps to meta.tag
  Narrative maps to text
  Identifier maps to identifier
  Status maps to extension
  Code maps to code
  Category maps to category
  CommentOrDescription maps to description
  Ingredient.IngredientStrength maps to ingredient.quantity
  Ingredient.SubstanceOrCode.Substance maps to ingredient.substance

NameFlagsCard.TypeDescription & Constraintsdoco
.. Substance obf-Substance
... meta
.... extension Slice: Unordered, Open by value:url
.... obf-SourceSystem-extension 0..1uriSourceSystem
URL: http://mcodeinitiative.org/codex/us/icare/StructureDefinition/obf-SourceSystem-extension
... extension Slice: Unordered, Open by value:url
... obf-Status-extension 0..1CodeableConceptStatus
URL: http://mcodeinitiative.org/codex/us/icare/StructureDefinition/obf-Status-extension
.... valueCodeableConcept Binding: substance-status (required)
... ingredient
.... substance Reference(obf-Substance)

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Substance 0..*obf-Substance
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... obf-SourceSystem-extension 0..1uriSourceSystem
URL: http://mcodeinitiative.org/codex/us/icare/StructureDefinition/obf-SourceSystem-extension
.... versionId Σ0..1idVersion specific identifier
.... lastUpdated Σ0..1instantWhen the resource version last changed
.... profile Σ0..*uriProfiles this resource claims to conform to
.... security Σ0..*CodingSecurity Labels applied to this resource
Binding: All Security Labels (extensible)
.... tag Σ0..*CodingTags applied to this resource
Binding: (unbound) (example)
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: http://tools.ietf.org/html/bcp47 (required)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by exists:url
.... obf-Status-extension 0..1CodeableConceptStatus
URL: http://mcodeinitiative.org/codex/us/icare/StructureDefinition/obf-Status-extension
..... id 0..1idxml:id (or equivalent in JSON)
..... url 1..1uri"http://mcodeinitiative.org/codex/us/icare/StructureDefinition/obf-Status-extension"
..... valueCodeableConcept 1..1CodeableConceptValue of extension
Binding: substance-status (required)
... 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 Σ1..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..1idxml: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 Σ0..*BackboneElementComposition information about the substance
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... quantity Σ0..1RatioOptional amount (concentration)
.... substance Σ1..1Reference(obf-Substance)A component of the substance

doco Documentation for this format

Summary

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Mapping Source

This structure represents the following mapping definition:

obf.Substance maps to Substance:
  Language maps to language
  ImplicitRules maps to implicitRules
  Metadata.VersionId maps to meta.versionId
  Metadata.SourceSystem maps to meta.extension
  Metadata.Profile maps to meta.profile
  Metadata.LastUpdated maps to meta.lastUpdated
  Metadata.SecurityLabel maps to meta.security
  Metadata.Tag maps to meta.tag
  Narrative maps to text
  Identifier maps to identifier
  Status maps to extension
  Code maps to code
  Category maps to category
  CommentOrDescription maps to description
  Ingredient.IngredientStrength maps to ingredient.quantity
  Ingredient.SubstanceOrCode.Substance maps to ingredient.substance

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Substance obf-Substance
... meta
.... extension Slice: Unordered, Open by value:url
.... obf-SourceSystem-extension 0..1uriSourceSystem
URL: http://mcodeinitiative.org/codex/us/icare/StructureDefinition/obf-SourceSystem-extension
... extension Slice: Unordered, Open by value:url
... obf-Status-extension 0..1CodeableConceptStatus
URL: http://mcodeinitiative.org/codex/us/icare/StructureDefinition/obf-Status-extension
.... valueCodeableConcept Binding: substance-status (required)
... ingredient
.... substance Reference(obf-Substance)

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Substance 0..*obf-Substance
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... obf-SourceSystem-extension 0..1uriSourceSystem
URL: http://mcodeinitiative.org/codex/us/icare/StructureDefinition/obf-SourceSystem-extension
.... versionId Σ0..1idVersion specific identifier
.... lastUpdated Σ0..1instantWhen the resource version last changed
.... profile Σ0..*uriProfiles this resource claims to conform to
.... security Σ0..*CodingSecurity Labels applied to this resource
Binding: All Security Labels (extensible)
.... tag Σ0..*CodingTags applied to this resource
Binding: (unbound) (example)
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: http://tools.ietf.org/html/bcp47 (required)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by exists:url
.... obf-Status-extension 0..1CodeableConceptStatus
URL: http://mcodeinitiative.org/codex/us/icare/StructureDefinition/obf-Status-extension
..... id 0..1idxml:id (or equivalent in JSON)
..... url 1..1uri"http://mcodeinitiative.org/codex/us/icare/StructureDefinition/obf-Status-extension"
..... valueCodeableConcept 1..1CodeableConceptValue of extension
Binding: substance-status (required)
... 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 Σ1..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..1idxml: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 Σ0..*BackboneElementComposition information about the substance
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... quantity Σ0..1RatioOptional amount (concentration)
.... substance Σ1..1Reference(obf-Substance)A component of the substance

doco Documentation for this format

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

 

Terminology Bindings

PathConformanceValueSet
Substance.meta.securityextensibleAll Security Labels
Substance.meta.tagexample
Substance.languagerequiredhttp://tools.ietf.org/html/bcp47
Substance.extension-status.valueCodeableConceptrequiredhttp://hl7.org/fhir/ValueSet/substance-status
Substance.categoryextensibleSubstance Category Codes
Substance.codeexampleSubstance Code

 

Constraints

IdPathDetailsRequirements