DaVinci Payer Data Exchange (PDex) US Drug Formulary
1.0.1 - STU 1.0.1
DaVinci Payer Data Exchange (PDex) US Drug Formulary
1.0.1 - STU 1.0.1
This page is part of the US Drug Formulary (v1.0.1: STU 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>Implementation Guide Version: 1.0.1</li><li>FHIR Version: 4.0.1</li><li>Supported formats: xml, json</li><li>Published: 2020-11-16</li><li>Published by: HL7 Pharmacy Working Group (Pharm WG)</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><h3 id="behavior">FHIR 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><li>(Status 410): deleted 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 of Search Criteria</strong></p><table class="grid"><thead><tr><th>Resource Type</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="#list">List</a></td><td><a href="StructureDefinition-usdf-CoveragePlan.html">CoveragePlan</a></td><td>
_id, identifier, item, status
</td><td>
</td><td>
</td><td>
</td></tr><tr><td><a href="#medicationknowledge">MedicationKnowledge</a></td><td><a href="StructureDefinition-usdf-FormularyDrug.html">FormularyDrug</a></td><td>
DrugName, DrugTier, DrugPlan, code, _id
</td><td>
</td><td>
</td><td>
</td></tr></tbody></table><br/><h4 id="list" class="no_toc">List</h4><p>Conformance Expectation: <strong>SHALL</strong></p><p>Supported Profiles:
<a href="StructureDefinition-usdf-CoveragePlan.html">CoveragePlan</a>
</p><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>Fetch and Search Criteria:</p><ul><li>
A Server <strong>SHALL</strong> be capable of returning a List resource using:
<br/>
<code class="highlighter-rouge">GET [base]/List/[id]</code>
</li><br/><li>
A Server <strong>SHOULD</strong> be capable of returning a List resource using:
<br/>
<code class="highlighter-rouge">GET [base]/List/[id]/_history/vid</code>
</li><br/> <!-- Only SHALL for include for now the capability statement does not create the primitive
extensios for this yet. --> <!-- Only SHALLs for revinclude for now the capability statement does not create the primitive extensios for this yet --></ul><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</a></td><td>
token
</td><td><code class="highlighter-rouge">GET [base]/List?_id=[id]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href="http://hl7.org/fhir/R4/search.html">identifier</a></td><td>
token
</td><td><code class="highlighter-rouge">GET [base]/List?identifier=[system]|[code]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href="http://hl7.org/fhir/R4/search.html">item</a></td><td>
reference
</td><td><code class="highlighter-rouge">GET [base]/List?item=[item]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href="http://hl7.org/fhir/R4/search.html">status</a></td><td>
token
</td><td><code class="highlighter-rouge">GET [base]/List?status=[status]</code></td></tr></tbody></table><hr/><h4 id="medicationknowledge" class="no_toc">MedicationKnowledge</h4><p>Conformance Expectation: <strong>SHALL</strong></p><p>Supported Profiles:
<a href="StructureDefinition-usdf-FormularyDrug.html">FormularyDrug</a>
</p><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>Fetch and Search Criteria:</p><ul><li>
A Server <strong>SHALL</strong> be capable of returning a MedicationKnowledge resource using:
<br/>
<code class="highlighter-rouge">GET [base]/MedicationKnowledge/[id]</code>
</li><br/><li>
A Server <strong>SHOULD</strong> be capable of returning a MedicationKnowledge resource using:
<br/>
<code class="highlighter-rouge">GET [base]/MedicationKnowledge/[id]/_history/vid</code>
</li><br/> <!-- Only SHALL for include for now the capability statement does not create the primitive
extensios for this yet. --> <!-- Only SHALLs for revinclude for now the capability statement does not create the primitive extensios for this yet --></ul><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="SearchParameter-DrugName.html">DrugName</a></td><td>
string
</td><td><code class="highlighter-rouge">GET [base]/MedicationKnowledge?DrugName=[DrugName]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href="http://hl7.org/fhir/R4/search.html">DrugTier</a></td><td>
token
</td><td><code class="highlighter-rouge">GET [base]/MedicationKnowledge?DrugTier=[system]|[code]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href="http://hl7.org/fhir/R4/search.html">DrugPlan</a></td><td>
string
</td><td><code class="highlighter-rouge">GET [base]/MedicationKnowledge?DrugPlan=[DrugPlan]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href="http://hl7.org/fhir/R4/search.html">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/search.html">_id</a></td><td>
token
</td><td><code class="highlighter-rouge">GET [base]/MedicationKnowledge?_id=[id]</code></td></tr></tbody></table><hr/><br/></div>
</text>
<url
value="http://hl7.org/fhir/us/davinci-drug-formulary/CapabilityStatement/usdf-server"/>
<version value="1.0.1"/>
<name value="UsdfServerCapabilityStatement"/>
<title value="usdf-server CapabilityStatement"/>
<status value="active"/>
<experimental value="false"/>
<date value="2020-11-16"/>
<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
- (Status 410): deleted 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="List"/>
<supportedProfile
value="http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-CoveragePlan"/>
<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="identifier"/>
<definition
value="http://hl7.org/fhir/SearchParameter/clinical-identifier"/>
<type value="token"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="item"/>
<definition value="http://hl7.org/fhir/SearchParameter/List-item"/>
<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/SearchParameter/List-status"/>
<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"/>
<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="DrugName"/>
<definition
value="http://hl7.org/fhir/us/davinci-drug-formulary/SearchParameter/DrugName"/>
<type value="string"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="DrugTier"/>
<definition
value="http://hl7.org/fhir/us/davinci-drug-formulary/SearchParameter/DrugTier"/>
<type value="token"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="DrugPlan"/>
<definition
value="http://hl7.org/fhir/us/davinci-drug-formulary/SearchParameter/DrugPlan"/>
<type value="string"/>
</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="_id"/>
<definition value="http://hl7.org/fhir/SearchParameter/Resource-id"/>
<type value="token"/>
</searchParam>
</resource>
</rest>
</CapabilityStatement>
IG © 2020+ HL7 Pharmacy Working Group. Package hl7.fhir.us.davinci-drug-formulary#1.0.1 based on FHIR 4.0.1. Generated 2020-12-21
Links: Table of Contents |
QA Report
| Version History |
Search |
|
Propose a change