HL7 FHIR JP Core ImplementationGuide
1.1.0 - release Japan flag

HL7 FHIR JP Core ImplementationGuide - Local Development build (v1.1.0). See the Directory of published versions

Data Type Profile: JP_MedicationRatio_Amount - XML Profile

Active as of 2022-10-24

XML representation of the jp-medicationratio-amount data type profile.

Raw xml | Download



<StructureDefinition xmlns="http://hl7.org/fhir">
  <id value="jp-medicationratio-amount"/>
  <text>
    <status value="extensions"/>
    <div xmlns="http://www.w3.org/1999/xhtml"><table border="0" cellpadding="0" cellspacing="0" style="border: 0px #F0F0F0 solid; font-size: 11px; font-family: verdana; vertical-align: top;"><tr style="border: 1px #F0F0F0 solid; font-size: 11px; font-family: verdana; vertical-align: top"><th style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="http://hl7.org/fhir/R4/formats.html#table" title="The logical name of the element">Name</a></th><th style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="http://hl7.org/fhir/R4/formats.html#table" title="Information about the use of the element">Flags</a></th><th style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="http://hl7.org/fhir/R4/formats.html#table" title="Minimum and Maximum # of times the the element can appear in the instance">Card.</a></th><th style="width: 100px" class="hierarchy"><a href="http://hl7.org/fhir/R4/formats.html#table" title="Reference to the type of the element">Type</a></th><th style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="http://hl7.org/fhir/R4/formats.html#table" title="Additional information about the element">Description &amp; Constraints</a><span style="float: right"><a href="http://hl7.org/fhir/R4/formats.html#table" title="Legend for this format"><img src="http://hl7.org/fhir/R4/help16.png" alt="doco" style="background-color: inherit"/></a></span></th></tr><tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white"><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck1.png)" class="hierarchy"><img src="tbl_spacer.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="icon_element.gif" alt="." style="background-color: white; background-color: inherit" title="Element" class="hierarchy"/> <a href="StructureDefinition-jp-medicationratio-amount-definitions.html#Ratio" title="パッケージあたり薬剤の投与量">Ratio</a><a name="Ratio"> </a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"/><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="opacity: 0.5">0</span><span style="opacity: 0.5">..</span><span style="opacity: 0.5">*</span></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="http://hl7.org/fhir/R4/datatypes.html#Ratio">Ratio</a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy">パッケージあたり薬剤の投与量</td></tr>
<tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: #F7F7F7"><td style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck10.png)" class="hierarchy"><img src="tbl_spacer.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_vjoin.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="icon_datatype.gif" alt="." style="background-color: #F7F7F7; background-color: inherit" title="Data Type" class="hierarchy"/> <a href="StructureDefinition-jp-medicationratio-amount-definitions.html#Ratio.numerator">numerator</a><a name="Ratio.numerator"> </a></td><td style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"/><td style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="opacity: 0.5">0</span><span style="opacity: 0.5">..</span><span style="opacity: 0.5">1</span></td><td style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="StructureDefinition-jp-medicationquantity.html" title="Quantity">JP_MedicationQuantity</a></td><td style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy">投与量</td></tr>
<tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white"><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck00.png)" class="hierarchy"><img src="tbl_spacer.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_vjoin_end.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="icon_datatype.gif" alt="." style="background-color: white; background-color: inherit" title="Data Type" class="hierarchy"/> <a href="StructureDefinition-jp-medicationratio-amount-definitions.html#Ratio.denominator">denominator</a><a name="Ratio.denominator"> </a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"/><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="opacity: 0.5">0</span><span style="opacity: 0.5">..</span><span style="opacity: 0.5">1</span></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="StructureDefinition-jp-medicationquantity.html" title="Quantity">JP_MedicationQuantity</a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy">パッケージ量</td></tr>
<tr><td colspan="5" class="hierarchy"><br/><a href="http://hl7.org/fhir/R4/formats.html#table" title="Legend for this format"><img src="http://hl7.org/fhir/R4/help16.png" alt="doco" style="background-color: inherit"/> Documentation for this format</a></td></tr></table></div>
  </text>
  <url
       value="http://jpfhir.jp/fhir/core/StructureDefinition/JP_MedicationRatio_Amount"/>
  <version value="1.1.0"/>
  <name value="JP_MedicationRatio_Amount"/>
  <title value="JP Core Medication Ratio Amount DataType"/>
  <status value="active"/>
  <date value="2022-10-24"/>
  <publisher
             value="FHIR Japanese implementation research working group in Japan Association of Medical Informatics (JAMI)"/>
  <contact>
    <name
          value="FHIR Japanese implementation research working group in Japan Association of Medical Informatics (JAMI)"/>
    <telecom>
      <system value="url"/>
      <value value="http://jpfhir.jp"/>
    </telecom>
    <telecom>
      <system value="email"/>
      <value value="office@hlfhir.jp"/>
    </telecom>
  </contact>
  <description
               value="このデータタイプはRatio DataTypeに対して、薬剤量/パッケージ量を表す比率を割り当てた制約と拡張を定めたものである。"/>
  <jurisdiction>
    <coding>
      <system value="urn:iso:std:iso:3166"/>
      <code value="JP"/>
    </coding>
  </jurisdiction>
  <copyright
             value="Copyright FHIR Japanese implementation research working group in Japan Association of Medical Informatics (JAMI) 一般社団法人日本医療情報学会NeXEHRS課題研究会FHIR日本実装検討WG"/>
  <fhirVersion value="4.0.1"/>
  <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"/>
  <type value="Ratio"/>
  <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Ratio"/>
  <derivation value="constraint"/>
  <snapshot>
    <element id="Ratio">
      <path value="Ratio"/>
      <short value="パッケージあたり薬剤の投与量"/>
      <definition value="パッケージあたり薬剤の投与量"/>
      <comment value="パッケージあたり薬剤の投与量について薬剤単位をバインディングした型である。"/>
      <min value="0"/>
      <max value="*"/>
      <base>
        <path value="Ratio"/>
        <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() or (children().count() &gt; id.count())"/>
        <xpath value="@value|f:*|h:div"/>
        <source value="http://hl7.org/fhir/StructureDefinition/Element"/>
      </constraint>
      <constraint>
        <key value="rat-1"/>
        <severity value="error"/>
        <human
               value="Numerator and denominator SHALL both be present, or both are absent. If both are absent, there SHALL be some extension present"/>
        <expression
                    value="(numerator.empty() xor denominator.exists()) and (numerator.exists() or extension.exists())"/>
        <xpath
               value="(count(f:numerator) = count(f:denominator)) and ((count(f:numerator) &gt; 0) or (count(f:extension) &gt; 0))"/>
        <source value="http://hl7.org/fhir/StructureDefinition/Ratio"/>
      </constraint>
      <isModifier value="false"/>
      <mapping>
        <identity value="rim"/>
        <map value="n/a"/>
      </mapping>
      <mapping>
        <identity value="v2"/>
        <map value="N/A"/>
      </mapping>
      <mapping>
        <identity value="rim"/>
        <map value="RTO"/>
      </mapping>
    </element>
    <element id="Ratio.id">
      <path value="Ratio.id"/>
      <representation value="xmlAttr"/>
      <short value="Unique id for inter-element referencing"/>
      <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>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type">
          <valueUrl value="string"/>
        </extension>
        <code value="http://hl7.org/fhirpath/System.String"/>
      </type>
      <isModifier value="false"/>
      <isSummary value="false"/>
      <mapping>
        <identity value="rim"/>
        <map value="n/a"/>
      </mapping>
    </element>
    <element id="Ratio.extension">
      <path value="Ratio.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. 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 can 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>
      <constraint>
        <key value="ele-1"/>
        <severity value="error"/>
        <human value="All FHIR elements must have a @value or children"/>
        <expression
                    value="hasValue() or (children().count() &gt; id.count())"/>
        <xpath value="@value|f:*|h:div"/>
        <source value="http://hl7.org/fhir/StructureDefinition/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(.), &quot;value&quot;)])"/>
        <source value="http://hl7.org/fhir/StructureDefinition/Extension"/>
      </constraint>
      <isModifier value="false"/>
      <isSummary value="false"/>
      <mapping>
        <identity value="rim"/>
        <map value="n/a"/>
      </mapping>
    </element>
    <element id="Ratio.numerator">
      <path value="Ratio.numerator"/>
      <short value="投与量"/>
      <definition value="薬剤に関する数量と単位を定めたデータイプ"/>
      <comment
               value="薬剤に関する数量と単位を定めている。ValueおよびCodeを必須としている。単位についてはMERIT9医薬品単位略号の利用を推進している。(**SHOULD**)"/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="Ratio.numerator"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="Quantity"/>
        <profile
                 value="http://jpfhir.jp/fhir/core/StructureDefinition/JP_MedicationQuantity"/>
      </type>
      <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() or (children().count() &gt; id.count())"/>
        <xpath value="@value|f:*|h:div"/>
        <source value="http://hl7.org/fhir/StructureDefinition/Element"/>
      </constraint>
      <constraint>
        <key value="qty-3"/>
        <severity value="error"/>
        <human
               value="If a code for the unit is present, the system SHALL also be present"/>
        <expression value="code.empty() or system.exists()"/>
        <xpath value="not(exists(f:code)) or exists(f:system)"/>
        <source value="http://hl7.org/fhir/StructureDefinition/Quantity"/>
      </constraint>
      <isModifier value="false"/>
      <mapping>
        <identity value="rim"/>
        <map value="n/a"/>
      </mapping>
      <mapping>
        <identity value="v2"/>
        <map value="SN (see also Range) or CQ"/>
      </mapping>
      <mapping>
        <identity value="rim"/>
        <map value="PQ, IVL&lt;PQ&gt;, MO, CO, depending on the values"/>
      </mapping>
    </element>
    <element id="Ratio.denominator">
      <path value="Ratio.denominator"/>
      <short value="パッケージ量"/>
      <definition value="薬剤に関する数量と単位を定めたデータイプ"/>
      <comment
               value="薬剤に関する数量と単位を定めている。ValueおよびCodeを必須としている。単位についてはMERIT9医薬品単位略号の利用を推進している。(**SHOULD**)"/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="Ratio.denominator"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="Quantity"/>
        <profile
                 value="http://jpfhir.jp/fhir/core/StructureDefinition/JP_MedicationQuantity"/>
      </type>
      <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() or (children().count() &gt; id.count())"/>
        <xpath value="@value|f:*|h:div"/>
        <source value="http://hl7.org/fhir/StructureDefinition/Element"/>
      </constraint>
      <constraint>
        <key value="qty-3"/>
        <severity value="error"/>
        <human
               value="If a code for the unit is present, the system SHALL also be present"/>
        <expression value="code.empty() or system.exists()"/>
        <xpath value="not(exists(f:code)) or exists(f:system)"/>
        <source value="http://hl7.org/fhir/StructureDefinition/Quantity"/>
      </constraint>
      <isModifier value="false"/>
      <mapping>
        <identity value="rim"/>
        <map value="n/a"/>
      </mapping>
      <mapping>
        <identity value="v2"/>
        <map value="SN (see also Range) or CQ"/>
      </mapping>
      <mapping>
        <identity value="rim"/>
        <map value="PQ, IVL&lt;PQ&gt;, MO, CO, depending on the values"/>
      </mapping>
    </element>
  </snapshot>
  <differential>
    <element id="Ratio">
      <path value="Ratio"/>
      <short value="パッケージあたり薬剤の投与量"/>
      <definition value="パッケージあたり薬剤の投与量"/>
      <comment value="パッケージあたり薬剤の投与量について薬剤単位をバインディングした型である。"/>
    </element>
    <element id="Ratio.numerator">
      <path value="Ratio.numerator"/>
      <short value="投与量"/>
      <type>
        <code value="Quantity"/>
        <profile
                 value="http://jpfhir.jp/fhir/core/StructureDefinition/JP_MedicationQuantity"/>
      </type>
    </element>
    <element id="Ratio.denominator">
      <path value="Ratio.denominator"/>
      <short value="パッケージ量"/>
      <type>
        <code value="Quantity"/>
        <profile
                 value="http://jpfhir.jp/fhir/core/StructureDefinition/JP_MedicationQuantity"/>
      </type>
    </element>
  </differential>
</StructureDefinition>