{ "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": "2020-11-16", "publisher": "HL7 Pharmacy Working Group", "patchFormat": [ "application/json-patch+json" ], "fhirVersion": "4.0.1", "jurisdiction": [ { "coding": [ { "code": "US", "system": "urn:iso:std:iso:3166" } ] } ], "name": "UsdfServerCapabilityStatement", "type": null, "experimental": "false", "resourceType": "CapabilityStatement", "title": "usdf-server CapabilityStatement", "package_version": "1.0.1", "status": "active", "id": "848079e0-9365-42bd-9f44-5eee0ac23a13", "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": "1.0.1", "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": [ { "type": "List", "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": "identifier", "type": "token", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ], "definition": "http://hl7.org/fhir/SearchParameter/clinical-identifier" }, { "name": "item", "type": "reference", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ], "definition": "http://hl7.org/fhir/SearchParameter/List-item" }, { "name": "status", "type": "token", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ], "definition": "http://hl7.org/fhir/SearchParameter/List-status" } ], "referencePolicy": [ "resolves" ], "supportedProfile": [ "http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-CoveragePlan" ] }, { "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": "DrugName", "type": "string", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ], "definition": "http://hl7.org/fhir/us/davinci-drug-formulary/SearchParameter/DrugName" }, { "name": "DrugTier", "type": "token", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ], "definition": "http://hl7.org/fhir/us/davinci-drug-formulary/SearchParameter/DrugTier" }, { "name": "DrugPlan", "type": "string", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ], "definition": "http://hl7.org/fhir/us/davinci-drug-formulary/SearchParameter/DrugPlan" }, { "name": "code", "type": "token", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ], "definition": "http://hl7.org/fhir/SearchParameter/MedicationKnowledge-code" }, { "name": "_id", "type": "token", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ], "definition": "http://hl7.org/fhir/SearchParameter/Resource-id" } ], "referencePolicy": [ "resolves" ], "supportedProfile": [ "http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-FormularyDrug" ] } ], "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\n - (Status 410): deleted 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" } ] }