GP Bundle

Access details from the GP record

Medications - Repeat

Returns general practitioner repeat medications results associated with a patient record.

Request

Request URL

https://graphnet-api-nonprod.azure-api.net/gp/patients/{patientDetailId}/gp-medications/repeat[?sortByDate][&sortByRubric][&sortByLastIssuedDate][&sortByDosage][&sortByQuantity][&filterByDate][&filterByRubric][&filterByLastIssuedDate][&filterByDosage][&filterByQuantity][&pageSize][&pageNumber]

Request parameters

patientDetailId

string
sortByDate (optional)

string

Gets or sets the direction for sorting collection by Date.
sortByRubric (optional)

string

Gets or sets the direction for sorting collection by Rubric.
sortByLastIssuedDate (optional)

string

Gets or sets the direction for sorting collection by LastIssuedDate.
sortByDosage (optional)

string

Gets or sets the direction for sorting collection by Dosage.
sortByQuantity (optional)

string

Gets or sets the direction for sorting collection by Quantity.
filterByDate (optional)

string

Format - date-time (as date-time in RFC3339). Gets or sets the value for filtering collection by Date.
filterByRubric (optional)

string

Gets or sets the value for filtering collection by Rubric.
filterByLastIssuedDate (optional)

string

Format - date-time (as date-time in RFC3339). Gets or sets the value for filtering collection by LastIssuedDate.
filterByDosage (optional)

string

Gets or sets the value for filtering collection by Dosage.
filterByQuantity (optional)

string

Gets or sets the value for filtering collection by Quantity.
pageSize (optional)

integer

Format - int32.
pageNumber (optional)

integer

Format - int32.

Request headers

Ocp-Apim-Subscription-Key

string

Subscription key which provides access to this API. Found in your Profile.
Authorization

string

OAuth 2.0 access token obtained from CareCentric System Authorisation. Supported grant types: Client credentials.

Request body

Responses

200 OK

Successful operation

{
  "GpRepeatMedicationsList": [
    {
      "Date": "string",
      "ReadCode": "string",
      "Rubric": "string",
      "Quantity": "string",
      "Dosage": "string",
      "LastIssuedDate": "string",
      "Units": "string",
      "MixtureId": "string",
      "Constituent": "string",
      "TenancyDescription": "string"
    }
  ],
  "TotalItemCount": 0
}

{
  "type": "object",
  "properties": {
    "GpRepeatMedicationsList": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "Date": {
            "type": "string",
            "description": "Gets or sets the date value.",
            "format": "date-time"
          },
          "ReadCode": {
            "type": "string",
            "description": "Gets or sets the read code."
          },
          "Rubric": {
            "type": "string",
            "description": "Gets or sets the rubric."
          },
          "Quantity": {
            "type": "string",
            "description": "Gets or sets the Quantity."
          },
          "Dosage": {
            "type": "string",
            "description": "Gets or sets the Dosage."
          },
          "LastIssuedDate": {
            "type": "string",
            "description": "Gets or sets the Last Issued Date.",
            "format": "date-time"
          },
          "Units": {
            "type": "string",
            "description": "Gets or sets the Units."
          },
          "MixtureId": {
            "type": "string",
            "description": "Gets or sets the Mixture ID."
          },
          "Constituent": {
            "type": "string",
            "description": "Gets or sets the Constituent."
          },
          "TenancyDescription": {
            "type": "string",
            "description": "Gets or sets the tenancy description."
          }
        },
        "description": "General practitioner RepeatMedications information."
      },
      "description": "Gets or sets the general practitioner repeat medications list."
    },
    "TotalItemCount": {
      "type": "integer",
      "description": "Gets or sets the total item count.",
      "format": "int32"
    }
  },
  "description": "General practitioner Repeat Medications Result information."
}

Sample
Schema

{
  "GpRepeatMedicationsList": [
    {
      "Date": "string",
      "ReadCode": "string",
      "Rubric": "string",
      "Quantity": "string",
      "Dosage": "string",
      "LastIssuedDate": "string",
      "Units": "string",
      "MixtureId": "string",
      "Constituent": "string",
      "TenancyDescription": "string"
    }
  ],
  "TotalItemCount": 0
}

{
  "type": "object",
  "properties": {
    "GpRepeatMedicationsList": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "Date": {
            "type": "string",
            "description": "Gets or sets the date value.",
            "format": "date-time"
          },
          "ReadCode": {
            "type": "string",
            "description": "Gets or sets the read code."
          },
          "Rubric": {
            "type": "string",
            "description": "Gets or sets the rubric."
          },
          "Quantity": {
            "type": "string",
            "description": "Gets or sets the Quantity."
          },
          "Dosage": {
            "type": "string",
            "description": "Gets or sets the Dosage."
          },
          "LastIssuedDate": {
            "type": "string",
            "description": "Gets or sets the Last Issued Date.",
            "format": "date-time"
          },
          "Units": {
            "type": "string",
            "description": "Gets or sets the Units."
          },
          "MixtureId": {
            "type": "string",
            "description": "Gets or sets the Mixture ID."
          },
          "Constituent": {
            "type": "string",
            "description": "Gets or sets the Constituent."
          },
          "TenancyDescription": {
            "type": "string",
            "description": "Gets or sets the tenancy description."
          }
        },
        "description": "General practitioner RepeatMedications information."
      },
      "description": "Gets or sets the general practitioner repeat medications list."
    },
    "TotalItemCount": {
      "type": "integer",
      "description": "Gets or sets the total item count.",
      "format": "int32"
    }
  },
  "description": "General practitioner Repeat Medications Result information."
}

Sample
Schema

<GPRepeatMedications.Models.GpRepeatMedicationsResult>
  <GpRepeatMedicationsList>
    <Date>string</Date>
    <ReadCode>string</ReadCode>
    <Rubric>string</Rubric>
    <Quantity>string</Quantity>
    <Dosage>string</Dosage>
    <LastIssuedDate>string</LastIssuedDate>
    <Units>string</Units>
    <MixtureId>string</MixtureId>
    <Constituent>string</Constituent>
    <TenancyDescription>string</TenancyDescription>
  </GpRepeatMedicationsList>
  <TotalItemCount>0</TotalItemCount>
</GPRepeatMedications.Models.GpRepeatMedicationsResult>

{
  "type": "object",
  "properties": {
    "GpRepeatMedicationsList": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "Date": {
            "type": "string",
            "description": "Gets or sets the date value.",
            "format": "date-time"
          },
          "ReadCode": {
            "type": "string",
            "description": "Gets or sets the read code."
          },
          "Rubric": {
            "type": "string",
            "description": "Gets or sets the rubric."
          },
          "Quantity": {
            "type": "string",
            "description": "Gets or sets the Quantity."
          },
          "Dosage": {
            "type": "string",
            "description": "Gets or sets the Dosage."
          },
          "LastIssuedDate": {
            "type": "string",
            "description": "Gets or sets the Last Issued Date.",
            "format": "date-time"
          },
          "Units": {
            "type": "string",
            "description": "Gets or sets the Units."
          },
          "MixtureId": {
            "type": "string",
            "description": "Gets or sets the Mixture ID."
          },
          "Constituent": {
            "type": "string",
            "description": "Gets or sets the Constituent."
          },
          "TenancyDescription": {
            "type": "string",
            "description": "Gets or sets the tenancy description."
          }
        },
        "description": "General practitioner RepeatMedications information."
      },
      "description": "Gets or sets the general practitioner repeat medications list."
    },
    "TotalItemCount": {
      "type": "integer",
      "description": "Gets or sets the total item count.",
      "format": "int32"
    }
  },
  "description": "General practitioner Repeat Medications Result information."
}

Sample
Schema

<GPRepeatMedications.Models.GpRepeatMedicationsResult>
  <GpRepeatMedicationsList>
    <Date>string</Date>
    <ReadCode>string</ReadCode>
    <Rubric>string</Rubric>
    <Quantity>string</Quantity>
    <Dosage>string</Dosage>
    <LastIssuedDate>string</LastIssuedDate>
    <Units>string</Units>
    <MixtureId>string</MixtureId>
    <Constituent>string</Constituent>
    <TenancyDescription>string</TenancyDescription>
  </GpRepeatMedicationsList>
  <TotalItemCount>0</TotalItemCount>
</GPRepeatMedications.Models.GpRepeatMedicationsResult>

{
  "type": "object",
  "properties": {
    "GpRepeatMedicationsList": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "Date": {
            "type": "string",
            "description": "Gets or sets the date value.",
            "format": "date-time"
          },
          "ReadCode": {
            "type": "string",
            "description": "Gets or sets the read code."
          },
          "Rubric": {
            "type": "string",
            "description": "Gets or sets the rubric."
          },
          "Quantity": {
            "type": "string",
            "description": "Gets or sets the Quantity."
          },
          "Dosage": {
            "type": "string",
            "description": "Gets or sets the Dosage."
          },
          "LastIssuedDate": {
            "type": "string",
            "description": "Gets or sets the Last Issued Date.",
            "format": "date-time"
          },
          "Units": {
            "type": "string",
            "description": "Gets or sets the Units."
          },
          "MixtureId": {
            "type": "string",
            "description": "Gets or sets the Mixture ID."
          },
          "Constituent": {
            "type": "string",
            "description": "Gets or sets the Constituent."
          },
          "TenancyDescription": {
            "type": "string",
            "description": "Gets or sets the tenancy description."
          }
        },
        "description": "General practitioner RepeatMedications information."
      },
      "description": "Gets or sets the general practitioner repeat medications list."
    },
    "TotalItemCount": {
      "type": "integer",
      "description": "Gets or sets the total item count.",
      "format": "int32"
    }
  },
  "description": "General practitioner Repeat Medications Result information."
}

400 Bad Request

Invalid parameter supplied

Representations

401 Unauthorized

Invalid credentials supplied

Representations

404 Not Found

Specified entity was not found or access denied

Representations

Code samples

@ECHO OFF

curl -v -X GET "https://graphnet-api-nonprod.azure-api.net/gp/patients/{patientDetailId}/gp-medications/repeat?sortByDate={string}&sortByRubric={string}&sortByLastIssuedDate={string}&sortByDosage={string}&sortByQuantity={string}&filterByDate={string}&filterByRubric={string}&filterByLastIssuedDate={string}&filterByDosage={string}&filterByQuantity={string}&pageSize={integer}&pageNumber={integer}"
-H "Ocp-Apim-Subscription-Key: {subscription key}"
-H "Authorization: {access token}"

--data-ascii "{body}"

using System;
using System.Net.Http.Headers;
using System.Text;
using System.Net.Http;
using System.Web;

namespace CSHttpClientSample
{
    static class Program
    {
        static void Main()
        {
            MakeRequest();
            Console.WriteLine("Hit ENTER to exit...");
            Console.ReadLine();
        }
        
        static async void MakeRequest()
        {
            var client = new HttpClient();
            var queryString = HttpUtility.ParseQueryString(string.Empty);

            // Request headers
            client.DefaultRequestHeaders.Add("Ocp-Apim-Subscription-Key", "{subscription key}");
            client.DefaultRequestHeaders.Add("Authorization", "{access token}");

            // Request parameters
            queryString["sortByDate"] = "{string}";
            queryString["sortByRubric"] = "{string}";
            queryString["sortByLastIssuedDate"] = "{string}";
            queryString["sortByDosage"] = "{string}";
            queryString["sortByQuantity"] = "{string}";
            queryString["filterByDate"] = "{string}";
            queryString["filterByRubric"] = "{string}";
            queryString["filterByLastIssuedDate"] = "{string}";
            queryString["filterByDosage"] = "{string}";
            queryString["filterByQuantity"] = "{string}";
            queryString["pageSize"] = "{integer}";
            queryString["pageNumber"] = "{integer}";
            var uri = "https://graphnet-api-nonprod.azure-api.net/gp/patients/{patientDetailId}/gp-medications/repeat?" + queryString;

            var response = await client.GetAsync(uri);
        }
    }
}

// // This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
import java.net.URI;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;

public class JavaSample 
{
    public static void main(String[] args) 
    {
        HttpClient httpclient = HttpClients.createDefault();

        try
        {
            URIBuilder builder = new URIBuilder("https://graphnet-api-nonprod.azure-api.net/gp/patients/{patientDetailId}/gp-medications/repeat");

            builder.setParameter("sortByDate", "{string}");
            builder.setParameter("sortByRubric", "{string}");
            builder.setParameter("sortByLastIssuedDate", "{string}");
            builder.setParameter("sortByDosage", "{string}");
            builder.setParameter("sortByQuantity", "{string}");
            builder.setParameter("filterByDate", "{string}");
            builder.setParameter("filterByRubric", "{string}");
            builder.setParameter("filterByLastIssuedDate", "{string}");
            builder.setParameter("filterByDosage", "{string}");
            builder.setParameter("filterByQuantity", "{string}");
            builder.setParameter("pageSize", "{integer}");
            builder.setParameter("pageNumber", "{integer}");

            URI uri = builder.build();
            HttpGet request = new HttpGet(uri);
            request.setHeader("Ocp-Apim-Subscription-Key", "{subscription key}");
            request.setHeader("Authorization", "{access token}");


            // Request body
            StringEntity reqEntity = new StringEntity("{body}");
            request.setEntity(reqEntity);

            HttpResponse response = httpclient.execute(request);
            HttpEntity entity = response.getEntity();

            if (entity != null) 
            {
                System.out.println(EntityUtils.toString(entity));
            }
        }
        catch (Exception e)
        {
            System.out.println(e.getMessage());
        }
    }
}

<!DOCTYPE html>
<html>
<head>
    <title>JSSample</title>
    <script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
</head>
<body>

<script type="text/javascript">
    $(function() {
        var params = {
            // Request parameters
            "sortByDate": "{string}",
            "sortByRubric": "{string}",
            "sortByLastIssuedDate": "{string}",
            "sortByDosage": "{string}",
            "sortByQuantity": "{string}",
            "filterByDate": "{string}",
            "filterByRubric": "{string}",
            "filterByLastIssuedDate": "{string}",
            "filterByDosage": "{string}",
            "filterByQuantity": "{string}",
            "pageSize": "{integer}",
            "pageNumber": "{integer}",
        };
      
        $.ajax({
            url: "https://graphnet-api-nonprod.azure-api.net/gp/patients/{patientDetailId}/gp-medications/repeat?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
                xhrObj.setRequestHeader("Authorization","{access token}");
            },
            type: "GET",
            // Request body
            data: "{body}",
        })
        .done(function(data) {
            alert("success");
        })
        .fail(function() {
            alert("error");
        });
    });
</script>
</body>
</html>

#import <Foundation/Foundation.h>

int main(int argc, const char * argv[])
{
    NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
    
    NSString* path = @"https://graphnet-api-nonprod.azure-api.net/gp/patients/{patientDetailId}/gp-medications/repeat";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                         @"sortByDate={string}",
                         @"sortByRubric={string}",
                         @"sortByLastIssuedDate={string}",
                         @"sortByDosage={string}",
                         @"sortByQuantity={string}",
                         @"filterByDate={string}",
                         @"filterByRubric={string}",
                         @"filterByLastIssuedDate={string}",
                         @"filterByDosage={string}",
                         @"filterByQuantity={string}",
                         @"pageSize={integer}",
                         @"pageNumber={integer}",
                      ];
    
    NSString* string = [array componentsJoinedByString:@"&"];
    path = [path stringByAppendingFormat:@"?%@", string];

    NSLog(@"%@", path);

    NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
    [_request setHTTPMethod:@"GET"];
    // Request headers
    [_request setValue:@"{subscription key}" forHTTPHeaderField:@"Ocp-Apim-Subscription-Key"];
    [_request setValue:@"{access token}" forHTTPHeaderField:@"Authorization"];
    // Request body
    [_request setHTTPBody:[@"{body}" dataUsingEncoding:NSUTF8StringEncoding]];
    
    NSURLResponse *response = nil;
    NSError *error = nil;
    NSData* _connectionData = [NSURLConnection sendSynchronousRequest:_request returningResponse:&response error:&error];

    if (nil != error)
    {
        NSLog(@"Error: %@", error);
    }
    else
    {
        NSError* error = nil;
        NSMutableDictionary* json = nil;
        NSString* dataString = [[NSString alloc] initWithData:_connectionData encoding:NSUTF8StringEncoding];
        NSLog(@"%@", dataString);
        
        if (nil != _connectionData)
        {
            json = [NSJSONSerialization JSONObjectWithData:_connectionData options:NSJSONReadingMutableContainers error:&error];
        }
        
        if (error || !json)
        {
            NSLog(@"Could not parse loaded json with error:%@", error);
        }
        
        NSLog(@"%@", json);
        _connectionData = nil;
    }
    
    [pool drain];

    return 0;
}

<?php
// This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
require_once 'HTTP/Request2.php';

$request = new Http_Request2('https://graphnet-api-nonprod.azure-api.net/gp/patients/{patientDetailId}/gp-medications/repeat');
$url = $request->getUrl();

$headers = array(
    // Request headers
    'Ocp-Apim-Subscription-Key' => '{subscription key}',
    'Authorization' => '{access token}',
);

$request->setHeader($headers);

$parameters = array(
    // Request parameters
    'sortByDate' => '{string}',
    'sortByRubric' => '{string}',
    'sortByLastIssuedDate' => '{string}',
    'sortByDosage' => '{string}',
    'sortByQuantity' => '{string}',
    'filterByDate' => '{string}',
    'filterByRubric' => '{string}',
    'filterByLastIssuedDate' => '{string}',
    'filterByDosage' => '{string}',
    'filterByQuantity' => '{string}',
    'pageSize' => '{integer}',
    'pageNumber' => '{integer}',
);

$url->setQueryVariables($parameters);

$request->setMethod(HTTP_Request2::METHOD_GET);

// Request body
$request->setBody("{body}");

try
{
    $response = $request->send();
    echo $response->getBody();
}
catch (HttpException $ex)
{
    echo $ex;
}

?>

########### Python 2.7 #############
import httplib, urllib, base64

headers = {
    # Request headers
    'Ocp-Apim-Subscription-Key': '{subscription key}',
    'Authorization': '{access token}',
}

params = urllib.urlencode({
    # Request parameters
    'sortByDate': '{string}',
    'sortByRubric': '{string}',
    'sortByLastIssuedDate': '{string}',
    'sortByDosage': '{string}',
    'sortByQuantity': '{string}',
    'filterByDate': '{string}',
    'filterByRubric': '{string}',
    'filterByLastIssuedDate': '{string}',
    'filterByDosage': '{string}',
    'filterByQuantity': '{string}',
    'pageSize': '{integer}',
    'pageNumber': '{integer}',
})

try:
    conn = httplib.HTTPSConnection('graphnet-api-nonprod.azure-api.net')
    conn.request("GET", "/gp/patients/{patientDetailId}/gp-medications/repeat?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################

########### Python 3.2 #############
import http.client, urllib.request, urllib.parse, urllib.error, base64

headers = {
    # Request headers
    'Ocp-Apim-Subscription-Key': '{subscription key}',
    'Authorization': '{access token}',
}

params = urllib.parse.urlencode({
    # Request parameters
    'sortByDate': '{string}',
    'sortByRubric': '{string}',
    'sortByLastIssuedDate': '{string}',
    'sortByDosage': '{string}',
    'sortByQuantity': '{string}',
    'filterByDate': '{string}',
    'filterByRubric': '{string}',
    'filterByLastIssuedDate': '{string}',
    'filterByDosage': '{string}',
    'filterByQuantity': '{string}',
    'pageSize': '{integer}',
    'pageNumber': '{integer}',
})

try:
    conn = http.client.HTTPSConnection('graphnet-api-nonprod.azure-api.net')
    conn.request("GET", "/gp/patients/{patientDetailId}/gp-medications/repeat?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################

require 'net/http'

uri = URI('https://graphnet-api-nonprod.azure-api.net/gp/patients/{patientDetailId}/gp-medications/repeat')

query = URI.encode_www_form({
    # Request parameters
    'sortByDate' => '{string}',
    'sortByRubric' => '{string}',
    'sortByLastIssuedDate' => '{string}',
    'sortByDosage' => '{string}',
    'sortByQuantity' => '{string}',
    'filterByDate' => '{string}',
    'filterByRubric' => '{string}',
    'filterByLastIssuedDate' => '{string}',
    'filterByDosage' => '{string}',
    'filterByQuantity' => '{string}',
    'pageSize' => '{integer}',
    'pageNumber' => '{integer}'
})
if query.length > 0
  if uri.query && uri.query.length > 0
    uri.query += '&' + query
  else
    uri.query = query
  end
end

request = Net::HTTP::Get.new(uri.request_uri)
# Request headers
request['Ocp-Apim-Subscription-Key'] = '{subscription key}'
# Request headers
request['Authorization'] = '{access token}'
# Request body
request.body = "{body}"

response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
    http.request(request)
end

puts response.body