HL7 FHIR Profile: Occupational Data for Health (ODH), Release 1 (Standard for Trial Use)
This page is part of the Occupational Data for Health (ODH) FHIR IG (v0.1.0: STU 1 Ballot 1) based on FHIR R3. The current version which supercedes this version is 1.2.0. For a full list of available versions, see the Directory of published versions 
<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="cimi-entity-Substance"/> <text> <status value="generated"/> <div xmlns="http://www.w3.org/1999/xhtml"> <p><b>ODH Substance Profile</b></p> <p>Any matter of defined composition that has discrete existence, whose origin may be biological, mineral or chemical.</p> <p><b>ODH Mapping Summary</b></p> <p><pre>cimi.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] </pre></p> </div> </text> <url value="http://hl7.org/fhir/us/odh/StructureDefinition/cimi-entity-Substance"/> <identifier> <system value="http://hl7.org/fhir/us/odh"/> <value value="cimi.entity.Substance"/> </identifier> <version value="0.1.0"/> <name value="SubstanceProfile"/> <title value="ODH Substance Profile"/> <status value="draft"/> <date value="2018-08-17T00:00:00+10:00"/> <publisher value="HL7"/> <contact> <telecom> <system value="url"/> <value value="http://standardhealthrecord.org"/> </telecom> </contact> <description value="Any matter of defined composition that has discrete existence, whose origin may be biological, mineral or chemical."/> <fhirVersion value="3.0.1"/> <mapping> <identity value="rim"/> <uri value="http://hl7.org/v3"/> <name value="RIM Mapping"/> </mapping> <mapping> <identity value="orim"/> <uri value="http://hl7.org/orim"/> <name value="Ontological RIM Mapping"/> </mapping> <mapping> <identity value="w5"/> <uri value="http://hl7.org/fhir/w5"/> <name value="W5 Mapping"/> </mapping> <kind value="resource"/> <abstract value="false"/> <type value="Substance"/> <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Substance"/> <derivation value="constraint"/> <snapshot> <element id="Substance:cimi-entity-Substance"> <path value="Substance"/> <short value="ODH Substance Profile"/> <definition value="Any matter of defined composition that has discrete existence, whose origin may be biological, mineral or chemical."/> <min value="0"/> <max value="*"/> <constraint> <key value="dom-2"/> <severity value="error"/> <human value="If the resource is contained in another resource, it SHALL NOT contain nested Resources"/> <expression value="contained.contained.empty()"/> <xpath value="not(parent::f:contained and f:contained)"/> <source value="DomainResource"/> </constraint> <constraint> <key value="dom-1"/> <severity value="error"/> <human value="If the resource is contained in another resource, it SHALL NOT contain any narrative"/> <expression value="contained.text.empty()"/> <xpath value="not(parent::f:contained and f:text)"/> <source value="DomainResource"/> </constraint> <constraint> <key value="dom-4"/> <severity value="error"/> <human value="If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated"/> <expression value="contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()"/> <xpath value="not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))"/> <source value="DomainResource"/> </constraint> <constraint> <key value="dom-3"/> <severity value="error"/> <human value="If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource"/> <expression value="contained.where(('#'+id in %resource.descendants().reference).not()).empty()"/> <xpath value="not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))"/> <source value="DomainResource"/> </constraint> <mapping> <identity value="rim"/> <map value="Entity. Role, or Act"/> </mapping> <mapping> <identity value="rim"/> <map value="Material"/> </mapping> <mapping> <identity value="orim"/> <map value="fhir:Substance rdfs:subClassOf rim:Entity, [ a owl:Restriction; owl:onProperty rim:Act.classCode; owl:allValuesFrom cs:EntityClass\#MAT ]."/> </mapping> <mapping> <identity value="w5"/> <map value="administrative.entity"/> </mapping> </element> <element id="Substance:cimi-entity-Substance.id"> <path value="Substance.id"/> <short value="Logical id of this artifact"/> <definition value="The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes."/> <comment value="The only time that a resource does not have an id is when it is being submitted to the server using a create operation."/> <min value="0"/> <max value="1"/> <base> <path value="Resource.id"/> <min value="0"/> <max value="1"/> </base> <type> <code value="id"/> </type> <isSummary value="true"/> </element> <element id="Substance:cimi-entity-Substance.meta"> <path value="Substance.meta"/> <short value="Metadata about the resource"/> <definition value="The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource."/> <min value="0"/> <max value="1"/> <base> <path value="Resource.meta"/> <min value="0"/> <max value="1"/> </base> <type> <code value="Meta"/> </type> <isSummary value="true"/> </element> <element id="Substance:cimi-entity-Substance.implicitRules"> <path value="Substance.implicitRules"/> <short value="A set of rules under which this content was created"/> <definition value="A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content."/> <comment value="Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation."/> <min value="0"/> <max value="1"/> <base> <path value="Resource.implicitRules"/> <min value="0"/> <max value="1"/> </base> <type> <code value="uri"/> </type> <isModifier value="true"/> <isSummary value="true"/> </element> <element id="Substance:cimi-entity-Substance.language"> <path value="Substance.language"/> <short value="Language of the resource content"/> <definition value="The base language in which the resource is written."/> <comment value="Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute)."/> <min value="0"/> <max value="1"/> <base> <path value="Resource.language"/> <min value="0"/> <max value="1"/> </base> <type> <code value="code"/> </type> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet"> <valueReference> <reference value="http://hl7.org/fhir/ValueSet/all-languages"/> </valueReference> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="Language"/> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding"> <valueBoolean value="true"/> </extension> <strength value="extensible"/> <description value="A human language."/> <valueSetReference> <reference value="http://hl7.org/fhir/ValueSet/languages"/> </valueSetReference> </binding> </element> <element id="Substance:cimi-entity-Substance.text"> <path value="Substance.text"/> <short value="Text summary of the resource, for human interpretation"/> <definition value="A human-readable narrative that contains a summary of the resource, and may 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."/> <comment value="Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded in formation is added later."/> <alias value="narrative"/> <alias value="html"/> <alias value="xhtml"/> <alias value="display"/> <min value="0"/> <max value="1"/> <base> <path value="DomainResource.text"/> <min value="0"/> <max value="1"/> </base> <type> <code value="Narrative"/> </type> <condition value="dom-1"/> <mapping> <identity value="rim"/> <map value="Act.text?"/> </mapping> </element> <element id="Substance:cimi-entity-Substance.contained"> <path value="Substance.contained"/> <short value="Contained, inline Resources"/> <definition value="These 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."/> <comment value="This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again."/> <alias value="inline resources"/> <alias value="anonymous resources"/> <alias value="contained resources"/> <min value="0"/> <max value="*"/> <base> <path value="DomainResource.contained"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Resource"/> </type> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element id="Substance:cimi-entity-Substance.extension"> <path value="Substance.extension"/> <slicing id="1"> <discriminator> <type value="value"/> <path value="url"/> </discriminator> <ordered value="false"/> <rules value="open"/> </slicing> <short value="Additional Content defined by implementations"/> <definition value="May be used to represent additional information that is not part of the basic definition of the resource. In order 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."/> <comment value="There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone."/> <alias value="extensions"/> <alias value="user content"/> <min value="0"/> <max value="*"/> <base> <path value="DomainResource.extension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> </type> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element id="Substance:cimi-entity-Substance.extension:category"> <path value="Substance.extension"/> <sliceName value="category"/> <definition value="The type, kind, or class of this item."/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> <profile value="http://hl7.org/fhir/us/odh/StructureDefinition/cimi-element-Category-extension"/> </type> </element> <element id="Substance:cimi-entity-Substance.extension:category.id"> <path value="Substance.extension.id"/> <representation value="xmlAttr"/> <short value="xml:id (or equivalent in JSON)"/> <definition value="unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces."/> <min value="0"/> <max value="1"/> <base> <path value="Element.id"/> <min value="0"/> <max value="1"/> </base> <type> <code value="string"/> </type> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element id="Substance:cimi-entity-Substance.extension:category.extension:extension"> <path value="Substance.extension.extension"/> <sliceName value="extension"/> <short value="Extension"/> <definition value="An Extension"/> <min value="0"/> <max value="0"/> <base> <path value="Element.extension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> </type> </element> <element id="Substance:cimi-entity-Substance.extension:category.url"> <path value="Substance.extension.url"/> <representation value="xmlAttr"/> <short value="identifies the meaning of the extension"/> <definition value="Source of the definition for the extension code - a logical name or a URL."/> <comment value="The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension."/> <min value="1"/> <max value="1"/> <base> <path value="Extension.url"/> <min value="1"/> <max value="1"/> </base> <type> <code value="uri"/> </type> <fixedUri value="http://hl7.org/fhir/us/odh/StructureDefinition/cimi-element-Category-extension"/> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element id="Substance:cimi-entity-Substance.extension:category.valueCodeableConcept"> <path value="Substance.extension.valueCodeableConcept"/> <short value="Value of extension"/> <definition value="Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list)."/> <min value="1"/> <max value="1"/> <base> <path value="Extension.value[x]"/> <min value="0"/> <max value="1"/> </base> <type> <code value="CodeableConcept"/> </type> <binding> <strength value="extensible"/> <valueSetReference> <reference value="http://hl7.org/fhir/ValueSet/substance-category"/> </valueSetReference> </binding> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element id="Substance:cimi-entity-Substance.extension:activeflagasacodeableconcept"> <path value="Substance.extension"/> <sliceName value="activeflagasacodeableconcept"/> <definition value="If the ActiveFlag is false, it indicates the record or item is no longer to be used and should generally be hidden for the user in the UI."/> <min value="0"/> <max value="1"/> <type> <code value="Extension"/> <profile value="http://hl7.org/fhir/us/odh/StructureDefinition/cimi-entity-ActiveFlagAsaCodeableConcept-extension"/> </type> </element> <element id="Substance:cimi-entity-Substance.extension:activeflagasacodeableconcept.id"> <path value="Substance.extension.id"/> <representation value="xmlAttr"/> <short value="xml:id (or equivalent in JSON)"/> <definition value="unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces."/> <min value="0"/> <max value="1"/> <base> <path value="Element.id"/> <min value="0"/> <max value="1"/> </base> <type> <code value="string"/> </type> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element id="Substance:cimi-entity-Substance.extension:activeflagasacodeableconcept.extension:extension"> <path value="Substance.extension.extension"/> <sliceName value="extension"/> <short value="Extension"/> <definition value="An Extension"/> <min value="0"/> <max value="0"/> <base> <path value="Element.extension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> </type> </element> <element id="Substance:cimi-entity-Substance.extension:activeflagasacodeableconcept.url"> <path value="Substance.extension.url"/> <representation value="xmlAttr"/> <short value="identifies the meaning of the extension"/> <definition value="Source of the definition for the extension code - a logical name or a URL."/> <comment value="The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension."/> <min value="1"/> <max value="1"/> <base> <path value="Extension.url"/> <min value="1"/> <max value="1"/> </base> <type> <code value="uri"/> </type> <fixedUri value="http://hl7.org/fhir/us/odh/StructureDefinition/cimi-entity-ActiveFlagAsaCodeableConcept-extension"/> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element id="Substance:cimi-entity-Substance.extension:activeflagasacodeableconcept.valueCodeableConcept"> <path value="Substance.extension.valueCodeableConcept"/> <short value="Value of extension"/> <definition value="Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list)."/> <min value="1"/> <max value="1"/> <base> <path value="Extension.value[x]"/> <min value="0"/> <max value="1"/> </base> <type> <code value="CodeableConcept"/> </type> <binding> <strength value="required"/> <valueSetReference> <reference value="http://hl7.org/fhir/ValueSet/substance-status"/> </valueSetReference> </binding> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element id="Substance:cimi-entity-Substance.extension:additionaltext"> <path value="Substance.extension"/> <sliceName value="additionaltext"/> <definition value="A text note containing additional details, explanation, description, comment, or summarization. Details can discuss, support, explain changes to, or dispute information."/> <min value="0"/> <max value="1"/> <type> <code value="Extension"/> <profile value="http://hl7.org/fhir/us/odh/StructureDefinition/cimi-core-AdditionalText-extension"/> </type> </element> <element id="Substance:cimi-entity-Substance.modifierExtension"> <path value="Substance.modifierExtension"/> <short value="Extensions that cannot be ignored"/> <definition value="May 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. Usually modifier elements provide negation or qualification. In order 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."/> <comment value="There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone."/> <alias value="extensions"/> <alias value="user content"/> <min value="0"/> <max value="*"/> <base> <path value="DomainResource.modifierExtension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> </type> <isModifier value="true"/> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element id="Substance:cimi-entity-Substance.identifier"> <path value="Substance.identifier"/> <short value="Unique identifier"/> <definition value="Unique identifier for the substance."/> <comment value="This identifier is associated with the kind of substance in contrast to the Substance.instance.identifier which is associated with the package/container."/> <min value="0"/> <max value="*"/> <type> <code value="Identifier"/> </type> <isSummary value="true"/> <mapping> <identity value="rim"/> <map value=".id"/> </mapping> <mapping> <identity value="w5"/> <map value="id"/> </mapping> </element> <element id="Substance:cimi-entity-Substance.status"> <path value="Substance.status"/> <short value="active | inactive | entered-in-error"/> <definition value="A code to indicate if the substance is actively used."/> <min value="0"/> <max value="1"/> <type> <code value="code"/> </type> <isSummary value="true"/> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="FHIRSubstanceStatus"/> </extension> <strength value="required"/> <description value="A code to indicate if the substance is actively used"/> <valueSetReference> <reference value="http://hl7.org/fhir/ValueSet/substance-status"/> </valueSetReference> </binding> <mapping> <identity value="rim"/> <map value=".statusCode"/> </mapping> <mapping> <identity value="w5"/> <map value="status"/> </mapping> </element> <element id="Substance:cimi-entity-Substance.category"> <path value="Substance.category"/> <short value="What class/type of substance this is"/> <definition value="A code that classifies the general type of substance. This is used for searching, sorting and display purposes."/> <comment value="The level of granularity is defined by the category concepts in the value set. More fine-grained filtering can be performed using the metadata and/or terminology hierarchy in Substance.code."/> <min value="0"/> <max value="*"/> <type> <code value="CodeableConcept"/> </type> <isSummary value="true"/> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="SubstanceCategory"/> </extension> <strength value="extensible"/> <description value="Category or classification of substance"/> <valueSetReference> <reference value="http://hl7.org/fhir/ValueSet/substance-category"/> </valueSetReference> </binding> <mapping> <identity value="rim"/> <map value=".code"/> </mapping> <mapping> <identity value="w5"/> <map value="class"/> </mapping> </element> <element id="Substance:cimi-entity-Substance.code"> <path value="Substance.code"/> <short value="What substance this is"/> <definition value="A code (or set of codes) that identify this substance."/> <comment value="This could be a reference to an externally defined code. It could also be a locally assigned code (e.g. a formulary), optionally with translations to the standard drug codes."/> <min value="1"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <isSummary value="true"/> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="SubstanceCode"/> </extension> <strength value="preferred"/> <description value="Substance codes"/> <valueSetReference> <reference value="http://hl7.org/fhir/ValueSet/substance-code"/> </valueSetReference> </binding> <mapping> <identity value="rim"/> <map value=".code"/> </mapping> <mapping> <identity value="orim"/> <map value="fhir:Substance.code rdfs:subPropertyOf rim:Entity.code"/> </mapping> <mapping> <identity value="w5"/> <map value="what"/> </mapping> </element> <element id="Substance:cimi-entity-Substance.description"> <path value="Substance.description"/> <short value="Textual description of the substance, comments"/> <definition value="A description of the substance - its appearance, handling requirements, and other usage notes."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isSummary value="true"/> <mapping> <identity value="rim"/> <map value=".player.desc"/> </mapping> </element> <element id="Substance:cimi-entity-Substance.instance"> <path value="Substance.instance"/> <short value="If this describes a specific package/container of the substance"/> <definition value="Substance may be used to describe a kind of substance, or a specific package/container of the substance: an instance."/> <min value="0"/> <max value="*"/> <type> <code value="BackboneElement"/> </type> <meaningWhenMissing value="If this element is not present, then the substance resource describes a kind of substance"/> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() | (children().count() > id.count())"/> <xpath value="@value|f:*|h:div"/> <source value="Element"/> </constraint> <isSummary value="true"/> <mapping> <identity value="rim"/> <map value=".player.determinerCode"/> </mapping> </element> <element id="Substance:cimi-entity-Substance.instance.id"> <path value="Substance.instance.id"/> <representation value="xmlAttr"/> <short value="xml:id (or equivalent in JSON)"/> <definition value="unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces."/> <min value="0"/> <max value="1"/> <base> <path value="Element.id"/> <min value="0"/> <max value="1"/> </base> <type> <code value="string"/> </type> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element id="Substance:cimi-entity-Substance.instance.extension"> <path value="Substance.instance.extension"/> <short value="Additional Content defined by implementations"/> <definition value="May be used to represent additional information that is not part of the basic definition of the element. In order 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."/> <comment value="There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone."/> <alias value="extensions"/> <alias value="user content"/> <min value="0"/> <max value="*"/> <base> <path value="Element.extension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> </type> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element id="Substance:cimi-entity-Substance.instance.modifierExtension"> <path value="Substance.instance.modifierExtension"/> <short value="Extensions that cannot be ignored"/> <definition value="May 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 that contains it. Usually modifier elements provide negation or qualification. In order 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."/> <comment value="There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone."/> <alias value="extensions"/> <alias value="user content"/> <alias value="modifiers"/> <min value="0"/> <max value="*"/> <base> <path value="BackboneElement.modifierExtension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> </type> <isModifier value="true"/> <isSummary value="true"/> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element id="Substance:cimi-entity-Substance.instance.identifier"> <path value="Substance.instance.identifier"/> <short value="Identifier of the package/container"/> <definition value="Identifier associated with the package/container (usually a label affixed directly)."/> <min value="0"/> <max value="1"/> <type> <code value="Identifier"/> </type> <isSummary value="true"/> <mapping> <identity value="rim"/> <map value=".id"/> </mapping> </element> <element id="Substance:cimi-entity-Substance.instance.expiry"> <path value="Substance.instance.expiry"/> <short value="When no longer valid to use"/> <definition value="When the substance is no longer valid to use. For some substances, a single arbitrary date is used for expiry."/> <min value="0"/> <max value="1"/> <type> <code value="dateTime"/> </type> <isSummary value="true"/> <mapping> <identity value="rim"/> <map value=".expiryTime"/> </mapping> </element> <element id="Substance:cimi-entity-Substance.instance.quantity"> <path value="Substance.instance.quantity"/> <short value="Amount of substance in the package"/> <definition value="The amount of the substance."/> <min value="0"/> <max value="1"/> <type> <code value="Quantity"/> <profile value="http://hl7.org/fhir/StructureDefinition/SimpleQuantity"/> </type> <isSummary value="true"/> <mapping> <identity value="rim"/> <map value=".player.quantity"/> </mapping> </element> <element id="Substance:cimi-entity-Substance.ingredient"> <path value="Substance.ingredient"/> <short value="Composition information about the substance"/> <definition value="A substance can be composed of other substances."/> <min value="0"/> <max value="*"/> <type> <code value="BackboneElement"/> </type> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() | (children().count() > id.count())"/> <xpath value="@value|f:*|h:div"/> <source value="Element"/> </constraint> <isSummary value="true"/> <mapping> <identity value="rim"/> <map value=".player.scopesRole[classCode=INGR]"/> </mapping> </element> <element id="Substance:cimi-entity-Substance.ingredient.id"> <path value="Substance.ingredient.id"/> <representation value="xmlAttr"/> <short value="xml:id (or equivalent in JSON)"/> <definition value="unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces."/> <min value="0"/> <max value="1"/> <base> <path value="Element.id"/> <min value="0"/> <max value="1"/> </base> <type> <code value="string"/> </type> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element id="Substance:cimi-entity-Substance.ingredient.extension"> <path value="Substance.ingredient.extension"/> <short value="Additional Content defined by implementations"/> <definition value="May be used to represent additional information that is not part of the basic definition of the element. In order 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."/> <comment value="There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone."/> <alias value="extensions"/> <alias value="user content"/> <min value="0"/> <max value="*"/> <base> <path value="Element.extension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> </type> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element id="Substance:cimi-entity-Substance.ingredient.modifierExtension"> <path value="Substance.ingredient.modifierExtension"/> <short value="Extensions that cannot be ignored"/> <definition value="May 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 that contains it. Usually modifier elements provide negation or qualification. In order 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."/> <comment value="There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone."/> <alias value="extensions"/> <alias value="user content"/> <alias value="modifiers"/> <min value="0"/> <max value="*"/> <base> <path value="BackboneElement.modifierExtension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> </type> <isModifier value="true"/> <isSummary value="true"/> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element id="Substance:cimi-entity-Substance.ingredient.quantity"> <path value="Substance.ingredient.quantity"/> <short value="Optional amount (concentration)"/> <definition value="The amount of the ingredient in the substance - a concentration ratio."/> <min value="0"/> <max value="1"/> <type> <code value="Ratio"/> </type> <isSummary value="true"/> <mapping> <identity value="rim"/> <map value=".quantity"/> </mapping> </element> <element id="Substance:cimi-entity-Substance.ingredient.substance[x]"> <path value="Substance.ingredient.substance[x]"/> <short value="A component of the substance"/> <definition value="Another substance that is a component of this substance."/> <min value="1"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <type> <code value="Reference"/> <targetProfile value="http://hl7.org/fhir/us/odh/StructureDefinition/cimi-entity-Substance"/> </type> <isSummary value="true"/> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="SubstanceIngredient"/> </extension> <strength value="example"/> <description value="Substance Ingredient codes"/> <valueSetReference> <reference value="http://hl7.org/fhir/ValueSet/substance-code"/> </valueSetReference> </binding> <mapping> <identity value="rim"/> <map value=".player"/> </mapping> </element> </snapshot> <differential> <element id="Substance:cimi-entity-Substance"> <path value="Substance"/> <short value="ODH Substance Profile"/> <definition value="Any matter of defined composition that has discrete existence, whose origin may be biological, mineral or chemical."/> </element> <element id="Substance:cimi-entity-Substance.extension:category"> <path value="Substance.extension"/> <sliceName value="category"/> <definition value="The type, kind, or class of this item."/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> <profile value="http://hl7.org/fhir/us/odh/StructureDefinition/cimi-element-Category-extension"/> </type> </element> <element id="Substance:cimi-entity-Substance.extension:category.valueCodeableConcept"> <path value="Substance.extension.valueCodeableConcept"/> <binding> <strength value="extensible"/> <valueSetReference> <reference value="http://hl7.org/fhir/ValueSet/substance-category"/> </valueSetReference> </binding> </element> <element id="Substance:cimi-entity-Substance.extension:activeflagasacodeableconcept"> <path value="Substance.extension"/> <sliceName value="activeflagasacodeableconcept"/> <definition value="If the ActiveFlag is false, it indicates the record or item is no longer to be used and should generally be hidden for the user in the UI."/> <min value="0"/> <max value="1"/> <type> <code value="Extension"/> <profile value="http://hl7.org/fhir/us/odh/StructureDefinition/cimi-entity-ActiveFlagAsaCodeableConcept-extension"/> </type> </element> <element id="Substance:cimi-entity-Substance.extension:activeflagasacodeableconcept.valueCodeableConcept"> <path value="Substance.extension.valueCodeableConcept"/> <binding> <strength value="required"/> <valueSetReference> <reference value="http://hl7.org/fhir/ValueSet/substance-status"/> </valueSetReference> </binding> </element> <element id="Substance:cimi-entity-Substance.extension:additionaltext"> <path value="Substance.extension"/> <sliceName value="additionaltext"/> <definition value="A text note containing additional details, explanation, description, comment, or summarization. Details can discuss, support, explain changes to, or dispute information."/> <min value="0"/> <max value="1"/> <type> <code value="Extension"/> <profile value="http://hl7.org/fhir/us/odh/StructureDefinition/cimi-core-AdditionalText-extension"/> </type> </element> <element id="Substance:cimi-entity-Substance.code"> <path value="Substance.code"/> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="SubstanceCode"/> </extension> <strength value="preferred"/> <description value="Substance codes"/> <valueSetReference> <reference value="http://hl7.org/fhir/ValueSet/substance-code"/> </valueSetReference> </binding> </element> <element id="Substance:cimi-entity-Substance.ingredient"> <path value="Substance.ingredient"/> </element> <element id="Substance:cimi-entity-Substance.ingredient.substance[x]"> <path value="Substance.ingredient.substance[x]"/> <type> <code value="CodeableConcept"/> </type> <type> <code value="Reference"/> <targetProfile value="http://hl7.org/fhir/us/odh/StructureDefinition/cimi-entity-Substance"/> </type> </element> </differential> </StructureDefinition>
ODH Version: 0.1.0 ®© FHIR Version: 3.0.1 generated on Tue, Aug 21, 2018 16:12+1000.
| History
