The DoseSpot REST API v2 contract for JumpStart customers - 139 operations, the subset available alongside DoseSpot's pre-built iFrame/SSO prescribing experience. Harvested verbatim from DoseSpot's own developer portal.
{
"swagger": "2.0",
"info": {
"version": "JumpStart_EPCSV2",
"title": "DoseSpot REST API - Plan: Jumpstart + EPCS - V2"
},
"host": "virtserver.swaggerhub.com",
"basePath": "/DoseSpot/dosespot-staging-rest-api-v2/JumpStart_EPCSV2",
"schemes": [
"https"
],
"paths": {
"/api/allergens/{allergenId}": {
"get": {
"tags": [
"Allergens"
],
"summary": "Search allergen by ID",
"description": "Retrieves an active or inactive Allergen Class or Screenable Ingredient\r\nmatching the ID",
"operationId": "Allergens_GetAllergenByIDV2",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/problem+json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "allergenId",
"in": "path",
"description": "",
"required": true,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/ItemResponse[AllergySearchResultForAPI]"
}
}
}
}
},
"/api/allergens/searchByRxCUI": {
"get": {
"tags": [
"Allergens"
],
"summary": "Search allergens by RxCUI",
"description": "Retrieves a list of Allergens matching the specified RxCUI",
"operationId": "Allergens_SearchByRxCUI",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/problem+json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "rxCui",
"in": "query",
"description": "",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object"
}
}
}
}
},
"/api/allergens/search": {
"get": {
"tags": [
"Allergens"
],
"summary": "Search allergens by name",
"description": "Retrieves a list of Allergen Classes or Screenable Ingredients\r\nmatching a specified query of three or more characters",
"operationId": "Allergens_AllergenSearchV2",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/problem+json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "name",
"in": "query",
"description": "",
"required": true,
"type": "string"
},
{
"name": "pageNumber",
"in": "query",
"description": "",
"required": false,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/PagedListResponse[AllergySearchResultForAPI]"
}
}
}
}
},
"/api/patients/{patientId}/allergies": {
"get": {
"tags": [
"Allergies"
],
"summary": "Get patient's allergies",
"description": "Retrieves a detailed list of all allergies for a given patient",
"operationId": "Allergies_GetPatientAllergiesV2",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/problem+json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "patientId",
"in": "path",
"description": "",
"required": true,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/ListResponse[PatientAllergy]"
}
}
}
}
},
"/api/patients/{patientId}/allergies/{patientAllergyId}": {
"put": {
"tags": [
"Allergies"
],
"summary": "Edit drug allergy",
"description": "Updates an existing drug allergy in a patient",
"operationId": "Allergies_EditPatientAllergyV2",
"consumes": [
"application/json",
"text/json",
"application/problem+json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/problem+json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "patientId",
"in": "path",
"description": "",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "patientAllergyId",
"in": "path",
"description": "",
"required": true,
"type": "integer",
"format": "int32"
},
{
"in": "body",
"name": "request",
"description": "No Known patient allergy data",
"required": true,
"schema": {
"$ref": "#/definitions/EditPatientAllergyRequest"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/Response"
}
}
}
}
},
"/api/patients/{patientId}/allergies/coded": {
"post": {
"tags": [
"Allergies"
],
"summary": "Add coded patient allergy",
"description": "Adds an coded allergy to a patient record",
"operationId": "Allergies_AddCodedPatientAllergyV2",
"consumes": [
"application/json",
"text/json",
"application/problem+json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/problem+json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "patientId",
"in": "path",
"description": "",
"required": true,
"type": "integer",
"format": "int32"
},
{
"in": "body",
"name": "request",
"description": "coded patient allergy data",
"required": true,
"schema": {
"$ref": "#/definitions/CodedPatientAllergyRequest"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/IdentifierResponse"
}
}
}
}
},
"/api/patients/{patientId}/allergies/freetext": {
"post": {
"tags": [
"Allergies"
],
"summary": "Add freetext patient allergy",
"description": "Adds an freetext allergy to a patient record",
"operationId": "Allergies_AddFreetextPatientAllergyV2",
"consumes": [
"application/json",
"text/json",
"application/problem+json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/problem+json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "patientId",
"in": "path",
"description": "",
"required": true,
"type": "integer",
"format": "int32"
},
{
"in": "body",
"name": "request",
"description": "freetext patient allergy data",
"required": true,
"schema": {
"$ref": "#/definitions/FreetextPatientAllergyRequest"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/IdentifierResponse"
}
}
}
}
},
"/api/patients/{patientId}/allergies/noKnownAllergy": {
"post": {
"tags": [
"Allergies"
],
"summary": "Add no known patient allergy record",
"description": "Adds an no known patient allergy record",
"operationId": "Allergies_AddNoKnownPatientAllergyV2",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/problem+json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "patientId",
"in": "path",
"description": "",
"required": true,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/IdentifierResponse"
}
}
}
}
},
"/api/clinics/{clinicId}/prescriptionFavorites": {
"get": {
"tags": [
"ClinicFavorites"
],
"summary": "Search for clinic prescription favorites",
"description": "Looks for at least 2 letter name with either all favorite types, Medication, Supply, or CompiledCompound favorite type",
"operationId": "ClinicFavorites_GetClinicPrescriptionFavoritesV2",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/problem+json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "clinicId",
"in": "path",
"description": "",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "favoriteType",
"in": "query",
"required": false,
"type": "string",
"maximum": 3,
"minimum": 0,
"enum": [
"All",
"Medication",
"Supply",
"CompiledCompound"
]
},
{
"name": "pageNumber",
"in": "query",
"required": false,
"type": "integer",
"maximum": 2147483645,
"minimum": 1,
"format": "int32"
},
{
"name": "pageSize",
"in": "query",
"required": false,
"type": "integer",
"maximum": 100,
"minimum": 1,
"format": "int32"
},
{
"name": "searchName",
"in": "query",
"required": false,
"type": "string",
"pattern": "^.{2,}$"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/PagedListResponse[ClinicFavoritePrescriptionResponse]"
}
}
}
}
},
"/api/clinics/{clinicId}/prescriptionFavorites/coded/{favoriteId}": {
"put": {
"tags": [
"ClinicFavorites"
],
"summary": "Edit Clinic Coded Medication Favorite Prescription",
"description": "Edits a favorite prescription defined by DoseSpot drug values to an existing clinic",
"operationId": "ClinicFavorites_EditClinicCodedMedicationFavoriteV2",
"consumes": [
"application/json",
"text/json",
"application/problem+json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/problem+json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "clinicId",
"in": "path",
"description": "clinic Id",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "favoriteId",
"in": "path",
"description": "Clinic Favorite Id",
"required": true,
"type": "integer",
"format": "int32"
},
{
"in": "body",
"name": "request",
"description": "Favorite medication prescription data",
"required": true,
"schema": {
"$ref": "#/definitions/ClinicPrescriptionFavoriteMedicationRequest"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/Response"
}
}
}
}
},
"/api/clinics/{clinicId}/prescriptionFavorites/supply/{favoriteId}": {
"put": {
"tags": [
"ClinicFavorites"
],
"summary": "Edit Clinic Supply Favorite Prescription",
"description": "Edits a favorite supply prescription defined by DoseSpot supply values to an existing clinic",
"operationId": "ClinicFavorites_EditClinicSupplyFavoriteV2",
"consumes": [
"application/json",
"text/json",
"application/problem+json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/problem+json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "clinicId",
"in": "path",
"description": "clinic Id",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "favoriteId",
"in": "path",
"description": "Clinic Favorite Id",
"required": true,
"type": "integer",
"format": "int32"
},
{
"in": "body",
"name": "request",
"description": "Favorite supply prescription data",
"required": true,
"schema": {
"$ref": "#/definitions/ClinicPrescriptionFavoriteSupplyRequest"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/Response"
}
}
}
}
},
"/api/clinics/{clinicId}/prescriptionFavorites/compiledcompound/{favoriteId}": {
"put": {
"tags": [
"ClinicFavorites"
],
"summary": "Edit Clinic Favorite Compiled Compound Prescription",
"description": "Edit a favorite compiled compound prescription defined by DoseSpot drug values to an existing clinic",
"operationId": "ClinicFavorites_EditClinicCompiledCompoundFavoriteV2",
"consumes": [
"application/json",
"text/json",
"application/problem+json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/problem+json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "clinicId",
"in": "path",
"description": "clinic Id",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "favoriteId",
"in": "path",
"description": "Clinic Favorite Id",
"required": true,
"type": "integer",
"format": "int32"
},
{
"in": "body",
"name": "request",
"description": "Favorite medication prescription data",
"required": true,
"schema": {
"$ref": "#/definitions/ClinicPrescriptionFavoriteCompiledCompoundRequest"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/Response"
}
}
}
}
},
"/api/clinics/{clinicId}/prescriptionFavorites/coded": {
"post": {
"tags": [
"ClinicFavorites"
],
"summary": "Add Clinic Coded Medication Favorite Prescription",
"description": "Adds a favorite prescription defined by DoseSpot drug values to an existing clinic",
"operationId": "ClinicFavorites_AddClinicCodedMedicationFavoriteV2",
"consumes": [
"application/json",
"text/json",
"application/problem+json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/problem+json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "clinicId",
"in": "path",
"description": "clinic Id",
"required": true,
"type": "integer",
"format": "int32"
},
{
"in": "body",
"name": "request",
"description": "Favorite medication prescription data",
"required": true,
"schema": {
"$ref": "#/definitions/ClinicPrescriptionFavoriteMedicationRequest"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/IdentifierResponse"
}
}
}
}
},
"/api/clinics/{clinicId}/prescriptionFavorites/supply": {
"post": {
"tags": [
"ClinicFavorites"
],
"summary": "Add Clinic Supply Favorite Prescription",
"description": "Adds a favorite supply prescription defined by DoseSpot supply values to an existing clinic",
"operationId": "ClinicFavorites_AddClinicSupplyFavoriteV2",
"consumes": [
"application/json",
"text/json",
"application/problem+json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/problem+json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "clinicId",
"in": "path",
"description": "clinic Id",
"required": true,
"type": "integer",
"format": "int32"
},
{
"in": "body",
"name": "request",
"description": "Favorite supply prescription data",
"required": true,
"schema": {
"$ref": "#/definitions/ClinicPrescriptionFavoriteSupplyRequest"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/IdentifierResponse"
}
}
}
}
},
"/api/clinics/{clinicId}/prescriptionFavorites/compiledcompound": {
"post": {
"tags": [
"ClinicFavorites"
],
"summary": "Add Clinic Compiled Compound Favorite Prescription",
"description": "Adds a favorite compiled compound prescription defined by DoseSpot drug values to an existing clinic",
"operationId": "ClinicFavorites_AddClinicCompiledCompoundFavoriteV2",
"consumes": [
"application/json",
"text/json",
"application/problem+json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/problem+json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "clinicId",
"in": "path",
"description": "clinic Id",
"required": true,
"type": "integer",
"format": "int32"
},
{
"in": "body",
"name": "request",
"description": "Favorite medication prescription data",
"required": true,
"schema": {
"$ref": "#/definitions/ClinicPrescriptionFavoriteCompiledCompoundRequest"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/IdentifierResponse"
}
}
}
}
},
"/api/clinicGroups": {
"post": {
"tags": [
"ClinicGroups"
],
"summary": "Manages clinic groups",
"description": "Handles clinic group actions which include adding and modifying clinic list in a clinic group.",
"operationId": "ClinicGroups_AddEditClinicGroupV2",
"consumes": [
"application/json",
"text/json",
"application/problem+json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/problem+json",
"application/xml",
"text/xml"
],
"parameters": [
{
"in": "body",
"name": "request",
"description": "",
"required": true,
"schema": {
"$ref": "#/definitions/AddEditClinicGroupRequest"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/AddEditClinicGroupResponse"
}
}
}
}
}
},
"/api/clinicians/{clinicianId}/prescriptionFavorites": {
"get": {
"tags": [
"ClinicianFavorites"
],
"summary": "Get clinician's favorite prescriptions",
"description": "Retrieves a list of clinician's favorite prescriptions",
"operationId": "ClinicianFavorites_GetClinicianPrescriptionFavoritesV2",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/problem+json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "clinicianId",
"in": "path",
"description": "clinician Id",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "favoriteType",
"in": "query",
"required": false,
"type": "string",
"maximum": 3,
"minimum": 0,
"enum": [
"All",
"Medication",
"Supply",
"CompiledCompound"
]
},
{
"name": "pageNumber",
"in": "query",
"required": false,
"type": "integer",
"maximum": 2147483645,
"minimum": 1,
"format": "int32"
},
{
"name": "pageSize",
"in": "query",
"required": false,
"type": "integer",
"maximum": 100,
"minimum": 1,
"format": "int32"
},
{
"name": "searchName",
"in": "query",
"required": false,
"type": "string",
"pattern": "^.{2,}$"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/PagedListResponse[ClinicianFavoritePrescriptionResponse]"
}
}
}
}
},
"/api/clinicians/prescriptionFavorites/coded/{favoriteId}": {
"put": {
"tags": [
"ClinicianFavorites"
],
"summary": "Edit Clinician's Coded Favorite Prescription",
"description": "Edits clinician's coded favorite prescription",
"operationId": "ClinicianFavorites_EditClinicianCodedPrescriptionFavoriteV2",
"consumes": [
"application/json",
"text/json",
"application/problem+json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/problem+json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "favoriteId",
"in": "path",
"description": "Clinician's Favorite Id",
"required": true,
"type": "integer",
"format": "int32"
},
{
"in": "body",
"name": "request",
"description": "Favorite medication prescription data",
"required": true,
"schema": {
"$ref": "#/definitions/ClinicianPrescriptionFavoriteCodedRequest"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/Response"
}
}
}
}
},
"/api/clinicians/prescriptionFavorites/supply/{favoriteId}": {
"put": {
"tags": [
"ClinicianFavorites"
],
"summary": "Edit Clinician's Supply Favorite Prescription",
"description": "Edits clinician's favorite supply prescription",
"operationId": "ClinicianFavorites_EditClinicianSupplyFavoriteV2",
"consumes": [
"application/json",
"text/json",
"application/problem+json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/problem+json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "favoriteId",
"in": "path",
"description": "Clinician's Favorite Id",
"required": true,
"type": "integer",
"format": "int32"
},
{
"in": "body",
"name": "request",
"description": "Favorite supply prescription data",
"required": true,
"schema": {
"$ref": "#/definitions/ClinicianPrescriptionFavoriteSupplyRequest"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/Response"
}
}
}
}
},
"/api/clinicians/prescriptionFavorites/compiledcompound/{favoriteId}": {
"put": {
"tags": [
"ClinicianFavorites"
],
"summary": "Edit Clinician's Favorite Compiled Compound Prescription",
"description": "Edit clinician's favorite compiled compound prescription",
"operationId": "ClinicianFavorites_EditClinicianCompiledCompoundFavoriteV2",
"consumes": [
"application/json",
"text/json",
"application/problem+json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/problem+json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "favoriteId",
"in": "path",
"description": "Clinician's Favorite Id",
"required": true,
"type": "integer",
"format": "int32"
},
{
"in": "body",
"name": "request",
"description": "Favorite medication prescription data",
"required": true,
"schema": {
"$ref": "#/definitions/ClinicianPrescriptionFavoriteCompiledCompoundRequest"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/Response"
}
}
}
}
},
"/api/clinicians/prescriptionFavorites/coded": {
"post": {
"tags": [
"ClinicianFavorites"
],
"summary": "Add clinician favorite coded Prescription",
"description": "Adds a favorite prescription defined by DoseSpot drug values to an existing clinician",
"operationId": "ClinicianFavorites_AddClinicianPrescriptionFavoriteV2",
"consumes": [
"application/json",
"text/json",
"application/problem+json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/problem+json",
"application/xml",
"text/xml"
],
"parameters": [
{
"in": "body",
"name": "request",
"description": "Favorite medication prescription data",
"required": true,
"schema": {
"$ref": "#/definitions/ClinicianPrescriptionFavoriteCodedRequest"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/IdentifierResponse"
}
}
}
}
},
"/api/clinicians/prescriptionFavorites/supply": {
"post": {
"tags": [
"ClinicianFavorites"
],
"summary": "Add Clinician Supply Favorite Prescription",
"description": "Adds a favorite supply prescription defined by DoseSpot supply values to an existing clinician",
"operationId": "ClinicianFavorites_AddClinicianSupplyFavoriteV2",
"consumes": [
"application/json",
"text/json",
"application/problem+json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/problem+json",
"application/xml",
"text/xml"
],
"parameters": [
{
"in": "body",
"name": "request",
"description": "Favorite supply prescription data",
"required": true,
"schema": {
"$ref": "#/definitions/ClinicianPrescriptionFavoriteSupplyRequest"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/IdentifierResponse"
}
}
}
}
},
"/api/clinicians/prescriptionFavorites/compiledcompound": {
"post": {
"tags": [
"ClinicianFavorites"
],
"summary": "Add Clinician Compiled Compound Favorite Prescription",
"description": "Adds a favorite compiled compound prescription defined by DoseSpot drug values to an existing clinician",
"operationId": "ClinicianFavorites_AddClinicianCompiledCompoundFavoriteV2",
# --- truncated at 32 KB (342 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/dosespot/refs/heads/main/openapi/_original/dosespot-rest-api-jumpstart-epcs-v2-swagger.json