{
  "description": "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.",
  "_filename": "CapabilityStatement-usdf-server.json",
  "package_name": "hl7.fhir.us.davinci-drug-formulary",
  "format": [ "xml", "json" ],
  "date": "2022-07-17",
  "publisher": "HL7 Pharmacy Working Group",
  "patchFormat": [ "application/json-patch+json" ],
  "fhirVersion": "4.0.1",
  "jurisdiction": [ {
    "coding": [ {
      "code": "US",
      "system": "urn:iso:std:iso:3166"
    } ]
  } ],
  "instantiates": [ "http://hl7.org/fhir/us/davinci-drug-formulary/CapabilityStatement/usdf-server" ],
  "name": "UsdfServerCapabilityStatement",
  "type": null,
  "experimental": "false",
  "resourceType": "CapabilityStatement",
  "title": "usdf-server CapabilityStatement",
  "package_version": "2.0.0",
  "status": "active",
  "id": "dedeb881-a77a-4055-9146-d81eae3b5587",
  "kind": "requirements",
  "implementationGuide": [ "http://hl7.org/fhir/us/davinci-drug-formulary/ImplementationGuide/hl7.fhir.us.davinci-drug-formulary" ],
  "url": "http://hl7.org/fhir/us/davinci-drug-formulary/CapabilityStatement/usdf-server",
  "version": "2.0.0",
  "contact": [ {
    "name": "HL7 Pharmacy Working Group",
    "telecom": [ {
      "value": "http://www.hl7.org/Special/committees/medication",
      "system": "url"
    }, {
      "value": "pharmacy@lists.HL7.org",
      "system": "email"
    } ]
  } ],
  "rest": [ {
    "mode": "server",
    "resource": [ {
      "searchParam": [ {
        "name": "_id",
        "type": "token",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHALL"
        } ],
        "definition": "http://hl7.org/fhir/SearchParameter/Resource-id"
      }, {
        "name": "_lastUpdated",
        "type": "date",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHALL"
        } ],
        "definition": "http://hl7.org/fhir/us/davinci-drug-formulary/SearchParameter/InsurancePlan-lastupdated"
      }, {
        "name": "identifier",
        "type": "token",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHALL"
        } ],
        "definition": "http://hl7.org/fhir/us/davinci-drug-formulary/SearchParameter/InsurancePlan-identifier"
      }, {
        "name": "status",
        "type": "token",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHALL"
        } ],
        "definition": "http://hl7.org/fhir/us/davinci-drug-formulary/SearchParameter/InsurancePlan-status"
      }, {
        "name": "period",
        "type": "date",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHALL"
        } ],
        "definition": "http://hl7.org/fhir/us/davinci-drug-formulary/SearchParameter/InsurancePlan-period"
      }, {
        "name": "type",
        "type": "token",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHALL"
        } ],
        "definition": "http://hl7.org/fhir/us/davinci-drug-formulary/SearchParameter/InsurancePlan-type"
      }, {
        "name": "name",
        "type": "string",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHALL"
        } ],
        "definition": "http://hl7.org/fhir/us/davinci-drug-formulary/SearchParameter/InsurancePlan-name"
      }, {
        "name": "coverage-type",
        "type": "token",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHALL"
        } ],
        "definition": "http://hl7.org/fhir/us/davinci-drug-formulary/SearchParameter/InsurancePlan-coverage-type"
      }, {
        "name": "formulary-coverage",
        "type": "reference",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHALL"
        } ],
        "definition": "http://hl7.org/fhir/us/davinci-drug-formulary/SearchParameter/InsurancePlan-formulary-coverage"
      }, {
        "name": "coverage-area",
        "type": "reference",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHALL"
        } ],
        "definition": "http://hl7.org/fhir/us/davinci-drug-formulary/SearchParameter/InsurancePlan-coverage-area"
      } ],
      "referencePolicy": [ "resolves" ],
      "type": "InsurancePlan",
      "interaction": [ {
        "code": "create",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "MAY"
        } ]
      }, {
        "code": "search-type",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHALL"
        } ]
      }, {
        "code": "read",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHALL"
        } ]
      }, {
        "code": "vread",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHOULD"
        } ]
      }, {
        "code": "update",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "MAY"
        } ]
      }, {
        "code": "patch",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "MAY"
        } ]
      }, {
        "code": "delete",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "MAY"
        } ]
      }, {
        "code": "history-instance",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHOULD"
        } ]
      }, {
        "code": "history-type",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "MAY"
        } ]
      } ],
      "extension": [ {
        "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
        "valueCode": "SHALL"
      } ],
      "supportedProfile": [ "http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-PayerInsurancePlan", "http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-Formulary" ],
      "_searchInclude": [ {
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHALL"
        } ]
      } ],
      "searchInclude": [ "formulary-coverage" ],
      "_supportedProfile": [ {
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHOULD"
        } ]
      }, {
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHALL"
        } ]
      } ]
    }, {
      "searchParam": [ {
        "name": "_id",
        "type": "token",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHALL"
        } ],
        "definition": "http://hl7.org/fhir/SearchParameter/Resource-id"
      }, {
        "name": "_lastUpdated",
        "type": "date",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHALL"
        } ],
        "definition": "http://hl7.org/fhir/us/davinci-drug-formulary/SearchParameter/Basic-lastupdated"
      }, {
        "name": "code",
        "type": "token",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHALL"
        } ],
        "definition": "http://hl7.org/fhir/us/davinci-drug-formulary/SearchParameter/Basic-code"
      }, {
        "name": "subject",
        "type": "reference",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHALL"
        } ],
        "definition": "http://hl7.org/fhir/us/davinci-drug-formulary/SearchParameter/Basic-subject"
      }, {
        "name": "status",
        "type": "token",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHALL"
        } ],
        "definition": "http://hl7.org/fhir/us/davinci-drug-formulary/SearchParameter/Basic-status"
      }, {
        "name": "period",
        "type": "date",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHALL"
        } ],
        "definition": "http://hl7.org/fhir/us/davinci-drug-formulary/SearchParameter/Basic-period"
      }, {
        "name": "formulary",
        "type": "reference",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHALL"
        } ],
        "definition": "http://hl7.org/fhir/us/davinci-drug-formulary/SearchParameter/Basic-formulary"
      }, {
        "name": "pharmacy-benefit-type",
        "type": "token",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHALL"
        } ],
        "definition": "http://hl7.org/fhir/us/davinci-drug-formulary/SearchParameter/Basic-pharmacy-benefit-type"
      }, {
        "name": "drug-tier",
        "type": "token",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHALL"
        } ],
        "definition": "http://hl7.org/fhir/us/davinci-drug-formulary/SearchParameter/Basic-drug-tier"
      } ],
      "referencePolicy": [ "resolves" ],
      "type": "Basic",
      "interaction": [ {
        "code": "create",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "MAY"
        } ]
      }, {
        "code": "search-type",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHALL"
        } ]
      }, {
        "code": "read",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHALL"
        } ]
      }, {
        "code": "vread",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHOULD"
        } ]
      }, {
        "code": "update",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "MAY"
        } ]
      }, {
        "code": "patch",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "MAY"
        } ]
      }, {
        "code": "delete",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "MAY"
        } ]
      }, {
        "code": "history-instance",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHOULD"
        } ]
      }, {
        "code": "history-type",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "MAY"
        } ]
      } ],
      "extension": [ {
        "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
        "valueCode": "SHALL"
      } ],
      "supportedProfile": [ "http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-FormularyItem" ],
      "_searchInclude": [ {
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHALL"
        } ]
      }, {
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHALL"
        } ]
      } ],
      "searchInclude": [ "subject", "formulary" ],
      "_supportedProfile": [ {
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHALL"
        } ]
      } ]
    }, {
      "type": "MedicationKnowledge",
      "extension": [ {
        "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
        "valueCode": "SHALL"
      } ],
      "interaction": [ {
        "code": "create",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "MAY"
        } ]
      }, {
        "code": "search-type",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHALL"
        } ]
      }, {
        "code": "read",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHALL"
        } ]
      }, {
        "code": "vread",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHOULD"
        } ]
      }, {
        "code": "update",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "MAY"
        } ]
      }, {
        "code": "patch",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "MAY"
        } ]
      }, {
        "code": "delete",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "MAY"
        } ]
      }, {
        "code": "history-instance",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHOULD"
        } ]
      }, {
        "code": "history-type",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "MAY"
        } ]
      } ],
      "searchParam": [ {
        "name": "_id",
        "type": "token",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHALL"
        } ],
        "definition": "http://hl7.org/fhir/SearchParameter/Resource-id"
      }, {
        "name": "_lastUpdated",
        "type": "date",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHALL"
        } ],
        "definition": "http://hl7.org/fhir/us/davinci-drug-formulary/SearchParameter/MedicationKnowledge-lastupdated"
      }, {
        "name": "status",
        "type": "token",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHALL"
        } ],
        "definition": "http://hl7.org/fhir/SearchParameter/MedicationKnowledge-status"
      }, {
        "name": "code",
        "type": "token",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHALL"
        } ],
        "definition": "http://hl7.org/fhir/SearchParameter/MedicationKnowledge-code"
      }, {
        "name": "drug-name",
        "type": "string",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHALL"
        } ],
        "definition": "http://hl7.org/fhir/us/davinci-drug-formulary/SearchParameter/MedicationKnowledge-drug-name"
      }, {
        "name": "doseform",
        "type": "token",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHOULD"
        } ],
        "definition": "http://hl7.org/fhir/us/davinci-drug-formulary/SearchParameter/MedicationKnowledge-doseform"
      } ],
      "referencePolicy": [ "resolves" ],
      "supportedProfile": [ "http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-FormularyDrug" ],
      "_supportedProfile": [ {
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHALL"
        } ]
      } ]
    }, {
      "type": "Location",
      "extension": [ {
        "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
        "valueCode": "SHALL"
      } ],
      "interaction": [ {
        "code": "create",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "MAY"
        } ]
      }, {
        "code": "search-type",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHALL"
        } ]
      }, {
        "code": "read",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHALL"
        } ]
      }, {
        "code": "vread",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHOULD"
        } ]
      }, {
        "code": "update",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "MAY"
        } ]
      }, {
        "code": "patch",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "MAY"
        } ]
      }, {
        "code": "delete",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "MAY"
        } ]
      }, {
        "code": "history-instance",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHOULD"
        } ]
      }, {
        "code": "history-type",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "MAY"
        } ]
      } ],
      "searchParam": [ {
        "name": "_id",
        "type": "token",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHALL"
        } ],
        "definition": "http://hl7.org/fhir/SearchParameter/Resource-id"
      }, {
        "name": "_lastUpdated",
        "type": "date",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHALL"
        } ],
        "definition": "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated"
      }, {
        "name": "address",
        "type": "string",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHALL"
        } ],
        "definition": "http://hl7.org/fhir/SearchParameter/Location-address"
      }, {
        "name": "address-city",
        "type": "string",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHALL"
        } ],
        "definition": "http://hl7.org/fhir/SearchParameter/Location-address-city"
      }, {
        "name": "address-state",
        "type": "string",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHALL"
        } ],
        "definition": "http://hl7.org/fhir/SearchParameter/Location-address-state"
      }, {
        "name": "address-postalcode",
        "type": "string",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHALL"
        } ],
        "definition": "http://hl7.org/fhir/SearchParameter/Location-address-postalcode"
      } ],
      "referencePolicy": [ "resolves" ],
      "supportedProfile": [ "http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-InsurancePlanLocation" ],
      "_supportedProfile": [ {
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHALL"
        } ]
      } ]
    } ],
    "documentation": "US Drug Formulary Server  **SHALL**:\n\n1. Support all profiles defined in this Implementation Guide..\n1.  Implement the RESTful behavior according to the FHIR specification.\n1. Return the following response classes:\n   - (Status 400): invalid parameter\n   - (Status 401/4xx): unauthorized request\n   - (Status 403): insufficient scope\n   - (Status 404): unknown resource\n1. Support json source formats for all US Drug Formulary interactions.\n1. Support the searchParameters on each profile  individually and in combination.\n\nUS Drug Formulary Server **SHOULD**:\n\n1. Support xml source formats for all US Drug Formulary interactions.\n"
  } ]
}