This page is part of the US Drug Formulary (v1.0.0: 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

• Content
• XML
• JSON
• Turtle

USDFServerCapabilityStatement

<CapabilityStatement xmlns="http://hl7.org/fhir">
  <id value="usdf-server"/>
  <text>
    <status value="additional"/>
    <div xmlns="http://www.w3.org/1999/xhtml"><h2 id="title">USDFServerCapabilityStatement</h2> <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> <table> <tr> <td>Mode:</td> <td>SERVER</td> </tr> <tr> <td>Description:</td> <td>The US Drug Formulary Server **SHALL**: <ol> <li>Support the US Drug Formulary CoveragePlan (List) and FormularyDrug (MedicationKnowledge) resource profile.</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> </ol> </td>     </tr>     <tr>     <td>    </td>     <td> The US Drug Formulary  Server **SHOULD**: <ol> <li>Support xml source formats for all US Drug Formulary interactions.</li> </ol> </td></tr> <tr>     <td>    </td>     <td>The US Drug Formulary Server supports the following transactions:     <ul>         <li>CoveragePlan (List) Resource             <ul>                 <li>**SHALL**: search-type, read,   </li>                 <li>**SHOULD** : vread, history-instance</li>                  <li>**MAY** : create, update, patch, delete, history-type</li>             </ul>         </li>         <li>FormularyDrug (MedicationKnowledge) Resource             <ul>                 <li>**SHALL**: search-type, read,   </li>                 <li>**SHOULD** : vread, history-instance</li>                 <li>**MAY** : create, update, patch, delete, history-type</li>             </ul>         </li>         </ul>   </td> </tr> <tr>     <td>    </td>     <td>The US Drug Formulary Server **SHALL** support the following searchParameters individually and in combination:     <ul>          <li>FormularyDrug (MedicationKnowledge) Resource             <ul>                 <li>DrugName </li>                 <li>DrugPlan </li>                 <li>DrugTier </li>                 <li>code</li>             </ul>         </li>     </ul>     </td> </tr> </table> </div>
  </text>
  <url
       value="http://hl7.org/fhir/us/davinci-drug-formulary/CapabilityStatement/usdf-server"/>
  <version value="1.0.0"/>
  <name value="USDFServerCapabilityStatement"/>
  <title value="US Drug Formulary Server Capability Statement"/>
  <status value="active"/>
  <experimental value="false"/>
  <date value="2020-01-08T00:00:00+10:00"/>
  <publisher value="HL7 International - US Realm Steering Committee"/>
  <contact>
    <telecom>
      <system value="url"/>
      <value value="http://www.hl7.org/Special/committees/usrealm/index.cfm"/>
    </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"/>
      <display value="United States of America"/>
    </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="The US Drug Formulary Server **SHALL**:

1. Support the US Drug Formulary CoveragePlan (List) and FormularyDrug (MedicationKnowledge) resource profile.
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.

The US Drug Formulary  Server **SHOULD**:

1. Support xml source formats for all US Drug Formulary interactions."/>
    <security>
      <description
                   value="1. See the [General Security Considerations](security.html) section for requirements and recommendations.
1. A server **SHALL** reject any unauthorized requests by returning an `HTTP 401` unauthorized response code."/>
    </security>
    <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"/>
      <searchRevInclude value="MedicationKnowledge:_id"/>
    </resource>
    <resource>
      <extension
                 url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
        <valueCode value="SHALL"/>
      </extension>
      <extension
                 url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination">
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <extension url="required">
          <valueString value="DrugName"/>
        </extension>
        <extension url="required">
          <valueString value="DrugPlan"/>
        </extension>
        <extension url="required">
          <valueString value="DrugTier"/>
        </extension>
        <extension url="required">
          <valueString value="code"/>
        </extension>
      </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"/>
      <searchRevInclude value="List:entry"/>
      <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="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="DrugTier"/>
        <definition
                    value="http://hl7.org/fhir/us/davinci-drug-formulary/SearchParameter/DrugTier"/>
        <type value="token"/>
      </searchParam>
    </resource>
  </rest>
</CapabilityStatement>