Extension-allergyintolerance-substanceexposurerisk.xml

substanceExposureRisk

<StructureDefinition xmlns="http://hl7.org/fhir">
  <id value="allergyintolerance-substanceExposureRisk"/> 
  <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg">
    <valueCode value="pc"/> 
  </extension> 
  <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm">
    <valueInteger value="1"/> 
  </extension> 
  <url value="http://hl7.org/fhir/StructureDefinition/allergyintolerance-substanceExposureRisk"/> 
  <name value="substanceExposureRisk"/> 
  <title value="substanceExposureRisk"/> 
  <status value="draft"/> 
  <date value="2015-02-21"/> 
  <publisher value="Health Level Seven, Inc. - FHIR WG"/> 
  <contact> 
    <telecom> 
      <system value="url"/> 
      <value value="HL7"/> 
    </telecom> 
  </contact> 
  <description value="A complex extension allowing structured capture of the exposure risk of the patient for
   an adverse reaction (allergy or intolerance) to the specified substance/product."/> 
  <fhirVersion value="3.0.2"/> 
  <mapping> 
    <identity value="v2"/> 
    <uri value="http://hl7.org/v2"/> 
    <name value="HL7 v2 Mapping"/> 
  </mapping> 
  <mapping> 
    <identity value="rim"/> 
    <uri value="http://hl7.org/v3"/> 
    <name value="RIM Mapping"/> 
  </mapping> 
  <kind value="complex-type"/> 
  <abstract value="false"/> 
  <contextType value="resource"/> 
  <context value="AllergyIntolerance"/> 
  <type value="Extension"/> 
  <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Extension"/> 
  <derivation value="constraint"/> 
  <snapshot> 
    <element id="Extension">
      <path value="Extension"/> 
      <short value="Exposure risk of adverse reaction (allergy or intolerance) to the specified substance/product"/> 
      <definition value="A complex extension allowing structured capture of the exposure risk of the patient for
       an adverse reaction (allergy or intolerance) to the specified substance/product."/> 
      <comment value="This extension is available and is intended to be used as a more completely structured
       and flexible alternative to the 'code' element for representing positive and negative
       allergy and intolerance statements.  If this extension element is present, the AllergyIntolerance.co
      de element SHALL be omitted (see invariant &quot;code or substanceExposureRisk&quot;)."/> 
      <min value="0"/> 
      <max value="1"/> 
      <base> 
        <path value="Extension"/> 
        <min value="0"/> 
        <max value="*"/> 
      </base> 
      <condition value="ele-1"/> 
      <constraint> 
        <key value="ele-1"/> 
        <severity value="error"/> 
        <human value="All FHIR elements must have a @value or children"/> 
        <expression value="hasValue() | (children().count() &gt; id.count())"/> 
        <xpath value="@value|f:*|h:div"/> 
        <source value="Element"/> 
      </constraint> 
      <constraint> 
        <key value="ext-1"/> 
        <severity value="error"/> 
        <human value="Must have either extensions or value[x], not both"/> 
        <expression value="extension.exists() != value.exists()"/> 
        <xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])"/> 
        <source value="Extension"/> 
      </constraint> 
      <constraint> 
        <key value="inv-1"/> 
        <severity value="error"/> 
        <human value="If the substanceExposureRisk extension element is present, the AllergyIntolerance.code
         element must be omitted."/> 
        <expression value="substanceExposureRisk.exists() and code.empty()"/> 
        <xpath value="exists(f:substanceExposureRisk) and not(exists(f:code))"/> 
      </constraint> 
    </element> 
    <element id="Extension.id">
      <path value="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="Extension.extension">
      <path value="Extension.extension"/> 
      <slicing> 
        <discriminator> 
          <type value="value"/> 
          <path value="url"/> 
        </discriminator> 
        <description value="Extensions are always sliced by (at least) url"/> 
        <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 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="Extension.extension:substance">
      <path value="Extension.extension"/> 
      <sliceName value="substance"/> 
      <short value="Substance (or pharmaceutical product)"/> 
      <definition value="Code for a substance or pharmaceutical product that is considered to be responsible for
       the adverse reaction risk or is known not to have an associated risk of an adverse reaction
       upon exposure."/> 
      <comment value="It is strongly recommended that this element be populated using a terminology, where possible.
       For example, some terminologies used include RxNorm, SNOMED CT, DM+D, NDFRT, UNII, and
       ATC. Plain text should only be used if there is no appropriate terminology available.
       Additional details can be specified in the text."/> 
      <min value="1"/> 
      <max value="1"/> 
      <base> 
        <path value="Element.extension"/> 
        <min value="0"/> 
        <max value="*"/> 
      </base> 
      <type> 
        <code value="Extension"/> 
      </type> 
      <mapping> 
        <identity value="v2"/> 
        <map value="AL1-3 / IAM-3"/> 
      </mapping> 
      <mapping> 
        <identity value="rim"/> 
        <map value=".participation[typeCode=CAGNT].role[classCode=ADMM].player[classCode=MAT, determinerCode=KIND,
         code &lt;= ExposureAgentEntityType]"/> 
      </mapping> 
    </element> 
    <element id="Extension.extension:substance.id">
      <path value="Extension.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="Extension.extension:substance.extension">
      <path value="Extension.extension.extension"/> 
      <slicing> 
        <discriminator> 
          <type value="value"/> 
          <path value="url"/> 
        </discriminator> 
        <description value="Extensions are always sliced by (at least) url"/> 
        <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 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="Extension.extension:substance.url">
      <path value="Extension.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="substance"/> 
      <mapping> 
        <identity value="rim"/> 
        <map value="N/A"/> 
      </mapping> 
    </element> 
    <element id="Extension.extension:substance.valueCodeableConcept">
      <path value="Extension.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="0"/> 
      <max value="1"/> 
      <base> 
        <path value="Extension.value[x]"/> 
        <min value="0"/> 
        <max value="1"/> 
      </base> 
      <type> 
        <code value="CodeableConcept"/> 
      </type> 
      <binding> 
        <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
          <valueString value="SubstanceCode"/> 
        </extension> 
        <strength value="example"/> 
        <description value="Codes defining the type of the substance (including pharmaceutical products)."/> 
        <valueSetReference> 
          <reference value="http://hl7.org/fhir/ValueSet/substance-code"/> 
        </valueSetReference> 
      </binding> 
      <mapping> 
        <identity value="rim"/> 
        <map value="N/A"/> 
      </mapping> 
    </element> 
    <element id="Extension.extension:exposurerisk">
      <path value="Extension.extension"/> 
      <sliceName value="exposureRisk"/> 
      <short value="known-reaction-risk | no-known-reaction-risk"/> 
      <definition value="The presence or absence of a known exposure risk of the patient for an adverse reaction
       (allergy or intolerance) to the specified substance/product."/> 
      <comment value="exposureRisk is a modifier of the substance."/> 
      <min value="1"/> 
      <max value="1"/> 
      <base> 
        <path value="Element.extension"/> 
        <min value="0"/> 
        <max value="*"/> 
      </base> 
      <type> 
        <code value="Extension"/> 
      </type> 
    </element> 
    <element id="Extension.extension:exposurerisk.id">
      <path value="Extension.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="Extension.extension:exposurerisk.extension">
      <path value="Extension.extension.extension"/> 
      <slicing> 
        <discriminator> 
          <type value="value"/> 
          <path value="url"/> 
        </discriminator> 
        <description value="Extensions are always sliced by (at least) url"/> 
        <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 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="Extension.extension:exposurerisk.url">
      <path value="Extension.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="exposureRisk"/> 
      <mapping> 
        <identity value="rim"/> 
        <map value="N/A"/> 
      </mapping> 
    </element> 
    <element id="Extension.extension:exposurerisk.valueCodeableConcept">
      <path value="Extension.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="0"/> 
      <max value="1"/> 
      <base> 
        <path value="Extension.value[x]"/> 
        <min value="0"/> 
        <max value="1"/> 
      </base> 
      <type> 
        <code value="CodeableConcept"/> 
      </type> 
      <binding> 
        <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
          <valueString value="AllergyIntoleranceSubstanceExposureRisk"/> 
        </extension> 
        <strength value="required"/> 
        <description value="The risk of an adverse reaction (allergy or intolerance) for this patient upon exposure
         to the substance (including pharmaceutical products)."/> 
        <valueSetReference> 
          <reference value="http://hl7.org/fhir/ValueSet/allerg-intol-substance-exp-risk"/> 
        </valueSetReference> 
      </binding> 
      <mapping> 
        <identity value="rim"/> 
        <map value="N/A"/> 
      </mapping> 
    </element> 
    <element id="Extension.url">
      <path value="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/StructureDefinition/allergyintolerance-substanceExposureRisk"/> 
      <mapping> 
        <identity value="rim"/> 
        <map value="N/A"/> 
      </mapping> 
    </element> 
    <element id="Extension.value[x]">
      <path value="Extension.value[x]"/> 
      <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="0"/> 
      <max value="0"/> 
      <base> 
        <path value="Extension.value[x]"/> 
        <min value="0"/> 
        <max value="1"/> 
      </base> 
      <type> 
        <code value="base64Binary"/> 
      </type> 
      <type> 
        <code value="boolean"/> 
      </type> 
      <type> 
        <code value="code"/> 
      </type> 
      <type> 
        <code value="date"/> 
      </type> 
      <type> 
        <code value="dateTime"/> 
      </type> 
      <type> 
        <code value="decimal"/> 
      </type> 
      <type> 
        <code value="id"/> 
      </type> 
      <type> 
        <code value="instant"/> 
      </type> 
      <type> 
        <code value="integer"/> 
      </type> 
      <type> 
        <code value="markdown"/> 
      </type> 
      <type> 
        <code value="oid"/> 
      </type> 
      <type> 
        <code value="positiveInt"/> 
      </type> 
      <type> 
        <code value="string"/> 
      </type> 
      <type> 
        <code value="time"/> 
      </type> 
      <type> 
        <code value="unsignedInt"/> 
      </type> 
      <type> 
        <code value="uri"/> 
      </type> 
      <type> 
        <code value="Address"/> 
      </type> 
      <type> 
        <code value="Age"/> 
      </type> 
      <type> 
        <code value="Annotation"/> 
      </type> 
      <type> 
        <code value="Attachment"/> 
      </type> 
      <type> 
        <code value="CodeableConcept"/> 
      </type> 
      <type> 
        <code value="Coding"/> 
      </type> 
      <type> 
        <code value="ContactPoint"/> 
      </type> 
      <type> 
        <code value="Count"/> 
      </type> 
      <type> 
        <code value="Distance"/> 
      </type> 
      <type> 
        <code value="Duration"/> 
      </type> 
      <type> 
        <code value="HumanName"/> 
      </type> 
      <type> 
        <code value="Identifier"/> 
      </type> 
      <type> 
        <code value="Money"/> 
      </type> 
      <type> 
        <code value="Period"/> 
      </type> 
      <type> 
        <code value="Quantity"/> 
      </type> 
      <type> 
        <code value="Range"/> 
      </type> 
      <type> 
        <code value="Ratio"/> 
      </type> 
      <type> 
        <code value="Reference"/> 
      </type> 
      <type> 
        <code value="SampledData"/> 
      </type> 
      <type> 
        <code value="Signature"/> 
      </type> 
      <type> 
        <code value="Timing"/> 
      </type> 
      <type> 
        <code value="Meta"/> 
      </type> 
      <mapping> 
        <identity value="rim"/> 
        <map value="N/A"/> 
      </mapping> 
    </element> 
  </snapshot> 
  <differential> 
    <element id="Extension">
      <path value="Extension"/> 
      <short value="Exposure risk of adverse reaction (allergy or intolerance) to the specified substance/product"/> 
      <definition value="A complex extension allowing structured capture of the exposure risk of the patient for
       an adverse reaction (allergy or intolerance) to the specified substance/product."/> 
      <comment value="This extension is available and is intended to be used as a more completely structured
       and flexible alternative to the 'code' element for representing positive and negative
       allergy and intolerance statements.  If this extension element is present, the AllergyIntolerance.co
      de element SHALL be omitted (see invariant &quot;code or substanceExposureRisk&quot;)."/> 
      <min value="0"/> 
      <max value="1"/> 
      <constraint> 
        <key value="inv-1"/> 
        <severity value="error"/> 
        <human value="If the substanceExposureRisk extension element is present, the AllergyIntolerance.code
         element must be omitted."/> 
        <expression value="substanceExposureRisk.exists() and code.empty()"/> 
        <xpath value="exists(f:substanceExposureRisk) and not(exists(f:code))"/> 
      </constraint> 
    </element> 
    <element id="Extension.extension:substance">
      <path value="Extension.extension"/> 
      <sliceName value="substance"/> 
      <short value="Substance (or pharmaceutical product)"/> 
      <definition value="Code for a substance or pharmaceutical product that is considered to be responsible for
       the adverse reaction risk or is known not to have an associated risk of an adverse reaction
       upon exposure."/> 
      <comment value="It is strongly recommended that this element be populated using a terminology, where possible.
       For example, some terminologies used include RxNorm, SNOMED CT, DM+D, NDFRT, UNII, and
       ATC. Plain text should only be used if there is no appropriate terminology available.
       Additional details can be specified in the text."/> 
      <min value="1"/> 
      <max value="1"/> 
      <type> 
        <code value="Extension"/> 
      </type> 
      <mapping> 
        <identity value="v2"/> 
        <map value="AL1-3 / IAM-3"/> 
      </mapping> 
      <mapping> 
        <identity value="rim"/> 
        <map value=".participation[typeCode=CAGNT].role[classCode=ADMM].player[classCode=MAT, determinerCode=KIND,
         code &lt;= ExposureAgentEntityType]"/> 
      </mapping> 
    </element> 
    <element id="Extension.extension:substance.extension">
      <path value="Extension.extension.extension"/> 
      <max value="0"/> 
    </element> 
    <element id="Extension.extension:substance.url">
      <path value="Extension.extension.url"/> 
      <type> 
        <code value="uri"/> 
      </type> 
      <fixedUri value="substance"/> 
    </element> 
    <element id="Extension.extension:substance.valueCodeableConcept">
      <path value="Extension.extension.valueCodeableConcept"/> 
      <type> 
        <code value="CodeableConcept"/> 
      </type> 
      <binding> 
        <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
          <valueString value="SubstanceCode"/> 
        </extension> 
        <strength value="example"/> 
        <description value="Codes defining the type of the substance (including pharmaceutical products)."/> 
        <valueSetReference> 
          <reference value="http://hl7.org/fhir/ValueSet/substance-code"/> 
        </valueSetReference> 
      </binding> 
    </element> 
    <element id="Extension.extension:exposurerisk">
      <path value="Extension.extension"/> 
      <sliceName value="exposureRisk"/> 
      <short value="known-reaction-risk | no-known-reaction-risk"/> 
      <definition value="The presence or absence of a known exposure risk of the patient for an adverse reaction
       (allergy or intolerance) to the specified substance/product."/> 
      <comment value="exposureRisk is a modifier of the substance."/> 
      <min value="1"/> 
      <max value="1"/> 
      <type> 
        <code value="Extension"/> 
      </type> 
    </element> 
    <element id="Extension.extension:exposurerisk.extension">
      <path value="Extension.extension.extension"/> 
      <max value="0"/> 
    </element> 
    <element id="Extension.extension:exposurerisk.url">
      <path value="Extension.extension.url"/> 
      <type> 
        <code value="uri"/> 
      </type> 
      <fixedUri value="exposureRisk"/> 
    </element> 
    <element id="Extension.extension:exposurerisk.valueCodeableConcept">
      <path value="Extension.extension.valueCodeableConcept"/> 
      <type> 
        <code value="CodeableConcept"/> 
      </type> 
      <binding> 
        <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
          <valueString value="AllergyIntoleranceSubstanceExposureRisk"/> 
        </extension> 
        <strength value="required"/> 
        <description value="The risk of an adverse reaction (allergy or intolerance) for this patient upon exposure
         to the substance (including pharmaceutical products)."/> 
        <valueSetReference> 
          <reference value="http://hl7.org/fhir/ValueSet/allerg-intol-substance-exp-risk"/> 
        </valueSetReference> 
      </binding> 
    </element> 
    <element id="Extension.url">
      <path value="Extension.url"/> 
      <type> 
        <code value="uri"/> 
      </type> 
      <fixedUri value="http://hl7.org/fhir/StructureDefinition/allergyintolerance-substanceExposureRisk"/> 
    </element> 
    <element id="Extension.value[x]">
      <path value="Extension.value[x]"/> 
      <min value="0"/> 
      <max value="0"/> 
    </element> 
  </differential> 
</StructureDefinition>