**THIS PAGE IS IN PROGRESS. THERE MAY BE DIFFERENCES BETWEEN THE APIS LISTED HERE AND THE APIS PROVISIONED TO YOUR ORGANIZATION IN YOUR SANDBOX & PRODUCTION ENVIRONMENTS.
\nDiasyst creates and maintains a growing library of medication data, guidelines-based algorithms, and reference files for chronic disease management. Through our RxINTEL APIs, platforms and solutions like yours can embed the power of Diasyst into your products and workflows to help improve patient outcomes, increase user engagement, and eliminate clinical inertia.
\nDiasyst’s APIs are built on GraphQL, allowing consumption of our services to be technically flexible, efficient, and scalable. For more information about GraphQL and free libraries that can be utilized with your tech stack, please visit: https://graphql.org/
\nDiasyst sources content and maintains all licenses to materials used, including official guidelines from the American Diabetes Association (ADA), the American Association of Clinical Endocrinologists (AACE), and the American College of Cardiology (ACC). In addition to widely recognized clinical practice guidelines, Diasyst develops its algorithms and content in accordance with FDA drug labels, safety announcements, clinical trials, and journal articles.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"21132988","collectionId":"5214dc78-fc7f-405b-ab34-e1d68ea94df2","publishedId":"2s7Z7ckrji","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2023-09-06T18:28:12.000Z"},"item":[{"name":"Rx Library","item":[{"name":"Rx Library General Queries","item":[{"name":"Library Changelog","id":"b1ce1f2f-06a2-49ab-b7de-936aeb0b88ee","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"DiasystSessionKey","value":"{{DiasystSessionKey}}","type":"text"},{"key":"DiasystAuthToken","value":"{{DiasystAuthToken}}","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"# This is a GraphQL query to fetch the changelog data for the rxLibrary\nquery rxLibraryChangelog {\n # The \"rxLibraryChangelog\" field is being queried\n rxLibraryChangelog { \n # The following fields are being requested for the returned object\n changesData {\n # data object containing the count of different types of changes\n insertedCount # number of newly added items\n updatedCount # number of updated items\n disabledCount # number of disabled items\n enabledCount # number of enabled items\n } \n creator { \n # data object containing information about the creator\n username # username of the creator\n email # email of the creator\n name # name of the creator\n }\n created # timestamp when the changes were made\n } \n}\n","variables":"{\n \n}"}},"url":"{{url}}","description":"This query allows the client to fetch the changelog of a library of medications. The query returns a list of changes, including the count of newly inserted, updated, disabled, and enabled items. It also returns information about the creator of the change, such as the username, email and name. The timestamp of when the change was made is also returned.
\nThe query calls the rxLibraryChangelog and returns several fields, including changesData, creator, created.changesData field returns an object with several fields, insertedCount, updatedCount, disabledCount, enabledCount, these fields indicate the count of different type of changes.creator field returns an object with username, email, name fields, which indicates the creator details.created field is timestamp field when the changes happen.
It is a simple query that fetches the log data of changes happened on the rxLibrary.
This query allows the client to fetch all the medication daytimes, this query calls the medicationDaytimes field and returns 3 fields id, short and key. id is a unique identifier, short short form of the medication daytime and key is the key for the medication daytime.
This is a GraphQL to fetch all the medication classes from the server. The medicationClasses field is queried, which returns a list of medication class objects. For each medication class object, the query requests the medicationClassId (a unique identifier) and the name of the medication class.
This is a GraphQL to fetch all the conditions from the server. The conditions field is queried, which returns a list of condition objects. For each condition object, the query requests the conditionId (a unique identifier) and the name of the condition.
This guide provides an overview of the general queries available for the Rx Library, which can be used to access various types of medication and health-related information.
\nThis is a GraphQL query that retrieves medication information based on a given condition ID. The query takes a variable $conditionId of type ID as an input. The query retrieves the medications associated with the given condition ID, and it limits the number of results to 2.
The query retrieves the medication ID, display name, generic name, and brand name of each medication. It also retrieves the medication class information, including the class ID and name, for each medication. Additionally, the query retrieves the condition information, including the condition ID and name, for each medication, as well as the dose forms for each medication.
\nThe query also retrieves the dose information, including the dose ID, quantity, dose, dose form, with filter_duplicates set to false, that is it will not filter the duplicate values. It also retrieves the NDC fullCode for each medication.
\nOverall, this query enables the retrieval of detailed information about medications, including their names, classes, conditions, doses, and NDC codes, based on a specified condition ID.
\n","urlObject":{"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"c83a7281-f800-428e-8582-d661b2fd146b","name":"List Medications by Condition","originalRequest":{"method":"POST","header":[{"key":"DiasystSessionKey","value":"{{DiasystSessionKey}}","type":"text"},{"key":"DiasystAuthToken","value":"{{DiasystAuthToken}}","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"query medications ($conditionId: ID) {\n medications (conditionId: $conditionId, page:{limit: 2}) {\n medicationId\n displayName\n genericName\n brandName\n classes {\n medicationClassId\n name\n }\n conditions {\n conditionId\n name\n }\n doseForms {\n doseForm\n }\n doses(filter_duplicates: false) {\n doseId\n quantity\n dose\n doseForm\n }\n NDC {\n fullCode\n }\n }\n}","variables":"{\n \"conditionId\": 2\n}"}},"url":"{{url}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 02 Nov 2022 16:35:40 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Set-Cookie","value":"AWSALB=vk5yappiQnWrPf39Aym2jB0Wx9FrtJwN76mY9LAxRmI1qp87DWFp6F5AoG5CJLWAu/QznVXTG2Q+QDQBPrcG4gEDrLt5ZeH/jod5OgD3KuBpKGgAvJGt8CQwJQRv; Expires=Wed, 09 Nov 2022 16:35:40 GMT; Path=/"},{"key":"Set-Cookie","value":"AWSALBCORS=vk5yappiQnWrPf39Aym2jB0Wx9FrtJwN76mY9LAxRmI1qp87DWFp6F5AoG5CJLWAu/QznVXTG2Q+QDQBPrcG4gEDrLt5ZeH/jod5OgD3KuBpKGgAvJGt8CQwJQRv; Expires=Wed, 09 Nov 2022 16:35:40 GMT; Path=/; SameSite=None; Secure"},{"key":"Content-Security-Policy","value":"frame-ancestors 'none'"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Headers","value":"Origin, X-Requested-With, Content-Type, Accept, DiasystAuthToken, DiasystSessionKey, DiasystRequestSignature, AdminAuthToken"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS"},{"key":"Server","value":"Diasyst"},{"key":"Strict-Transport-Security","value":"max-age=63072000; includeSubDomains; preload"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"medications\": [\n {\n \"medicationId\": \"1\",\n \"displayName\": \"Metformin ER\",\n \"genericName\": \"Metformin Extended Release\",\n \"brandName\": \"Fortamet\",\n \"classes\": [\n {\n \"medicationClassId\": \"1\",\n \"name\": \"Biguanides\"\n }\n ],\n \"conditions\": [\n {\n \"conditionId\": \"2\",\n \"name\": \"Type 2 Diabetes\"\n }\n ],\n \"doseForms\": [\n {\n \"doseForm\": \"1000\"\n }\n ],\n \"doses\": [\n {\n \"doseId\": \"0\",\n \"quantity\": 0,\n \"dose\": \"0\",\n \"doseForm\": \"0\"\n },\n {\n \"doseId\": \"5\",\n \"quantity\": 1,\n \"dose\": \"1000\",\n \"doseForm\": \"1000\"\n },\n {\n \"doseId\": \"6\",\n \"quantity\": 2,\n \"dose\": \"2000\",\n \"doseForm\": \"1000\"\n }\n ],\n \"NDC\": [\n {\n \"fullCode\": \"59630-574\"\n },\n {\n \"fullCode\": \"59630-574-60\"\n },\n {\n \"fullCode\": \"59630-575\"\n },\n {\n \"fullCode\": \"59630-575-60\"\n }\n ]\n },\n {\n \"medicationId\": \"3\",\n \"displayName\": \"Metformin ER\",\n \"genericName\": \"Metformin Hydrochloride\",\n \"brandName\": \"Glumetza\",\n \"classes\": [\n {\n \"medicationClassId\": \"1\",\n \"name\": \"Biguanides\"\n }\n ],\n \"conditions\": [\n {\n \"conditionId\": \"2\",\n \"name\": \"Type 2 Diabetes\"\n }\n ],\n \"doseForms\": [\n {\n \"doseForm\": \"500\"\n },\n {\n \"doseForm\": \"1000\"\n }\n ],\n \"doses\": [\n {\n \"doseId\": \"0\",\n \"quantity\": 0,\n \"dose\": \"0\",\n \"doseForm\": \"0\"\n },\n {\n \"doseId\": \"15\",\n \"quantity\": 1,\n \"dose\": \"500\",\n \"doseForm\": \"500\"\n },\n {\n \"doseId\": \"16\",\n \"quantity\": 2,\n \"dose\": \"1000\",\n \"doseForm\": \"500\"\n },\n {\n \"doseId\": \"19\",\n \"quantity\": 1,\n \"dose\": \"1000\",\n \"doseForm\": \"1000\"\n },\n {\n \"doseId\": \"17\",\n \"quantity\": 3,\n \"dose\": \"1500\",\n \"doseForm\": \"500\"\n },\n {\n \"doseId\": \"18\",\n \"quantity\": 4,\n \"dose\": \"2000\",\n \"doseForm\": \"500\"\n },\n {\n \"doseId\": \"20\",\n \"quantity\": 2,\n \"dose\": \"2000\",\n \"doseForm\": \"1000\"\n }\n ],\n \"NDC\": [\n {\n \"fullCode\": \"68012-003\"\n },\n {\n \"fullCode\": \"68012-003-16\"\n },\n {\n \"fullCode\": \"68012-002\"\n },\n {\n \"fullCode\": \"68012-002-13\"\n },\n {\n \"fullCode\": \"68012-004\"\n },\n {\n \"fullCode\": \"68012-004-50\"\n }\n ]\n }\n ]\n }\n}"}],"_postman_id":"cafa6167-61f8-4d64-b8e5-c190f5a0a616"},{"name":"List Medications by Class","id":"1baacbbb-8f83-43e6-a8c4-ff2cf2615ef5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"DiasystSessionKey","value":"{{DiasystSessionKey}}","type":"text"},{"key":"DiasystAuthToken","value":"{{DiasystAuthToken}}","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"# This is a GraphQL query that retrieves medication information based on a given medication class ID.\n# The query takes a variable $medicationClassId of type ID as an input.\nquery medications ($medicationClassId: ID) {\n # The query retrieves the medications associated with the given medication class ID, and it limits the number of results.\n medications (medicationClassId:$medicationClassId, page:{limit: 2}) {\n # The query retrieves the medication ID, display name, generic name, and brand name of each medication.\n medicationId\n displayName\n genericName\n brandName\n # The query retrieves the medication class information, including the class ID and name, for each medication.\n classes {\n medicationClassId\n name\n }\n # The query retrieves the condition information, including the condition ID and name, for each medication.\n conditions {\n conditionId\n name\n }\n # The query retrieves the dose forms for each medication\n doseForms {\n doseForm\n }\n # The query retrieves the dose information, including the dose ID, quantity, dose, dose form, \n # with filter_duplicates set to false\n doses(filter_duplicates: false) {\n doseId\n quantity\n dose\n doseForm\n }\n # The query retrieves the NDC fullCode for each medication.\n NDC {\n fullCode\n }\n }\n}\n","variables":"{\n \"medicationClassId\":2\n}"}},"url":"{{url}}","description":"This query is similar to the previous one, but instead of retrieving medication information based on a given condition ID, it retrieves medication information based on a given medication class ID. The query takes a variable $medicationClassId of type ID as an input. The query retrieves the medications associated with the given medication class ID, and it limits the number of results to 2. The query retrieves the medication ID, display name, generic name, brand name, medication class information, condition information, dose forms, dose information, and NDC fullCode for each medication. Overall, this query enables the retrieval of detailed information about medications, including their names, classes, conditions, doses, and NDC codes, based on a specified medication class ID.
This query is similar to the previous ones, but instead of retrieving medication information based on a given condition ID or medication class ID, it retrieves medication information based on a given NDC code. The query takes a variable $medicationNDC of type String as an input. The query retrieves the medications associated with the given NDC code, and it limits the number of results to 2. The query retrieves the medication ID, display name, generic name, brand name, medication class information, condition information, dose forms, dose information, and NDC fullCode for each medication. Overall, this query enables the retrieval of detailed information about medications, including their names, classes, conditions, doses, and NDC codes, based on a specified NDC code.
This query is similar to the previous ones, but instead of retrieving medication information based on a given condition ID, medication class ID or NDC code, it retrieves medication information based on a given search term. The query takes a variable $searchTerm of type String as an input. The query retrieves the medications associated with the given search term, and it limits the number of results to 2. The query retrieves the medication ID, display name, generic name, brand name, medication class information, condition information, dose forms, dose information, and NDC fullCode for each medication. Overall, this query enables the retrieval of detailed information about medications, including their names, classes, conditions, doses, and NDC codes, based on a specified search term.
This query is different from the previous ones, as it retrieves detailed information about a specific medication based on its ID. The query takes a variable $medicationId of type ID! as an input, which means that the variable is non-nullable and must be passed a value. The query retrieves the medication associated with the given medication ID. The query retrieves the medication ID, display name, generic name, brand name, medication class information, condition information, dose forms, dose information, and NDC fullCode for the medication. Overall, this query enables the retrieval of detailed information about a specific medication based on its ID.
The RxLibrary service provides structured data for all supported medications in Diasyst, currently including all FDA-approved medications indicated for the management of type 2 diabetes and hypertension. Data includes medication brand names, generic names, classes, NDCs, and doses, which allows platforms to build UI to gather, track, and maintain medication records for their patient populations in a very structured manner. UI
can be provider/clinical staff-facing or patient/caregiver-facing.
For platforms that already track medications, RxLibrary is utilized as a mapping mechanism to translate your platform’s data structure to Diasyst’s, so that RxRecs and RxUI may be implemented.
\nThe base URL to send all API requests https://example.com will be provided by Diasyst. HTTPS is required for all API requests.
The Rx Library API follows GraphQL conventions when possible, with all operations performed via query or mutation.
camelCase.2020-08-12T02:12:33.231Z) while dates will include only the date (2020-08-12).The purpose of this query is to retrieve information about an account and the associated practices.
\nquery practice: this is the query's name, and it serves as an identifier for the query operation.account: This is the first field requested. It represents the root object in the query.providerId, firstName, lastName, phone: These are the fields of the account object being requested.practice: This is a nested field within the account object. It represents another object type with its own fields.practiceId, name, state: These are the fields of the practice object being requested.availablePractices: This is another nested field within the account object, representing a list of practice objects.description: This is a field of the availablePractices object.This query will retrieve the providerId, firstName, lastName, phone of the account object and the practiceId, name, state of the practice object. Additionally, it will retrieve the name, state, description and practiceId of all the availablePractices objects associated with the account.
The purpose of this query is to retrieve information about indicators.
\nquery Indicators: this is the query's name, and it serves as an identifier for the query operation.indicators: This is the first field requested. It represents the root object in the query.indicatorId, name, key, type: These are the fields of the indicators object being requested.This query will retrieve the indicatorId, name, key, and type of all the indicators objects.
The code is a GraphQL query that retrieves patient information. The query takes an optional parameter $needsAttention of type Boolean, which allows filtering of patients based on the needsAttention attribute. The query calls the patients field with the optional parameter needsAttention set to the passed in $needsAttention variable. The following fields are selected for each patient returned by the query: clientId, patientId, medicalRecord, firstName, lastName, and needsAttention.
This is a GraphQL mutation named recommendationGenerate that takes a required argument clientId of type ID.
This mutation generates a recommendation for a given client ID. It calls the recommendationGenerate mutation and returns information about the recommendation, including the recommendation ID, medication information, and prescribed dose information. The medications field contains information about each medication in the recommendation, including the medication's display name, generic name, and ID. The planDoses field contains information about each prescribed dose, including the daytime information, prescribed dose amount, and prescribed dose ID. The currentRevision field contains information about the current revision of the recommendation, including the creator, created date and time, medication information, and prescribed dose information for each medication in the current revision. The algorithmReference field contains information about the algorithm reference for the prescribed dose, including the page number, relevant text, file name, and disclaimer.
The mutation returns an object that includes the following fields:
\nrecommendationRevisionId: a string representing the ID of the recommendation revision.recommendationId: a string representing the ID of the recommendation.medications: an array of objects representing medications. Each object includes the following fields:medication: an object representing a medication, including the displayName, genericName, and medicationId.medicationId: a string representing the ID of the medication.planDoses: an array of objects representing the plan doses for the medication. Each object includes the following fields:daytime: an object representing the daytime of the dose, including the id and key.prescribed: an object representing the prescribed dose, including the dose and doseId.recommendation: an object representing the recommendation, including the following fields:recommendationId: a string representing the ID of the recommendation.created: a string representing the date the recommendation was created.creator: a string representing the ID of the user who created the recommendation.isRevised: a boolean indicating whether the recommendation has been revised.type: a string representing the type of recommendation.currentRevision: an object representing the current revision of the recommendation, including the following fields:creator: a string representing the ID of the user who created the current revision.created: a string representing the date the current revision was created.medications: an array of objects representing medications. Each object includes the following fields:medication: an object representing a medication, including the genericName, displayName, and medicationId.planDoses: an array of objects representing the plan doses for the medication. Each object includes the following fields:problem: a string representing the problem that the medication is intended to solve.rationale: a string representing the rationale for the medication.solution: an object representing the solution to the problem, including the medicationId, daytimeId, and dose.algorithmReference: an object representing a reference to the algorithm used to generate the recommendation, including the pageNumber, pdfPageNumber, relevantText, file, and disclaimer.