{"openapi": "3.0.3", "info": {"title": "Open US Drug Formulary Server Capability Statement", "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.", "license": {"name": "Creative Commons Zero v1.0 Universal", "url": "http://spdx.org/licenses/CC0-1.0.html"}, "version": "2.0.1", "contact": {"email": "pharmacy@lists.HL7.org", "url": "http://www.hl7.org/Special/committees/medication"}}, "externalDocs": {"url": "http://hl7.org/fhir/us/davinci-drug-formulary/ImplementationGuide/hl7.fhir.us.davinci-drug-formulary", "description": "External Docs Description"}, "paths": {"/open-formulary/metadata": {"summary": "Access to the Server's Capability Statement", "description": "All FHIR Servers return a CapabilityStatement that describes what services they perform", "get": {"tags": ["Metadata"], "summary": "Return the server's capability statement", "responses": {"default": {"description": "Error, with details", "content": {"application/fhir+json": {"schema": {"type": "object", "externalDocs": {"url": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome"}}}}}, "200": {"description": "the capbility statement", "content": {"application/fhir+json": {"schema": {"type": "object", "externalDocs": {"url": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/CapabilityStatement"}}}}}}}}, "/open-formulary/InsurancePlan": {"get": {"tags": ["Open US Drug Formulary Server Endpoints"], "description": "Returns a bundle of the InsurancePlan resource that match provided search parameters", "responses": {"default": {"description": "Error, with details", "content": {"application/fhir+json": {"schema": {"type": "object", "externalDocs": {"url": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome"}}}}}, "200": {"description": "A InsurancePlan with specified resource id.", "content": {"application/fhir+json": {"schema": {"type": "object", "externalDocs": {"url": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome"}}}}}}, "parameters": [{"name": "_id", "in": "query", "required": false, "schema": {"type": "token"}}, {"name": "_lastUpdated", "in": "query", "required": false, "schema": {"type": "date"}}, {"name": "identifier", "in": "query", "required": false, "schema": {"type": "token"}}, {"name": "status", "in": "query", "required": false, "schema": {"type": "token"}}, {"name": "period", "in": "query", "required": false, "schema": {"type": "date"}}, {"name": "type", "in": "query", "required": false, "schema": {"type": "token"}}, {"name": "name", "in": "query", "required": false, "schema": {"type": "string"}}, {"name": "coverage-type", "in": "query", "required": false, "schema": {"type": "token"}}, {"name": "formulary-coverage", "in": "query", "required": false, "schema": {"type": "reference"}}, {"name": "coverage-area", "in": "query", "required": false, "schema": {"type": "reference"}}]}}, "/open-formulary/InsurancePlan/{rid}": {"get": {"tags": ["Open US Drug Formulary Server Endpoints"], "description": "Returns a specified InsurancePlan resource with a given resource id", "responses": {"default": {"description": "Error, with details", "content": {"application/fhir+json": {"schema": {"type": "object", "externalDocs": {"url": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome"}}}}}, "200": {"description": "A InsurancePlan with specified resource id.", "content": {"application/fhir+json": {"schema": {"type": "object", "externalDocs": {"url": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome"}}}}}}, "parameters": [{"name": "rid", "in": "path", "required": true, "schema": {"type": "string"}}]}}, "/open-formulary/InsurancePlan/{rid}/_history/{hid}": {"get": {"tags": ["Open US Drug Formulary Server Endpoints"], "description": "Returns a specified InsurancePlan resource with a given resource id and a specific historical version", "responses": {"default": {"description": "Error, with details", "content": {"application/fhir+json": {"schema": {"type": "object", "externalDocs": {"url": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome"}}}}}, "200": {"description": "A InsurancePlan with specified resource id.", "content": {"application/fhir+json": {"schema": {"type": "object", "externalDocs": {"url": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome"}}}}}}, "parameters": [{"name": "rid", "in": "path", "required": true, "schema": {"type": "string"}}, {"name": "hid", "in": "path", "required": true, "schema": {"type": "string"}}]}}, "/open-formulary/InsurancePlan/{rid}/_history": {"get": {"tags": ["Open US Drug Formulary Server Endpoints"], "description": "Returns a bundle of all versions for the InsurancePlan resource with given resource id", "responses": {"default": {"description": "Error, with details", "content": {"application/fhir+json": {"schema": {"type": "object", "externalDocs": {"url": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome"}}}}}, "200": {"description": "A InsurancePlan with specified resource id.", "content": {"application/fhir+json": {"schema": {"type": "object", "externalDocs": {"url": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome"}}}}}}, "parameters": [{"name": "rid", "in": "path", "required": true, "schema": {"type": "string"}}]}}, "/open-formulary/InsurancePlan/_history": {"get": {"tags": ["Open US Drug Formulary Server Endpoints"], "description": "Returns a bundle of all versions for the InsurancePlan resource that match provided search parameters", "responses": {"default": {"description": "Error, with details", "content": {"application/fhir+json": {"schema": {"type": "object", "externalDocs": {"url": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome"}}}}}, "200": {"description": "A InsurancePlan with specified resource id.", "content": {"application/fhir+json": {"schema": {"type": "object", "externalDocs": {"url": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome"}}}}}}, "parameters": [{"name": "_id", "in": "query", "required": false, "schema": {"type": "token"}}, {"name": "_lastUpdated", "in": "query", "required": false, "schema": {"type": "date"}}, {"name": "identifier", "in": "query", "required": false, "schema": {"type": "token"}}, {"name": "status", "in": "query", "required": false, "schema": {"type": "token"}}, {"name": "period", "in": "query", "required": false, "schema": {"type": "date"}}, {"name": "type", "in": "query", "required": false, "schema": {"type": "token"}}, {"name": "name", "in": "query", "required": false, "schema": {"type": "string"}}, {"name": "coverage-type", "in": "query", "required": false, "schema": {"type": "token"}}, {"name": "formulary-coverage", "in": "query", "required": false, "schema": {"type": "reference"}}, {"name": "coverage-area", "in": "query", "required": false, "schema": {"type": "reference"}}]}}, "/open-formulary/Basic": {"get": {"tags": ["Open US Drug Formulary Server Endpoints"], "description": "Returns a bundle of the Basic resource that match provided search parameters", "responses": {"default": {"description": "Error, with details", "content": {"application/fhir+json": {"schema": {"type": "object", "externalDocs": {"url": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome"}}}}}, "200": {"description": "A Basic with specified resource id.", "content": {"application/fhir+json": {"schema": {"type": "object", "externalDocs": {"url": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome"}}}}}}, "parameters": [{"name": "_id", "in": "query", "required": false, "schema": {"type": "token"}}, {"name": "_lastUpdated", "in": "query", "required": false, "schema": {"type": "date"}}, {"name": "code", "in": "query", "required": false, "schema": {"type": "token"}}, {"name": "subject", "in": "query", "required": false, "schema": {"type": "reference"}}, {"name": "status", "in": "query", "required": false, "schema": {"type": "token"}}, {"name": "period", "in": "query", "required": false, "schema": {"type": "date"}}, {"name": "formulary", "in": "query", "required": false, "schema": {"type": "reference"}}, {"name": "pharmacy-benefit-type", "in": "query", "required": false, "schema": {"type": "token"}}, {"name": "drug-tier", "in": "query", "required": false, "schema": {"type": "token"}}]}}, "/open-formulary/Basic/{rid}": {"get": {"tags": ["Open US Drug Formulary Server Endpoints"], "description": "Returns a specified Basic resource with a given resource id", "responses": {"default": {"description": "Error, with details", "content": {"application/fhir+json": {"schema": {"type": "object", "externalDocs": {"url": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome"}}}}}, "200": {"description": "A Basic with specified resource id.", "content": {"application/fhir+json": {"schema": {"type": "object", "externalDocs": {"url": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome"}}}}}}, "parameters": [{"name": "rid", "in": "path", "required": true, "schema": {"type": "string"}}]}}, "/open-formulary/Basic/{rid}/_history/{hid}": {"get": {"tags": ["Open US Drug Formulary Server Endpoints"], "description": "Returns a specified Basic resource with a given resource id and a specific historical version", "responses": {"default": {"description": "Error, with details", "content": {"application/fhir+json": {"schema": {"type": "object", "externalDocs": {"url": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome"}}}}}, "200": {"description": "A Basic with specified resource id.", "content": {"application/fhir+json": {"schema": {"type": "object", "externalDocs": {"url": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome"}}}}}}, "parameters": [{"name": "rid", "in": "path", "required": true, "schema": {"type": "string"}}, {"name": "hid", "in": "path", "required": true, "schema": {"type": "string"}}]}}, "/open-formulary/Basic/{rid}/_history": {"get": {"tags": ["Open US Drug Formulary Server Endpoints"], "description": "Returns a bundle of all versions for the Basic resource with given resource id", "responses": {"default": {"description": "Error, with details", "content": {"application/fhir+json": {"schema": {"type": "object", "externalDocs": {"url": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome"}}}}}, "200": {"description": "A Basic with specified resource id.", "content": {"application/fhir+json": {"schema": {"type": "object", "externalDocs": {"url": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome"}}}}}}, "parameters": [{"name": "rid", "in": "path", "required": true, "schema": {"type": "string"}}]}}, "/open-formulary/Basic/_history": {"get": {"tags": ["Open US Drug Formulary Server Endpoints"], "description": "Returns a bundle of all versions for the Basic resource that match provided search parameters", "responses": {"default": {"description": "Error, with details", "content": {"application/fhir+json": {"schema": {"type": "object", "externalDocs": {"url": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome"}}}}}, "200": {"description": "A Basic with specified resource id.", "content": {"application/fhir+json": {"schema": {"type": "object", "externalDocs": {"url": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome"}}}}}}, "parameters": [{"name": "_id", "in": "query", "required": false, "schema": {"type": "token"}}, {"name": "_lastUpdated", "in": "query", "required": false, "schema": {"type": "date"}}, {"name": "code", "in": "query", "required": false, "schema": {"type": "token"}}, {"name": "subject", "in": "query", "required": false, "schema": {"type": "reference"}}, {"name": "status", "in": "query", "required": false, "schema": {"type": "token"}}, {"name": "period", "in": "query", "required": false, "schema": {"type": "date"}}, {"name": "formulary", "in": "query", "required": false, "schema": {"type": "reference"}}, {"name": "pharmacy-benefit-type", "in": "query", "required": false, "schema": {"type": "token"}}, {"name": "drug-tier", "in": "query", "required": false, "schema": {"type": "token"}}]}}, "/open-formulary/MedicationKnowledge": {"get": {"tags": ["Open US Drug Formulary Server Endpoints"], "description": "Returns a bundle of the MedicationKnowledge resource that match provided search parameters", "responses": {"default": {"description": "Error, with details", "content": {"application/fhir+json": {"schema": {"type": "object", "externalDocs": {"url": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome"}}}}}, "200": {"description": "A MedicationKnowledge with specified resource id.", "content": {"application/fhir+json": {"schema": {"type": "object", "externalDocs": {"url": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome"}}}}}}, "parameters": [{"name": "_id", "in": "query", "required": false, "schema": {"type": "token"}}, {"name": "_lastUpdated", "in": "query", "required": false, "schema": {"type": "date"}}, {"name": "status", "in": "query", "required": false, "schema": {"type": "token"}}, {"name": "code", "in": "query", "required": false, "schema": {"type": "token"}}, {"name": "drug-name", "in": "query", "required": false, "schema": {"type": "string"}}, {"name": "doseform", "in": "query", "required": false, "schema": {"type": "token"}}]}}, "/open-formulary/MedicationKnowledge/{rid}": {"get": {"tags": ["Open US Drug Formulary Server Endpoints"], "description": "Returns a specified MedicationKnowledge resource with a given resource id", "responses": {"default": {"description": "Error, with details", "content": {"application/fhir+json": {"schema": {"type": "object", "externalDocs": {"url": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome"}}}}}, "200": {"description": "A MedicationKnowledge with specified resource id.", "content": {"application/fhir+json": {"schema": {"type": "object", "externalDocs": {"url": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome"}}}}}}, "parameters": [{"name": "rid", "in": "path", "required": true, "schema": {"type": "string"}}]}}, "/open-formulary/MedicationKnowledge/{rid}/_history/{hid}": {"get": {"tags": ["Open US Drug Formulary Server Endpoints"], "description": "Returns a specified MedicationKnowledge resource with a given resource id and a specific historical version", "responses": {"default": {"description": "Error, with details", "content": {"application/fhir+json": {"schema": {"type": "object", "externalDocs": {"url": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome"}}}}}, "200": {"description": "A MedicationKnowledge with specified resource id.", "content": {"application/fhir+json": {"schema": {"type": "object", "externalDocs": {"url": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome"}}}}}}, "parameters": [{"name": "rid", "in": "path", "required": true, "schema": {"type": "string"}}, {"name": "hid", "in": "path", "required": true, "schema": {"type": "string"}}]}}, "/open-formulary/MedicationKnowledge/{rid}/_history": {"get": {"tags": ["Open US Drug Formulary Server Endpoints"], "description": "Returns a bundle of all versions for the MedicationKnowledge resource with given resource id", "responses": {"default": {"description": "Error, with details", "content": {"application/fhir+json": {"schema": {"type": "object", "externalDocs": {"url": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome"}}}}}, "200": {"description": "A MedicationKnowledge with specified resource id.", "content": {"application/fhir+json": {"schema": {"type": "object", "externalDocs": {"url": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome"}}}}}}, "parameters": [{"name": "rid", "in": "path", "required": true, "schema": {"type": "string"}}]}}, "/open-formulary/MedicationKnowledge/_history": {"get": {"tags": ["Open US Drug Formulary Server Endpoints"], "description": "Returns a bundle of all versions for the MedicationKnowledge resource that match provided search parameters", "responses": {"default": {"description": "Error, with details", "content": {"application/fhir+json": {"schema": {"type": "object", "externalDocs": {"url": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome"}}}}}, "200": {"description": "A MedicationKnowledge with specified resource id.", "content": {"application/fhir+json": {"schema": {"type": "object", "externalDocs": {"url": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome"}}}}}}, "parameters": [{"name": "_id", "in": "query", "required": false, "schema": {"type": "token"}}, {"name": "_lastUpdated", "in": "query", "required": false, "schema": {"type": "date"}}, {"name": "status", "in": "query", "required": false, "schema": {"type": "token"}}, {"name": "code", "in": "query", "required": false, "schema": {"type": "token"}}, {"name": "drug-name", "in": "query", "required": false, "schema": {"type": "string"}}, {"name": "doseform", "in": "query", "required": false, "schema": {"type": "token"}}]}}, "/open-formulary/Location": {"get": {"tags": ["Open US Drug Formulary Server Endpoints"], "description": "Returns a bundle of the Location resource that match provided search parameters", "responses": {"default": {"description": "Error, with details", "content": {"application/fhir+json": {"schema": {"type": "object", "externalDocs": {"url": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome"}}}}}, "200": {"description": "A Location with specified resource id.", "content": {"application/fhir+json": {"schema": {"type": "object", "externalDocs": {"url": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome"}}}}}}, "parameters": [{"name": "_id", "in": "query", "required": false, "schema": {"type": "token"}}, {"name": "_lastUpdated", "in": "query", "required": false, "schema": {"type": "date"}}, {"name": "address", "in": "query", "required": false, "schema": {"type": "string"}}, {"name": "address-city", "in": "query", "required": false, "schema": {"type": "string"}}, {"name": "address-state", "in": "query", "required": false, "schema": {"type": "string"}}, {"name": "address-postalcode", "in": "query", "required": false, "schema": {"type": "string"}}]}}, "/open-formulary/Location/{rid}": {"get": {"tags": ["Open US Drug Formulary Server Endpoints"], "description": "Returns a specified Location resource with a given resource id", "responses": {"default": {"description": "Error, with details", "content": {"application/fhir+json": {"schema": {"type": "object", "externalDocs": {"url": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome"}}}}}, "200": {"description": "A Location with specified resource id.", "content": {"application/fhir+json": {"schema": {"type": "object", "externalDocs": {"url": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome"}}}}}}, "parameters": [{"name": "rid", "in": "path", "required": true, "schema": {"type": "string"}}]}}, "/open-formulary/Location/{rid}/_history/{hid}": {"get": {"tags": ["Open US Drug Formulary Server Endpoints"], "description": "Returns a specified Location resource with a given resource id and a specific historical version", "responses": {"default": {"description": "Error, with details", "content": {"application/fhir+json": {"schema": {"type": "object", "externalDocs": {"url": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome"}}}}}, "200": {"description": "A Location with specified resource id.", "content": {"application/fhir+json": {"schema": {"type": "object", "externalDocs": {"url": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome"}}}}}}, "parameters": [{"name": "rid", "in": "path", "required": true, "schema": {"type": "string"}}, {"name": "hid", "in": "path", "required": true, "schema": {"type": "string"}}]}}, "/open-formulary/Location/{rid}/_history": {"get": {"tags": ["Open US Drug Formulary Server Endpoints"], "description": "Returns a bundle of all versions for the Location resource with given resource id", "responses": {"default": {"description": "Error, with details", "content": {"application/fhir+json": {"schema": {"type": "object", "externalDocs": {"url": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome"}}}}}, "200": {"description": "A Location with specified resource id.", "content": {"application/fhir+json": {"schema": {"type": "object", "externalDocs": {"url": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome"}}}}}}, "parameters": [{"name": "rid", "in": "path", "required": true, "schema": {"type": "string"}}]}}, "/open-formulary/Location/_history": {"get": {"tags": ["Open US Drug Formulary Server Endpoints"], "description": "Returns a bundle of all versions for the Location resource that match provided search parameters", "responses": {"default": {"description": "Error, with details", "content": {"application/fhir+json": {"schema": {"type": "object", "externalDocs": {"url": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome"}}}}}, "200": {"description": "A Location with specified resource id.", "content": {"application/fhir+json": {"schema": {"type": "object", "externalDocs": {"url": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome"}}}}}}, "parameters": [{"name": "_id", "in": "query", "required": false, "schema": {"type": "token"}}, {"name": "_lastUpdated", "in": "query", "required": false, "schema": {"type": "date"}}, {"name": "address", "in": "query", "required": false, "schema": {"type": "string"}}, {"name": "address-city", "in": "query", "required": false, "schema": {"type": "string"}}, {"name": "address-state", "in": "query", "required": false, "schema": {"type": "string"}}, {"name": "address-postalcode", "in": "query", "required": false, "schema": {"type": "string"}}]}}}, "components": {}}