{ "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", "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/ClinicianPrescriptionFavoriteCompiledCompoundRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/IdentifierResponse" } } } } }, "/api/clinicians/prescriptionFavorites": { "delete": { "tags": [ "ClinicianFavorites" ], "summary": "Delete Clinician Favorites", "operationId": "ClinicianFavorites_DeleteClinicianFavoriteV2", "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": "List of Favorite Ids", "required": true, "schema": { "$ref": "#/definitions/FavoriteIdListRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/IdentifierResponse" } } } } } }, "/api/clinicians/ordersets/{orderSetId}/details": { "get": { "tags": [ "ClinicianOrderSets" ], "summary": "Get an order set details", "operationId": "ClinicianOrderSets_GetClinicianOrderSetDetailsV2", "consumes": [], "produces": [ "application/json", "text/json", "application/problem+json", "application/xml", "text/xml" ], "parameters": [ { "name": "orderSetId", "in": "path", "description": "The order set to update", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OrderSetDetailsResponse" } } } } }, "/api/clinicians/ordersets": { "get": { "tags": [ "ClinicianOrderSets" ], "summary": "Get clinician Order Sets", "operationId": "ClinicianOrderSets_GetClinicianOrderSetsV2", "consumes": [], "produces": [ "application/json", "text/json", "application/problem+json", "application/xml", "text/xml" ], "parameters": [ { "name": "pageNumber", "in": "query", "description": "Gets or sets the page number for the request.Default value will be 1.", "required": false, "type": "integer", "format": "int32" }, { "name": "pageSize", "in": "query", "description": "Gets or sets the page size for the request. Default value will be 20.", "required": false, "type": "integer", "format": "int32" }, { "name": "sortOrder", "in": "query", "description": "Gets or sets the sort order for the request. Value will be Asc or Desc. Default value will be Asc.", "required": false, "type": "string", "enum": [ "Asc", "Desc" ] }, { "name": "searchString", "in": "query", "description": "Gets or sets the search string for the request.", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PagedListResponse[OrderSetResponse]" } } } }, "post": { "tags": [ "ClinicianOrderSets" ], "summary": "Add an Order Set", "operationId": "ClinicianOrderSets_AddClinicianOrderSetV2", "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": "Order Set data", "required": true, "schema": { "$ref": "#/definitions/OrderSetRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/IdentifierResponse" } } } } }, "/api/clinicians/ordersets/{orderSetId}": { "put": { "tags": [ "ClinicianOrderSets" ], "summary": "Update an Order Set", "operationId": "ClinicianOrderSets_UpdateClinicianOrderSetV2", "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": "orderSetId", "in": "path", "description": "The order set to update", "required": true, "type": "integer", "format": "int32" }, { "in": "body", "name": "request", "description": "Order Set data", "required": true, "schema": { "$ref": "#/definitions/OrderSetRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Response" } } } }, "delete": { "tags": [ "ClinicianOrderSets" ], "summary": "Delete an order set", "operationId": "ClinicianOrderSets_DeleteClinicianOrderSetV2", "consumes": [], "produces": [ "application/json", "text/json", "application/problem+json", "application/xml", "text/xml" ], "parameters": [ { "name": "orderSetId", "in": "path", "description": "The order set to delete", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Response" } } } } }, "/api/clinicians/pdmp": { "get": { "tags": [ "Clinicians" ], "summary": "Get Prescription Drug Monitoring Program data", "description": "Get Prescription Drug Monitoring Program data for the clinician's state", "operationId": "Clinicians_GetClinicianPDMPV2", "consumes": [], "produces": [ "application/json", "text/json", "application/problem+json", "application/xml", "text/xml" ], "parameters": [], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemResponse[PDMPResponse]" } } } } }, "/api/clinicians/idpDisclaimer": { "get": { "tags": [ "Clinicians" ], "summary": "Get identity proofing disclaimer", "description": "Retrieves the signing of the disclaimer for identity proofing for a clinician. If you have signed the disclaimer, there will be a date.", "operationId": "Clinicians_GetIdentityProofingDisclaimerV2", "consumes": [], "produces": [ "application/json", "text/json", "application/problem+json", "application/xml", "text/xml" ], "parameters": [], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ClinicianIdentityProofingDisclaimerResponse" } } } }, "post": { "tags": [ "Clinicians" ], "summary": "Accept identity proofing disclaimer", "description": "Completes the signing of the disclaimer for identity proofing for a clinician.", "operationId": "Clinicians_AcceptIdentityProofingDisclaimerV2", "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": "Accept Disclaimer Request", "required": true, "schema": { "$ref": "#/definitions/ClinicianIdentityProofingDisclaimerRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ClinicianIdentityProofingDisclaimerResponse" } } } } }, "/api/clinicians/{clinicianId}": { "get": { "tags": [ "Clinicians" ], "summary": "Get clinician information", "description": "Get Clinician's details By ID", "operationId": "Clinicians_GetClinicianDetailsByIdV2", "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" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemResponse[Clinician]" } } } }, "put": { "tags": [ "Clinicians" ], "summary": "Edit clinician information", "description": "Updates an existing clinician\u00e2\u0080\u0099s contact information", "operationId": "Clinicians_PutClinicianEditV2", "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": "clinicianId", "in": "path", "description": "Clinician ID", "required": true, "type": "integer", "format": "int32" }, { "in": "body", "name": "request", "description": "Updated clinician data", "required": true, "schema": { "$ref": "#/definitions/AddEditClinicianRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Response" } } } } }, "/api/clinician": { "get": { "tags": [ "Clinicians" ], "summary": "Get Clinician By Npi Or Dea", "operationId": "Clinicians_GetClinicianByNpiOrDeaV2", "consumes": [], "produces": [ "application/json", "text/json", "application/problem+json", "application/xml", "text/xml" ], "parameters": [ { "name": "npi", "in": "query", "description": "", "required": false, "type": "string" }, { "name": "dea", "in": "query", "description": "", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/IdentifierResponse" } } } } }, "/api/patients/{patientId}/clinicians": { "get": { "tags": [ "Clinicians" ], "summary": "Get patient's clinicians", "description": "Retrieves information on all clinicians that have affected a patient record", "operationId": "Clinicians_GetPatientCliniciansV2", "consumes": [], "produces": [ "application/json", "text/json", "application/problem+json", "application/xml", "text/xml" ], "parameters": [ { "name": "patientId", "in": "path", "description": "Patient ID", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ListResponse[Clinician]" } } } } }, "/api/clinicians/{clinicianId}/legalAgreements": { "get": { "tags": [ "Clinicians" ], "summary": "Retrieves a list of clinician's legal agreements", "operationId": "Clinicians_GetClinicianLegalAgreementsV2", "consumes": [], "produces": [ "application/json", "text/json", "application/problem+json", "application/xml", "text/xml" ], "parameters": [ { "name": "clinicianId", "in": "path", "description": "", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ListResponse[AgreementInfoResponse]" } } } } }, "/api/clinicians/{clinicianId}/registrationStatus": { "get": { "tags": [ "Clinicians" ], "summary": "Get clinician specific registration status", "description": "Retrieves a clinician\u00e2\u0080\u0099s registration status at the clinic used to obtain the Authentication token", "operationId": "Clinicians_ClinicianCheckRegistrationStatusV2", "consumes": [], "produces": [ "application/json", "text/json", "application/problem+json", "application/xml", "text/xml" ], "parameters": [ { "name": "clinicianId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemResponse[eRxRegistrationStatusType]" } } } } }, "/api/prescriptions/{prescriptionId}/prescriberInfo": { "get": { "tags": [ "Clinicians" ], "summary": "Get a Prescription's prescriber Information", "operationId": "Clinicians_GetPrescriptionPrescriberInfoAPIV2", "consumes": [], "produces": [ "application/json", "text/json", "application/problem+json", "application/xml", "text/xml" ], "parameters": [ { "name": "prescriptionId", "in": "path", "description": "The prescription Id", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PrescriberInfoResponse" } } } } }, "/api/clinicians/pin": { "post": { "tags": [ "Clinicians" ], "summary": "Sets a clinician's PIN", "operationId": "Clinicians_SetPinV2", "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": "PIN Request Data", "required": true, "schema": { "$ref": "#/definitions/ClinicianSetPinRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Response" } } } }, "put": { "tags": [ "Clinicians" ], "summary": "Change a clinician's PIN", "operationId": "Clinicians_ChangePinV2", "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": "PIN Request Data", "required": true, "schema": { "$ref": "#/definitions/ClinicianChangePinRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Response" } } } } }, "/api/clinicians/{clinicianId}/supervisors": { "put": { "tags": [ "Clinicians" ], "summary": "Add a supervisor to a clinician", "operationId": "Clinicians_AddSupervisorToClinicianV2", "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": "clinicianId", "in": "path", "description": "The ID of the clinician", "required": true, "type": "integer", "format": "int32" }, { "in": "body", "name": "request", "required": true, "schema": { "type": "array", "items": { "$ref": "#/definitions/SupervisorToClinicianRequest" } } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Response" } } } }, "delete": { "tags": [ "Clinicians" ], "summary": "Remove a supervisor from a clinician", "operationId": "Clinicians_DeleteSupervisorToClinicianV2", "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": "clinicianId", "in": "path", "description": "The ID of the clinician", "required": true, "type": "integer", "format": "int32" }, { "in": "body", "name": "request", "required": true, "schema": { "$ref": "#/definitions/DeleteClinicianSupervisorRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Response" } } } } }, "/api/clinicians": { "post": { "tags": [ "Clinicians" ], "summary": "Add new clinician", "description": "Creates a new clinician", "operationId": "Clinicians_ClinicianAddV2", "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": "New clinician data", "required": true, "schema": { "$ref": "#/definitions/AddEditClinicianRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/IdentifierResponse" } } } } }, "/api/clinicians/idp": { "post": { "tags": [ "Clinicians" ], "summary": "Clinician identity proofing", "description": "Completes the first step of identity proofing for a clinician. This must be completed along with subsequent steps in \r\norder to enable electronic prescribing of controlled substances by this clinician. The results will return a session \r\nID and a collection of questions and answers (3 sets of 4 answers), which can be used as the body parameters for the \r\nsecond step of IDP", "operationId": "Clinicians_ClinicianIdentityProofingV2", "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": "IDP data", "required": true, "schema": { "$ref": "#/definitions/ClinicianIdentityProofingRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ClinicianIdentityProofingResponse" } } } } }, "/api/clinicians/idpOtp": { "post": { "tags": [ "Clinicians" ], "summary": "Submit IDP one time code", "description": "Identity Proofing with a one time code", "operationId": "Clinicians_ClinicianIdentityProofingOneTimeCodeV2", "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/ClinicianIdentityProofingOneTimeCodeRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ClinicianIdentityProofingResponse" } } } } }, "/api/clinicians/resetPin": { "post": { "tags": [ "Clinicians" ], "summary": "Reset My Pin", "description": "Resets the clinician's PIN to \"\" or null", "operationId": "Clinicians_ResetMyPinV2", "consumes": [], "produces": [ "application/json", "text/json", "application/problem+json", "application/xml", "text/xml" ], "parameters": [], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Response" } } } } }, "/api/clinicians/idpAnswers": { "post": { "tags": [ "Clinicians" ], "summary": "Submit clinician identity proofing answers", "description": "Completes the final step of identity proofing for a clinician. This must be completed along with subsequent steps to enable electronic \r\nprescribing of controlled substances by this clinician.If an additional question is returned, this same method must be used again to \r\nsubmit an answer for it. After this, a clinician will either be marked as having passed or failed identity proofing.", "operationId": "Clinicians_ClinicianIdentityProofingAnswersV2", "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": "IDP data", "required": true, "schema": { "$ref": "#/definitions/ClinicianIdentityProofingAnswersRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ClinicianIdentityProofingResponse" } } } } }, "/api/clinicians/resyncToken": { "post": { "tags": [ "Clinicians" ], "summary": "Resync clinician's token", "description": "Resync's clinician token to match the token generated by the authentication manager", "operationId": "Clinicians_ResyncTokenV2", "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": "Token Request Data", "required": true, "schema": { "$ref": "#/definitions/ClinicianResyncTokenRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Response" } } } } }, "/api/clinicians/tfaActivate": { "post": { "tags": [ "Clinicians" ], "summary": "Two factor authentication activation", "description": "Completes a clinician's two factor activation", "operationId": "Clinicians_TfaActivateV2", "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": "TFA Request Data", "required": true, "schema": { "$ref": "#/definitions/ClinicianTfaActivationRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Response" } } } } }, "/api/clinicians/sendMobileTfa": { "post": { "tags": [ "Clinicians" ], "summary": "Send mobile activation message", "description": "Registers a clinician with DUO Mobile and sends download and activation message", "operationId": "Clinicians_SendMobileTfaV2", "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": "TFA Initiate Request Data", "required": true, "schema": { "$ref": "#/definitions/ClinicianMobileTfaInitiationRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Response" } } } } }, "/api/clinicians/tfaDeactivate": { "post": { "tags": [ "Clinicians" ], "summary": "Two factor authentication de-activation", "description": "Completes a clinician's two factor deactivation", "operationId": "Clinicians_TfaDeactivateV2", "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": "TFA Request Data", "required": true, "schema": { "$ref": "#/definitions/ClinicianTfaDeactivationRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Response" } } } } }, "/api/clinicians/acceptAgreement": { "post": { "tags": [ "Clinicians" ], "summary": "Accepts a legal agreement", "operationId": "Clinicians_AcceptAgreementV2", "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/ClinicianAcceptAgreementRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ClinicianAcceptAgreementResponse" } } } } }, "/api/clinicians/{clinicianId}/idpInit": { "post": { "tags": [ "Clinicians" ], "summary": "Initialize identity proofing", "description": "Mark Clinician IDP Initialized", "operationId": "Clinicians_InitializeIDPV2", "consumes": [], "produces": [ "application/json", "text/json", "application/problem+json", "application/xml", "text/xml" ], "parameters": [ { "name": "clinicianId", "in": "path", "description": "", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Response" } } } } }, "/api/clinicians/{clinicianId}/resetPin": { "post": { "tags": [ "Clinicians" ], "summary": "Reset Clinician's PIN", "description": "Resets a different clinician's PIN to \"\" or null", "operationId": "Clinicians_ResetClinicianPinV2", "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" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Response" } } } } }, "/api/clinicians/{clinicianId}/initTfaActivate": { "post": { "tags": [ "Clinicians" ], "summary": "Initialize two factor authentication", "description": "Initializes activation of a clinician's two factor authentication", "operationId": "Clinicians_InitializeTfaActivationV2", "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": "clinicianId", "in": "path", "description": "Clinician ID", "required": true, "type": "integer", "format": "int32" }, { "in": "body", "name": "request", "description": "TFA Init Activation Request Data", "required": true, "schema": { "$ref": "#/definitions/ClinicianInitializeTfaActivationRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Response" } } } } }, "/api/clinicians/{clinicianId}/initTfaDeactivate": { "post": { "tags": [ "Clinicians" ], "summary": "Initialize two factor authentication deactivation", "description": "Initializes deactivation of a clinician's two factor authentication", "operationId": "Clinicians_InitializeTfaDeactivationV2", "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" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Response" } } } } }, "/api/clinic/ordersets": { "get": { "tags": [ "ClinicOrderSets" ], "summary": "Get clinic Order Sets", "operationId": "ClinicOrderSets_GetClinicOrderSets", "consumes": [], "produces": [ "application/json", "text/json", "application/problem+json", "application/xml", "text/xml" ], "parameters": [ { "name": "pageNumber", "in": "query", "description": "Gets or sets the page number for the request.Default value will be 1.", "required": false, "type": "integer", "format": "int32" }, { "name": "pageSize", "in": "query", "description": "Gets or sets the page size for the request. Default value will be 20.", "required": false, "type": "integer", "format": "int32" }, { "name": "sortOrder", "in": "query", "description": "Gets or sets the sort order for the request. Value will be Asc or Desc. Default value will be Asc.", "required": false, "type": "string", "enum": [ "Asc", "Desc" ] }, { "name": "searchString", "in": "query", "description": "Gets or sets the search string for the request.", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PagedListResponse[ClinicOrderSetResponse]" } } } } }, "/api/clinics/{clinicId}": { "get": { "tags": [ "Clinics" ], "summary": "Gets clinic information", "description": "Given a clinicId gets the respective clinic\u00e2\u0080\u0099s information", "operationId": "Clinics_GetClinicDetailsV2", "consumes": [], "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" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ClinicDetailResponse" } } } }, "put": { "tags": [ "Clinics" ], "summary": "Edit Clinic information", "description": "Updates an existing clinic\u00e2\u0080\u0099s contact information", "operationId": "Clinics_ClinicEditV2", "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": "Updated clinic data", "required": true, "schema": { "$ref": "#/definitions/AddEditClinicRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Response" } } } } }, "/api/patients/{patientId}/clinics": { "get": { "tags": [ "Clinics" ], "summary": "Get patient's clinics", "description": "Retrieves information on all clinics that have been associated with a patient", "operationId": "Clinics_GetPatientClinicsV2", "consumes": [], "produces": [ "application/json", "text/json", "application/problem+json", "application/xml", "text/xml" ], "parameters": [ { "name": "patientId", "in": "path", "description": "Patient ID", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ListResponse[Clinic]" } } } } }, "/api/clinicians/{clinicianId}/clinicIds": { "get": { "tags": [ "Clinics" ], "summary": "Gets a clinician's clinic identifiers", "description": "Retrieves a list of clinic identifiers for a clinician\r\nregardless of eRx functions for those clinics", "operationId": "Clinics_GetClinicianClinicsV2", "consumes": [], "produces": [ "application/json", "text/json", "application/problem+json", "application/xml", "text/xml" ], "parameters": [ { "name": "clinicianId", "in": "path", "description": "", "required": true, "type": "integer", "format": "int32" }, { "name": "includeClinicGroups", "in": "query", "required": false, "type": "boolean" }, { "name": "clinicStatus", "in": "query", "required": false, "type": "string", "maximum": 2, "minimum": 0, "enum": [ "Active", "Inactive", "All" ] } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ListResponse[ClinicIdentifier]" } } } } }, "/api/clinics": { "post": { "tags": [ "Clinics" ], "summary": "Add clinic", "description": "Adds a new clinic", "operationId": "Clinics_ClinicAddV2", "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": "New clinic data", "required": true, "schema": { "$ref": "#/definitions/AddEditClinicRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ClinicKeyResponse" } } } } }, "/api/patients/{patientId}/transfer": { "post": { "tags": [ "Clinics" ], "summary": "Transfer patient clinic", "description": "Change the clinic this patient is associated with", "operationId": "Clinics_PatientClinicTransferV2", "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": "changeClinicRequest", "description": "", "required": true, "schema": { "$ref": "#/definitions/ChangePatientClinicRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Response" } } } } }, "/api/clinicians/{clinicianId}/clinics": { "post": { "tags": [ "Clinics" ], "summary": "Add clinician clinics", "description": "Adds a clinician to one or more existing clinics", "operationId": "Clinics_ClinicianAddMultipleClinicsV2", "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": "clinicianId", "in": "path", "description": "Clinician ID", "required": true, "type": "integer", "format": "int32" }, { "in": "body", "name": "request", "description": "Clinic list", "required": true, "schema": { "$ref": "#/definitions/ClinicianAddMultipleClinicsRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/Response" } } } } } }, "/api/clinics/{clinicId}/clinicians": { "delete": { "tags": [ "Clinics" ], "summary": "Removes clinician(s) from a specified clinic", "description": "Removes an array of clinicians from a specified clinic", "operationId": "Clinics_ClinicRemoveMultipleCliniciansV2", "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": "List of Clinician IDs", "required": true, "schema": { "$ref": "#/definitions/ClinicRemoveMultipleCliniciansRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/Response" } } } } } }, "/api/clinicians/{clinicianId}/deanumbers": { "get": { "tags": [ "Clinicians" ], "summary": "Get clinician's DEA numbers", "operationId": "DEANumbers_GetDEANumbers", "consumes": [], "produces": [ "application/json", "text/json", "application/problem+json", "application/xml", "text/xml" ], "parameters": [ { "name": "clinicianId", "in": "path", "description": "", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ListResponse[DEANumberResponse]" } } } }, "post": { "tags": [ "Clinicians" ], "summary": "Add a DEA number to a clinician", "operationId": "DEANumbers_AddDEANumber", "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": "clinicianId", "in": "path", "description": "the clinician id", "required": true, "type": "integer", "format": "int32" }, { "in": "body", "name": "request", "description": "The request", "required": true, "schema": { "$ref": "#/definitions/DEANumberRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/IdentifierGuidResponse" } } } } }, "/api/clinicians/{clinicianId}/deanumbers/{deanumberId}": { "get": { "tags": [ "Clinicians" ], "summary": "Get a clinician's DEA number", "operationId": "DEANumbers_GetDEANumber", "consumes": [], "produces": [ "application/json", "text/json", "application/problem+json", "application/xml", "text/xml" ], "parameters": [ { "name": "clinicianId", "in": "path", "description": "The clinician to update", "required": true, "type": "integer", "format": "int32" }, { "name": "deanumberId", "in": "path", "description": "The clinician DEA Number Id", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemResponse[DEANumberResponse]" } } } }, "put": { "tags": [ "Clinicians" ], "summary": "Edit a DEA number to a clinician", "operationId": "DEANumbers_EditDEANumber", "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": "clinicianId", "in": "path", "description": "The clinician to update", "required": true, "type": "integer", "format": "int32" }, { "name": "deanumberId", "in": "path", "description": "The clinician DEA Number Id", "required": true, "type": "string", "format": "uuid" }, { "in": "body", "name": "request", "description": "The request", "required": true, "schema": { "$ref": "#/definitions/DEANumberRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Response" } } } }, "delete": { "tags": [ "Clinicians" ], "summary": "Delete a clinician's DEA number", "operationId": "DEANumbers_DeleteDEANumber", "consumes": [], "produces": [ "application/json", "text/json", "application/problem+json", "application/xml", "text/xml" ], "parameters": [ { "name": "clinicianId", "in": "path", "description": "The clinician to update", "required": true, "type": "integer", "format": "int32" }, { "name": "deanumberId", "in": "path", "description": "The clinician DEA Number Id", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Response" } } } } }, "/api/diagnoses/search": { "get": { "tags": [ "Diagnoses" ], "summary": "Search Diagnoses", "description": "Search diagnoses by International Classification of Diseases codes or by CDT procedural codes", "operationId": "Diagnoses_DiagnosisSearchV2", "consumes": [], "produces": [ "application/json", "text/json", "application/problem+json", "application/xml", "text/xml" ], "parameters": [ { "name": "searchTerm", "in": "query", "description": "The term we are searching", "required": true, "type": "string" }, { "name": "pageNumber", "in": "query", "description": "The page number default to 1", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PagedListResponse[DiagnosisSearchResult]" } } } } }, "/api/patients/{patientId}/insurance": { "post": { "tags": [ "Eligibilities" ], "summary": "Add custom insurance info", "description": "Add custom insurance to a patient provided the clinic allows it.", "operationId": "Eligibilities_CustomInsuranceInfoV2", "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": "customInsuranceRequest", "description": "", "required": true, "schema": { "$ref": "#/definitions/CustomInsuranceRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/IdentifierResponse" } } } } }, "/api/general/check": { "get": { "tags": [ "HealthCheck" ], "summary": "Check API health", "description": "Verifies the API is up and running", "operationId": "HealthCheck_CheckHealthV2", "consumes": [], "produces": [ "application/json", "text/json", "application/problem+json", "application/xml", "text/xml" ], "parameters": [], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Response" } } } } }, "/api/patients/{patientId}/interactions/drugs": { "get": { "tags": [ "Interactions" ], "summary": "Check drug-drug interactions", "description": "Retrieves a list of interactions among the medications in a patient\u00e2\u0080\u0099s record", "operationId": "Interactions_GetDrugInteractionsV2", "consumes": [], "produces": [ "application/json", "text/json", "application/problem+json", "application/xml", "text/xml" ], "parameters": [ { "name": "patientId", "in": "path", "description": "Patient ID", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ListResponse[DrugInteraction]" } } } } }, "/api/patients/{patientId}/interactions/allergies": { "get": { "tags": [ "Interactions" ], "summary": "Get allergies interactions", "description": "Retrieves a list of interactions between the medications and drug allergies in a patient\u00e2\u0080\u0099s record", "operationId": "Interactions_GetAllergyInteractionsV2", "consumes": [], "produces": [ "application/json", "text/json", "application/problem+json", "application/xml", "text/xml" ], "parameters": [ { "name": "patientId", "in": "path", "description": "Patient ID", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ListResponse[AllergyInteraction]" } } } } }, "/api/patients/{patientId}/interactions/precheck/{dispensableDrugId}": { "get": { "tags": [ "Interactions" ], "summary": "Check pre-check interactions", "description": "Checks the interactions (drug and allergy) without actually adding the drug to the patient's record.", "operationId": "Interactions_GetPreCheckInteractionsV2", "consumes": [], "produces": [ "application/json", "text/json", "application/problem+json", "application/xml", "text/xml" ], "parameters": [ { "name": "patientId", "in": "path", "description": "Patient ID", "required": true, "type": "integer", "format": "int32" }, { "name": "dispensableDrugId", "in": "path", "description": "Dispensable Drug ID", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PreCheckInteractionsResponse" } } } } }, "/api/patients/{patientId}/medications/history": { "get": { "tags": [ "MedicationHistory" ], "summary": "Get patient's medication history", "description": "Retrieves a patient\u00e2\u0080\u0099s medication history according to PBM insurance claims submitted to the Surescripts \r\nePrescribing network. A date range may be specified. A patient must give consent to retrieve this data.", "operationId": "MedicationHistory_GetMedicationHistoryV2", "consumes": [], "produces": [ "application/json", "text/json", "application/problem+json", "application/xml", "text/xml" ], "parameters": [ { "name": "patientId", "in": "path", "description": "Patient ID", "required": true, "type": "integer", "format": "int32" }, { "name": "start", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "end", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "pageNumber", "in": "query", "required": false, "type": "integer", "maximum": 2147483645, "minimum": 1, "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PagedListResponse[SureScriptsHistoryMedication]" } } } } }, "/api/patients/{patientId}/medications/history/consent": { "post": { "tags": [ "MedicationHistory" ], "summary": "Log patient's medication history consent", "description": "Logs a patient\u00e2\u0080\u0099s consent for their clinician to retrieve and view their medication history", "operationId": "MedicationHistory_LogPatientMedicationHistoryConsentV2", "consumes": [], "produces": [ "application/json", "text/json", "application/problem+json", "application/xml", "text/xml" ], "parameters": [ { "name": "patientId", "in": "path", "description": "Patient ID", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemResponse[DateTime]" } } } } }, "/api/dispenseUnits": { "get": { "tags": [ "Medications" ], "summary": "Get Dispense Units", "description": "Returns a detailed list of all types of dispense units available for prescription requests", "operationId": "Medications_GetStandardDispenseUnitsV2", "consumes": [], "produces": [ "application/json", "text/json", "application/problem+json", "application/xml", "text/xml" ], "parameters": [], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ListResponse[StandardDispenseUnitType]" } } } } }, "/api/dispenseUnits/{dispenseUnitId}": { "get": { "tags": [ "Medications" ], "summary": "Get Dispense Unit By Id", "description": "Lists the details of a specified dispense unit type", "operationId": "Medications_GetStandardDispenseUnitByIDV2", "consumes": [], "produces": [ "application/json", "text/json", "application/problem+json", "application/xml", "text/xml" ], "parameters": [ { "name": "dispenseUnitId", "in": "path", "description": "Dispense units id", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemResponse[StandardDispenseUnitType]" } } } } }, "/api/medications/searchByRxCUI": { "get": { "tags": [ "Medications" ], "summary": "Get dispensable drugs by rxCUI", "description": "Returns a list of drugs based on an rxCUI", "operationId": "Medications_MedicationSearchRxCUIV2", "consumes": [], "produces": [ "application/json", "text/json", "application/problem+json", "application/xml", "text/xml" ], "parameters": [ { "name": "rxCUI", "in": "query", "description": "", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ListResponse[MedicationSelectResult]" } } } } }, "/api/medications/search": { "get": { "tags": [ "Medications" ], "summary": "Search for drugs", "description": "Returns a list of relevant dispensable drugs matching a specified drug name of three or more characters.", "operationId": "Medications_MedicationSearchV2", "consumes": [], "produces": [ "application/json", "text/json", "application/problem+json", "application/xml", "text/xml" ], "parameters": [ { "name": "pageNumber", "in": "query", "description": "Starting page number (1-based)", "required": false, "type": "integer", "format": "int32" }, { "name": "name", "in": "query", "required": true, "type": "string", "pattern": "^.{2,}$" }, { "name": "drugStatus", "in": "query", "required": false, "type": "string", "enum": [ "Active", "Inactive", "All" ] } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PagedListResponse[MedicationSearchResult]" } } } } }, "/api/medications/select": { "get": { "tags": [ "Medications" ], "summary": "Get dispensable drug detail", "description": "Selects a drug based on rxCUI OR NDC OR DispensableDrugId.", "operationId": "Medications_MedicationSelectV2", "consumes": [], "produces": [ "application/json", "text/json", "application/problem+json", "application/xml", "text/xml" ], "parameters": [ { "name": "dispensableDrugId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "nDC", "in": "query", "required": false, "type": "string" }, { "name": "rXCUI", "in": "query", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemResponse[MedicationSelectResult]" } } } } }, "/api/medications/monograph": { "get": { "tags": [ "Medications" ], "summary": "Get Drug Monograph", "description": "Get a drug monograph based on a DispensableDrugId or an NDC.", "operationId": "Medications_GetDrugMonographV2", "consumes": [], "produces": [ "application/json", "text/json", "application/problem+json", "application/xml", "text/xml" ], "parameters": [ { "name": "dispensableDrugId", "in": "query", "description": "DispensableDrugId", "required": false, "type": "integer", "maximum": 2147483645, "minimum": 1, "format": "int32" }, { "name": "nDC", "in": "query", "description": "Drug NDC", "required": false, "type": "string" }, { "name": "monographFormat", "in": "query", "description": "Return XML or HTML defaults to HTML", "required": false, "type": "string", "maximum": 2, "minimum": 1, "enum": [ "HTML", "XML" ] } ], "responses": { "200": { "description": "HTML or XML of the Drug Monograph or 'We could not locate the drug monograph at this time'." } } } }, "/api/patients/{patientId}/narx": { "get": { "tags": [ "Narx" ], "summary": "Get patient Narx Report", "description": "Returns the patient's report if any", "operationId": "Narx_GetPatientNarxReportV2", "consumes": [], "produces": [ "application/json", "text/json", "application/problem+json", "application/xml", "text/xml" ], "parameters": [ { "name": "patientId", "in": "path", "description": "PatientId", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/NarxResponse" } } } } }, "/api/patients/{patientId}/narx/latest": { "get": { "tags": [ "Narx" ], "summary": "Get latest patient NARX/PDMP data timestamp", "description": "Returns the timestamp of the most recent successful NARX/PDMP request for the patient", "operationId": "Narx_GetLatestNarxV2", "consumes": [], "produces": [ "application/json", "text/json", "application/problem+json", "application/xml", "text/xml" ], "parameters": [ { "name": "patientId", "in": "path", "description": "PatientId", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/LatestNarxResponse" } } } } }, "/api/patients/{patientId}/narx/report": { "get": { "tags": [ "Narx" ], "summary": "Get patient Narx Report Link", "description": "Returns the url to the Narx Report for the patient", "operationId": "Narx_GetPatientNarxReportLinkV2", "consumes": [], "produces": [ "application/json", "text/json", "application/problem+json", "application/xml", "text/xml" ], "parameters": [ { "name": "patientId", "in": "path", "description": "PatientId", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemResponse[String]" } } } } }, "/api/notifications/counts": { "get": { "tags": [ "Notifications" ], "summary": "Get Notification Counts For Current Clinician", "description": "Lists the number of notifications for refill requests, transmission errors, and prescriptions that are pending a response from the clinician at a single clinic", "operationId": "Notifications_GetPrescriberNotificationCountsV2", "consumes": [], "produces": [ "application/json", "text/json", "application/problem+json", "application/xml", "text/xml" ], "parameters": [], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PrescriberNotificationCountsResponse" } } } } }, "/api/notifications/errors": { "get": { "tags": [ "Notifications" ], "summary": "Get Transmission Errors For Current Clinician", "description": "Lists the notifications for transmission errors for the clinician's associated clinic(s)", "operationId": "Notifications_GetTransmissionErrorDetailsV2", "consumes": [], "produces": [ "application/json", "text/json", "application/problem+json", "application/xml", "text/xml" ], "parameters": [ { "name": "pageNumber", "in": "query", "required": false, "type": "integer", "maximum": 2147483647, "minimum": 1, "format": "int32" }, { "name": "clinic", "in": "query", "required": false, "type": "string", "maximum": 1, "minimum": 0, "enum": [ "All", "Current" ] } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PagedListResponse[TransmissionErrors]" } } } } }, "/api/patients/{patientId}": { "get": { "tags": [ "Patients" ], "summary": "Get patient demographics", "description": "Retrieves the existing demographic information in a patient record.", "operationId": "Patients_GetPatientDemographicDataV2", "consumes": [], "produces": [ "application/json", "text/json", "application/problem+json", "application/xml", "text/xml" ], "parameters": [ { "name": "patientId", "in": "path", "description": "Patient ID", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemResponse[GetPatient]" } } } }, "put": { "tags": [ "Patients" ], "summary": "Edit patient demographics", "description": "Updates the demographic information for an existing patient record", "operationId": "Patients_EditPatientDemographicDataV2", "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": "Patient ID", "required": true, "type": "integer", "format": "int32" }, { "in": "body", "name": "request", "description": "Updated patient data", "required": true, "schema": { "$ref": "#/definitions/AddEditPatientRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Response" } } } } }, "/api/patients/search": { "get": { "tags": [ "Patients" ], "summary": "Search Patients", "description": "Returns a list of patient records matching a specified search query.", "operationId": "Patients_SearchPatientsV2", "consumes": [], "produces": [ "application/json", "text/json", "application/problem+json", "application/xml", "text/xml" ], "parameters": [ { "name": "firstName", "in": "query", "description": "Patient First Name", "required": false, "type": "string" }, { "name": "lastName", "in": "query", "description": "Patient Last Name", "required": false, "type": "string" }, { "name": "dob", "in": "query", "description": "Patient date of birth (M/dd/yyyy)", "required": false, "type": "string", "format": "date-time" }, { "name": "status", "in": "query", "description": "Patient Status to include (if none supplied defaults to both)", "required": false, "type": "string", "enum": [ "InactiveOnly", "ActiveOnly", "Both" ] }, { "name": "pageNumber", "in": "query", "description": "Page Number", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PagedListResponse[Patient]" } } } } }, "/api/patients/{patientId}/SSN": { "put": { "tags": [ "Patients" ], "summary": "Add/Update Patient SSN details", "operationId": "Patients_AddEditPatientSsnV2", "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": "", "required": true, "schema": { "$ref": "#/definitions/PatientSsnRequestModel" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/IdentifierResponse" } } } }, "delete": { "tags": [ "Patients" ], "summary": "Delete patient's SSN", "description": "Deletes the SSN from a Patient.", "operationId": "Patients_DeletePatientSSNV2", "consumes": [], "produces": [ "application/json", "text/json", "application/problem+json", "application/xml", "text/xml" ], "parameters": [ { "name": "patientId", "in": "path", "description": "Patient ID", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Response" } } } } }, "/api/patients": { "post": { "tags": [ "Patients" ], "summary": "Add Patient", "description": "Creates a new patient and returns the corresponding patient ID", "operationId": "Patients_AddPatientV2", "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": "New patient data", "required": true, "schema": { "$ref": "#/definitions/AddEditPatientRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/IdentifierResponse" } } } } }, "/api/patients/merge": { "post": { "tags": [ "Patients" ], "summary": "Merge patient's medications and allergies", "description": "Merges the medications from one patient record to another patient record.\r\nOptionally merges allergies when MergeAllergies is set to true.\r\nThis includes all types of self-reported medications and prescriptions.\r\nWhen MergeAllergies is true, all allergies are also merged.\r\nDuplicate allergies are not created. When an AllergenID is present, allergies are considered duplicates based on matching AllergenID. When AllergenID is not present, allergies are considered duplicates based on the combination of AllergyCode, AllergyCodeTypeID, and DisplayName. Free-text allergies and NKA (No Known Allergies) entries are also deduplicated according to their free-text description and NKA status so that equivalent entries are not duplicated.\r\nOther patient data such as demographics, preferred pharmacies, etc. are NOT merged.", "operationId": "Patients_MergePatientsV2", "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": "Patient IDs of patients being merged and merge options", "required": true, "schema": { "$ref": "#/definitions/MergePatientsRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Response" } } } } }, "/api/pharmacies/search": { "get": { "tags": [ "Pharmacies" ], "summary": "Search pharmacies", "description": "Returns a list of pharmacies matching the specified search parameters", "operationId": "Pharmacies_PharmacySearchV2", "consumes": [], "produces": [ "application/json", "text/json", "application/problem+json", "application/xml", "text/xml" ], "parameters": [ { "name": "name", "in": "query", "description": "Pharmacy name", "required": false, "type": "string" }, { "name": "city", "in": "query", "description": "City", "required": false, "type": "string" }, { "name": "state", "in": "query", "description": "State", "required": false, "type": "string" }, { "name": "zip", "in": "query", "description": "ZIP code", "required": false, "type": "string" }, { "name": "address", "in": "query", "description": "Street address", "required": false, "type": "string" }, { "name": "phoneOrFax", "in": "query", "description": "Phone or fax number", "required": false, "type": "string" }, { "name": "specialty", "in": "query", "description": "Array of pharmacy specialty types to filter the search.", "required": false, "type": "array", "items": { "type": "string", "enum": [ "Any", "FaxPharmacy", "EPCS", "TwentyFourHourPharmacy", "LongTermCarePharmacy", "MailOrder", "Retail", "SpecialtyPharmacy" ] }, "collectionFormat": "multi" }, { "name": "ncpdpId", "in": "query", "description": "NCPDP identifier for the pharmacy.", "required": false, "type": "string" }, { "name": "pageNumber", "in": "query", "description": "Page number for paginated search results. Defaults to 1.", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PagedListResponse[Pharmacy]" } } } } }, "/api/pharmacies/{pharmacyId}": { "get": { "tags": [ "Pharmacies" ], "summary": "Get pharmacy details", "description": "Retrieves key data about a single pharmacy on the Surescripts ePrescribing network", "operationId": "Pharmacies_GetPharmacyV2", "consumes": [], "produces": [ "application/json", "text/json", "application/problem+json", "application/xml", "text/xml" ], "parameters": [ { "name": "pharmacyId", "in": "path", "description": "Pharmacy ID", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemResponse[Pharmacy]" } } } } }, "/api/patients/{patientId}/pharmacies": { "get": { "tags": [ "Pharmacies" ], "summary": "Get patient's pharmacies", "description": "Retrieves a detailed list of a preferred pharmacies in the patient\u00e2\u0080\u0099s record", "operationId": "Pharmacies_GetPatientPharmaciesV2", "consumes": [], "produces": [ "application/json", "text/json", "application/problem+json", "application/xml", "text/xml" ], "parameters": [ { "name": "patientId", "in": "path", "description": "Patient ID", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ListResponse[PatientPharmacy]" } } } }, "post": { "tags": [ "Pharmacies" ], "summary": "Add Pharmacy to Patient", "description": "Adds a pharmacy to a patient\u00e2\u0080\u0099s preferred pharmacies list", "operationId": "Pharmacies_AddPatientPharmacyV2", "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": "Patient ID", "required": true, "type": "integer", "format": "int32" }, { "in": "body", "name": "request", "description": "", "required": true, "schema": { "$ref": "#/definitions/AddEditPatientPharmacyRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Response" } } } } }, "/api/pharmacies/restrictions": { "get": { "tags": [ "Pharmacies" ], "summary": "Get Pharmacy Restrictions", "description": "Retrieves a list of a preferred pharmacies given\r\na Dispensable Drug ID", "operationId": "Pharmacies_GetPharmacyRestrictionsV2", "consumes": [], "produces": [ "application/json", "text/json", "application/problem+json", "application/xml", "text/xml" ], "parameters": [ { "name": "dispensableDrugId", "in": "query", "required": true, "type": "integer", "format": "int32" }, { "name": "pageNumber", "in": "query", "required": false, "type": "integer", "maximum": 2147483645, "minimum": 1, "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PagedListResponse[Pharmacy]" } } } } }, "/api/patients/{patientId}/pharmacies/{pharmacyId}": { "delete": { "tags": [ "Pharmacies" ], "summary": "Delete Pharmacy from Patient", "description": "Removes a pharmacy from a patient\u00e2\u0080\u0099s preferred pharmacies list", "operationId": "Pharmacies_RemovePatientPharmacyV2", "consumes": [], "produces": [ "application/json", "text/json", "application/problem+json", "application/xml", "text/xml" ], "parameters": [ { "name": "patientId", "in": "path", "description": "Patient ID", "required": true, "type": "integer", "format": "int32" }, { "name": "pharmacyId", "in": "path", "description": "Pharmacy ID", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Response" } } } } }, "/api/patients/{patientId}/prescriptions/{prescriptionId}": { "get": { "tags": [ "Prescriptions" ], "summary": "Get Prescriptions", "description": "Retrieves details of a prescription in a patient record", "operationId": "Prescriptions_GetPatientPrescriptionV2", "consumes": [], "produces": [ "application/json", "text/json", "application/problem+json", "application/xml", "text/xml" ], "parameters": [ { "name": "patientId", "in": "path", "description": "Patient ID", "required": true, "type": "integer", "format": "int32" }, { "name": "prescriptionId", "in": "path", "description": "Prescription ID", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PrescriptionResponse" } } } } }, "/api/patients/{patientId}/prescriptions/{prescriptionId}/log": { "get": { "tags": [ "Prescriptions" ], "summary": "Get Prescription Logs", "description": "Retrieves the prescription log for an existing prescription in a patient record. This is the full history of the prescription.", "operationId": "Prescriptions_GetPrescriptionLogDetailsV2", "consumes": [], "produces": [ "application/json", "text/json", "application/problem+json", "application/xml", "text/xml" ], "parameters": [ { "name": "patientId", "in": "path", "description": "Patient ID", "required": true, "type": "integer", "format": "int32" }, { "name": "prescriptionId", "in": "path", "description": "Prescription ID", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ListResponse[PrescriptionLog]" } } } } }, "/api/patients/{patientId}/prescriptions/{prescriptionId}/snapshot": { "get": { "tags": [ "Prescriptions" ], "summary": "Get Precription snapshot", "description": "Retrieves prescription snapshot", "operationId": "Prescriptions_GetPrescriptionSnapshotV2", "consumes": [], "produces": [ "application/json", "text/json", "application/problem+json", "application/xml", "text/xml" ], "parameters": [ { "name": "patientId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "prescriptionId", "in": "path", "description": "Prescription ID", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PrescriptionSnapshotResponse" } } } } }, "/api/patients/{patientId}/prescriptions": { "get": { "tags": [ "Prescriptions" ], "summary": "Get patient's prescriptions", "description": "Retrieves details of prescriptions in a patient record", "operationId": "Prescriptions_GetPatientPrescriptionsV2", "consumes": [], "produces": [ "application/json", "text/json", "application/problem+json", "application/xml", "text/xml" ], "parameters": [ { "name": "patientId", "in": "path", "description": "Patient ID", "required": true, "type": "integer", "format": "int32" }, { "name": "endDate", "in": "query", "description": "End of date range (timestamp UTC)", "required": false, "type": "string", "format": "date-time" }, { "name": "startDate", "in": "query", "description": "Start of date range (timestamp UTC)", "required": false, "type": "string", "format": "date-time" }, { "name": "statusClass", "in": "query", "description": "Getting Prescription for Active/Inactive/Pending Medication", "required": false, "type": "string", "maximum": 3, "minimum": 1, "enum": [ "Active", "Inactive", "Pending" ] }, { "name": "prescriptionStatus", "in": "query", "description": "The status of the prescription", "required": false, "type": "string", "maximum": 14, "minimum": 1, "enum": [ "Entered", "Printed", "Sending", "eRxSent", "FaxSent", "Error", "Deleted", "Requested", "Edited", "EpcsError", "EpcsSigned", "ReadyToSign", "PharmacyVerified", "PharmacySelect", "Retracted" ] }, { "name": "pageNumber", "in": "query", "description": "The page number default to 1", "required": false, "type": "integer", "format": "int32" }, { "name": "sortColumn", "in": "query", "description": "Sort Column", "required": false, "type": "string", "maximum": 0, "minimum": 0, "enum": [ "DateWritten" ] }, { "name": "sortOrder", "in": "query", "description": "Sort Order", "required": false, "type": "string", "maximum": 1, "minimum": 0, "enum": [ "Asc", "Desc" ] } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PagedListResponse[Prescription]" } } } }, "delete": { "tags": [ "Prescriptions" ], "summary": "Delete Prescriptions", "description": "Marks 1 or more prescriptions in a patient\u00e2\u0080\u0099s record as deleted. Deleted prescriptions are not included in any interaction checks.", "operationId": "Prescriptions_DeletePrescriptionsV2", "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": "Patient ID", "required": true, "type": "integer", "format": "int32" }, { "in": "body", "name": "request", "description": "List of prescription IDs", "required": true, "schema": { "$ref": "#/definitions/PrescriptionIdListRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/IdentifierResponse" } } } } } }, "/api/patients/{patientId}/prescriptions/coded/{prescriptionId}": { "put": { "tags": [ "Prescriptions" ], "summary": "Edit Coded Prescription", "description": "Edits an existing prescription for a specified patient", "operationId": "Prescriptions_EditCodedPrescriptionV2", "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": "Patient ID", "required": true, "type": "integer", "format": "int32" }, { "name": "prescriptionId", "in": "path", "description": "Prescription ID", "required": true, "type": "integer", "format": "int32" }, { "in": "body", "name": "request", "description": "Updated prescription data", "required": true, "schema": { "$ref": "#/definitions/CodedPrescriptionRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Response" } } } } }, "/api/patients/{patientId}/prescriptions/supply/{prescriptionId}": { "put": { "tags": [ "Prescriptions" ], "summary": "Edit Coded Supply Prescription", "description": "Edits a prescription defined by Dosespot drug values to an existing patient record", "operationId": "Prescriptions_EditCodedSupplyV2", "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": "prescriptionId", "in": "path", "description": "", "required": true, "type": "integer", "format": "int32" }, { "in": "body", "name": "request", "description": "", "required": true, "schema": { "$ref": "#/definitions/CodedSupplyRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Response" } } } } }, "/api/patients/{patientId}/prescriptions/supply/freetext/{prescriptionId}": { "put": { "tags": [ "Prescriptions" ], "summary": "Edit Free Text supply Prescription", "description": "Edits an existing supply prescription for a specified patient", "operationId": "Prescriptions_EditFreeTextSupplyPrescriptionV2", "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": "Patient ID", "required": true, "type": "integer", "format": "int32" }, { "name": "prescriptionId", "in": "path", "description": "Prescription ID", "required": true, "type": "integer", "format": "int32" }, { "in": "body", "name": "request", "description": "Updated prescription data", "required": true, "schema": { "$ref": "#/definitions/FreeTextSupplyPrescriptionRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Response" } } } } }, "/api/patients/{patientId}/prescriptions/compiledcompound/{prescriptionId}": { "put": { "tags": [ "Prescriptions" ], "summary": "Edit Compiled Compound", "description": "Edits an existing compound prescription for a specified patient", "operationId": "Prescriptions_EditCompiledCompoundV2", "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": "Patient ID", "required": true, "type": "integer", "format": "int32" }, { "name": "prescriptionId", "in": "path", "description": "Prescription ID", "required": true, "type": "integer", "format": "int32" }, { "in": "body", "name": "request", "description": "Updated prescription data", "required": true, "schema": { "$ref": "#/definitions/CompoundPrescriptionRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/IdentifierResponse" } } } } }, "/api/patients/{patientId}/prescriptions/coded": { "post": { "tags": [ "Prescriptions" ], "summary": "Add Coded Prescription", "description": "Adds a prescription defined by DoseSpot drug values to an existing patient record", "operationId": "Prescriptions_AddCodedPrescriptionV2", "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": "Patient ID", "required": true, "type": "integer", "format": "int32" }, { "in": "body", "name": "request", "description": "Prescription data", "required": true, "schema": { "$ref": "#/definitions/CodedPrescriptionRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/IdentifierResponse" } } } } }, "/api/patients/{patientId}/prescriptions/supply": { "post": { "tags": [ "Prescriptions" ], "summary": "Add Coded Supply Prescription", "description": "Adds a supply defined by DoseSpot drug values to an existing patient record", "operationId": "Prescriptions_AddCodedSupplyV2", "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": "", "required": true, "schema": { "$ref": "#/definitions/CodedSupplyRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/IdentifierResponse" } } } } }, "/api/patients/{patientId}/prescriptions/supply/freetext": { "post": { "tags": [ "Prescriptions" ], "summary": "Add Free Text Supply Prescription", "description": "Adds a supply prescription request for a patient defined by its display name", "operationId": "Prescriptions_AddFreeTextSupplyPrescriptionV2", "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": "Patient ID", "required": true, "type": "integer", "format": "int32" }, { "in": "body", "name": "request", "description": "Prescription data", "required": true, "schema": { "$ref": "#/definitions/FreeTextSupplyPrescriptionRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/IdentifierResponse" } } } } }, "/api/patients/{patientId}/prescriptions/compiledcompound": { "post": { "tags": [ "Prescriptions" ], "summary": "Add Compiled Compound", "description": "Adds a compound prescription to an existing patient record", "operationId": "Prescriptions_AddCompiledCompoundV2", "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": "Patient ID", "required": true, "type": "integer", "format": "int32" }, { "in": "body", "name": "request", "description": "Prescription data", "required": true, "schema": { "$ref": "#/definitions/CompoundPrescriptionRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/IdentifierResponse" } } } } }, "/api/patients/{patientId}/prescriptions/{prescriptionId}/cancel": { "post": { "tags": [ "Prescriptions" ], "summary": "Cancel Prescription", "description": "Cancel a patient's particular prescription", "operationId": "Prescriptions_CancelPrescriptionV2", "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": "Patient ID", "required": true, "type": "integer", "format": "int32" }, { "name": "prescriptionId", "in": "path", "description": "Prescription ID", "required": true, "type": "integer", "format": "int32" }, { "in": "body", "name": "request", "description": "Comment", "required": true, "schema": { "$ref": "#/definitions/CancelPrescriptionRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Response" } } } } }, "/api/patients/{patientId}/prescriptions/{prescriptionId}/medicationStatus": { "post": { "tags": [ "Prescriptions" ], "summary": "Update Prescription's medication Status", "description": "Updates the status of an existing prescription for a specified patient", "operationId": "Prescriptions_UpdatePrescriptionStatusV2", "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": "Patient ID", "required": true, "type": "integer", "format": "int32" }, { "name": "prescriptionId", "in": "path", "description": "Prescription ID", "required": true, "type": "integer", "format": "int32" }, { "in": "body", "name": "request", "description": "Medication status data", "required": true, "schema": { "$ref": "#/definitions/UpdatePrescriptionMedicationStatusRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Response" } } } } }, "/api/patients/{patientId}/prescriptions/{prescriptionId}/pharmacy": { "patch": { "tags": [ "Prescriptions" ], "summary": "Change Prescription Pharmacy", "description": "Changes the pharmacy that an existing prescription in a patient record is queued to be sent to", "operationId": "Prescriptions_ChangePrescriptionPharmacyV2", "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": "prescriptionId", "in": "path", "description": "", "required": true, "type": "integer", "format": "int32" }, { "in": "body", "name": "request", "description": "", "required": true, "schema": { "$ref": "#/definitions/ChangePrescriptionPharmacyRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Response" } } } } }, "/api/priorAuths/{priorAuthId}/statusLog": { "get": { "tags": [ "PriorAuthorizations" ], "summary": "Get Status Log for Specific Prior Authorization Case By Id", "description": "Status Log for Specific Prior Authorization Case By Id", "operationId": "PriorAuthorizations_GetPriorAuthorizationStatusLogV2", "consumes": [], "produces": [ "application/json", "text/json", "application/problem+json", "application/xml", "text/xml" ], "parameters": [ { "name": "priorAuthId", "in": "path", "description": "Prior Authorization Case ID", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PriorAuthorizationStatusLogUIResponse" } } } } }, "/ui/priorAuths/{priorAuthId}/statusLog": { "get": { "tags": [ "PriorAuthorizations" ], "summary": "Get Status Log for Specific Prior Authorization Case By Id", "description": "Status Log for Specific Prior Authorization Case By Id", "operationId": "PriorAuthorizationsInternal_GetPriorAuthorizationStatusLogV2UI", "consumes": [], "produces": [ "application/json", "text/json", "application/problem+json", "application/xml", "text/xml" ], "parameters": [ { "name": "priorAuthId", "in": "path", "description": "Prior Authorization Case ID", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PriorAuthorizationStatusLogUIResponse" } } } } }, "/api/refills/pending": { "get": { "tags": [ "Refills" ], "summary": "Get refill requests for clinic(s)/patient", "description": "Retrieves information on refill requests associated with clinician's clinic(s)/patient", "operationId": "Refills_GetRefillRequestDetailsV2", "consumes": [], "produces": [ "application/json", "text/json", "application/problem+json", "application/xml", "text/xml" ], "parameters": [ { "name": "clinic", "in": "query", "required": false, "type": "string", "maximum": 1, "minimum": 0, "enum": [ "All", "Current" ] }, { "name": "patientId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "pageNumber", "in": "query", "required": false, "type": "integer", "maximum": 2147483647, "minimum": 1, "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PagedListResponse[GetRefillResponse]" } } } } }, "/api/refills/pending/detailed": { "get": { "tags": [ "Refills" ], "summary": "Get detailed refill requests for clinic(s)/patient", "description": "Retrieves information on refill requests associated with clinician's clinic(s)/patient", "operationId": "Refills_GetDetailedRefillRequestsV2", "consumes": [], "produces": [ "application/json", "text/json", "application/problem+json", "application/xml", "text/xml" ], "parameters": [ { "name": "clinic", "in": "query", "required": false, "type": "string", "maximum": 1, "minimum": 0, "enum": [ "All", "Current" ] }, { "name": "patientId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "pageNumber", "in": "query", "required": false, "type": "integer", "maximum": 2147483647, "minimum": 1, "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PagedListResponse[GetRefillDetailedResponse]" } } } } }, "/api/refills/{refillId}/changePatient": { "patch": { "tags": [ "Refills" ], "summary": "Change the patient details on a refill request", "description": "Provides the ability to link a refill request to a different, existing patient in the same clinic.\r\nThis is only applicable for refill requests that came in from the pharmacy with discrepancies in a patient\u00e2\u0080\u0099s name,\r\ndate of birth, or gender and were not able to be automatically linked to the appropriate, existing patient within DoseSpot.", "operationId": "Refills_ChangeRefillRequestPatientV2", "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": "refillId", "in": "path", "description": "Refill ID", "required": true, "type": "integer", "format": "int32" }, { "in": "body", "name": "request", "description": "Patient ID", "required": true, "schema": { "$ref": "#/definitions/ChangeRefillPatientRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Response" } } } } }, "/api/rxchanges/pending": { "get": { "tags": [ "RxChanges" ], "summary": "Get Clinician's Rx Change requests for clinic(s)/patient", "description": "Lists the number of notifications for pending RxChange requests associated with clinician's clinic(s)/patient", "operationId": "RxChanges_GetRxChangeQueueV2", "consumes": [], "produces": [ "application/json", "text/json", "application/problem+json", "application/xml", "text/xml" ], "parameters": [ { "name": "clinic", "in": "query", "required": false, "type": "string", "maximum": 1, "minimum": 0, "enum": [ "All", "Current" ] }, { "name": "patientId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "pageNumber", "in": "query", "required": false, "type": "integer", "maximum": 2147483647, "minimum": 1, "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PagedListResponse[GetRxChangeResponse]" } } } } }, "/api/rxchanges/pending/detailed": { "get": { "tags": [ "RxChanges" ], "summary": "Get Clinician's Rx Change requests for clinic(s)/patient", "description": "Lists the number of notifications for pending RxChange requests associated with clinician's clinic(s)/patient.\r\nIncludes detailed prescription information.", "operationId": "RxChanges_GetRxChangeQueueDetailedV2", "consumes": [], "produces": [ "application/json", "text/json", "application/problem+json", "application/xml", "text/xml" ], "parameters": [ { "name": "clinic", "in": "query", "required": false, "type": "string", "maximum": 1, "minimum": 0, "enum": [ "All", "Current" ] }, { "name": "patientId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "pageNumber", "in": "query", "required": false, "type": "integer", "maximum": 2147483647, "minimum": 1, "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PagedListResponse[GetRxChangeDetailedResponse]" } } } } }, "/api/rxchanges/{rxChangeId}/patients/{patientId}/reconcile": { "post": { "tags": [ "RxChanges" ], "summary": "Reconcile Rx. Change", "description": "Links an existing Rx. Change request to a patient record", "operationId": "RxChanges_ReconcileRxChangeV2", "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": "Patient ID", "required": true, "type": "integer", "format": "int32" }, { "name": "rxChangeId", "in": "path", "description": "rxChange ID", "required": true, "type": "integer", "format": "int32" }, { "in": "body", "name": "request", "description": "Referenced Prescription ID", "required": true, "schema": { "$ref": "#/definitions/ReconcileRxChangeRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Response" } } } } }, "/api/rxchanges/{rxChangeId}/changePatient": { "patch": { "tags": [ "RxChanges" ], "summary": "Change patient details in a rxchange request", "description": "Links the rxChange request to a different, existing patient in the same clinic", "operationId": "RxChanges_ChangeRxChangeRequestPatientV2", "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": "rxChangeId", "in": "path", "description": "rxChange ID", "required": true, "type": "integer", "format": "int32" }, { "in": "body", "name": "request", "description": "Patient ID", "required": true, "schema": { "$ref": "#/definitions/ChangeRxChangePatientRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Response" } } } } }, "/api/patients/{patientId}/selfReportedMedications/{selfReportedMedicationId}": { "get": { "tags": [ "SelfReportedMedications" ], "summary": "Get patient's self-reported medication details by SelfReportedMedicationId", "description": "Retrieves details of self-reported medication in a patient record by SelfReportedMedicationId", "operationId": "SelfReportedMedications_GetPatientSelfReportMedicationDetailsByIdV2", "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" }, { "name": "selfReportedMedicationId", "in": "path", "description": "", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemResponse[SelfReportedMedicationResponse]" } } } } }, "/api/patients/{patientId}/selfReportedMedications": { "get": { "tags": [ "SelfReportedMedications" ], "summary": "Get patient's self-reported medications", "description": "Retrieves details of self-reported medications in a patient record", "operationId": "SelfReportedMedications_GetPatientSelfReportMedicationsV2", "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" }, { "name": "startDate", "in": "query", "description": "", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "description": "", "required": false, "type": "string", "format": "date-time" }, { "name": "pageNumber", "in": "query", "description": "", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PagedListResponse[SelfReportedMedicationResponse]" } } } } }, "/api/patients/{patientId}/selfReportedMedications/coded/{selfReportedMedicationId}": { "put": { "tags": [ "SelfReportedMedications" ], "summary": "Edit a coded self-reported medication", "description": "Updates an existing self-reported medication in a patient record", "operationId": "SelfReportedMedications_EditSelfReportedMedicationCodedV2", "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": "Patient ID", "required": true, "type": "integer", "format": "int32" }, { "name": "selfReportedMedicationId", "in": "path", "description": "Self-reported medication ID", "required": true, "type": "integer", "format": "int32" }, { "in": "body", "name": "request", "description": "Self-reported medication data", "required": true, "schema": { "$ref": "#/definitions/CodedSelfReportedMedicationRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/IdentifierResponse" } } } } }, "/api/patients/{patientId}/selfReportedMedications/simple/{selfReportedMedicationId}": { "put": { "tags": [ "SelfReportedMedications" ], "summary": "Edit a simple self-reported medication", "description": "Updates an existing simple self-reported medication in a patient record", "operationId": "SelfReportedMedications_EditSelfReportedMedicationSimpleV2", "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": "Patient ID", "required": true, "type": "integer", "format": "int32" }, { "name": "selfReportedMedicationId", "in": "path", "description": "Self-reported medication ID", "required": true, "type": "integer", "format": "int32" }, { "in": "body", "name": "request", "description": "Self-reported medication data", "required": true, "schema": { "$ref": "#/definitions/SimpleSelfReportedMedicationRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/IdentifierResponse" } } } } }, "/api/patients/{patientId}/selfReportedMedications/freetext/{selfReportedMedicationId}": { "put": { "tags": [ "SelfReportedMedications" ], "summary": "Edit a free-text self-reported medication", "description": "Updates an existing self-reported medication specified by a free-text DisplayName in a patient\u00e2\u0080\u0099s record", "operationId": "SelfReportedMedications_EditSelfReportedMedicationFreeTextV2", "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": "Patient ID", "required": true, "type": "integer", "format": "int32" }, { "name": "selfReportedMedicationId", "in": "path", "description": "Self-reported medication ID", "required": true, "type": "integer", "format": "int32" }, { "in": "body", "name": "request", "description": "Self-reported medication data", "required": true, "schema": { "$ref": "#/definitions/FreeTextSelfReportedMedicationRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/IdentifierResponse" } } } } }, "/api/patients/{patientId}/selfReportedMedications/coded": { "post": { "tags": [ "SelfReportedMedications" ], "summary": "Add a coded self-reported medication", "description": "Adds a coded self-reported medication to a patient\u00e2\u0080\u0099s record", "operationId": "SelfReportedMedications_AddSelfReportedMedicationCodedV2", "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": "Patient ID", "required": true, "type": "integer", "format": "int32" }, { "in": "body", "name": "request", "description": "Self-reported medication data", "required": true, "schema": { "$ref": "#/definitions/CodedSelfReportedMedicationRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/IdentifierResponse" } } } } }, "/api/patients/{patientId}/selfReportedMedications/simple": { "post": { "tags": [ "SelfReportedMedications" ], "summary": "Add a simple self-reported medication", "description": "Adds a simple self-reported medication to a patient\u00e2\u0080\u0099s record", "operationId": "SelfReportedMedications_AddSelfReportedMedicationSimpleV2", "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": "Patient ID", "required": true, "type": "integer", "format": "int32" }, { "in": "body", "name": "request", "description": "Self-reported medication data", "required": true, "schema": { "$ref": "#/definitions/SimpleSelfReportedMedicationRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/IdentifierResponse" } } } } }, "/api/patients/{patientId}/selfReportedMedications/freetext": { "post": { "tags": [ "SelfReportedMedications" ], "summary": "Add a free-text self-reported medication", "description": "Adds a free-text self-reported medication to a patient\u00e2\u0080\u0099s record meaning the clinician can type any 300 character name.\r\nThis should only be used if a simple or coded version of the medication does not exist", "operationId": "SelfReportedMedications_AddSelfReportedMedicationFreeTextV2", "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": "Patient ID", "required": true, "type": "integer", "format": "int32" }, { "in": "body", "name": "request", "description": "Self-reported medication data", "required": true, "schema": { "$ref": "#/definitions/FreeTextSelfReportedMedicationRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/IdentifierResponse" } } } } }, "/api/patients/{patientId}/selfReportedMedications/{selfReportedMedicationId}/updateStatus": { "post": { "tags": [ "SelfReportedMedications" ], "summary": "Update self-reported medication status", "description": "Updates the status of a self-reported medication in a patient\u00e2\u0080\u0099s record", "operationId": "SelfReportedMedications_UpdateSelfReportedMedicationStatusV2", "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": "Patient ID", "required": true, "type": "integer", "format": "int32" }, { "name": "selfReportedMedicationId", "in": "path", "description": "Self-reported medication ID", "required": true, "type": "integer", "format": "int32" }, { "in": "body", "name": "request", "description": "Patient medication status data", "required": true, "schema": { "$ref": "#/definitions/UpdateSelfReportedMedicationStatusRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Response" } } } } }, "/api/supplies/{supplyId}": { "get": { "tags": [ "Supplies" ], "summary": "Get supply information", "description": "Returns a supply matching the ID", "operationId": "Supplies_GetSupplyByIDV2", "consumes": [], "produces": [ "application/json", "text/json", "application/problem+json", "application/xml", "text/xml" ], "parameters": [ { "name": "supplyId", "in": "path", "description": "", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ItemResponse[SupplySearchResultForAPI]" } } } } }, "/api/supplies/search": { "get": { "tags": [ "Supplies" ], "summary": "Search supplies\r\nmatching the exact NDC xor exact UPC.", "description": "Returns a list of supplies matching a supply name of three or more characters xor matching the exact NDC xor exact UPC (or HRI). Can filter active/obsolete supplies.", "operationId": "Supplies_SuppliesSearchV2", "consumes": [], "produces": [ "application/json", "text/json", "application/problem+json", "application/xml", "text/xml" ], "parameters": [ { "name": "pageNumber", "in": "query", "description": "1-based (default of 1)", "required": false, "type": "integer", "format": "int32" }, { "name": "name", "in": "query", "required": false, "type": "string" }, { "name": "ndc", "in": "query", "required": false, "type": "string" }, { "name": "upc", "in": "query", "required": false, "type": "string" }, { "name": "supplyStatus", "in": "query", "required": false, "type": "string", "enum": [ "Active", "Inactive", "All" ] } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PagedListResponse[SupplySearchResultForAPI]" } } } } } }, "definitions": { "ItemResponse[AllergySearchResultForAPI]": { "type": "object", "properties": { "Item": { "description": "The response object.", "$ref": "#/definitions/AllergySearchResultForAPI" }, "Result": { "description": "The result of the operation.", "$ref": "#/definitions/Result" } }, "description": "Represents a generic response containing a single object." }, "AllergySearchResultForAPI": { "type": "object", "properties": { "Name": { "type": "string", "description": "Could be Allergen class xor screenable ingredient generic drug name" }, "BrandName": { "type": "string", "description": "If this is a screenable ingredient, we return the brand name" }, "AllergenId": { "type": "integer", "format": "int32", "description": "The record's PK" }, "AllergenType": { "type": "string", "description": "Either AllergenClass or ScreenableIngredient", "enum": [ "AllergenClass", "ScreenableIngredient", "FoodAndEnvironmentalAllergens", "RoutedDoseFormDrugs" ] }, "IsActive": { "type": "boolean", "description": "Whether the AllergenClass or ScreenableIngredient is Active or Inactive" }, "AllergenCategory": { "type": "string", "description": "CommonAllergens (from the common allergens of Medispan, UncommonAllergens\r\n(expressly pulled from all screenable ingredients/classes that exist),\r\nOtherBrandDrugs (from the brand drugs of Medispan - routed doseform drugs)", "enum": [ "CommonAllergens", "UncommonAllergens", "OtherBrandDrugs" ] }, "RxCuis": { "type": "array", "description": "Gets or sets the list of RxCUI identifiers.", "items": { "type": "string" } } } }, "Result": { "type": "object", "required": [ "ResultCode" ], "properties": { "ResultCode": { "type": "string", "description": "The result code of the operation." }, "ResultDescription": { "type": "string", "description": "A description of the result, if there were errors." } }, "description": "Represents the result of a service operation." }, "PagedListResponse[AllergySearchResultForAPI]": { "type": "object", "properties": { "Items": { "type": "array", "description": "The list of elements to return.", "readOnly": true, "items": { "$ref": "#/definitions/AllergySearchResultForAPI" } }, "PageResult": { "$ref": "#/definitions/PageResult" }, "Result": { "description": "The result of the operation.", "$ref": "#/definitions/Result" } } }, "PageResult": { "type": "object", "properties": { "CurrentPage": { "type": "integer", "format": "int32" }, "TotalPages": { "type": "integer", "format": "int32" }, "PageSize": { "type": "integer", "format": "int32" }, "TotalCount": { "type": "integer", "format": "int32" }, "HasPrevious": { "type": "boolean", "readOnly": true }, "HasNext": { "type": "boolean", "readOnly": true } } }, "ListResponse[PatientAllergy]": { "type": "object", "properties": { "Items": { "type": "array", "description": "The list of elements to return.", "items": { "$ref": "#/definitions/PatientAllergy" } }, "Result": { "description": "The result of the operation.", "$ref": "#/definitions/Result" } }, "description": "Represents a generic response containing a list of objects." }, "PatientAllergy": { "type": "object", "properties": { "PatientAllergyId": { "type": "integer", "format": "int32" }, "DisplayName": { "type": "string" }, "AllergenId": { "type": "integer", "format": "int32" }, "AllergenType": { "type": "string", "enum": [ "AllergenClass", "ScreenableIngredient", "FoodAndEnvironmentalAllergens", "RoutedDoseFormDrugs" ] }, "Reaction": { "type": "string" }, "ReactionType": { "type": "string", "enum": [ "Allergy", "AdverseReaction" ] }, "StatusType": { "type": "string", "enum": [ "Active", "Inactive", "Deleted" ] }, "OnsetDate": { "type": "string", "format": "date-time" }, "LastUpdatedUserId": { "type": "integer", "format": "int32" } } }, "EditPatientAllergyRequest": { "type": "object", "required": [ "ReactionType", "StatusType" ], "properties": { "Reaction": { "type": "string", "minLength": 0, "maxLength": 200 }, "ReactionType": { "type": "string", "description": "The allergy reaction type.", "enum": [ "Allergy", "AdverseReaction" ] }, "StatusType": { "type": "string", "description": "The status of the allergy.", "enum": [ "Active", "Inactive", "Deleted" ] }, "OnsetDate": { "type": "string", "format": "date-time", "description": "The onset date of the allergy." } } }, "Response": { "type": "object", "properties": { "Result": { "description": "The result of the operation.", "$ref": "#/definitions/Result" } }, "description": "The result of the operation." }, "CodedPatientAllergyRequest": { "type": "object", "required": [ "AllergenId", "ReactionType", "StatusType" ], "properties": { "AllergenId": { "type": "integer", "format": "int32" }, "Reaction": { "type": "string", "description": "The patient reaction to the allergy.", "minLength": 0, "maxLength": 200 }, "ReactionType": { "type": "string", "description": "The allergy reaction type.", "enum": [ "Allergy", "AdverseReaction" ] }, "StatusType": { "type": "string", "description": "The status of the allergy.", "enum": [ "Active", "Inactive", "Deleted" ] }, "OnsetDate": { "type": "string", "format": "date-time", "description": "The onset date of the allergy." } } }, "IdentifierResponse": { "type": "object", "properties": { "Id": { "type": "integer", "format": "int32", "description": "The entity identifier." }, "Result": { "description": "The result of the operation.", "$ref": "#/definitions/Result" } }, "description": "Represents a generic response containing an entity identifier." }, "FreetextPatientAllergyRequest": { "type": "object", "required": [ "FreeTextDisplayName", "ReactionType", "StatusType" ], "properties": { "FreeTextDisplayName": { "type": "string", "minLength": 0, "maxLength": 200 }, "Reaction": { "type": "string", "description": "The patient reaction to the allergy.", "minLength": 0, "maxLength": 200 }, "ReactionType": { "type": "string", "description": "The allergy reaction type.", "enum": [ "Allergy", "AdverseReaction" ] }, "StatusType": { "type": "string", "description": "The status of the allergy.", "enum": [ "Active", "Inactive", "Deleted" ] }, "OnsetDate": { "type": "string", "format": "date-time", "description": "The onset date of the allergy." } } }, "GetFavoritesRequest": { "type": "object", "properties": { "FavoriteType": { "type": "string", "enum": [ "All", "Medication", "Supply", "CompiledCompound" ] }, "PageNumber": { "type": "integer", "format": "int32", "minimum": 1, "maximum": 2147483645 }, "PageSize": { "type": "integer", "format": "int32", "minimum": 1, "maximum": 100 }, "SearchName": { "type": "string", "pattern": "^.{2,}$" } } }, "PagedListResponse[ClinicFavoritePrescriptionResponse]": { "type": "object", "properties": { "Items": { "type": "array", "description": "The list of elements to return.", "readOnly": true, "items": { "$ref": "#/definitions/ClinicFavoritePrescriptionResponse" } }, "PageResult": { "$ref": "#/definitions/PageResult" }, "Result": { "description": "The result of the operation.", "$ref": "#/definitions/Result" } } }, "ClinicFavoritePrescriptionResponse": { "type": "object", "properties": { "ClinicFavoritePrescriptionId": { "type": "integer", "format": "int32" }, "DispenseUnitTypeId": { "type": "integer", "format": "int32" }, "FirstDiagnosis": { "$ref": "#/definitions/PrescriptionDiagnosis" }, "SecondDiagnosis": { "$ref": "#/definitions/PrescriptionDiagnosis" }, "MedDisplayName": { "type": "string" }, "MedFullName": { "type": "string" }, "MedStrengthString": { "type": "string" }, "Directions": { "type": "string" }, "Quantity": { "type": "string" }, "DispensableDrugId": { "type": "integer", "format": "int32" }, "Refills": { "type": "integer", "format": "int32" }, "DaysSupply": { "type": "integer", "format": "int32" }, "NoSubstitutions": { "type": "boolean" }, "Notes": { "type": "string" }, "Title": { "type": "string" }, "SpecialtyType": { "type": "string", "enum": [ "AllergyAndImmunology", "Dermatology", "Dentistry", "BehavioralHealth", "FamilyMedicine", "InternalMedicine", "ObstetricsAndGynecology", "Orthopedics", "Pediatrics", "PhysicalMedicine", "Psychiatry", "Urology" ] }, "DateAdded": { "type": "string", "format": "date-time" }, "DateLastUsed": { "type": "string", "format": "date-time" }, "IsSupply": { "type": "boolean" }, "CompoundId": { "type": "integer", "format": "int32" }, "IsCompound": { "type": "boolean" }, "SourceClinicId": { "type": "integer", "format": "int32" }, "SupplyId": { "type": "integer", "format": "int32" }, "CompoundIngredients": { "type": "array", "items": { "$ref": "#/definitions/CompoundIngredient" } } } }, "PrescriptionDiagnosis": { "type": "object", "properties": { "PrimaryDiagnosis": { "$ref": "#/definitions/Diagnosis" }, "SecondaryDiagnosis": { "$ref": "#/definitions/Diagnosis" } } }, "CompoundIngredient": { "type": "object", "required": [ "Quantity" ], "properties": { "DispensableDrugId": { "type": "integer", "format": "int32" }, "FreeText": { "type": "string" }, "DispenseUnitId": { "type": "integer", "format": "int32" }, "Quantity": { "type": "string" }, "IsFreeTextEPCS": { "type": "boolean" } } }, "Diagnosis": { "type": "object", "properties": { "DiagnosisId": { "type": "integer", "format": "int32" }, "DiagnosisCode": { "type": "string" }, "DiagnosisDescription": { "type": "string" } } }, "ClinicPrescriptionFavoriteMedicationRequest": { "type": "object", "required": [ "Directions", "DispensableDrugId", "DispenseUnitTypeId", "Quantity", "Refills", "Title" ], "properties": { "DispensableDrugId": { "type": "integer", "format": "int32" }, "SpecialtyType": { "type": "integer", "format": "int32" }, "Refills": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 99 }, "DaysSupply": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 365 }, "DispenseUnitTypeId": { "type": "integer", "format": "int32" }, "Quantity": { "type": "string" }, "NoSubstitutions": { "type": "boolean" }, "Notes": { "type": "string", "minLength": 0, "maxLength": 1000 }, "Directions": { "type": "string", "minLength": 0, "maxLength": 1000 }, "Title": { "type": "string", "minLength": 0, "maxLength": 500 }, "FirstPrescriptionDiagnosis": { "$ref": "#/definitions/PrescriptionDiagnosisIds" }, "SecondPrescriptionDiagnosis": { "$ref": "#/definitions/PrescriptionDiagnosisIds" } } }, "PrescriptionDiagnosisIds": { "type": "object", "properties": { "PrimaryDiagnosisId": { "type": "integer", "format": "int32" }, "SecondaryDiagnosisId": { "type": "integer", "format": "int32" } } }, "ClinicPrescriptionFavoriteSupplyRequest": { "type": "object", "required": [ "Directions", "DispenseUnitTypeId", "Quantity", "Refills", "Title" ], "properties": { "SupplyId": { "type": "integer", "format": "int32" }, "FreeText": { "type": "string" }, "SpecialtyType": { "type": "integer", "format": "int32" }, "Refills": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 99 }, "DaysSupply": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 365 }, "DispenseUnitTypeId": { "type": "integer", "format": "int32" }, "Quantity": { "type": "string" }, "NoSubstitutions": { "type": "boolean" }, "Notes": { "type": "string", "minLength": 0, "maxLength": 1000 }, "Directions": { "type": "string", "minLength": 0, "maxLength": 1000 }, "Title": { "type": "string", "minLength": 0, "maxLength": 500 }, "FirstPrescriptionDiagnosis": { "$ref": "#/definitions/PrescriptionDiagnosisIds" }, "SecondPrescriptionDiagnosis": { "$ref": "#/definitions/PrescriptionDiagnosisIds" } } }, "ClinicPrescriptionFavoriteCompiledCompoundRequest": { "type": "object", "required": [ "CompoundDescription", "CompoundIngredients", "Directions", "DispenseUnitTypeId", "Quantity", "Refills", "Title" ], "properties": { "CompoundDescription": { "type": "string" }, "CompoundIngredients": { "type": "array", "items": { "$ref": "#/definitions/CompoundIngredient" } }, "SpecialtyType": { "type": "integer", "format": "int32" }, "Refills": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 99 }, "DaysSupply": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 365 }, "DispenseUnitTypeId": { "type": "integer", "format": "int32" }, "Quantity": { "type": "string" }, "NoSubstitutions": { "type": "boolean" }, "Notes": { "type": "string", "minLength": 0, "maxLength": 1000 }, "Directions": { "type": "string", "minLength": 0, "maxLength": 1000 }, "Title": { "type": "string", "minLength": 0, "maxLength": 500 }, "FirstPrescriptionDiagnosis": { "$ref": "#/definitions/PrescriptionDiagnosisIds" }, "SecondPrescriptionDiagnosis": { "$ref": "#/definitions/PrescriptionDiagnosisIds" } } }, "AddEditClinicGroupRequest": { "type": "object", "required": [ "ClinicIds" ], "properties": { "ClinicIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "ClinicGroupName": { "type": "string" } } }, "AddEditClinicGroupResponse": { "type": "object", "properties": { "UserId": { "type": "integer", "format": "int32" }, "ClientId": { "type": "integer", "format": "int32" }, "ClientName": { "type": "string" }, "ClinicIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "ClinicGroupName": { "type": "string" }, "Result": { "description": "The result of the operation.", "$ref": "#/definitions/Result" } } }, "PagedListResponse[ClinicianFavoritePrescriptionResponse]": { "type": "object", "properties": { "Items": { "type": "array", "description": "The list of elements to return.", "readOnly": true, "items": { "$ref": "#/definitions/ClinicianFavoritePrescriptionResponse" } }, "PageResult": { "$ref": "#/definitions/PageResult" }, "Result": { "description": "The result of the operation.", "$ref": "#/definitions/Result" } } }, "ClinicianFavoritePrescriptionResponse": { "type": "object", "properties": { "ClinicianFavoritePrescriptionID": { "type": "integer", "format": "int32" }, "ClinicianID": { "type": "integer", "format": "int32" }, "DispenseUnitTypeID": { "type": "integer", "format": "int32" }, "FirstDiagnosis": { "$ref": "#/definitions/PrescriptionDiagnosis" }, "SecondDiagnosis": { "$ref": "#/definitions/PrescriptionDiagnosis" }, "MedDisplayName": { "type": "string" }, "MedFullName": { "type": "string" }, "MedStrengthString": { "type": "string" }, "Directions": { "type": "string" }, "Quantity": { "type": "string" }, "DispensableDrugId": { "type": "integer", "format": "int32" }, "Refills": { "type": "integer", "format": "int32" }, "DaysSupply": { "type": "integer", "format": "int32" }, "NoSubstitutions": { "type": "boolean" }, "Notes": { "type": "string" }, "Title": { "type": "string" }, "SpecialtyType": { "type": "string", "enum": [ "AllergyAndImmunology", "Dermatology", "Dentistry", "BehavioralHealth", "FamilyMedicine", "InternalMedicine", "ObstetricsAndGynecology", "Orthopedics", "Pediatrics", "PhysicalMedicine", "Psychiatry", "Urology" ] }, "DateAdded": { "type": "string", "format": "date-time" }, "DateLastUsed": { "type": "string", "format": "date-time" }, "IsSupply": { "type": "boolean" }, "CompoundId": { "type": "integer", "format": "int32" }, "IsCompound": { "type": "boolean" }, "SourceClinicId": { "type": "integer", "format": "int32" }, "SupplyId": { "type": "integer", "format": "int32" }, "CompoundIngredients": { "type": "array", "items": { "$ref": "#/definitions/CompoundIngredient" } } } }, "ClinicianPrescriptionFavoriteCodedRequest": { "type": "object", "required": [ "Directions", "DispensableDrugId", "DispenseUnitTypeId", "Quantity", "Refills", "Title" ], "properties": { "DispensableDrugId": { "type": "integer", "format": "int32" }, "Refills": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 99 }, "DaysSupply": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 365 }, "DispenseUnitTypeId": { "type": "integer", "format": "int32" }, "Quantity": { "type": "string" }, "NoSubstitutions": { "type": "boolean" }, "Notes": { "type": "string", "minLength": 0, "maxLength": 1000 }, "Directions": { "type": "string", "minLength": 0, "maxLength": 1000 }, "Title": { "type": "string", "minLength": 0, "maxLength": 500 }, "FirstPrescriptionDiagnosis": { "$ref": "#/definitions/PrescriptionDiagnosisIds" }, "SecondPrescriptionDiagnosis": { "$ref": "#/definitions/PrescriptionDiagnosisIds" } } }, "ClinicianPrescriptionFavoriteSupplyRequest": { "type": "object", "required": [ "Directions", "DispenseUnitTypeId", "Quantity", "Refills", "Title" ], "properties": { "SupplyId": { "type": "integer", "format": "int32" }, "FreeText": { "type": "string" }, "Refills": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 99 }, "DaysSupply": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 365 }, "DispenseUnitTypeId": { "type": "integer", "format": "int32" }, "Quantity": { "type": "string" }, "NoSubstitutions": { "type": "boolean" }, "Notes": { "type": "string", "minLength": 0, "maxLength": 1000 }, "Directions": { "type": "string", "minLength": 0, "maxLength": 1000 }, "Title": { "type": "string", "minLength": 0, "maxLength": 500 }, "FirstPrescriptionDiagnosis": { "$ref": "#/definitions/PrescriptionDiagnosisIds" }, "SecondPrescriptionDiagnosis": { "$ref": "#/definitions/PrescriptionDiagnosisIds" } } }, "ClinicianPrescriptionFavoriteCompiledCompoundRequest": { "type": "object", "required": [ "CompoundDescription", "CompoundIngredients", "Directions", "DispenseUnitTypeId", "Quantity", "Refills", "Title" ], "properties": { "CompoundDescription": { "type": "string" }, "CompoundIngredients": { "type": "array", "items": { "$ref": "#/definitions/CompoundIngredient" } }, "Refills": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 99 }, "DaysSupply": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 365 }, "DispenseUnitTypeId": { "type": "integer", "format": "int32" }, "Quantity": { "type": "string" }, "NoSubstitutions": { "type": "boolean" }, "Notes": { "type": "string", "minLength": 0, "maxLength": 1000 }, "Directions": { "type": "string", "minLength": 0, "maxLength": 1000 }, "Title": { "type": "string", "minLength": 0, "maxLength": 500 }, "FirstPrescriptionDiagnosis": { "$ref": "#/definitions/PrescriptionDiagnosisIds" }, "SecondPrescriptionDiagnosis": { "$ref": "#/definitions/PrescriptionDiagnosisIds" } } }, "FavoriteIdListRequest": { "type": "object", "properties": { "FavoriteIds": { "type": "array", "items": { "type": "integer", "format": "int32" } } } }, "OrderSetDetailsResponse": { "type": "object", "properties": { "OrderSetId": { "type": "integer", "format": "int32" }, "Title": { "type": "string" }, "Favorites": { "type": "array", "items": { "$ref": "#/definitions/ClinicianFavoritePrescriptionResponse" } }, "Result": { "description": "The result of the operation.", "$ref": "#/definitions/Result" } } }, "GetOrderSetRequest": { "type": "object", "properties": { "PageNumber": { "type": "integer", "format": "int32", "description": "Gets or sets the page number for the request.Default value will be 1." }, "PageSize": { "type": "integer", "format": "int32", "description": "Gets or sets the page size for the request. Default value will be 20." }, "SortOrder": { "type": "string", "description": "Gets or sets the sort order for the request. Value will be Asc or Desc. Default value will be Asc.", "enum": [ "Asc", "Desc" ] }, "SearchString": { "type": "string", "description": "Gets or sets the search string for the request." } } }, "PagedListResponse[OrderSetResponse]": { "type": "object", "properties": { "Items": { "type": "array", "description": "The list of elements to return.", "readOnly": true, "items": { "$ref": "#/definitions/OrderSetResponse" } }, "PageResult": { "$ref": "#/definitions/PageResult" }, "Result": { "description": "The result of the operation.", "$ref": "#/definitions/Result" } } }, "OrderSetResponse": { "type": "object", "properties": { "OrderSetId": { "type": "integer", "format": "int32" }, "Title": { "type": "string" }, "Favorites": { "type": "array", "items": { "$ref": "#/definitions/ClinicianFavoritePrescriptionResponse" } } } }, "OrderSetRequest": { "type": "object", "required": [ "Title" ], "properties": { "Title": { "type": "string", "minLength": 3, "maxLength": 500 }, "Favorites": { "type": "array", "items": { "$ref": "#/definitions/OrderSetFavorite" } } } }, "OrderSetFavorite": { "type": "object", "required": [ "Directions", "DispenseUnitTypeId", "Quantity", "Refills" ], "properties": { "DispensableDrugId": { "type": "integer", "format": "int32" }, "SupplyId": { "type": "integer", "format": "int32", "minimum": 1, "maximum": 2147483647 }, "FreeText": { "type": "string", "minLength": 3, "maxLength": 300 }, "CompoundDescription": { "type": "string", "minLength": 3, "maxLength": 2000 }, "CompoundIngredients": { "type": "array", "items": { "$ref": "#/definitions/CompoundIngredient" } }, "FavoriteId": { "type": "integer", "format": "int32" }, "Refills": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 99 }, "DaysSupply": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 365 }, "DispenseUnitTypeId": { "type": "integer", "format": "int32", "minimum": 1, "maximum": 2147483647 }, "Quantity": { "type": "string" }, "NoSubstitutions": { "type": "boolean" }, "Notes": { "type": "string" }, "Directions": { "type": "string" }, "FirstPrescriptionDiagnosis": { "$ref": "#/definitions/PrescriptionDiagnosisIds" }, "SecondPrescriptionDiagnosis": { "$ref": "#/definitions/PrescriptionDiagnosisIds" } } }, "ItemResponse[PDMPResponse]": { "type": "object", "properties": { "Item": { "description": "The response object.", "$ref": "#/definitions/PDMPResponse" }, "Result": { "description": "The result of the operation.", "$ref": "#/definitions/Result" } }, "description": "Represents a generic response containing a single object." }, "PDMPResponse": { "type": "object", "properties": { "StateId": { "type": "integer", "format": "int32" }, "ProgramName": { "type": "string" }, "URL": { "type": "string" }, "Message": { "type": "string" } } }, "ClinicianIdentityProofingDisclaimerResponse": { "type": "object", "properties": { "IdpDisclaimerDate": { "type": "string", "format": "date-time" }, "IdpDisclaimerId": { "type": "integer", "format": "int32" }, "IdpDisclaimerText": { "type": "string" }, "Result": { "description": "The result of the operation.", "$ref": "#/definitions/Result" } } }, "ClinicianIdentityProofingDisclaimerRequest": { "type": "object", "required": [ "IdpDisclaimerId" ], "properties": { "IdpDisclaimerId": { "type": "integer", "format": "int32" } } }, "ItemResponse[Clinician]": { "type": "object", "properties": { "Item": { "description": "The response object.", "$ref": "#/definitions/Clinician" }, "Result": { "description": "The result of the operation.", "$ref": "#/definitions/Result" } }, "description": "Represents a generic response containing a single object." }, "Clinician": { "type": "object", "required": [ "Address1", "City", "DateOfBirth", "FirstName", "LastName", "PrimaryFax", "PrimaryPhone", "PrimaryPhoneType", "State", "ZipCode" ], "properties": { "ClinicianId": { "type": "integer", "format": "int32" }, "Prefix": { "type": "string", "minLength": 0, "maxLength": 10 }, "FirstName": { "type": "string" }, "MiddleName": { "type": "string", "minLength": 0, "maxLength": 35 }, "LastName": { "type": "string" }, "Suffix": { "type": "string", "minLength": 0, "maxLength": 10 }, "DateOfBirth": { "type": "string", "format": "date-time" }, "Email": { "type": "string" }, "Address1": { "type": "string", "minLength": 0, "maxLength": 35 }, "Address2": { "type": "string", "minLength": 0, "maxLength": 35 }, "City": { "type": "string" }, "State": { "type": "string" }, "ZipCode": { "type": "string" }, "PrimaryPhone": { "type": "string" }, "PrimaryPhoneType": { "type": "string", "enum": [ "Undefined", "Beeper", "Cell", "Fax", "Home", "Work", "Night", "Primary" ] }, "PrimaryFax": { "type": "string", "minLength": 0, "maxLength": 25 }, "PhoneAdditional1": { "type": "string", "minLength": 0, "maxLength": 25 }, "PhoneAdditionalType1": { "type": "string", "enum": [ "Undefined", "Beeper", "Cell", "Fax", "Home", "Work", "Night", "Primary" ] }, "PhoneAdditional2": { "type": "string", "minLength": 0, "maxLength": 25 }, "PhoneAdditionalType2": { "type": "string", "enum": [ "Undefined", "Beeper", "Cell", "Fax", "Home", "Work", "Night", "Primary" ] }, "PhoneAdditional3": { "type": "string", "minLength": 0, "maxLength": 25 }, "PhoneAdditionalType3": { "type": "string", "enum": [ "Undefined", "Beeper", "Cell", "Fax", "Home", "Work", "Night", "Primary" ] }, "DEANumbers": { "type": "array", "items": { "$ref": "#/definitions/DeaNumber" } }, "DEANumber": { "type": "string" }, "NADEANumbers": { "type": "array", "items": { "$ref": "#/definitions/NaDeaNumber" } }, "MedicalLicenseNumbers": { "type": "array", "items": { "$ref": "#/definitions/MedicalLicenseNumber" } }, "NPINumber": { "type": "string" }, "Roles": { "type": "array", "items": { "type": "string", "enum": [ "PrescribingClinician", "ReportingClinician", "EpcsCoordinator", "ClinicianAdmin", "PrescribingAgentClinician", "ProxyClinician" ] } }, "PDMPRoleType": { "type": "string", "enum": [ "Physician", "Dentist", "NursePractioner", "PhysiciansAssistant", "Resident", "Intern", "Psychologist", "Optometrist", "NaturopathicPhysician" ] }, "SpecialtyTypeId": { "type": "integer", "format": "int32" }, "Confirmed": { "type": "boolean" }, "Active": { "type": "boolean" }, "AccountLocked": { "type": "boolean" }, "EpcsRequested": { "type": "boolean" }, "ClinicInfo": { "type": "array", "items": { "$ref": "#/definitions/ClinicianClinicErxSummary" } } } }, "DeaNumber": { "type": "object", "required": [ "DEANumber" ], "properties": { "DEANumber": { "type": "string", "pattern": "^[A-Z][A-Z9][0-9]{7}(-[A-Z0-9]{1,7})?$" }, "State": { "type": "string" }, "ClinicId": { "type": "string" } } }, "NaDeaNumber": { "type": "object", "required": [ "NADEANumber" ], "properties": { "NADEANumber": { "type": "string", "pattern": "^[a-zA-Z0-9]{9}$" }, "State": { "type": "string" }, "ClinicId": { "type": "string" } } }, "MedicalLicenseNumber": { "type": "object", "required": [ "LicenseNumber" ], "properties": { "LicenseNumber": { "type": "string", "minLength": 0, "maxLength": 35 }, "State": { "type": "string" }, "ClinicId": { "type": "string" } } }, "ClinicianClinicErxSummary": { "type": "object", "properties": { "ClinicId": { "type": "integer", "format": "int32" }, "HasNewRx": { "type": "boolean" }, "HasRefills": { "type": "boolean" }, "HasRxChange": { "type": "boolean" }, "HasCancel": { "type": "boolean" }, "HasRxFill": { "type": "boolean" }, "HasEpcs": { "type": "boolean" }, "HasEpa": { "type": "boolean" } } }, "AddEditClinicianRequest": { "type": "object", "required": [ "Address1", "City", "ClinicianRoleType", "DateOfBirth", "FirstName", "LastName", "PrimaryFax", "PrimaryPhone", "State", "ZipCode" ], "properties": { "Prefix": { "type": "string", "minLength": 0, "maxLength": 10 }, "FirstName": { "type": "string" }, "MiddleName": { "type": "string", "minLength": 0, "maxLength": 35 }, "LastName": { "type": "string" }, "Suffix": { "type": "string", "minLength": 0, "maxLength": 10 }, "DateOfBirth": { "type": "string", "format": "date-time" }, "Email": { "type": "string" }, "Address1": { "type": "string", "minLength": 0, "maxLength": 35 }, "Address2": { "type": "string", "minLength": 0, "maxLength": 35 }, "City": { "type": "string" }, "State": { "type": "string" }, "ZipCode": { "type": "string" }, "PrimaryPhone": { "type": "string" }, "PrimaryPhoneType": { "type": "string", "enum": [ "Undefined", "Beeper", "Cell", "Fax", "Home", "Work", "Night", "Primary" ] }, "PrimaryFax": { "type": "string", "minLength": 0, "maxLength": 25 }, "PhoneAdditional1": { "type": "string", "minLength": 0, "maxLength": 25 }, "PhoneAdditionalType1": { "type": "string", "enum": [ "Undefined", "Beeper", "Cell", "Fax", "Home", "Work", "Night", "Primary" ] }, "PhoneAdditional2": { "type": "string", "minLength": 0, "maxLength": 25 }, "PhoneAdditionalType2": { "type": "string", "enum": [ "Undefined", "Beeper", "Cell", "Fax", "Home", "Work", "Night", "Primary" ] }, "PhoneAdditional3": { "type": "string", "minLength": 0, "maxLength": 25 }, "PhoneAdditionalType3": { "type": "string", "enum": [ "Undefined", "Beeper", "Cell", "Fax", "Home", "Work", "Night", "Primary" ] }, "DEANumber": { "type": "string", "pattern": "^[A-Z][A-Z9][0-9]{7}(-[A-Z0-9]{1,7})?$" }, "DEANumbers": { "type": "array", "items": { "$ref": "#/definitions/DeaNumber" } }, "NADEANumbers": { "type": "array", "items": { "$ref": "#/definitions/NaDeaNumber" } }, "MedicalLicenseNumbers": { "type": "array", "items": { "$ref": "#/definitions/MedicalLicenseNumber" } }, "NPINumber": { "type": "string" }, "ClinicianRoleType": { "type": "array", "items": { "type": "string", "enum": [ "PrescribingClinician", "ReportingClinician", "EpcsCoordinator", "ClinicianAdmin", "PrescribingAgentClinician", "ProxyClinician" ] } }, "EPCSRequested": { "type": "boolean" }, "Active": { "type": "boolean" }, "PDMPRoleType": { "type": "string", "enum": [ "Physician", "Dentist", "NursePractioner", "PhysiciansAssistant", "Resident", "Intern", "Psychologist", "Optometrist", "NaturopathicPhysician" ] }, "ClinicianSpecialtyType": { "type": "string", "enum": [ "AllergyAndImmunology", "Dermatology", "Dentistry", "BehavioralHealth", "FamilyMedicine", "InternalMedicine", "ObstetricsAndGynecology", "Orthopedics", "Pediatrics", "PhysicalMedicine", "Psychiatry", "Urology" ] } }, "description": "Represents a request to add or edit a clinician.\r\nThis class overrides the identifier property so that it will not be serialized for requests." }, "ListResponse[Clinician]": { "type": "object", "properties": { "Items": { "type": "array", "description": "The list of elements to return.", "items": { "$ref": "#/definitions/Clinician" } }, "Result": { "description": "The result of the operation.", "$ref": "#/definitions/Result" } }, "description": "Represents a generic response containing a list of objects." }, "ListResponse[AgreementInfoResponse]": { "type": "object", "properties": { "Items": { "type": "array", "description": "The list of elements to return.", "items": { "$ref": "#/definitions/AgreementInfoResponse" } }, "Result": { "description": "The result of the operation.", "$ref": "#/definitions/Result" } }, "description": "Represents a generic response containing a list of objects." }, "AgreementInfoResponse": { "type": "object", "properties": { "AgreementId": { "type": "integer", "format": "int32" }, "AgreementDate": { "type": "string", "format": "date-time" }, "AgreementText": { "type": "string" } } }, "ItemResponse[eRxRegistrationStatusType]": { "type": "object", "properties": { "Item": { "type": "string", "description": "The response object.", "enum": [ "Pending", "RegistrationSuccess", "RegistrationError", "IDPSuccess", "IDPError", "TFAActivateInit", "TFAActivatedSuccess", "TFAActivatedError", "TFADeactivateInit", "TFADeactivatedSuccess", "TFADeactivatedError", "IDPInitializeSuccess", "NotApplicable" ] }, "Result": { "description": "The result of the operation.", "$ref": "#/definitions/Result" } }, "description": "Represents a generic response containing a single object." }, "PrescriberInfoResponse": { "type": "object", "properties": { "Prescriber": { "$ref": "#/definitions/PrescriberInfo" }, "PrescriberAgent": { "$ref": "#/definitions/PrescriberAgentInfo" }, "Supervisor": { "$ref": "#/definitions/PrescriberInfo" }, "Result": { "description": "The result of the operation.", "$ref": "#/definitions/Result" } } }, "PrescriberInfo": { "type": "object", "properties": { "Address1": { "type": "string" }, "Address2": { "type": "string" }, "City": { "type": "string" }, "State": { "type": "string" }, "ZipCode": { "type": "string" }, "PrimaryPhone": { "type": "string" }, "PrimaryPhoneType": { "type": "string", "enum": [ "Undefined", "Beeper", "Cell", "Fax", "Home", "Work", "Night", "Primary" ] }, "DEANumber": { "type": "string" }, "Prefix": { "type": "string" }, "FirstName": { "type": "string" }, "MiddleName": { "type": "string" }, "LastName": { "type": "string" }, "Suffix": { "type": "string" } } }, "PrescriberAgentInfo": { "type": "object", "properties": { "Prefix": { "type": "string" }, "FirstName": { "type": "string" }, "MiddleName": { "type": "string" }, "LastName": { "type": "string" }, "Suffix": { "type": "string" } } }, "ClinicianChangePinRequest": { "type": "object", "required": [ "CurrentPIN", "NewPIN" ], "properties": { "CurrentPIN": { "type": "string" }, "NewPIN": { "type": "string" } } }, "ClinicianSetPinRequest": { "type": "object", "required": [ "PIN" ], "properties": { "PIN": { "type": "string" } } }, "SupervisorToClinicianRequest": { "type": "object", "required": [ "ClinicId" ], "properties": { "ClinicId": { "type": "integer", "format": "int32" }, "SupervisorId": { "type": "integer", "format": "int32" } } }, "DeleteClinicianSupervisorRequest": { "type": "object", "required": [ "ClinicIds" ], "properties": { "ClinicIds": { "type": "array", "items": { "type": "integer", "format": "int32" } } } }, "ClinicianIdentityProofingRequest": { "type": "object", "required": [ "City", "CreditCardNumber", "DateOfBirth", "FirstName", "HomeAddress", "IsMobileNumber", "LastName", "PhoneNumber", "State", "ZipCode" ], "properties": { "FirstName": { "type": "string", "minLength": 0, "maxLength": 32, "pattern": "^[A-Za-z]+(?:[ '\\-][A-Za-z]+)*$" }, "MiddleName": { "type": "string", "minLength": 0, "maxLength": 32, "pattern": "^$|^[A-Za-z]+$" }, "LastName": { "type": "string", "minLength": 0, "maxLength": 32, "pattern": "^(?=.{2,32}$)[A-Za-z]+(?:[ '\\-][A-Za-z]+)*$" }, "HomeAddress": { "type": "string", "pattern": "^[A-Za-z0-9\\/\\.\\-\\#\\ ]+$" }, "City": { "type": "string", "minLength": 0, "maxLength": 38, "pattern": "^[A-Za-z]+\\.?(?:[ '\\-][A-Za-z]+\\.?)*$" }, "State": { "type": "string" }, "ZipCode": { "type": "string", "minLength": 0, "maxLength": 10, "pattern": "^(?:\\d{5}|\\d{9}|\\d{5}\\-\\d{4})$" }, "DateOfBirth": { "type": "string", "format": "date-time" }, "SocialSecurityNumber": { "type": "string", "minLength": 0, "maxLength": 11, "pattern": "^(?:\\d{9}|\\d{3}\\-\\d{2}\\-\\d{4}|\\d{3} \\d{2} \\d{4})$" }, "CreditCardNumber": { "type": "string" }, "DrivingLicenseNumber": { "type": "string" }, "DrivingLicenseNumberState": { "type": "string" }, "PhoneNumber": { "type": "string" }, "IsMobileNumber": { "type": "boolean" } }, "description": "represent a request to clinican identity proof" }, "ClinicianIdentityProofingResponse": { "type": "object", "properties": { "SessionID": { "type": "string" }, "Questions": { "type": "array", "items": { "type": "string" } }, "Answers": { "type": "array", "items": { "type": "array", "items": { "type": "string" } } }, "OtpSent": { "type": "boolean" }, "IdpResultSummary": { "type": "string" }, "IDCapture": { "type": "boolean" }, "Result": { "description": "The result of the operation.", "$ref": "#/definitions/Result" } } }, "ClinicianIdentityProofingOneTimeCodeRequest": { "type": "object", "required": [ "MobileCode", "SessionID" ], "properties": { "SessionID": { "type": "string" }, "MobileCode": { "type": "string", "description": "Entered OTP" } }, "description": "represent a request to clinican identity proof one time code after success" }, "ClinicianIdentityProofingAnswersRequest": { "type": "object", "required": [ "Answers", "SessionID" ], "properties": { "SessionID": { "type": "string" }, "Answers": { "type": "array", "items": { "type": "string" } } } }, "ClinicianResyncTokenRequest": { "type": "object", "required": [ "Code1", "Code2", "Code3" ], "properties": { "Code1": { "type": "string" }, "Code2": { "type": "string" }, "Code3": { "type": "string" } } }, "ClinicianTfaActivationRequest": { "type": "object", "properties": { "CredentialID": { "type": "string" }, "ReferenceNumber": { "type": "string" }, "OneTimePassword": { "type": "string" }, "PIN": { "type": "string" } } }, "ClinicianMobileTfaInitiationRequest": { "type": "object", "required": [ "MobilePhoneNumber" ], "properties": { "MobilePhoneNumber": { "type": "string" } } }, "ClinicianTfaDeactivationRequest": { "type": "object", "required": [ "OneTimePassword", "PIN" ], "properties": { "CredentialID": { "type": "string" }, "OneTimePassword": { "type": "string" }, "PIN": { "type": "string" } } }, "ClinicianAcceptAgreementRequest": { "type": "object", "required": [ "AgreementId", "NameSigned" ], "properties": { "AgreementId": { "type": "integer", "format": "int32" }, "NameSigned": { "type": "string" } } }, "ClinicianAcceptAgreementResponse": { "type": "object", "properties": { "AgreementId": { "type": "integer", "format": "int32" }, "NameSigned": { "type": "string" }, "Result": { "description": "The result of the operation.", "$ref": "#/definitions/Result" } } }, "ClinicianInitializeTfaActivationRequest": { "type": "object", "required": [ "TfaTypeId" ], "properties": { "TfaTypeId": { "type": "string", "enum": [ "Mobile", "Token" ] } } }, "PagedListResponse[ClinicOrderSetResponse]": { "type": "object", "properties": { "Items": { "type": "array", "description": "The list of elements to return.", "readOnly": true, "items": { "$ref": "#/definitions/ClinicOrderSetResponse" } }, "PageResult": { "$ref": "#/definitions/PageResult" }, "Result": { "description": "The result of the operation.", "$ref": "#/definitions/Result" } } }, "ClinicOrderSetResponse": { "type": "object", "properties": { "OrderSetId": { "type": "integer", "format": "int32", "description": "Gets or sets the unique identifier for the order set." }, "Title": { "type": "string", "description": "Gets or sets the title of the order set." }, "Favorites": { "type": "array", "description": "Gets or sets the list of favorite prescriptions associated with this order set.", "items": { "$ref": "#/definitions/ClinicFavoritePrescriptionResponse" } } } }, "ClinicDetailResponse": { "type": "object", "properties": { "Clinic": { "$ref": "#/definitions/Clinic" }, "Result": { "description": "The result of the operation.", "$ref": "#/definitions/Result" } } }, "Clinic": { "type": "object", "required": [ "Address1", "City", "ClinicName", "PrimaryPhone", "PrimaryPhoneType", "State", "ZipCode" ], "properties": { "ClinicId": { "type": "integer", "format": "int32" }, "ClinicName": { "type": "string" }, "ClinicNameLongForm": { "type": "string", "minLength": 0, "maxLength": 250 }, "Address1": { "type": "string" }, "Address2": { "type": "string", "minLength": 0, "maxLength": 35 }, "Active": { "type": "boolean" }, "City": { "type": "string" }, "State": { "type": "string" }, "ZipCode": { "type": "string" }, "PrimaryPhone": { "type": "string", "minLength": 0, "maxLength": 25 }, "PrimaryPhoneType": { "type": "string", "enum": [ "Undefined", "Beeper", "Cell", "Fax", "Home", "Work", "Night", "Primary" ] }, "PrimaryFax": { "type": "string", "minLength": 0, "maxLength": 25 }, "PhoneAdditional1": { "type": "string", "minLength": 0, "maxLength": 25 }, "PhoneAdditionalType1": { "type": "string", "enum": [ "Undefined", "Beeper", "Cell", "Fax", "Home", "Work", "Night", "Primary" ] }, "PhoneAdditional2": { "type": "string", "minLength": 0, "maxLength": 25 }, "PhoneAdditionalType2": { "type": "string", "enum": [ "Undefined", "Beeper", "Cell", "Fax", "Home", "Work", "Night", "Primary" ] }, "PhoneAdditional3": { "type": "string", "minLength": 0, "maxLength": 25 }, "PhoneAdditionalType3": { "type": "string", "enum": [ "Undefined", "Beeper", "Cell", "Fax", "Home", "Work", "Night", "Primary" ] } } }, "AddEditClinicRequest": { "type": "object", "required": [ "Address1", "City", "ClinicName", "PrimaryPhone", "PrimaryPhoneType", "State", "ZipCode" ], "properties": { "ClinicName": { "type": "string" }, "ClinicNameLongForm": { "type": "string", "minLength": 0, "maxLength": 250 }, "Address1": { "type": "string" }, "Address2": { "type": "string", "minLength": 0, "maxLength": 35 }, "Active": { "type": "boolean" }, "City": { "type": "string" }, "State": { "type": "string" }, "ZipCode": { "type": "string" }, "PrimaryPhone": { "type": "string", "minLength": 0, "maxLength": 25 }, "PrimaryPhoneType": { "type": "string", "enum": [ "Undefined", "Beeper", "Cell", "Fax", "Home", "Work", "Night", "Primary" ] }, "PrimaryFax": { "type": "string", "minLength": 0, "maxLength": 25 }, "PhoneAdditional1": { "type": "string", "minLength": 0, "maxLength": 25 }, "PhoneAdditionalType1": { "type": "string", "enum": [ "Undefined", "Beeper", "Cell", "Fax", "Home", "Work", "Night", "Primary" ] }, "PhoneAdditional2": { "type": "string", "minLength": 0, "maxLength": 25 }, "PhoneAdditionalType2": { "type": "string", "enum": [ "Undefined", "Beeper", "Cell", "Fax", "Home", "Work", "Night", "Primary" ] }, "PhoneAdditional3": { "type": "string", "minLength": 0, "maxLength": 25 }, "PhoneAdditionalType3": { "type": "string", "enum": [ "Undefined", "Beeper", "Cell", "Fax", "Home", "Work", "Night", "Primary" ] } }, "description": "Represents a request to add or edit a clinic.\r\nThis class overrides the identifier property so that it will not be serialized for requests." }, "ListResponse[Clinic]": { "type": "object", "properties": { "Items": { "type": "array", "description": "The list of elements to return.", "items": { "$ref": "#/definitions/Clinic" } }, "Result": { "description": "The result of the operation.", "$ref": "#/definitions/Result" } }, "description": "Represents a generic response containing a list of objects." }, "ClinicianClinicsRequest": { "type": "object", "properties": { "IncludeClinicGroups": { "type": "boolean" }, "ClinicStatus": { "type": "string", "enum": [ "Active", "Inactive", "All" ] } } }, "ListResponse[ClinicIdentifier]": { "type": "object", "properties": { "Items": { "type": "array", "description": "The list of elements to return.", "items": { "$ref": "#/definitions/ClinicIdentifier" } }, "Result": { "description": "The result of the operation.", "$ref": "#/definitions/Result" } }, "description": "Represents a generic response containing a list of objects." }, "ClinicIdentifier": { "type": "object", "properties": { "ClinicId": { "type": "integer", "format": "int32" } } }, "ClinicKeyResponse": { "type": "object", "properties": { "ClinicId": { "type": "integer", "format": "int32" }, "ClinicKey": { "type": "string" }, "Result": { "description": "The result of the operation.", "$ref": "#/definitions/Result" } } }, "ChangePatientClinicRequest": { "type": "object", "required": [ "ClinicIdToAdd", "ClinicIdToRemove" ], "properties": { "ClinicIdToRemove": { "type": "integer", "format": "int32" }, "ClinicIdToAdd": { "type": "integer", "format": "int32" } } }, "ClinicianAddMultipleClinicsRequest": { "type": "object", "required": [ "ClinicIds" ], "properties": { "ClinicIds": { "type": "array", "items": { "type": "integer", "format": "int32" } } } }, "ClinicRemoveMultipleCliniciansRequest": { "type": "object", "required": [ "ClinicianIds" ], "properties": { "ClinicianIds": { "type": "array", "items": { "type": "integer", "format": "int32" } } } }, "ListResponse[DEANumberResponse]": { "type": "object", "properties": { "Items": { "type": "array", "description": "The list of elements to return.", "items": { "$ref": "#/definitions/DEANumberResponse" } }, "Result": { "description": "The result of the operation.", "$ref": "#/definitions/Result" } }, "description": "Represents a generic response containing a list of objects." }, "DEANumberResponse": { "type": "object", "properties": { "DEANumberId": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "DEANumber": { "type": "string" }, "AddressLine1": { "type": "string" }, "AddressLine2": { "type": "string" }, "City": { "type": "string" }, "State": { "type": "string" }, "Zip": { "type": "string" } } }, "DEANumberRequest": { "type": "object", "required": [ "DEANumber", "State" ], "properties": { "DEANumber": { "type": "string", "pattern": "^[A-Z][A-Z9][0-9]{7}(-[A-Z0-9]{1,7})?$" }, "AddressLine1": { "type": "string" }, "AddressLine2": { "type": "string" }, "City": { "type": "string" }, "State": { "type": "string", "description": "State abbreviation like DC, CA or State name like 'District of Columbia', 'California'" }, "Zip": { "type": "string", "description": "5-digits zip code or extended zip+4 with a dash separator (xxxxx-xxxx)", "pattern": "^\\d{5}(-\\d{4})?$" } } }, "IdentifierGuidResponse": { "type": "object", "properties": { "Id": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000", "description": "The entity identifier." }, "Result": { "description": "The result of the operation.", "$ref": "#/definitions/Result" } }, "description": "Represents a generic response containing an entity identifier." }, "ItemResponse[DEANumberResponse]": { "type": "object", "properties": { "Item": { "description": "The response object.", "$ref": "#/definitions/DEANumberResponse" }, "Result": { "description": "The result of the operation.", "$ref": "#/definitions/Result" } }, "description": "Represents a generic response containing a single object." }, "PagedListResponse[DiagnosisSearchResult]": { "type": "object", "properties": { "Items": { "type": "array", "description": "The list of elements to return.", "readOnly": true, "items": { "$ref": "#/definitions/DiagnosisSearchResult" } }, "PageResult": { "$ref": "#/definitions/PageResult" }, "Result": { "description": "The result of the operation.", "$ref": "#/definitions/Result" } } }, "DiagnosisSearchResult": { "type": "object", "properties": { "DiagnosisId": { "type": "integer", "format": "int32" }, "DiagnosisCode": { "type": "string" }, "DiagnosisName": { "type": "string" } } }, "CustomInsuranceRequest": { "type": "object", "required": [ "PatientInsuranceIdentifier", "PatientInsuranceIdentifierType" ], "properties": { "PatientInsuranceIdentifierType": { "type": "string", "enum": [ "PayerID", "ProcessorIdentificationNumber", "NAICCode", "MutuallyDefined", "StandardUniqueHealthPlanIdentifier", "IINNumber" ] }, "PatientInsuranceIdentifier": { "type": "string", "minLength": 0, "maxLength": 35 }, "PersonCode": { "type": "string", "minLength": 0, "maxLength": 2 }, "PayerName": { "type": "string" }, "CustomEligibilityDetails": { "type": "array", "items": { "$ref": "#/definitions/CustomEligibilityInfo" } } } }, "CustomEligibilityInfo": { "type": "object", "properties": { "CustomEligibilityInfoType": { "type": "string", "enum": [ "PCN", "CardholderID", "GroupID" ] }, "CustomEligibilityInfoValue": { "type": "string" } } }, "ListResponse[DrugInteraction]": { "type": "object", "properties": { "Items": { "type": "array", "description": "The list of elements to return.", "items": { "$ref": "#/definitions/DrugInteraction" } }, "Result": { "description": "The result of the operation.", "$ref": "#/definitions/Result" } }, "description": "Represents a generic response containing a list of objects." }, "DrugInteraction": { "type": "object", "properties": { "InteractionMessage": { "type": "string" }, "SeverityLevel": { "type": "string", "enum": [ "MinorInteraction", "ModerateInteraction", "MajorInteraction", "UnknownInteraction" ] }, "Drugs": { "type": "array", "items": { "$ref": "#/definitions/DrugInformation" } }, "IsProspective": { "type": "boolean" } } }, "DrugInformation": { "type": "object", "properties": { "DispensableDrugId": { "type": "integer", "format": "int32" }, "RoutedDoseFormDrugId": { "type": "integer", "format": "int32" }, "DrugName": { "type": "string" } } }, "ListResponse[AllergyInteraction]": { "type": "object", "properties": { "Items": { "type": "array", "description": "The list of elements to return.", "items": { "$ref": "#/definitions/AllergyInteraction" } }, "Result": { "description": "The result of the operation.", "$ref": "#/definitions/Result" } }, "description": "Represents a generic response containing a list of objects." }, "AllergyInteraction": { "type": "object", "properties": { "InteractionMessage": { "type": "string" } } }, "PatientAllergiesInternal": { "type": "object", "properties": { "PatientAllergyId": { "type": "integer", "format": "int32" }, "ReactionType": { "type": "string", "enum": [ "Allergy", "AdverseReaction" ] }, "Reaction": { "type": "string" } } }, "PreCheckInteractionsResponse": { "type": "object", "properties": { "AllergyInteractions": { "type": "array", "items": { "$ref": "#/definitions/AllergyInteraction" } }, "DrugInteractions": { "type": "array", "items": { "$ref": "#/definitions/DrugInteraction" } }, "Result": { "description": "The result of the operation.", "$ref": "#/definitions/Result" } } }, "MedicationHistoryRequest": { "type": "object", "properties": { "Start": { "type": "string", "format": "date-time" }, "End": { "type": "string", "format": "date-time" }, "PageNumber": { "type": "integer", "format": "int32", "minimum": 1, "maximum": 2147483645 } } }, "PagedListResponse[SureScriptsHistoryMedication]": { "type": "object", "properties": { "Items": { "type": "array", "description": "The list of elements to return.", "readOnly": true, "items": { "$ref": "#/definitions/SureScriptsHistoryMedication" } }, "PageResult": { "$ref": "#/definitions/PageResult" }, "Result": { "description": "The result of the operation.", "$ref": "#/definitions/Result" } } }, "SureScriptsHistoryMedication": { "type": "object", "properties": { "PatientMedicationHistoryId": { "type": "integer", "format": "int64" }, "PharmacyNotes": { "type": "string" }, "NoSubstitutions": { "type": "boolean" }, "EffectiveDate": { "type": "string", "format": "date-time" }, "LastFillDate": { "type": "string", "format": "date-time" }, "Payer": { "type": "string" }, "DaysSupply": { "type": "integer", "format": "int32" }, "Directions": { "type": "string" }, "DispenseUnitDescription": { "type": "string" }, "DispenseUnitId": { "type": "integer", "format": "int32" }, "Quantity": { "type": "string" }, "Refills": { "type": "string" }, "WrittenDate": { "type": "string", "format": "date-time" }, "DiagnosisCode": { "type": "string" }, "DiagnosisQualifier": { "type": "string" }, "DoseForm": { "type": "string" }, "Route": { "type": "string" }, "Strength": { "type": "string" }, "GenericDrugName": { "type": "string" }, "DispensableDrugId": { "type": "integer", "format": "int32" }, "Brand": { "type": "boolean" }, "RxCUI": { "type": "string" }, "OTC": { "type": "boolean" }, "NDC": { "type": "string" }, "Schedule": { "type": "integer", "format": "int32" }, "DisplayName": { "type": "string" }, "DrugClassification": { "type": "string" }, "ExpirationDate": { "type": "string", "format": "date-time" } } }, "ItemResponse[DateTime]": { "type": "object", "properties": { "Item": { "type": "string", "format": "date-time", "description": "The response object." }, "Result": { "description": "The result of the operation.", "$ref": "#/definitions/Result" } }, "description": "Represents a generic response containing a single object." }, "ListResponse[StandardDispenseUnitType]": { "type": "object", "properties": { "Items": { "type": "array", "description": "The list of elements to return.", "items": { "$ref": "#/definitions/StandardDispenseUnitType" } }, "Result": { "description": "The result of the operation.", "$ref": "#/definitions/Result" } }, "description": "Represents a generic response containing a list of objects." }, "StandardDispenseUnitType": { "type": "object", "properties": { "StandardDispenseUnitTypeID": { "type": "integer", "format": "int32" }, "Name": { "type": "string" }, "Abbreviation": { "type": "string" }, "Singular": { "type": "string" }, "Plural": { "type": "string" }, "SingularOrPlural": { "type": "string" }, "PotencyUnitCode": { "type": "string" }, "IsActive": { "type": "boolean" } } }, "ItemResponse[StandardDispenseUnitType]": { "type": "object", "properties": { "Item": { "description": "The response object.", "$ref": "#/definitions/StandardDispenseUnitType" }, "Result": { "description": "The result of the operation.", "$ref": "#/definitions/Result" } }, "description": "Represents a generic response containing a single object." }, "ListResponse[MedicationSelectResult]": { "type": "object", "properties": { "Items": { "type": "array", "description": "The list of elements to return.", "items": { "$ref": "#/definitions/MedicationSelectResult" } }, "Result": { "description": "The result of the operation.", "$ref": "#/definitions/Result" } }, "description": "Represents a generic response containing a list of objects." }, "MedicationSelectResult": { "type": "object", "properties": { "DispensableDrugId": { "type": "integer", "format": "int32" }, "NDC": { "type": "string" }, "RXCUI": { "type": "integer", "format": "int32" }, "DisplayName": { "type": "string" }, "DrugName": { "type": "string" }, "Route": { "type": "string" }, "DoseForm": { "type": "string" }, "Strength": { "type": "string" }, "DispenseUnitId": { "type": "integer", "format": "int32" }, "Brand": { "type": "boolean" }, "GenericDrugName": { "type": "string" }, "OTC": { "type": "boolean" }, "IsObsolete": { "type": "boolean" }, "DrugClassification": { "type": "string" }, "Schedule": { "type": "integer", "format": "int32" }, "StateSchedule": { "type": "array", "items": { "$ref": "#/definitions/StateSchedule" } } } }, "StateSchedule": { "type": "object", "properties": { "StateName": { "type": "string" }, "Schedule": { "type": "integer", "format": "int32" } } }, "MedicationSearchRequest": { "type": "object", "required": [ "Name" ], "properties": { "Name": { "type": "string", "pattern": "^.{2,}$" }, "DrugStatus": { "type": "string", "enum": [ "Active", "Inactive", "All" ] } } }, "PagedListResponse[MedicationSearchResult]": { "type": "object", "properties": { "Items": { "type": "array", "description": "The list of elements to return.", "readOnly": true, "items": { "$ref": "#/definitions/MedicationSearchResult" } }, "PageResult": { "$ref": "#/definitions/PageResult" }, "Result": { "description": "The result of the operation.", "$ref": "#/definitions/Result" } } }, "MedicationSearchResult": { "type": "object", "properties": { "DispensableDrugId": { "type": "integer", "format": "int32" }, "RoutedDoseFormDrugId": { "type": "integer", "format": "int32" }, "NDC": { "type": "string" }, "RXCUI": { "type": "integer", "format": "int32" }, "NameWithRouteDoseForm": { "type": "string" }, "Strength": { "type": "string" }, "IsObsolete": { "type": "boolean" } } }, "MedicationSelectRequest": { "type": "object", "properties": { "DispensableDrugId": { "type": "integer", "format": "int32" }, "NDC": { "type": "string" }, "RXCUI": { "type": "integer", "format": "int32" } } }, "ItemResponse[MedicationSelectResult]": { "type": "object", "properties": { "Item": { "description": "The response object.", "$ref": "#/definitions/MedicationSelectResult" }, "Result": { "description": "The result of the operation.", "$ref": "#/definitions/Result" } }, "description": "Represents a generic response containing a single object." }, "MedicationMonographRequest": { "type": "object", "properties": { "DispensableDrugId": { "type": "integer", "format": "int32", "description": "DispensableDrugId", "minimum": 1, "maximum": 2147483645 }, "NDC": { "type": "string", "description": "Drug NDC" }, "MonographFormat": { "type": "string", "description": "Return XML or HTML defaults to HTML", "enum": [ "HTML", "XML" ] } } }, "NarxResponse": { "type": "object", "properties": { "HasReport": { "type": "boolean" }, "SoftErrorMessages": { "type": "array", "items": { "$ref": "#/definitions/KeyValuePair[String,String]" } }, "DisallowedMessages": { "type": "array", "items": { "$ref": "#/definitions/KeyValuePair[String,String]" } }, "Disclaimer": { "type": "string" }, "ReportStates": { "type": "array", "items": { "type": "string" } }, "ReportStatesMessage": { "type": "string" }, "NarxScores": { "type": "array", "items": { "$ref": "#/definitions/KeyValuePair[String,String]" } }, "Result": { "description": "The result of the operation.", "$ref": "#/definitions/Result" } } }, "KeyValuePair[String,String]": { "type": "object", "properties": { "key": { "type": "string" }, "value": { "type": "string" } } }, "LatestNarxResponse": { "type": "object", "properties": { "LatestTimestamp": { "type": "string", "format": "date-time" }, "PatientId": { "type": "integer", "format": "int32" }, "LastPulledByClinicianId": { "type": "integer", "format": "int32" }, "LastPulledAtClinicId": { "type": "integer", "format": "int32" }, "Encounter": { "type": "string" } } }, "ItemResponse[String]": { "type": "object", "properties": { "Item": { "type": "string", "description": "The response object." }, "Result": { "description": "The result of the operation.", "$ref": "#/definitions/Result" } }, "description": "Represents a generic response containing a single object." }, "PrescriberNotificationCountsResponse": { "type": "object", "properties": { "RefillRequestsCount": { "type": "integer", "format": "int32" }, "TransactionErrorsCount": { "type": "integer", "format": "int32" }, "PendingPrescriptionsCount": { "type": "integer", "format": "int32" }, "PendingRxChangeCount": { "type": "integer", "format": "int32" }, "Result": { "description": "The result of the operation.", "$ref": "#/definitions/Result" } } }, "TransmissionErrorDetailsRequest": { "type": "object", "properties": { "PageNumber": { "type": "integer", "format": "int32", "minimum": 1, "maximum": 2147483647 }, "Clinic": { "type": "string", "enum": [ "All", "Current" ] } } }, "PagedListResponse[TransmissionErrors]": { "type": "object", "properties": { "Items": { "type": "array", "description": "The list of elements to return.", "readOnly": true, "items": { "$ref": "#/definitions/TransmissionErrors" } }, "PageResult": { "$ref": "#/definitions/PageResult" }, "Result": { "description": "The result of the operation.", "$ref": "#/definitions/Result" } } }, "TransmissionErrors": { "type": "object", "properties": { "PrescriptionId": { "type": "integer", "format": "int32" }, "DateWritten": { "type": "string", "format": "date-time" }, "ErrorDateTimeStamp": { "type": "string", "format": "date-time" }, "ErrorDetails": { "type": "string" }, "PatientId": { "type": "integer", "format": "int32" }, "ClinicId": { "type": "integer", "format": "int32" } } }, "ItemResponse[GetPatient]": { "type": "object", "properties": { "Item": { "description": "The response object.", "$ref": "#/definitions/GetPatient" }, "Result": { "description": "The result of the operation.", "$ref": "#/definitions/Result" } }, "description": "Represents a generic response containing a single object." }, "GetPatient": { "type": "object", "properties": { "PatientId": { "type": "integer", "format": "int32" }, "Prefix": { "type": "string" }, "FirstName": { "type": "string" }, "MiddleName": { "type": "string" }, "LastName": { "type": "string" }, "Suffix": { "type": "string" }, "DateOfBirth": { "type": "string", "format": "date-time" }, "Gender": { "type": "string", "enum": [ "Male", "Female", "Unknown" ] }, "Email": { "type": "string" }, "Address1": { "type": "string" }, "Address2": { "type": "string" }, "City": { "type": "string" }, "State": { "type": "string" }, "ZipCode": { "type": "string" }, "PhoneAdditional1": { "type": "string" }, "PhoneAdditional2": { "type": "string" }, "PhoneAdditionalType1": { "type": "string", "enum": [ "Undefined", "Beeper", "Cell", "Fax", "Home", "Work", "Night", "Primary" ] }, "PhoneAdditionalType2": { "type": "string", "enum": [ "Undefined", "Beeper", "Cell", "Fax", "Home", "Work", "Night", "Primary" ] }, "PrimaryPhone": { "type": "string" }, "PrimaryPhoneType": { "type": "string", "enum": [ "Undefined", "Beeper", "Cell", "Fax", "Home", "Work", "Night", "Primary" ] }, "Weight": { "type": "number", "format": "float" }, "WeightMetric": { "type": "string", "enum": [ "lb", "kg" ] }, "Height": { "type": "number", "format": "float" }, "HeightMetric": { "type": "string", "enum": [ "inch", "cm" ] }, "NonDoseSpotMedicalRecordNumber": { "type": "string" }, "Active": { "type": "boolean" }, "Encounter": { "type": "string" }, "IsHospice": { "type": "boolean" }, "HasSSN": { "type": "boolean" } } }, "AddEditPatientRequest": { "type": "object", "required": [ "Active", "Address1", "City", "DateOfBirth", "FirstName", "Gender", "LastName", "PrimaryPhone", "PrimaryPhoneType", "State", "ZipCode" ], "properties": { "Prefix": { "type": "string", "minLength": 0, "maxLength": 10 }, "FirstName": { "type": "string", "minLength": 0, "maxLength": 35 }, "MiddleName": { "type": "string", "minLength": 0, "maxLength": 35 }, "LastName": { "type": "string", "minLength": 0, "maxLength": 35 }, "Suffix": { "type": "string", "minLength": 0, "maxLength": 10 }, "DateOfBirth": { "type": "string", "format": "date-time" }, "Gender": { "type": "string", "enum": [ "Male", "Female", "Unknown" ] }, "Email": { "type": "string", "minLength": 0, "maxLength": 80 }, "Address1": { "type": "string", "minLength": 0, "maxLength": 35 }, "Address2": { "type": "string", "minLength": 0, "maxLength": 35 }, "City": { "type": "string", "minLength": 0, "maxLength": 35 }, "State": { "type": "string", "minLength": 0, "maxLength": 50 }, "ZipCode": { "type": "string", "minLength": 0, "maxLength": 10 }, "PhoneAdditional1": { "type": "string", "minLength": 0, "maxLength": 25 }, "PhoneAdditional2": { "type": "string", "minLength": 0, "maxLength": 25 }, "PhoneAdditionalType1": { "type": "string", "enum": [ "Undefined", "Beeper", "Cell", "Fax", "Home", "Work", "Night", "Primary" ] }, "PhoneAdditionalType2": { "type": "string", "enum": [ "Undefined", "Beeper", "Cell", "Fax", "Home", "Work", "Night", "Primary" ] }, "PrimaryPhone": { "type": "string", "minLength": 0, "maxLength": 25 }, "PrimaryPhoneType": { "type": "string", "enum": [ "Undefined", "Beeper", "Cell", "Fax", "Home", "Work", "Night", "Primary" ] }, "Weight": { "type": "number", "format": "float" }, "WeightMetric": { "type": "string", "enum": [ "lb", "kg" ] }, "Height": { "type": "number", "format": "float" }, "HeightMetric": { "type": "string", "enum": [ "inch", "cm" ] }, "NonDoseSpotMedicalRecordNumber": { "type": "string", "minLength": 0, "maxLength": 35 }, "Active": { "type": "boolean" }, "Encounter": { "type": "string", "minLength": 0, "maxLength": 50 }, "IsHospice": { "type": "boolean" } } }, "PatientsSearchRequest": { "type": "object", "properties": { "FirstName": { "type": "string", "description": "Patient First Name" }, "LastName": { "type": "string", "description": "Patient Last Name" }, "Dob": { "type": "string", "format": "date-time", "description": "Patient date of birth (M/dd/yyyy)" }, "Status": { "type": "string", "description": "Patient Status to include (if none supplied defaults to both)", "enum": [ "InactiveOnly", "ActiveOnly", "Both" ] }, "PageNumber": { "type": "integer", "format": "int32", "description": "Page Number" } } }, "PagedListResponse[Patient]": { "type": "object", "properties": { "Items": { "type": "array", "description": "The list of elements to return.", "readOnly": true, "items": { "$ref": "#/definitions/Patient" } }, "PageResult": { "$ref": "#/definitions/PageResult" }, "Result": { "description": "The result of the operation.", "$ref": "#/definitions/Result" } } }, "Patient": { "type": "object", "required": [ "Active", "Address1", "City", "DateOfBirth", "FirstName", "Gender", "LastName", "PrimaryPhone", "PrimaryPhoneType", "State", "ZipCode" ], "properties": { "PatientId": { "type": "integer", "format": "int32" }, "Prefix": { "type": "string", "minLength": 0, "maxLength": 10 }, "FirstName": { "type": "string", "minLength": 0, "maxLength": 35 }, "MiddleName": { "type": "string", "minLength": 0, "maxLength": 35 }, "LastName": { "type": "string", "minLength": 0, "maxLength": 35 }, "Suffix": { "type": "string", "minLength": 0, "maxLength": 10 }, "DateOfBirth": { "type": "string", "format": "date-time" }, "Gender": { "type": "string", "enum": [ "Male", "Female", "Unknown" ] }, "Email": { "type": "string", "minLength": 0, "maxLength": 80 }, "Address1": { "type": "string", "minLength": 0, "maxLength": 35 }, "Address2": { "type": "string", "minLength": 0, "maxLength": 35 }, "City": { "type": "string", "minLength": 0, "maxLength": 35 }, "State": { "type": "string", "minLength": 0, "maxLength": 50 }, "ZipCode": { "type": "string", "minLength": 0, "maxLength": 10 }, "PhoneAdditional1": { "type": "string", "minLength": 0, "maxLength": 25 }, "PhoneAdditional2": { "type": "string", "minLength": 0, "maxLength": 25 }, "PhoneAdditionalType1": { "type": "string", "enum": [ "Undefined", "Beeper", "Cell", "Fax", "Home", "Work", "Night", "Primary" ] }, "PhoneAdditionalType2": { "type": "string", "enum": [ "Undefined", "Beeper", "Cell", "Fax", "Home", "Work", "Night", "Primary" ] }, "PrimaryPhone": { "type": "string", "minLength": 0, "maxLength": 25 }, "PrimaryPhoneType": { "type": "string", "enum": [ "Undefined", "Beeper", "Cell", "Fax", "Home", "Work", "Night", "Primary" ] }, "Weight": { "type": "number", "format": "float" }, "WeightMetric": { "type": "string", "enum": [ "lb", "kg" ] }, "Height": { "type": "number", "format": "float" }, "HeightMetric": { "type": "string", "enum": [ "inch", "cm" ] }, "NonDoseSpotMedicalRecordNumber": { "type": "string", "minLength": 0, "maxLength": 35 }, "Active": { "type": "boolean" }, "Encounter": { "type": "string", "minLength": 0, "maxLength": 50 }, "IsHospice": { "type": "boolean" } } }, "PatientSsnRequestModel": { "type": "object", "required": [ "PatientSSN" ], "properties": { "PatientSSN": { "type": "string", "pattern": "^(?:\\d{9}|\\d{3}-\\d{2}-\\d{4})$" } } }, "MergePatientsRequest": { "type": "object", "required": [ "FromPatientId", "ToPatientId" ], "properties": { "FromPatientId": { "type": "integer", "format": "int32", "description": "The patient identifier to merge from." }, "ToPatientId": { "type": "integer", "format": "int32", "description": "The patient identifier to merge to." }, "MergeAllergies": { "type": "boolean", "description": "Indicates whether to merge allergies from the source patient to the target patient.\r\nDefault is false for backwards compatibility." } }, "description": "Represents a request to merge two patients." }, "PharmacySearchRequest": { "type": "object", "properties": { "Name": { "type": "string", "description": "Pharmacy name" }, "City": { "type": "string", "description": "City" }, "State": { "type": "string", "description": "State" }, "Zip": { "type": "string", "description": "ZIP code" }, "Address": { "type": "string", "description": "Street address" }, "PhoneOrFax": { "type": "string", "description": "Phone or fax number" }, "Specialty": { "type": "array", "description": "Array of pharmacy specialty types to filter the search.", "items": { "type": "string", "enum": [ "Any", "FaxPharmacy", "EPCS", "TwentyFourHourPharmacy", "LongTermCarePharmacy", "MailOrder", "Retail", "SpecialtyPharmacy" ] } }, "NcpdpId": { "type": "string", "description": "NCPDP identifier for the pharmacy." }, "PageNumber": { "type": "integer", "format": "int32", "description": "Page number for paginated search results. Defaults to 1." } } }, "PagedListResponse[Pharmacy]": { "type": "object", "properties": { "Items": { "type": "array", "description": "The list of elements to return.", "readOnly": true, "items": { "$ref": "#/definitions/Pharmacy" } }, "PageResult": { "$ref": "#/definitions/PageResult" }, "Result": { "description": "The result of the operation.", "$ref": "#/definitions/Result" } } }, "Pharmacy": { "type": "object", "properties": { "PharmacyId": { "type": "integer", "format": "int32", "description": "The pharmacy identifier." }, "StoreName": { "type": "string", "description": "The pharmacy store name." }, "Address1": { "type": "string", "description": "The pharmacy address." }, "Address2": { "type": "string", "description": "The pharmacy address." }, "City": { "type": "string", "description": "The pharmacy city." }, "State": { "type": "string", "description": "The pharmacy state." }, "ZipCode": { "type": "string", "description": "The pharmacy zip code." }, "PrimaryPhone": { "type": "string", "description": "The pharmacy primary phone number." }, "PrimaryPhoneType": { "type": "string", "description": "The pharmacy primary phone type.", "enum": [ "Undefined", "Beeper", "Cell", "Fax", "Home", "Work", "Night", "Primary" ] }, "PrimaryFax": { "type": "string", "description": "The pharmacy primary fax number." }, "PhoneAdditional1": { "type": "string", "description": "Additional phone number." }, "PhoneAdditionalType1": { "type": "string", "description": "Additional phone type.", "enum": [ "Undefined", "Beeper", "Cell", "Fax", "Home", "Work", "Night", "Primary" ] }, "PhoneAdditional2": { "type": "string", "description": "Additional phone number." }, "PhoneAdditionalType2": { "type": "string", "description": "Additional phone type.", "enum": [ "Undefined", "Beeper", "Cell", "Fax", "Home", "Work", "Night", "Primary" ] }, "PhoneAdditional3": { "type": "string", "description": "Additional phone number." }, "PhoneAdditionalType3": { "type": "string", "description": "Additional phone type.", "enum": [ "Undefined", "Beeper", "Cell", "Fax", "Home", "Work", "Night", "Primary" ] }, "PharmacySpecialties": { "type": "array", "description": "The pharmacy specialties.", "items": { "type": "string" } }, "ServiceLevel": { "type": "integer", "format": "int32", "description": "The pharmacy service level." }, "Latitude": { "type": "number", "format": "double", "description": "The pharmacy Latitude." }, "Longitude": { "type": "number", "format": "double", "description": "The pharmacy Longitude." }, "NCPDPID": { "type": "string" } }, "description": "Represents a pharmacy entity." }, "ItemResponse[Pharmacy]": { "type": "object", "properties": { "Item": { "description": "The response object.", "$ref": "#/definitions/Pharmacy" }, "Result": { "description": "The result of the operation.", "$ref": "#/definitions/Result" } }, "description": "Represents a generic response containing a single object." }, "ListResponse[PatientPharmacy]": { "type": "object", "properties": { "Items": { "type": "array", "description": "The list of elements to return.", "items": { "$ref": "#/definitions/PatientPharmacy" } }, "Result": { "description": "The result of the operation.", "$ref": "#/definitions/Result" } }, "description": "Represents a generic response containing a list of objects." }, "PatientPharmacy": { "type": "object", "properties": { "IsDefault": { "type": "boolean", "description": "Whether or not the pharmacy is patient preferred." }, "PharmacyId": { "type": "integer", "format": "int32", "description": "The pharmacy identifier." }, "StoreName": { "type": "string", "description": "The pharmacy store name." }, "Address1": { "type": "string", "description": "The pharmacy address." }, "Address2": { "type": "string", "description": "The pharmacy address." }, "City": { "type": "string", "description": "The pharmacy city." }, "State": { "type": "string", "description": "The pharmacy state." }, "ZipCode": { "type": "string", "description": "The pharmacy zip code." }, "PrimaryPhone": { "type": "string", "description": "The pharmacy primary phone number." }, "PrimaryPhoneType": { "type": "string", "description": "The pharmacy primary phone type.", "enum": [ "Undefined", "Beeper", "Cell", "Fax", "Home", "Work", "Night", "Primary" ] }, "PrimaryFax": { "type": "string", "description": "The pharmacy primary fax number." }, "PhoneAdditional1": { "type": "string", "description": "Additional phone number." }, "PhoneAdditionalType1": { "type": "string", "description": "Additional phone type.", "enum": [ "Undefined", "Beeper", "Cell", "Fax", "Home", "Work", "Night", "Primary" ] }, "PhoneAdditional2": { "type": "string", "description": "Additional phone number." }, "PhoneAdditionalType2": { "type": "string", "description": "Additional phone type.", "enum": [ "Undefined", "Beeper", "Cell", "Fax", "Home", "Work", "Night", "Primary" ] }, "PhoneAdditional3": { "type": "string", "description": "Additional phone number." }, "PhoneAdditionalType3": { "type": "string", "description": "Additional phone type.", "enum": [ "Undefined", "Beeper", "Cell", "Fax", "Home", "Work", "Night", "Primary" ] }, "PharmacySpecialties": { "type": "array", "description": "The pharmacy specialties.", "items": { "type": "string" } }, "ServiceLevel": { "type": "integer", "format": "int32", "description": "The pharmacy service level." }, "Latitude": { "type": "number", "format": "double", "description": "The pharmacy Latitude." }, "Longitude": { "type": "number", "format": "double", "description": "The pharmacy Longitude." }, "NCPDPID": { "type": "string" } }, "description": "Represents a pharmacy entity in relation to a patient." }, "AddEditPatientPharmacyRequest": { "type": "object", "properties": { "PharmacyId": { "type": "integer", "format": "int32" }, "SetAsPrimary": { "type": "boolean" } } }, "GetPharmacyRestrictionsRequest": { "type": "object", "required": [ "DispensableDrugId" ], "properties": { "DispensableDrugId": { "type": "integer", "format": "int32" }, "PageNumber": { "type": "integer", "format": "int32", "minimum": 1, "maximum": 2147483645 } } }, "PrescriptionResponse": { "type": "object", "properties": { "Prescription": { "$ref": "#/definitions/Prescription" }, "Result": { "description": "The result of the operation.", "$ref": "#/definitions/Result" } } }, "Prescription": { "type": "object", "properties": { "FirstPrescriptionDiagnosis": { "$ref": "#/definitions/PrescriptionDiagnosis" }, "SecondPrescriptionDiagnosis": { "$ref": "#/definitions/PrescriptionDiagnosis" }, "Refills": { "type": "string" }, "PrescriptionId": { "type": "integer", "format": "int32" }, "WrittenDate": { "type": "string", "format": "date-time" }, "Directions": { "type": "string" }, "Quantity": { "type": "string" }, "DispenseUnitId": { "type": "integer", "format": "int32" }, "DaysSupply": { "type": "integer", "format": "int32" }, "PharmacyId": { "type": "integer", "format": "int32" }, "PharmacyNotes": { "type": "string" }, "NoSubstitutions": { "type": "boolean" }, "EffectiveDate": { "type": "string", "format": "date-time" }, "LastFillDate": { "type": "string", "format": "date-time" }, "PrescriberId": { "type": "integer", "format": "int32" }, "PrescriberAgentId": { "type": "integer", "format": "int32" }, "RxReferenceNumber": { "type": "string" }, "Status": { "type": "string", "enum": [ "Unknown", "Entered", "Printed", "Sending", "eRxSent", "FaxSent", "Error", "Deleted", "Requested", "Edited", "EpcsError", "EpcsSigned", "ReadyToSign", "PharmacyVerified", "PharmacySelect" ] }, "Formulary": { "type": "boolean" }, "EligibilityId": { "type": "integer", "format": "int32" }, "Type": { "type": "string", "enum": [ "Coded", "FreeText", "NDC", "Supply", "Compound" ] }, "NonDoseSpotPrescriptionId": { "type": "string" }, "ErrorIgnored": { "type": "boolean" }, "SupplyId": { "type": "integer", "format": "int32" }, "FreeTextType": { "type": "string", "enum": [ "Medication", "Supply", "Compound" ] }, "ClinicId": { "type": "integer", "format": "int32" }, "SupervisorId": { "type": "integer", "format": "int32" }, "IsUrgent": { "type": "boolean" }, "IsRxRenewal": { "type": "boolean" }, "RxRenewalNote": { "type": "string" }, "Strength": { "type": "string" }, "PatientMedicationId": { "type": "integer", "format": "int32" }, "MedicationStatus": { "type": "string", "enum": [ "Unknown", "Active", "Inactive", "Discontinued", "Deleted", "Completed", "CancelRequested", "CancelPending", "Cancelled", "CancelDenied", "Changed", "FullFill", "PartialFill", "NoFill" ] }, "Comment": { "type": "string" }, "DateInactive": { "type": "string", "format": "date-time" }, "Encounter": { "type": "string" }, "DisplayName": { "type": "string" }, "DispensableDrugId": { "type": "integer", "format": "int32" }, "Schedule": { "type": "integer", "format": "int32" }, "CompoundIngredients": { "type": "array", "items": { "$ref": "#/definitions/CompoundIngredient" } } } }, "ListResponse[PrescriptionLog]": { "type": "object", "properties": { "Items": { "type": "array", "description": "The list of elements to return.", "items": { "$ref": "#/definitions/PrescriptionLog" } }, "Result": { "description": "The result of the operation.", "$ref": "#/definitions/Result" } }, "description": "Represents a generic response containing a list of objects." }, "PrescriptionLog": { "type": "object", "properties": { "Status": { "type": "string", "enum": [ "Unknown", "Entered", "Printed", "Sending", "eRxSent", "FaxSent", "Error", "Deleted", "Requested", "Edited", "EpcsError", "EpcsSigned", "ReadyToSign", "PharmacyVerified", "PharmacySelect" ] }, "DateTimeStamp": { "type": "string", "format": "date-time" }, "AdditionalInfo": { "type": "string" }, "Ignored": { "type": "boolean" }, "User": { "type": "string" }, "WasRefillRequest": { "type": "boolean" }, "MedicationStatus": { "type": "string", "enum": [ "Unknown", "Active", "Inactive", "Discontinued", "Deleted", "Completed", "CancelRequested", "CancelPending", "Cancelled", "CancelDenied", "Changed", "FullFill", "PartialFill", "NoFill" ] } } }, "PrescriptionSnapshotResponse": { "type": "object", "properties": { "PrescriptionSnapshot": { "$ref": "#/definitions/PrescriptionSnapshot" }, "Result": { "description": "The result of the operation.", "$ref": "#/definitions/Result" } } }, "PrescriptionSnapshot": { "type": "object", "properties": { "Prescriber": { "$ref": "#/definitions/PrescriberSnapshot" }, "Patient": { "$ref": "#/definitions/PatientSnapshot" }, "Agent": { "$ref": "#/definitions/AgentSnapshot" }, "Supervisor": { "$ref": "#/definitions/SupervisorSnapshot" }, "Pharmacy": { "$ref": "#/definitions/PharmacySnapshot" }, "Medication": { "$ref": "#/definitions/MedicationSnapshot" } } }, "PrescriberSnapshot": { "type": "object", "properties": { "FirstName": { "type": "string" }, "LastName": { "type": "string" }, "DEANumber": { "type": "string" }, "NPINumber": { "type": "string" }, "Address": { "$ref": "#/definitions/AddressSnapshot" } } }, "PatientSnapshot": { "type": "object", "properties": { "FirstName": { "type": "string" }, "LastName": { "type": "string" }, "DateOfBirth": { "type": "string", "format": "date-time" }, "Address": { "$ref": "#/definitions/AddressSnapshot" } } }, "AgentSnapshot": { "type": "object", "properties": { "FirstName": { "type": "string" }, "LastName": { "type": "string" } } }, "SupervisorSnapshot": { "type": "object", "properties": { "FirstName": { "type": "string" }, "LastName": { "type": "string" }, "DEANumber": { "type": "string" }, "NPINumber": { "type": "string" }, "Address": { "$ref": "#/definitions/AddressSnapshot" } } }, "PharmacySnapshot": { "type": "object", "properties": { "StoreName": { "type": "string" }, "NCPDPID": { "type": "string" }, "NPI": { "type": "string" }, "Address": { "$ref": "#/definitions/AddressSnapshot" } } }, "MedicationSnapshot": { "type": "object", "properties": { "DisplayName": { "type": "string" }, "Schedule": { "type": "integer", "format": "int32" }, "State": { "type": "string" }, "Strength": { "type": "string" }, "Route": { "type": "string" }, "GenericDrugName": { "type": "string" }, "IsRx": { "type": "boolean" }, "OTC": { "type": "boolean" }, "NDC_UPC_HRI": { "type": "string" }, "NDC_UPC_HRI_Type": { "type": "integer", "format": "int32" } } }, "AddressSnapshot": { "type": "object", "properties": { "Address1": { "type": "string" }, "Address2": { "type": "string" }, "City": { "type": "string" }, "State": { "type": "string" }, "ZipCode": { "type": "string" } } }, "GetPatientMedicationApiRequest": { "type": "object", "properties": { "EndDate": { "type": "string", "format": "date-time", "description": "End of date range (timestamp UTC)" }, "StartDate": { "type": "string", "format": "date-time", "description": "Start of date range (timestamp UTC)" }, "StatusClass": { "type": "string", "description": "Getting Prescription for Active/Inactive/Pending Medication", "enum": [ "Active", "Inactive", "Pending" ] }, "PrescriptionStatus": { "type": "string", "description": "The status of the prescription", "enum": [ "Entered", "Printed", "Sending", "eRxSent", "FaxSent", "Error", "Deleted", "Requested", "Edited", "EpcsError", "EpcsSigned", "ReadyToSign", "PharmacyVerified", "PharmacySelect", "Retracted" ] }, "PageNumber": { "type": "integer", "format": "int32", "description": "The page number default to 1" }, "SortColumn": { "type": "string", "description": "Sort Column", "enum": [ "DateWritten" ] }, "SortOrder": { "type": "string", "description": "Sort Order", "enum": [ "Asc", "Desc" ] } } }, "PagedListResponse[Prescription]": { "type": "object", "properties": { "Items": { "type": "array", "description": "The list of elements to return.", "readOnly": true, "items": { "$ref": "#/definitions/Prescription" } }, "PageResult": { "$ref": "#/definitions/PageResult" }, "Result": { "description": "The result of the operation.", "$ref": "#/definitions/Result" } } }, "PrescriptionIdListRequest": { "type": "object", "properties": { "PrescriptionIds": { "type": "array", "items": { "type": "integer", "format": "int32" } } } }, "CodedPrescriptionRequest": { "type": "object", "required": [ "Directions", "DispensableDrugId", "DispenseUnitId", "Quantity", "Refills", "Status" ], "properties": { "DispensableDrugId": { "type": "integer", "format": "int32" }, "PatientFormularyId": { "type": "integer", "format": "int32" }, "FirstPrescriptionDiagnosis": { "$ref": "#/definitions/PrescriptionDiagnosisIds" }, "SecondPrescriptionDiagnosis": { "$ref": "#/definitions/PrescriptionDiagnosisIds" }, "Refills": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 99 }, "DaysSupply": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 365 }, "DispenseUnitId": { "type": "integer", "format": "int32" }, "Quantity": { "type": "number", "format": "double" }, "Directions": { "type": "string", "minLength": 0, "maxLength": 1000 }, "PharmacyId": { "type": "integer", "format": "int32" }, "PharmacyNotes": { "type": "string", "minLength": 0, "maxLength": 210 }, "NoSubstitutions": { "type": "boolean" }, "EffectiveDate": { "type": "string", "format": "date-time" }, "RxReferenceNumber": { "type": "string", "minLength": 0, "maxLength": 35 }, "EligibilityId": { "type": "integer", "format": "int32" }, "NonDoseSpotPrescriptionId": { "type": "string", "minLength": 0, "maxLength": 35 }, "IsRefillReplace": { "type": "boolean" }, "IsUrgent": { "type": "boolean" }, "SupervisorId": { "type": "integer", "format": "int32" }, "RetailPharmacyToMailToPatient": { "type": "boolean" }, "RTPSCoupon": { "$ref": "#/definitions/RTPSCoupon" }, "Status": { "type": "string", "enum": [ "Unknown", "Active", "Inactive", "Discontinued", "Deleted", "Completed", "CancelRequested", "CancelPending", "Cancelled", "CancelDenied", "Changed", "FullFill", "PartialFill", "NoFill" ] }, "InactiveDate": { "type": "string", "format": "date-time" }, "Comment": { "type": "string", "minLength": 0, "maxLength": 500 }, "Encounter": { "type": "string", "minLength": 0, "maxLength": 50 } } }, "RTPSCoupon": { "type": "object", "properties": { "BIN": { "type": "string" }, "PCN": { "type": "string" }, "MemberID": { "type": "string" }, "GroupID": { "type": "string" } } }, "CodedSupplyRequest": { "type": "object", "required": [ "Directions", "DispenseUnitId", "Quantity", "Refills", "Status", "SupplyId" ], "properties": { "SupplyId": { "type": "integer", "format": "int32", "minimum": 1, "maximum": 2147483647 }, "FirstPrescriptionDiagnosis": { "$ref": "#/definitions/PrescriptionDiagnosisIds" }, "SecondPrescriptionDiagnosis": { "$ref": "#/definitions/PrescriptionDiagnosisIds" }, "Refills": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 99 }, "DaysSupply": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 365 }, "DispenseUnitId": { "type": "integer", "format": "int32" }, "Quantity": { "type": "number", "format": "double" }, "Directions": { "type": "string", "minLength": 0, "maxLength": 1000 }, "PharmacyId": { "type": "integer", "format": "int32" }, "PharmacyNotes": { "type": "string", "minLength": 0, "maxLength": 210 }, "NoSubstitutions": { "type": "boolean" }, "EffectiveDate": { "type": "string", "format": "date-time" }, "RxReferenceNumber": { "type": "string", "minLength": 0, "maxLength": 35 }, "EligibilityId": { "type": "integer", "format": "int32" }, "NonDoseSpotPrescriptionId": { "type": "string", "minLength": 0, "maxLength": 35 }, "IsRefillReplace": { "type": "boolean" }, "IsUrgent": { "type": "boolean" }, "SupervisorId": { "type": "integer", "format": "int32" }, "RetailPharmacyToMailToPatient": { "type": "boolean" }, "RTPSCoupon": { "$ref": "#/definitions/RTPSCoupon" }, "Status": { "type": "string", "enum": [ "Unknown", "Active", "Inactive", "Discontinued", "Deleted", "Completed", "CancelRequested", "CancelPending", "Cancelled", "CancelDenied", "Changed", "FullFill", "PartialFill", "NoFill" ] }, "InactiveDate": { "type": "string", "format": "date-time" }, "Comment": { "type": "string", "minLength": 0, "maxLength": 500 }, "Encounter": { "type": "string", "minLength": 0, "maxLength": 50 } } }, "FreeTextSupplyPrescriptionRequest": { "type": "object", "required": [ "Directions", "DispenseUnitId", "DisplayName", "NotControlled", "Quantity", "Refills", "Status" ], "properties": { "DisplayName": { "type": "string", "minLength": 3, "maxLength": 300 }, "NotControlled": { "type": "boolean" }, "FirstPrescriptionDiagnosis": { "$ref": "#/definitions/PrescriptionDiagnosisIds" }, "SecondPrescriptionDiagnosis": { "$ref": "#/definitions/PrescriptionDiagnosisIds" }, "Refills": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 99 }, "DaysSupply": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 365 }, "DispenseUnitId": { "type": "integer", "format": "int32" }, "Quantity": { "type": "number", "format": "double" }, "Directions": { "type": "string", "minLength": 0, "maxLength": 1000 }, "PharmacyId": { "type": "integer", "format": "int32" }, "PharmacyNotes": { "type": "string", "minLength": 0, "maxLength": 210 }, "NoSubstitutions": { "type": "boolean" }, "EffectiveDate": { "type": "string", "format": "date-time" }, "RxReferenceNumber": { "type": "string", "minLength": 0, "maxLength": 35 }, "EligibilityId": { "type": "integer", "format": "int32" }, "NonDoseSpotPrescriptionId": { "type": "string", "minLength": 0, "maxLength": 35 }, "IsRefillReplace": { "type": "boolean" }, "IsUrgent": { "type": "boolean" }, "SupervisorId": { "type": "integer", "format": "int32" }, "RetailPharmacyToMailToPatient": { "type": "boolean" }, "RTPSCoupon": { "$ref": "#/definitions/RTPSCoupon" }, "Status": { "type": "string", "enum": [ "Unknown", "Active", "Inactive", "Discontinued", "Deleted", "Completed", "CancelRequested", "CancelPending", "Cancelled", "CancelDenied", "Changed", "FullFill", "PartialFill", "NoFill" ] }, "InactiveDate": { "type": "string", "format": "date-time" }, "Comment": { "type": "string", "minLength": 0, "maxLength": 500 }, "Encounter": { "type": "string", "minLength": 0, "maxLength": 50 } } }, "CompoundPrescriptionRequest": { "type": "object", "required": [ "CompoundDescription", "CompoundIngredients", "Directions", "DispenseUnitId", "Quantity", "Refills", "Status" ], "properties": { "CompoundDescription": { "type": "string" }, "CompoundIngredients": { "type": "array", "items": { "$ref": "#/definitions/CompoundIngredient" } }, "FirstPrescriptionDiagnosis": { "$ref": "#/definitions/PrescriptionDiagnosisIds" }, "SecondPrescriptionDiagnosis": { "$ref": "#/definitions/PrescriptionDiagnosisIds" }, "Refills": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 99 }, "DaysSupply": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 365 }, "DispenseUnitId": { "type": "integer", "format": "int32" }, "Quantity": { "type": "number", "format": "double" }, "Directions": { "type": "string", "minLength": 0, "maxLength": 1000 }, "PharmacyId": { "type": "integer", "format": "int32" }, "PharmacyNotes": { "type": "string", "minLength": 0, "maxLength": 210 }, "NoSubstitutions": { "type": "boolean" }, "EffectiveDate": { "type": "string", "format": "date-time" }, "RxReferenceNumber": { "type": "string", "minLength": 0, "maxLength": 35 }, "EligibilityId": { "type": "integer", "format": "int32" }, "NonDoseSpotPrescriptionId": { "type": "string", "minLength": 0, "maxLength": 35 }, "IsRefillReplace": { "type": "boolean" }, "IsUrgent": { "type": "boolean" }, "SupervisorId": { "type": "integer", "format": "int32" }, "RetailPharmacyToMailToPatient": { "type": "boolean" }, "RTPSCoupon": { "$ref": "#/definitions/RTPSCoupon" }, "Status": { "type": "string", "enum": [ "Unknown", "Active", "Inactive", "Discontinued", "Deleted", "Completed", "CancelRequested", "CancelPending", "Cancelled", "CancelDenied", "Changed", "FullFill", "PartialFill", "NoFill" ] }, "InactiveDate": { "type": "string", "format": "date-time" }, "Comment": { "type": "string", "minLength": 0, "maxLength": 500 }, "Encounter": { "type": "string", "minLength": 0, "maxLength": 50 } } }, "CancelPrescriptionRequest": { "type": "object", "properties": { "Comment": { "type": "string", "minLength": 0, "maxLength": 500 } } }, "UpdatePrescriptionMedicationStatusRequest": { "type": "object", "required": [ "Status" ], "properties": { "Status": { "type": "string", "enum": [ "Unknown", "Active", "Inactive", "Discontinued", "Deleted", "Completed", "CancelRequested", "CancelPending", "Cancelled", "CancelDenied", "Changed", "FullFill", "PartialFill", "NoFill" ] }, "Comment": { "type": "string", "minLength": 0, "maxLength": 500 }, "InactiveDate": { "type": "string", "format": "date-time" } } }, "ChangePrescriptionPharmacyRequest": { "type": "object", "required": [ "PharmacyId" ], "properties": { "PharmacyId": { "type": "integer", "format": "int32" } } }, "PriorAuthorizationStatusLogUIResponse": { "type": "object", "properties": { "StatusLog": { "type": "array", "items": { "$ref": "#/definitions/PriorAuthStatusLogUI" } }, "Result": { "description": "The result of the operation.", "$ref": "#/definitions/Result" } } }, "PriorAuthStatusLogUI": { "type": "object", "properties": { "Status": { "type": "string" }, "AdditionalInfo": { "type": "string" }, "CreatedDateStamp": { "type": "string", "format": "date-time" }, "Attachment": { "$ref": "#/definitions/PAAttachment" } } }, "PAAttachment": { "type": "object", "properties": { "AttachmentId": { "type": "integer", "format": "int32" }, "CreatedDateStamp": { "type": "string", "format": "date-time" }, "FileName": { "type": "string" }, "IsOutbound": { "type": "boolean" } } }, "GetRefillRequest": { "type": "object", "properties": { "Clinic": { "type": "string", "enum": [ "All", "Current" ] }, "PatientId": { "type": "integer", "format": "int32" }, "PageNumber": { "type": "integer", "format": "int32", "minimum": 1, "maximum": 2147483647 } } }, "PagedListResponse[GetRefillResponse]": { "type": "object", "properties": { "Items": { "type": "array", "description": "The list of elements to return.", "readOnly": true, "items": { "$ref": "#/definitions/GetRefillResponse" } }, "PageResult": { "$ref": "#/definitions/PageResult" }, "Result": { "description": "The result of the operation.", "$ref": "#/definitions/Result" } } }, "GetRefillResponse": { "type": "object", "properties": { "RefillId": { "type": "integer", "format": "int32" }, "NewPatient": { "type": "boolean" }, "Patient": { "$ref": "#/definitions/Patient" }, "ClinicId": { "type": "integer", "format": "int32" }, "ClinicianId": { "type": "integer", "format": "int32" }, "RequestedPrescriptionId": { "type": "integer", "format": "int32" }, "DispensedPrescriptionId": { "type": "integer", "format": "int32" }, "OriginalPrescriptionId": { "type": "integer", "format": "int32" }, "PharmacyId": { "type": "integer", "format": "int32" }, "RequestedDate": { "type": "string", "format": "date-time" }, "RequestExpirationDate": { "type": "string", "format": "date-time" } } }, "PagedListResponse[GetRefillDetailedResponse]": { "type": "object", "properties": { "Items": { "type": "array", "description": "The list of elements to return.", "readOnly": true, "items": { "$ref": "#/definitions/GetRefillDetailedResponse" } }, "PageResult": { "$ref": "#/definitions/PageResult" }, "Result": { "description": "The result of the operation.", "$ref": "#/definitions/Result" } } }, "GetRefillDetailedResponse": { "type": "object", "properties": { "RefillId": { "type": "integer", "format": "int32" }, "NewPatient": { "type": "boolean" }, "Patient": { "$ref": "#/definitions/Patient" }, "ClinicId": { "type": "integer", "format": "int32" }, "ClinicianId": { "type": "integer", "format": "int32" }, "RequestedPrescription": { "$ref": "#/definitions/Prescription" }, "DispensedPrescription": { "$ref": "#/definitions/Prescription" }, "OriginalPrescription": { "$ref": "#/definitions/Prescription" }, "PharmacyId": { "type": "integer", "format": "int32" }, "RequestedDate": { "type": "string", "format": "date-time" }, "RequestExpirationDate": { "type": "string", "format": "date-time" } } }, "ChangeRefillPatientRequest": { "type": "object", "required": [ "PatientId" ], "properties": { "PatientId": { "type": "integer", "format": "int32" } } }, "GetRxChangeRequest": { "type": "object", "properties": { "Clinic": { "type": "string", "enum": [ "All", "Current" ] }, "PatientId": { "type": "integer", "format": "int32" }, "PageNumber": { "type": "integer", "format": "int32", "minimum": 1, "maximum": 2147483647 } } }, "PagedListResponse[GetRxChangeResponse]": { "type": "object", "properties": { "Items": { "type": "array", "description": "The list of elements to return.", "readOnly": true, "items": { "$ref": "#/definitions/GetRxChangeResponse" } }, "PageResult": { "$ref": "#/definitions/PageResult" }, "Result": { "description": "The result of the operation.", "$ref": "#/definitions/Result" } } }, "GetRxChangeResponse": { "type": "object", "properties": { "RxChangeRequestId": { "type": "integer", "format": "int32" }, "RxChangeType": { "type": "string" }, "RxChangeSubType": { "type": "string" }, "Source": { "type": "string" }, "NewPatient": { "type": "boolean" }, "Patient": { "$ref": "#/definitions/Patient" }, "UnmatchedChange": { "type": "boolean" }, "PrescribedPrescriptionId": { "type": "integer", "format": "int32" }, "RequestedMedications": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "ClinicianId": { "type": "integer", "format": "int32" }, "ClinicId": { "type": "integer", "format": "int32" }, "PharmacyId": { "type": "integer", "format": "int32" }, "RequestedDate": { "type": "string", "format": "date-time" }, "RequestExpirationDate": { "type": "string", "format": "date-time" }, "OriginalPrescriptionId": { "type": "integer", "format": "int32" }, "PayerName": { "type": "string" }, "DrugUseEvaluations": { "type": "array", "items": { "$ref": "#/definitions/DrugUseEvaluation" } } } }, "DrugUseEvaluation": { "type": "object", "properties": { "Reason": { "type": "string" }, "Service": { "type": "string" }, "AckReason": { "type": "string" }, "Result": { "type": "string" }, "Significance": { "type": "string" } } }, "PagedListResponse[GetRxChangeDetailedResponse]": { "type": "object", "properties": { "Items": { "type": "array", "description": "The list of elements to return.", "readOnly": true, "items": { "$ref": "#/definitions/GetRxChangeDetailedResponse" } }, "PageResult": { "$ref": "#/definitions/PageResult" }, "Result": { "description": "The result of the operation.", "$ref": "#/definitions/Result" } } }, "GetRxChangeDetailedResponse": { "type": "object", "properties": { "RxChangeRequestId": { "type": "integer", "format": "int32" }, "RxChangeType": { "type": "string" }, "RxChangeSubType": { "type": "string" }, "Source": { "type": "string" }, "NewPatient": { "type": "boolean" }, "Patient": { "$ref": "#/definitions/Patient" }, "UnmatchedChange": { "type": "boolean" }, "PrescribedPrescription": { "$ref": "#/definitions/Prescription" }, "RequestedMedications": { "type": "array", "items": { "$ref": "#/definitions/Prescription" } }, "ClinicianId": { "type": "integer", "format": "int32" }, "ClinicId": { "type": "integer", "format": "int32" }, "PharmacyId": { "type": "integer", "format": "int32" }, "RequestedDate": { "type": "string", "format": "date-time" }, "RequestExpirationDate": { "type": "string", "format": "date-time" }, "OriginalPrescription": { "$ref": "#/definitions/Prescription" }, "PayerName": { "type": "string" }, "DrugUseEvaluations": { "type": "array", "items": { "$ref": "#/definitions/DrugUseEvaluation" } } } }, "ReconcileRxChangeRequest": { "type": "object", "required": [ "ReferencedPrescriptionId" ], "properties": { "ReferencedPrescriptionId": { "type": "integer", "format": "int32", "minimum": 1, "maximum": 2147483647 } } }, "ChangeRxChangePatientRequest": { "type": "object", "required": [ "PatientId" ], "properties": { "PatientId": { "type": "integer", "format": "int32" } } }, "ItemResponse[SelfReportedMedicationResponse]": { "type": "object", "properties": { "Item": { "description": "The response object.", "$ref": "#/definitions/SelfReportedMedicationResponse" }, "Result": { "description": "The result of the operation.", "$ref": "#/definitions/Result" } }, "description": "Represents a generic response containing a single object." }, "SelfReportedMedicationResponse": { "type": "object", "properties": { "SelfReportedMedicationId": { "type": "integer", "format": "int32" }, "DateReported": { "type": "string", "format": "date-time" }, "DatePrescribed": { "type": "string", "format": "date-time" }, "DisplayName": { "type": "string" }, "DispenseUnitType": { "type": "string" }, "DosageText": { "type": "string" }, "Directions": { "type": "string" }, "DaysSupply": { "type": "integer", "format": "int32" }, "Dispense": { "type": "string" }, "Quantity": { "type": "string" }, "DispenseUnitTypeId": { "type": "integer", "format": "int32" }, "Refills": { "type": "integer", "format": "int32" }, "Comment": { "type": "string" }, "Status": { "type": "string", "enum": [ "Unknown", "Active", "Inactive", "Discontinued", "Deleted", "Completed", "CancelRequested", "CancelPending", "Cancelled", "CancelDenied", "Changed", "FullFill", "PartialFill", "NoFill" ] }, "DiscontinuedDate": { "type": "string", "format": "date-time" }, "Schedule": { "type": "integer", "format": "int32" }, "Encounter": { "type": "string" }, "DispensableDrugID": { "type": "integer", "format": "int32" }, "RoutedDoseformDrugID": { "type": "integer", "format": "int32" }, "RoutedDoseFormDrugID": { "type": "integer", "format": "int32" }, "OTC": { "type": "boolean" }, "NDC": { "type": "string" }, "DoseForm": { "type": "string" }, "Route": { "type": "string" }, "Strength": { "type": "string" } } }, "PagedListResponse[SelfReportedMedicationResponse]": { "type": "object", "properties": { "Items": { "type": "array", "description": "The list of elements to return.", "readOnly": true, "items": { "$ref": "#/definitions/SelfReportedMedicationResponse" } }, "PageResult": { "$ref": "#/definitions/PageResult" }, "Result": { "description": "The result of the operation.", "$ref": "#/definitions/Result" } } }, "CodedSelfReportedMedicationRequest": { "type": "object", "required": [ "DispensableDrugId", "Status" ], "properties": { "DispensableDrugId": { "type": "integer", "format": "int32" }, "Refills": { "type": "integer", "format": "int32" }, "DaysSupply": { "type": "integer", "format": "int32" }, "DispenseUnitId": { "type": "integer", "format": "int32" }, "Quantity": { "type": "number", "format": "double" }, "Directions": { "type": "string", "minLength": 0, "maxLength": 500 }, "WrittenDate": { "type": "string", "format": "date-time" }, "PrescriberUserId": { "type": "integer", "format": "int32" }, "PrescribingAgentUserId": { "type": "integer", "format": "int32" }, "Status": { "type": "string", "enum": [ "Unknown", "Active", "Inactive", "Discontinued", "Deleted", "Completed", "CancelRequested", "CancelPending", "Cancelled", "CancelDenied", "Changed", "FullFill", "PartialFill", "NoFill" ] }, "InactiveDate": { "type": "string", "format": "date-time" }, "Comment": { "type": "string", "minLength": 0, "maxLength": 500 }, "Encounter": { "type": "string", "minLength": 0, "maxLength": 50 } } }, "SimpleSelfReportedMedicationRequest": { "type": "object", "required": [ "RoutedDoseFormDrugId", "Status" ], "properties": { "RoutedDoseFormDrugId": { "type": "integer", "format": "int32" }, "Refills": { "type": "integer", "format": "int32" }, "DaysSupply": { "type": "integer", "format": "int32" }, "DispenseUnitId": { "type": "integer", "format": "int32" }, "Quantity": { "type": "number", "format": "double" }, "Directions": { "type": "string", "minLength": 0, "maxLength": 500 }, "WrittenDate": { "type": "string", "format": "date-time" }, "PrescriberUserId": { "type": "integer", "format": "int32" }, "PrescribingAgentUserId": { "type": "integer", "format": "int32" }, "Status": { "type": "string", "enum": [ "Unknown", "Active", "Inactive", "Discontinued", "Deleted", "Completed", "CancelRequested", "CancelPending", "Cancelled", "CancelDenied", "Changed", "FullFill", "PartialFill", "NoFill" ] }, "InactiveDate": { "type": "string", "format": "date-time" }, "Comment": { "type": "string", "minLength": 0, "maxLength": 500 }, "Encounter": { "type": "string", "minLength": 0, "maxLength": 50 } } }, "FreeTextSelfReportedMedicationRequest": { "type": "object", "required": [ "DisplayName", "Status" ], "properties": { "DisplayName": { "type": "string", "minLength": 0, "maxLength": 300 }, "Refills": { "type": "integer", "format": "int32" }, "DaysSupply": { "type": "integer", "format": "int32" }, "DispenseUnitId": { "type": "integer", "format": "int32" }, "Quantity": { "type": "number", "format": "double" }, "Directions": { "type": "string", "minLength": 0, "maxLength": 500 }, "WrittenDate": { "type": "string", "format": "date-time" }, "PrescriberUserId": { "type": "integer", "format": "int32" }, "PrescribingAgentUserId": { "type": "integer", "format": "int32" }, "Status": { "type": "string", "enum": [ "Unknown", "Active", "Inactive", "Discontinued", "Deleted", "Completed", "CancelRequested", "CancelPending", "Cancelled", "CancelDenied", "Changed", "FullFill", "PartialFill", "NoFill" ] }, "InactiveDate": { "type": "string", "format": "date-time" }, "Comment": { "type": "string", "minLength": 0, "maxLength": 500 }, "Encounter": { "type": "string", "minLength": 0, "maxLength": 50 } } }, "UpdateSelfReportedMedicationStatusRequest": { "type": "object", "required": [ "Status" ], "properties": { "Status": { "type": "string", "enum": [ "Unknown", "Active", "Inactive", "Discontinued", "Deleted", "Completed", "CancelRequested", "CancelPending", "Cancelled", "CancelDenied", "Changed", "FullFill", "PartialFill", "NoFill" ] }, "InactiveDate": { "type": "string", "format": "date-time" }, "Comment": { "type": "string", "minLength": 0, "maxLength": 500 }, "Encounter": { "type": "string", "minLength": 0, "maxLength": 50 } } }, "ItemResponse[SupplySearchResultForAPI]": { "type": "object", "properties": { "Item": { "description": "The response object.", "$ref": "#/definitions/SupplySearchResultForAPI" }, "Result": { "description": "The result of the operation.", "$ref": "#/definitions/Result" } }, "description": "Represents a generic response containing a single object." }, "SupplySearchResultForAPI": { "type": "object", "properties": { "SupplyId": { "type": "integer", "format": "int32", "description": "Primary key in the Supply table" }, "NDC": { "type": "string", "description": "National Drug Code" }, "UPC": { "type": "string", "description": "Universal Packaging Code" }, "Name": { "type": "string", "description": "Supply name" }, "OTC": { "type": "boolean", "description": "True if IsRx is true" }, "IsObsolete": { "type": "boolean" } } }, "SupplySearchRequest": { "type": "object", "properties": { "Name": { "type": "string" }, "Ndc": { "type": "string" }, "Upc": { "type": "string" }, "SupplyStatus": { "type": "string", "enum": [ "Active", "Inactive", "All" ] } } }, "PagedListResponse[SupplySearchResultForAPI]": { "type": "object", "properties": { "Items": { "type": "array", "description": "The list of elements to return.", "readOnly": true, "items": { "$ref": "#/definitions/SupplySearchResultForAPI" } }, "PageResult": { "$ref": "#/definitions/PageResult" }, "Result": { "description": "The result of the operation.", "$ref": "#/definitions/Result" } } } } }