DaVinci Payer Data Exchange (PDex) US Drug Formulary
2.1.0 - STU 3 (ci-build) United States of America flag

DaVinci Payer Data Exchange (PDex) US Drug Formulary, published by HL7 International / Pharmacy. This guide is not an authorized publication; it is the continuous build for version 2.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/davinci-pdex-formulary/ and changes regularly. See the Directory of published versions

CapabilityStatement: US Drug Formulary Server Capability Statement

Official URL: http://hl7.org/fhir/us/davinci-drug-formulary/CapabilityStatement/usdf-server Version: 2.0.1
Standards status: Trial-use Computable Name: UsdfServerCapabilityStatement

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.

Raw OpenAPI-Swagger Definition file | Download

Generated Narrative: CapabilityStatement usdf-server

usdf-server CapabilityStatement

  • Implementation Guide Version: 2.0.1
  • FHIR Version: 4.0.1
  • Supported Formats: xml, json
  • Supported Patch Formats: application/json-patch+json
  • Published on: 2022-07-17
  • Published by: HL7 International / Pharmacy

Note to Implementers: FHIR Capabilities

Any FHIR capability may be 'allowed' by the system unless explicitly marked as 'SHALL NOT'. A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case.

SHALL Support the Following Implementation Guides

FHIR RESTful Capabilities

Mode: server

US Drug Formulary Server SHALL:

  1. Support all profiles defined in this Implementation Guide..
  2. Implement the RESTful behavior according to the FHIR specification.
  3. Return the following response classes:
    • (Status 400): invalid parameter
    • (Status 401/4xx): unauthorized request
    • (Status 403): insufficient scope
    • (Status 404): unknown resource
  4. Support json source formats for all US Drug Formulary interactions.
  5. 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.
Summary of System-wide Interactions

Capabilities by Resource/Profile

Summary

The summary table lists the resources that are part of this configuration, and for each resource it lists:

  • The relevant profiles (if any)
  • The interactions supported by each resource (Read, Search, Update, and Create, are always shown, while VRead, Patch, Delete, History on Instance, or History on Type are only present if at least one of the resources has support for them.
  • The required, recommended, and some optional search parameters (if any).
  • The linked resources enabled for _include
  • The other resources enabled for _revinclude
  • The operations on the resource (if any)
Resource TypeProfileRV-RSUPCDH-IH-TSearches_include_revincludeOperations
InsurancePlanSupported Profiles
  Payer Insurance Plan
  Formulary		yyyyyyyyy_id, _lastUpdated, identifier, status, period, type, name, coverage-type, formulary-coverage, coverage-areaformulary-coverage
BasicSupported Profiles
  Formulary Item		yyyyyyyyy_id, _lastUpdated, code, subject, status, period, formulary, pharmacy-benefit-type, drug-tiersubject, formulary
MedicationKnowledgeSupported Profiles
  Formulary Drug		yyyyyyyyy_id, _lastUpdated, status, code, drug-name, doseform
LocationSupported Profiles
  Insurance Plan Location		yyyyyyyyy_id, _lastUpdated, address, address-city, address-state, address-postalcode

Resource Conformance: SHALL InsurancePlan

Core FHIR Resource
InsurancePlan
Reference Policy
resolves
Interaction summary
  • SHALL support search-type, read.
  • SHOULD support vread, history-instance.
  • MAY support create, update, patch, delete, history-type.

Supported Profiles

Payer Insurance Plan
Formulary

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_idtoken
SHALL_lastUpdateddate
SHALLidentifiertoken
SHALLstatustoken
SHALLperioddate
SHALLtypetoken
SHALLnamestring
SHALLcoverage-typetoken
SHALLformulary-coveragereference
SHALLcoverage-areareference
 

Resource Conformance: SHALL Basic

Core FHIR Resource
Basic
Reference Policy
resolves
Interaction summary
  • SHALL support search-type, read.
  • SHOULD support vread, history-instance.
  • MAY support create, update, patch, delete, history-type.

Supported Profiles

Formulary Item

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_idtoken
SHALL_lastUpdateddate
SHALLcodetoken
SHALLsubjectreference
SHALLstatustoken
SHALLperioddate
SHALLformularyreference
SHALLpharmacy-benefit-typetoken
SHALLdrug-tiertoken
 

Resource Conformance: SHALL MedicationKnowledge

Core FHIR Resource
MedicationKnowledge
Reference Policy
resolves
Interaction summary
  • SHALL support search-type, read.
  • SHOULD support vread, history-instance.
  • MAY support create, update, patch, delete, history-type.

Supported Profiles

Formulary Drug

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_idtoken
SHALL_lastUpdateddate
SHALLstatustoken
SHALLcodetoken
SHALLdrug-namestring
SHOULDdoseformtoken
 

Resource Conformance: SHALL Location

Core FHIR Resource
Location
Reference Policy
resolves
Interaction summary
  • SHALL support search-type, read.
  • SHOULD support vread, history-instance.
  • MAY support create, update, patch, delete, history-type.

Supported Profiles

Insurance Plan Location

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_idtoken
SHALL_lastUpdateddate
SHALLaddressstring
SHALLaddress-citystring
SHALLaddress-statestring
SHALLaddress-postalcodestring