PrescribeIT® Specification and Guide Version 3.0 Revision C

http://prescribeit.ca/fhir/OperationDefinition/formulary

Raw XML

<OperationDefinition xmlns="http://hl7.org/fhir">
  <id value="formulary"/>
  <text>
    <status value="extensions"/>
    <div xmlns="http://www.w3.org/1999/xhtml"><h2>Prescribable Product Formulary Lookup</h2><p>OPERATION: Prescribable Product Formulary Lookup</p><p>The official URL for this operation definition is: </p><pre>http://prescribeit.ca/fhir/OperationDefinition/formulary</pre><div><p>This operation provides a means of looking up the formulary status of a specified medication in a specified jurisdiction, as well as identifying approximate cost for the medication.  This information can be used to aid prescribing decisions.</p>
</div><p>URL: [base]/$formulary</p><p>Parameters</p><table class="grid"><tr><td><b>Use</b></td><td><b>Name</b></td><td><b>Cardinality</b></td><td><b>Type</b></td><td><b>Binding</b></td><td><b>Documentation</b></td></tr><tr><td>IN</td><td>jurisdiction</td><td>1..1</td><td><a href="http://hl7.org/fhir/2016may/datatypes.html#code">code</a></td><td><a href="https://tgateway.infoway-inforoute.ca/vs/canadianjurisdiction">https://fhir.infoway-inforoute.ca/ValueSet/canadianjurisdiction|20170626</a> (Required)</td><td><div><p>The code for the jurisdiction whose formulary is being checked.  (This will generally be the jurisdiction in which the pharmacy operates, though it may vary for online or border pharmacies.</p>
</div></td></tr><tr><td>IN</td><td>product</td><td>1..1</td><td><a href="http://hl7.org/fhir/2016may/datatypes.html#code">code</a></td><td><a href="https://tgateway.infoway-inforoute.ca/vs/prescriptionmedicinalproduct">https://fhir.infoway-inforoute.ca/ValueSet/prescriptionmedicinalproduct</a> (Extensible)</td><td><div><p>The code for the drug or natural health product to be looked up in the formulary.  This may be a code for a specific manufactured product or a more general code.  If a more general code is provided, coverage information will be returned for all associated manufactured products with entries in the formulary.</p>
</div></td></tr><tr><td>IN</td><td>representative-din</td><td>0..1</td><td><a href="http://hl7.org/fhir/2016may/datatypes.html#boolean">boolean</a></td><td/><td><div><p>This boolean (allowed values are 'true' and 'false') may only be sent if the product is a DIN.  I.e. If the 'system' portion of the product parameter matches the URL 'http://hl7.org/fhir/sid/ca-hc-din'.  If set to true, it indicates that the search should match on all products having the same formulation as the specified manufactured product, regardless of manufacturer or packaging.</p>
</div></td></tr><tr><td>OUT</td><td>product</td><td>0..*</td><td></td><td/><td><div><p>A manufactured medication found in the jurisdictional formulary associated with the requested drug.  (There will be a maximum of one repetition if the search was for a manufactured product, but there may be more if the search was for a higher-level product.)</p>
</div></td></tr><tr><td>OUT</td><td>product.code</td><td>1..1</td><td><a href="http://hl7.org/fhir/2016may/datatypes.html#Coding">Coding</a></td><td><a href="https://tgateway.infoway-inforoute.ca/vs/prescriptionmedicinalproduct">https://fhir.infoway-inforoute.ca/ValueSet/prescriptionmedicinalproduct</a> (Extensible)</td><td><div><p>The code and name of the product</p>
</div></td></tr><tr><td>OUT</td><td>product.coverage</td><td>1..1</td><td><a href="http://hl7.org/fhir/2016may/datatypes.html#CodeableConcept">CodeableConcept</a></td><td><a href="https://tgateway.infoway-inforoute.ca/vs/prescriptionmedicationcoverage">https://fhir.infoway-inforoute.ca/ValueSet/prescriptionmedicationcoverage|20190430</a> (Required)</td><td><div><p>A code indicating whether the specified product is covered within the specified jurisdiction's formulary</p>
</div></td></tr><tr><td>OUT</td><td>product.costSymbol</td><td>0..1</td><td><a href="http://hl7.org/fhir/2016may/datatypes.html#string">string</a></td><td/><td><div><p>A symbolic representation of the relative cost of a unit of the product (e.g. '$$' or '$$$$+')</p>
</div></td></tr><tr><td>OUT</td><td>product.unitCost</td><td>0..1</td><td><a href="http://hl7.org/fhir/2016may/datatypes.html#Quantity">Quantity</a></td><td/><td><div><p>The estimated cost of a unit of the product in dollars</p>
<p>NOTE: This element is being included for potential future use only.  It is not supported in this release</p>
</div></td></tr><tr><td>OUT</td><td>product.costRange</td><td>0..1</td><td><a href="http://hl7.org/fhir/2016may/datatypes.html#string">string</a></td><td/><td><div><p>A dollar range expressing the expected unit cost of the product (e.g. '$10-20')</p>
</div></td></tr><tr><td>OUT</td><td>product.costUnit</td><td>0..1</td><td><a href="http://hl7.org/fhir/2016may/datatypes.html#string">string</a></td><td/><td><div><p>The quantity of the drug associated with the cost symbol and cost range (e.g. 'per mg' or 'per 28 tablet package')</p>
</div></td></tr><tr><td>OUT</td><td>product.manufacturedProductUrl</td><td>0..1</td><td><a href="http://hl7.org/fhir/2016may/datatypes.html#uri">uri</a></td><td/><td><div><p>A link to a web page or document where additional information can be found about the manufactured product</p>
</div></td></tr><tr><td>OUT</td><td>product.conditionalCoverageUrl</td><td>0..1</td><td><a href="http://hl7.org/fhir/2016may/datatypes.html#uri">uri</a></td><td/><td><div><p>A link to a web page or document where additional information can be found about the formulary's conditional coverage rules</p>
</div></td></tr></table></div>
  </text>
  <url value="http://prescribeit.ca/fhir/OperationDefinition/formulary"/>
  <version value="3.0 Revision C"/>
  <name value="Prescribable Product Formulary Lookup"/>
  <status value="draft"/>
  <kind value="operation"/>
  <date value="2017-01-11T20:45:48-05:00"/>
  <publisher value="Canada Health Infoway"/>
  <contact>
    <telecom>
      <system value="other"/>
      <value value="http://infoway-inforoute.ca"/>
    </telecom>
  </contact>
  <description
               value="This operation provides a means of looking up the formulary status of a specified medication in a specified jurisdiction, as well as identifying approximate cost for the medication.  This information can be used to aid prescribing decisions."/>
  <code value="formulary"/>
  <system value="true"/>
  <instance value="false"/>
  <parameter>
    <name value="jurisdiction"/>
    <use value="in"/>
    <min value="1"/>
    <max value="1"/>
    <documentation
                   value="The code for the jurisdiction whose formulary is being checked.  (This will generally be the jurisdiction in which the pharmacy operates, though it may vary for online or border pharmacies."/>
    <type value="code"/>
    <binding>
      <strength value="required"/>
      <valueSetReference>
        <reference
                   value="https://fhir.infoway-inforoute.ca/ValueSet/canadianjurisdiction|20170626"/>
      </valueSetReference>
    </binding>
  </parameter>
  <parameter>
    <name value="product"/>
    <use value="in"/>
    <min value="1"/>
    <max value="1"/>
    <documentation
                   value="The code for the drug or natural health product to be looked up in the formulary.  This may be a code for a specific manufactured product or a more general code.  If a more general code is provided, coverage information will be returned for all associated manufactured products with entries in the formulary."/>
    <type value="code"/>
    <binding>
      <strength value="extensible"/>
      <valueSetReference>
        <reference
                   value="https://fhir.infoway-inforoute.ca/ValueSet/prescriptionmedicinalproduct"/>
      </valueSetReference>
    </binding>
  </parameter>
  <parameter>
    <name value="representative-din"/>
    <use value="in"/>
    <min value="0"/>
    <max value="1"/>
    <documentation
                   value="This boolean (allowed values are &#39;true&#39; and &#39;false&#39;) may only be sent if the product is a DIN.  I.e. If the &#39;system&#39; portion of the product parameter matches the URL &#39;http://hl7.org/fhir/sid/ca-hc-din&#39;.  If set to true, it indicates that the search should match on all products having the same formulation as the specified manufactured product, regardless of manufacturer or packaging."/>
    <type value="boolean"/>
  </parameter>
  <parameter>
    <name value="product"/>
    <use value="out"/>
    <min value="0"/>
    <max value="*"/>
    <documentation
                   value="A manufactured medication found in the jurisdictional formulary associated with the requested drug.  (There will be a maximum of one repetition if the search was for a manufactured product, but there may be more if the search was for a higher-level product.)"/>
    <part>
      <name value="code"/>
      <use value="out"/>
      <min value="1"/>
      <max value="1"/>
      <documentation value="The code and name of the product"/>
      <type value="Coding"/>
      <binding>
        <strength value="extensible"/>
        <valueSetReference>
          <reference
                     value="https://fhir.infoway-inforoute.ca/ValueSet/prescriptionmedicinalproduct"/>
        </valueSetReference>
      </binding>
    </part>
    <part>
      <name value="coverage"/>
      <use value="out"/>
      <min value="1"/>
      <max value="1"/>
      <documentation
                     value="A code indicating whether the specified product is covered within the specified jurisdiction&#39;s formulary"/>
      <type value="CodeableConcept"/>
      <profile>
        <reference
                   value="http://sharedhealth.exchange/fhir/StructureDefinition/dtprofile-codeableconcept-code"/>
      </profile>
      <binding>
        <strength value="required"/>
        <valueSetReference>
          <reference
                     value="https://fhir.infoway-inforoute.ca/ValueSet/prescriptionmedicationcoverage|20190430"/>
        </valueSetReference>
      </binding>
    </part>
    <part>
      <name value="costSymbol"/>
      <use value="out"/>
      <min value="0"/>
      <max value="1"/>
      <documentation
                     value="A symbolic representation of the relative cost of a unit of the product (e.g. &#39;$$&#39; or &#39;$$$$+&#39;)"/>
      <type value="string"/>
    </part>
    <part>
      <name value="unitCost"/>
      <use value="out"/>
      <min value="0"/>
      <max value="1"/>
      <documentation
                     value="The estimated cost of a unit of the product in dollars

NOTE: This element is being included for potential future use only.  It is not supported in this release"/>
      <type value="Quantity"/>
    </part>
    <part>
      <name value="costRange"/>
      <use value="out"/>
      <min value="0"/>
      <max value="1"/>
      <documentation
                     value="A dollar range expressing the expected unit cost of the product (e.g. &#39;$10-20&#39;)"/>
      <type value="string"/>
    </part>
    <part>
      <name value="costUnit"/>
      <use value="out"/>
      <min value="0"/>
      <max value="1"/>
      <documentation
                     value="The quantity of the drug associated with the cost symbol and cost range (e.g. &#39;per mg&#39; or &#39;per 28 tablet package&#39;)"/>
      <type value="string"/>
    </part>
    <part>
      <name value="manufacturedProductUrl"/>
      <use value="out"/>
      <min value="0"/>
      <max value="1"/>
      <documentation
                     value="A link to a web page or document where additional information can be found about the manufactured product"/>
      <type value="uri"/>
    </part>
    <part>
      <name value="conditionalCoverageUrl"/>
      <use value="out"/>
      <min value="0"/>
      <max value="1"/>
      <documentation
                     value="A link to a web page or document where additional information can be found about the formulary&#39;s conditional coverage rules"/>
      <type value="uri"/>
    </part>
  </parameter>
</OperationDefinition>