DaVinci Payer Data Exchange (PDex) US Drug Formulary | STU2 Ballot
1.2.0 - STU2 Ballot
DaVinci Payer Data Exchange (PDex) US Drug Formulary | STU2 Ballot
1.2.0 - STU2 Ballot
This page is part of the US Drug Formulary (v1.2.0: STU 2 Ballot 1) based on FHIR R4. The current version which supercedes this version is 2.0.0. For a full list of available versions, see the Directory of published versions 
<CapabilityStatement xmlns="http://hl7.org/fhir">
<id value="usdf-server"/>
<text>
<status value="generated"/>
<div xmlns="http://www.w3.org/1999/xhtml"><h2 id="title">usdf-server CapabilityStatement</h2><ul><li><b>Official URL:</b><code>http://hl7.org/fhir/us/davinci-drug-formulary/CapabilityStatement/usdf-server</code></li><li><b>Implementation Guide Version:</b> 1.2.0</li><li><b>FHIR Version:</b> 4.0.1</li><li><b>Intended Use:</b> Requirements</li><li><b>Supported Formats:</b>
XML, JSON
</li><li><b>Supported Patch Formats:</b>
APPLICATION/JSON-PATCH+JSON
</li><li><b>Published:</b> 2021-11-11</li><li><b>Published by:</b> HL7 Pharmacy Working Group</li><li><b>Status:</b> Active</li></ul><p>This Section describes the expected capabilities of the US Drug Formulary Server actor which is responsible for providing responses to the queries submitted by the US Drug Formulary Requestors. The complete list of FHIR profiles, RESTful operations, and search parameters supported by US Drug Formulary Server are defined.</p> <!-- No support expectation extension --><h3 id="igs" class="no_toc">Support the Following Implementation Guides:</h3><ul><li><a href="http://hl7.org/fhir/us/davinci-drug-formulary/ImplementationGuide/hl7.fhir.us.davinci-drug-formulary">DaVinci Payer Data Exchange (PDex) US Drug Formulary (STU2 ballot)</a></li></ul> <!-- REST Behavior --><h3 id="behavior">FHIR Server RESTful Capabilities</h3><p>US Drug Formulary Server <strong>SHALL</strong>:</p><ol><li>Support all profiles defined in this Implementation Guide..</li><li>Implement the RESTful behavior according to the FHIR specification.</li><li>Return the following response classes:
<ul><li>(Status 400): invalid parameter</li><li>(Status 401/4xx): unauthorized request</li><li>(Status 403): insufficient scope</li><li>(Status 404): unknown resource</li></ul>
</li><li>Support json source formats for all US Drug Formulary interactions.</li><li>Support the searchParameters on each profile individually and in combination.</li></ol><p>US Drug Formulary Server <strong>SHOULD</strong>:</p><ol><li>Support xml source formats for all US Drug Formulary interactions.</li></ol><h3 id="resource--details" class="no_toc">RESTful Capabilities by Resource/Profile:</h3><p><strong>Summary</strong></p><table class="grid"><thead><tr><th>Resource Type</th><th>Supported Interactions</th><th>Supported Profiles</th><th>Supported Searches</th><th>Supported <code>_includes</code></th><th>Supported <code>_revincludes</code></th><th>Supported Operations</th></tr></thead><tbody><tr><td><a href="#insuranceplan">InsurancePlan</a></td><td>
create,
search-type,
read,
vread,
update,
patch,
delete,
history-instance,
history-type
</td> <!-- Supported Profiles --><td><a href="http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-PayerInsurancePlan">Payer Insurance Plan</a>,
<a href="http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-Formulary">Formulary</a></td> <!-- Supported Searches --><td>
_id, _lastUpdated, identifier, status, period, type, name, coverage-type, formulary-coverage, coverage-area
</td> <!-- Supported _includes --><td>
formulary-coverage
</td> <!-- Supported _revincludes --><td>
</td> <!-- Supported Operations --><td>
</td></tr><tr><td><a href="#basic">Basic</a></td><td>
create,
search-type,
read,
vread,
update,
patch,
delete,
history-instance,
history-type
</td> <!-- Supported Profiles --><td><a href="http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-FormularyItem">Formulary Item</a></td> <!-- Supported Searches --><td>
_id, _lastUpdated, code, subject, status, period, formulary, pharmacy-type, drug-tier
</td> <!-- Supported _includes --><td>
subject, formulary
</td> <!-- Supported _revincludes --><td>
</td> <!-- Supported Operations --><td>
</td></tr><tr><td><a href="#medicationknowledge">MedicationKnowledge</a></td><td>
create,
search-type,
read,
vread,
update,
patch,
delete,
history-instance,
history-type
</td> <!-- Supported Profiles --><td><a href="http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-FormularyDrug">Formulary Drug</a></td> <!-- Supported Searches --><td>
_id, _lastUpdated, status, code, drug-name, doseform
</td> <!-- Supported _includes --><td>
</td> <!-- Supported _revincludes --><td>
</td> <!-- Supported Operations --><td>
</td></tr><tr><td><a href="#location">Location</a></td><td>
create,
search-type,
read,
vread,
update,
patch,
delete,
history-instance,
history-type
</td> <!-- Supported Profiles --><td><a href="http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-InsurancePlanLocation">Insurance Plan Location</a></td> <!-- Supported Searches --><td>
_id, _lastUpdated, address, address-city, address-state, address-postalcode
</td> <!-- Supported _includes --><td>
</td> <!-- Supported _revincludes --><td>
</td> <!-- Supported Operations --><td>
</td></tr></tbody></table> <!-- Resource Details --><h4 id="insuranceplan" class="no_toc">InsurancePlan</h4><p>Conformance Expectation: <strong>SHALL</strong></p><p>Supported Profiles:</p><ul><li><strong>SHOULD</strong> support:
<a href="http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-PayerInsurancePlan">Payer Insurance Plan</a>,
</li><li><strong>SHALL</strong> support:
<a href="http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-Formulary">Formulary</a>
</li></ul><p>Reference Policy: <code>resolves</code></p><p>Profile Interaction Summary:</p><ul><li><strong>SHALL</strong> support
<code>search-type</code>,
<code>read</code>.</li><li><strong>SHOULD</strong> support
<code>vread</code>,
<code>history-instance</code>.</li><li><strong>MAY</strong> support
<code>create</code>,
<code>update</code>,
<code>patch</code>,
<code>delete</code>,
<code>history-type</code>.</li></ul><p>Modify Criteria:</p><ul><li>
A Server <strong>MAY</strong> be capable of creating an InsurancePlan resource using:
<code class="highlighter-rouge">POST [base]/InsurancePlan/[id]{?_format=[mime-type]}</code>
</li><li>
A Server <strong>MAY</strong> be capable of updating an existing InsurancePlan resource using:
<code class="highlighter-rouge">PUT [base]/InsurancePlan/[id]{?_format=[mime-type]}</code>
</li><li>
A Server <strong>MAY</strong> be capable of deleting an InsurancePlan resource using:
<code class="highlighter-rouge">DELETE [base]/InsurancePlan/[id]</code>
</li><li>
A Server <strong>MAY</strong> be capable of patching an existing InsurancePlan resource using:
<code class="highlighter-rouge">PATCH [base]/InsurancePlan/[id]{?_format=[mime-type]}</code>
</li></ul><p>Fetch and Search Criteria:</p><ul><li>
A Server <strong>SHALL</strong> be capable of returning an InsurancePlan resource using:
<code class="highlighter-rouge">GET [base]/InsurancePlan/[id]</code>
</li><li>
A Server <strong>SHOULD</strong> be capable of returning an InsurancePlan resource using:
<code class="highlighter-rouge">GET [base]/InsurancePlan/[id]/_history/vid</code>
</li><li>
A Server <strong>SHALL</strong> be capable of returning resources matching a search query using:
<code class="highlighter-rouge">GET [base]/InsurancePlan/[id]{?[parameters]{&_format=[mime-type]}}</code>
</li><li>
A Server <strong>SHOULD</strong> be capable of returning a history of a InsurancePlan using:
<code class="highlighter-rouge">GET [base]/InsurancePlan/[id]/_history{?[parameters]&_format=[mime-type]}</code>
</li><li>
A Server <strong>MAY</strong> be capable of returning the history of InsurancePlan resources using:
<code class="highlighter-rouge">GET [base]/InsurancePlan/_history{?[parameters]&_format=[mime-type]}</code>
</li><li>
A Server <strong>SHALL </strong> be capable of supporting the following _includes:
<ul><li>formulary-coverage - <code class="highlighter-rouge">GET [base]/InsurancePlan?[parameter=value]&_include=formulary-coverage</code></li></ul>
</li></ul> <!-- Only included search parameters that are not MAY or there is no conformance requirement included --><p>Search Parameter Summary:</p><table class="grid"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Example</th></tr></thead><tbody><tr><td><strong>SHALL</strong></td><td><a href="http://hl7.org/fhir/R4/search.html#id">
_id</a></td><td>
token
</td><td><code class="highlighter-rouge">GET [base]/InsurancePlan?_id=[id]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href="http://hl7.org/fhir/R4/search.html#lastUpdated">
_lastUpdated</a></td><td>
date
</td><td><code class="highlighter-rouge">GET [base]/InsurancePlan?_lastUpdated=[dateTime]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href="http://hl7.org/fhir/R4/insuranceplan.html#search">
identifier</a></td><td>
token
</td><td><code class="highlighter-rouge">GET [base]/InsurancePlan?identifier=[system]|[code]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href="http://hl7.org/fhir/R4/insuranceplan.html#search">
status</a></td><td>
token
</td><td><code class="highlighter-rouge">GET [base]/InsurancePlan?status=[system]|[code]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href="http://hl7.org/fhir/R4/insuranceplan.html#search">
period</a></td><td>
date
</td><td><code class="highlighter-rouge">GET [base]/InsurancePlan?period=[period]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href="http://hl7.org/fhir/R4/insuranceplan.html#search">
type</a></td><td>
token
</td><td><code class="highlighter-rouge">GET [base]/InsurancePlan?type=[system]|[code]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href="http://hl7.org/fhir/R4/insuranceplan.html#search">
name</a></td><td>
string
</td><td><code class="highlighter-rouge">GET [base]/InsurancePlan?name=[name]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href="http://hl7.org/fhir/R4/insuranceplan.html#search">
coverage-type</a></td><td>
token
</td><td><code class="highlighter-rouge">GET [base]/InsurancePlan?coverage-type=[system]|[code]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href="http://hl7.org/fhir/R4/insuranceplan.html#search">
formulary-coverage</a></td><td>
reference
</td><td><code class="highlighter-rouge">GET [base]/InsurancePlan?formulary-coverage=[type]/[id]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href="http://hl7.org/fhir/R4/insuranceplan.html#search">
coverage-area</a></td><td>
reference
</td><td><code class="highlighter-rouge">GET [base]/InsurancePlan?coverage-area=[type]/[id]</code></td></tr></tbody></table><h4 id="basic" class="no_toc">Basic</h4><p>Conformance Expectation: <strong>SHALL</strong></p><p>Supported Profiles:</p><ul><li><strong>SHALL</strong> support:
<a href="http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-FormularyItem">Formulary Item</a>
</li></ul><p>Reference Policy: <code>resolves</code></p><p>Profile Interaction Summary:</p><ul><li><strong>SHALL</strong> support
<code>search-type</code>,
<code>read</code>.</li><li><strong>SHOULD</strong> support
<code>vread</code>,
<code>history-instance</code>.</li><li><strong>MAY</strong> support
<code>create</code>,
<code>update</code>,
<code>patch</code>,
<code>delete</code>,
<code>history-type</code>.</li></ul><p>Modify Criteria:</p><ul><li>
A Server <strong>MAY</strong> be capable of creating a Basic resource using:
<code class="highlighter-rouge">POST [base]/Basic/[id]{?_format=[mime-type]}</code>
</li><li>
A Server <strong>MAY</strong> be capable of updating an existing Basic resource using:
<code class="highlighter-rouge">PUT [base]/Basic/[id]{?_format=[mime-type]}</code>
</li><li>
A Server <strong>MAY</strong> be capable of deleting a Basic resource using:
<code class="highlighter-rouge">DELETE [base]/Basic/[id]</code>
</li><li>
A Server <strong>MAY</strong> be capable of patching an existing Basic resource using:
<code class="highlighter-rouge">PATCH [base]/Basic/[id]{?_format=[mime-type]}</code>
</li></ul><p>Fetch and Search Criteria:</p><ul><li>
A Server <strong>SHALL</strong> be capable of returning a Basic resource using:
<code class="highlighter-rouge">GET [base]/Basic/[id]</code>
</li><li>
A Server <strong>SHOULD</strong> be capable of returning a Basic resource using:
<code class="highlighter-rouge">GET [base]/Basic/[id]/_history/vid</code>
</li><li>
A Server <strong>SHALL</strong> be capable of returning resources matching a search query using:
<code class="highlighter-rouge">GET [base]/Basic/[id]{?[parameters]{&_format=[mime-type]}}</code>
</li><li>
A Server <strong>SHOULD</strong> be capable of returning a history of a Basic using:
<code class="highlighter-rouge">GET [base]/Basic/[id]/_history{?[parameters]&_format=[mime-type]}</code>
</li><li>
A Server <strong>MAY</strong> be capable of returning the history of Basic resources using:
<code class="highlighter-rouge">GET [base]/Basic/_history{?[parameters]&_format=[mime-type]}</code>
</li><li>
A Server <strong>SHALL </strong> be capable of supporting the following _includes:
<ul><li>subject - <code class="highlighter-rouge">GET [base]/Basic?[parameter=value]&_include=subject</code></li><li>formulary - <code class="highlighter-rouge">GET [base]/Basic?[parameter=value]&_include=formulary</code></li></ul>
</li></ul> <!-- Only included search parameters that are not MAY or there is no conformance requirement included --><p>Search Parameter Summary:</p><table class="grid"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Example</th></tr></thead><tbody><tr><td><strong>SHALL</strong></td><td><a href="http://hl7.org/fhir/R4/search.html#id">
_id</a></td><td>
token
</td><td><code class="highlighter-rouge">GET [base]/Basic?_id=[id]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href="http://hl7.org/fhir/R4/search.html#lastUpdated">
_lastUpdated</a></td><td>
date
</td><td><code class="highlighter-rouge">GET [base]/Basic?_lastUpdated=[dateTime]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href="http://hl7.org/fhir/R4/basic.html#search">
code</a></td><td>
token
</td><td><code class="highlighter-rouge">GET [base]/Basic?code=[system]|[code]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href="http://hl7.org/fhir/R4/basic.html#search">
subject</a></td><td>
reference
</td><td><code class="highlighter-rouge">GET [base]/Basic?subject=[type]/[id]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href="http://hl7.org/fhir/R4/basic.html#search">
status</a></td><td>
token
</td><td><code class="highlighter-rouge">GET [base]/Basic?status=[system]|[code]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href="http://hl7.org/fhir/R4/basic.html#search">
period</a></td><td>
date
</td><td><code class="highlighter-rouge">GET [base]/Basic?period=[period]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href="http://hl7.org/fhir/R4/basic.html#search">
formulary</a></td><td>
reference
</td><td><code class="highlighter-rouge">GET [base]/Basic?formulary=[type]/[id]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href="http://hl7.org/fhir/R4/basic.html#search">
pharmacy-type</a></td><td>
token
</td><td><code class="highlighter-rouge">GET [base]/Basic?pharmacy-type=[system]|[code]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href="http://hl7.org/fhir/R4/basic.html#search">
drug-tier</a></td><td>
token
</td><td><code class="highlighter-rouge">GET [base]/Basic?drug-tier=[system]|[code]</code></td></tr></tbody></table><h4 id="medicationknowledge" class="no_toc">MedicationKnowledge</h4><p>Conformance Expectation: <strong>SHALL</strong></p><p>Supported Profiles:</p><ul><li><strong>SHALL</strong> support:
<a href="http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-FormularyDrug">Formulary Drug</a>
</li></ul><p>Reference Policy: <code>resolves</code></p><p>Profile Interaction Summary:</p><ul><li><strong>SHALL</strong> support
<code>search-type</code>,
<code>read</code>.</li><li><strong>SHOULD</strong> support
<code>vread</code>,
<code>history-instance</code>.</li><li><strong>MAY</strong> support
<code>create</code>,
<code>update</code>,
<code>patch</code>,
<code>delete</code>,
<code>history-type</code>.</li></ul><p>Modify Criteria:</p><ul><li>
A Server <strong>MAY</strong> be capable of creating a MedicationKnowledge resource using:
<code class="highlighter-rouge">POST [base]/MedicationKnowledge/[id]{?_format=[mime-type]}</code>
</li><li>
A Server <strong>MAY</strong> be capable of updating an existing MedicationKnowledge resource using:
<code class="highlighter-rouge">PUT [base]/MedicationKnowledge/[id]{?_format=[mime-type]}</code>
</li><li>
A Server <strong>MAY</strong> be capable of deleting a MedicationKnowledge resource using:
<code class="highlighter-rouge">DELETE [base]/MedicationKnowledge/[id]</code>
</li><li>
A Server <strong>MAY</strong> be capable of patching an existing MedicationKnowledge resource using:
<code class="highlighter-rouge">PATCH [base]/MedicationKnowledge/[id]{?_format=[mime-type]}</code>
</li></ul><p>Fetch and Search Criteria:</p><ul><li>
A Server <strong>SHALL</strong> be capable of returning a MedicationKnowledge resource using:
<code class="highlighter-rouge">GET [base]/MedicationKnowledge/[id]</code>
</li><li>
A Server <strong>SHOULD</strong> be capable of returning a MedicationKnowledge resource using:
<code class="highlighter-rouge">GET [base]/MedicationKnowledge/[id]/_history/vid</code>
</li><li>
A Server <strong>SHALL</strong> be capable of returning resources matching a search query using:
<code class="highlighter-rouge">GET [base]/MedicationKnowledge/[id]{?[parameters]{&_format=[mime-type]}}</code>
</li><li>
A Server <strong>SHOULD</strong> be capable of returning a history of a MedicationKnowledge using:
<code class="highlighter-rouge">GET [base]/MedicationKnowledge/[id]/_history{?[parameters]&_format=[mime-type]}</code>
</li><li>
A Server <strong>MAY</strong> be capable of returning the history of MedicationKnowledge resources using:
<code class="highlighter-rouge">GET [base]/MedicationKnowledge/_history{?[parameters]&_format=[mime-type]}</code>
</li></ul> <!-- Only included search parameters that are not MAY or there is no conformance requirement included --><p>Search Parameter Summary:</p><table class="grid"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Example</th></tr></thead><tbody><tr><td><strong>SHALL</strong></td><td><a href="http://hl7.org/fhir/R4/search.html#id">
_id</a></td><td>
token
</td><td><code class="highlighter-rouge">GET [base]/MedicationKnowledge?_id=[id]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href="http://hl7.org/fhir/R4/search.html#lastUpdated">
_lastUpdated</a></td><td>
date
</td><td><code class="highlighter-rouge">GET [base]/MedicationKnowledge?_lastUpdated=[dateTime]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href="http://hl7.org/fhir/R4/medicationknowledge.html#search">
status</a></td><td>
token
</td><td><code class="highlighter-rouge">GET [base]/MedicationKnowledge?status=[system]|[code]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href="http://hl7.org/fhir/R4/medicationknowledge.html#search">
code</a></td><td>
token
</td><td><code class="highlighter-rouge">GET [base]/MedicationKnowledge?code=[system]|[code]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href="http://hl7.org/fhir/R4/medicationknowledge.html#search">
drug-name</a></td><td>
string
</td><td><code class="highlighter-rouge">GET [base]/MedicationKnowledge?drug-name=[drug-name]</code></td></tr><tr><td><strong>SHOULD</strong></td><td><a href="http://hl7.org/fhir/R4/medicationknowledge.html#search">
doseform</a></td><td>
token
</td><td><code class="highlighter-rouge">GET [base]/MedicationKnowledge?doseform=[system]|[code]</code></td></tr></tbody></table><h4 id="location" class="no_toc">Location</h4><p>Conformance Expectation: <strong>SHOULD</strong></p><p>Supported Profiles:</p><ul><li><strong>SHALL</strong> support:
<a href="http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-InsurancePlanLocation">Insurance Plan Location</a>
</li></ul><p>Reference Policy: <code>resolves</code></p><p>Profile Interaction Summary:</p><ul><li><strong>SHALL</strong> support
<code>search-type</code>,
<code>read</code>.</li><li><strong>SHOULD</strong> support
<code>vread</code>,
<code>history-instance</code>.</li><li><strong>MAY</strong> support
<code>create</code>,
<code>update</code>,
<code>patch</code>,
<code>delete</code>,
<code>history-type</code>.</li></ul><p>Modify Criteria:</p><ul><li>
A Server <strong>MAY</strong> be capable of creating a Location resource using:
<code class="highlighter-rouge">POST [base]/Location/[id]{?_format=[mime-type]}</code>
</li><li>
A Server <strong>MAY</strong> be capable of updating an existing Location resource using:
<code class="highlighter-rouge">PUT [base]/Location/[id]{?_format=[mime-type]}</code>
</li><li>
A Server <strong>MAY</strong> be capable of deleting a Location resource using:
<code class="highlighter-rouge">DELETE [base]/Location/[id]</code>
</li><li>
A Server <strong>MAY</strong> be capable of patching an existing Location resource using:
<code class="highlighter-rouge">PATCH [base]/Location/[id]{?_format=[mime-type]}</code>
</li></ul><p>Fetch and Search Criteria:</p><ul><li>
A Server <strong>SHALL</strong> be capable of returning a Location resource using:
<code class="highlighter-rouge">GET [base]/Location/[id]</code>
</li><li>
A Server <strong>SHOULD</strong> be capable of returning a Location resource using:
<code class="highlighter-rouge">GET [base]/Location/[id]/_history/vid</code>
</li><li>
A Server <strong>SHALL</strong> be capable of returning resources matching a search query using:
<code class="highlighter-rouge">GET [base]/Location/[id]{?[parameters]{&_format=[mime-type]}}</code>
</li><li>
A Server <strong>SHOULD</strong> be capable of returning a history of a Location using:
<code class="highlighter-rouge">GET [base]/Location/[id]/_history{?[parameters]&_format=[mime-type]}</code>
</li><li>
A Server <strong>MAY</strong> be capable of returning the history of Location resources using:
<code class="highlighter-rouge">GET [base]/Location/_history{?[parameters]&_format=[mime-type]}</code>
</li></ul> <!-- Only included search parameters that are not MAY or there is no conformance requirement included --><p>Search Parameter Summary:</p><table class="grid"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Example</th></tr></thead><tbody><tr><td><strong>SHALL</strong></td><td><a href="http://hl7.org/fhir/R4/search.html#id">
_id</a></td><td>
token
</td><td><code class="highlighter-rouge">GET [base]/Location?_id=[id]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href="http://hl7.org/fhir/R4/search.html#lastUpdated">
_lastUpdated</a></td><td>
date
</td><td><code class="highlighter-rouge">GET [base]/Location?_lastUpdated=[dateTime]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href="http://hl7.org/fhir/R4/location.html#search">
address</a></td><td>
string
</td><td><code class="highlighter-rouge">GET [base]/Location?address=[address]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href="http://hl7.org/fhir/R4/location.html#search">
address-city</a></td><td>
string
</td><td><code class="highlighter-rouge">GET [base]/Location?address-city=[address-city]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href="http://hl7.org/fhir/R4/location.html#search">
address-state</a></td><td>
string
</td><td><code class="highlighter-rouge">GET [base]/Location?address-state=[address-state]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href="http://hl7.org/fhir/R4/location.html#search">
address-postalcode</a></td><td>
string
</td><td><code class="highlighter-rouge">GET [base]/Location?address-postalcode=[address-postalcode]</code></td></tr></tbody></table></div>
</text>
<url
value="http://hl7.org/fhir/us/davinci-drug-formulary/CapabilityStatement/usdf-server"/>
<version value="1.2.0"/>
<name value="UsdfServerCapabilityStatement"/>
<title value="usdf-server CapabilityStatement"/>
<status value="active"/>
<experimental value="false"/>
<date value="2021-11-11"/>
<publisher value="HL7 Pharmacy Working Group"/>
<contact>
<name value="HL7 Pharmacy Working Group"/>
<telecom>
<system value="url"/>
<value value="http://www.hl7.org/Special/committees/medication"/>
</telecom>
<telecom>
<system value="email"/>
<value value="pharmacy@lists.HL7.org"/>
</telecom>
</contact>
<description
value="This Section describes the expected capabilities of the US Drug Formulary Server actor which is responsible for providing responses to the queries submitted by the US Drug Formulary Requestors. The complete list of FHIR profiles, RESTful operations, and search parameters supported by US Drug Formulary Server are defined."/>
<jurisdiction>
<coding>
<system value="urn:iso:std:iso:3166"/>
<code value="US"/>
</coding>
</jurisdiction>
<kind value="requirements"/>
<fhirVersion value="4.0.1"/>
<format value="xml"/>
<format value="json"/>
<patchFormat value="application/json-patch+json"/>
<implementationGuide
value="http://hl7.org/fhir/us/davinci-drug-formulary/ImplementationGuide/hl7.fhir.us.davinci-drug-formulary"/>
<rest>
<mode value="server"/>
<documentation
value="US Drug Formulary Server **SHALL**:
1. Support all profiles defined in this Implementation Guide..
1. Implement the RESTful behavior according to the FHIR specification.
1. Return the following response classes:
- (Status 400): invalid parameter
- (Status 401/4xx): unauthorized request
- (Status 403): insufficient scope
- (Status 404): unknown resource
1. Support json source formats for all US Drug Formulary interactions.
1. Support the searchParameters on each profile individually and in combination.
US Drug Formulary Server **SHOULD**:
1. Support xml source formats for all US Drug Formulary interactions.
"/>
<resource>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<type value="InsurancePlan"/>
<supportedProfile
value="http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-PayerInsurancePlan">
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
</supportedProfile>
<supportedProfile
value="http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-Formulary">
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
</supportedProfile>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="create"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<code value="search-type"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<code value="read"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<code value="vread"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="update"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="patch"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="delete"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<code value="history-instance"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="history-type"/>
</interaction>
<referencePolicy value="resolves"/>
<searchInclude value="formulary-coverage">
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
</searchInclude>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="_id"/>
<definition value="http://hl7.org/fhir/SearchParameter/Resource-id"/>
<type value="token"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="_lastUpdated"/>
<definition
value="http://hl7.org/fhir/us/davinci-drug-formulary/SearchParameter/InsurancePlan-lastupdated"/>
<type value="date"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="identifier"/>
<definition
value="http://hl7.org/fhir/us/davinci-drug-formulary/SearchParameter/InsurancePlan-identifier"/>
<type value="token"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="status"/>
<definition
value="http://hl7.org/fhir/us/davinci-drug-formulary/SearchParameter/InsurancePlan-status"/>
<type value="token"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="period"/>
<definition
value="http://hl7.org/fhir/us/davinci-drug-formulary/SearchParameter/InsurancePlan-period"/>
<type value="date"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="type"/>
<definition
value="http://hl7.org/fhir/us/davinci-drug-formulary/SearchParameter/InsurancePlan-type"/>
<type value="token"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="name"/>
<definition
value="http://hl7.org/fhir/us/davinci-drug-formulary/SearchParameter/InsurancePlan-name"/>
<type value="string"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="coverage-type"/>
<definition
value="http://hl7.org/fhir/us/davinci-drug-formulary/SearchParameter/InsurancePlan-coverage-type"/>
<type value="token"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="formulary-coverage"/>
<definition
value="http://hl7.org/fhir/us/davinci-drug-formulary/SearchParameter/InsurancePlan-formulary-coverage"/>
<type value="reference"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="coverage-area"/>
<definition
value="http://hl7.org/fhir/us/davinci-drug-formulary/SearchParameter/InsurancePlan-coverage-area"/>
<type value="reference"/>
</searchParam>
</resource>
<resource>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<type value="Basic"/>
<supportedProfile
value="http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-FormularyItem">
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
</supportedProfile>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="create"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<code value="search-type"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<code value="read"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<code value="vread"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="update"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="patch"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="delete"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<code value="history-instance"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="history-type"/>
</interaction>
<referencePolicy value="resolves"/>
<searchInclude value="subject">
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
</searchInclude>
<searchInclude value="formulary">
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
</searchInclude>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="_id"/>
<definition value="http://hl7.org/fhir/SearchParameter/Resource-id"/>
<type value="token"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="_lastUpdated"/>
<definition
value="http://hl7.org/fhir/us/davinci-drug-formulary/SearchParameter/Basic-lastupdated"/>
<type value="date"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="code"/>
<definition
value="http://hl7.org/fhir/us/davinci-drug-formulary/SearchParameter/Basic-code"/>
<type value="token"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="subject"/>
<definition
value="http://hl7.org/fhir/us/davinci-drug-formulary/SearchParameter/Basic-subject"/>
<type value="reference"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="status"/>
<definition
value="http://hl7.org/fhir/us/davinci-drug-formulary/SearchParameter/Basic-status"/>
<type value="token"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="period"/>
<definition
value="http://hl7.org/fhir/us/davinci-drug-formulary/SearchParameter/Basic-period"/>
<type value="date"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="formulary"/>
<definition
value="http://hl7.org/fhir/us/davinci-drug-formulary/SearchParameter/Basic-formulary"/>
<type value="reference"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="pharmacy-type"/>
<definition
value="http://hl7.org/fhir/us/davinci-drug-formulary/SearchParameter/Basic-pharmacy-type"/>
<type value="token"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="drug-tier"/>
<definition
value="http://hl7.org/fhir/us/davinci-drug-formulary/SearchParameter/Basic-drug-tier"/>
<type value="token"/>
</searchParam>
</resource>
<resource>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<type value="MedicationKnowledge"/>
<supportedProfile
value="http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-FormularyDrug">
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
</supportedProfile>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="create"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<code value="search-type"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<code value="read"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<code value="vread"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="update"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="patch"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="delete"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<code value="history-instance"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="history-type"/>
</interaction>
<referencePolicy value="resolves"/>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="_id"/>
<definition value="http://hl7.org/fhir/SearchParameter/Resource-id"/>
<type value="token"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="_lastUpdated"/>
<definition
value="http://hl7.org/fhir/us/davinci-drug-formulary/SearchParameter/MedicationKnowledge-lastupdated"/>
<type value="date"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="status"/>
<definition
value="http://hl7.org/fhir/SearchParameter/MedicationKnowledge-status"/>
<type value="token"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="code"/>
<definition
value="http://hl7.org/fhir/SearchParameter/MedicationKnowledge-code"/>
<type value="token"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="drug-name"/>
<definition
value="http://hl7.org/fhir/us/davinci-drug-formulary/SearchParameter/MedicationKnowledge-drug-name"/>
<type value="string"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<name value="doseform"/>
<definition
value="http://hl7.org/fhir/us/davinci-drug-formulary/SearchParameter/MedicationKnowledge-doseform"/>
<type value="token"/>
</searchParam>
</resource>
<resource>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<type value="Location"/>
<supportedProfile
value="http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-InsurancePlanLocation">
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
</supportedProfile>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="create"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<code value="search-type"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<code value="read"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<code value="vread"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="update"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="patch"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="delete"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<code value="history-instance"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="history-type"/>
</interaction>
<referencePolicy value="resolves"/>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="_id"/>
<definition value="http://hl7.org/fhir/SearchParameter/Resource-id"/>
<type value="token"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="_lastUpdated"/>
<definition
value="http://hl7.org/fhir/SearchParameter/Resource-lastUpdated"/>
<type value="date"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="address"/>
<definition value="http://hl7.org/fhir/SearchParameter/Location-address"/>
<type value="string"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="address-city"/>
<definition
value="http://hl7.org/fhir/SearchParameter/Location-address-city"/>
<type value="string"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="address-state"/>
<definition
value="http://hl7.org/fhir/SearchParameter/Location-address-state"/>
<type value="string"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="address-postalcode"/>
<definition
value="http://hl7.org/fhir/SearchParameter/Location-address-postalcode"/>
<type value="string"/>
</searchParam>
</resource>
</rest>
</CapabilityStatement>
IG © 2021+ HL7 Pharmacy Working Group. Package hl7.fhir.us.davinci-drug-formulary#1.2.0 based on FHIR 4.0.1. Generated 2021-12-03
Links: Table of Contents |
QA Report
| Version History |
Search |
|
Propose a change