Demographics Bundle

API change history

Search for patients and retrieve demographic data

Find Patient

Searches for patient using the specified criteria.

Try it

Request

Request URL

https://graphnet-api-nonprod.azure-api.net/demographics/patients/search

Request headers

Content-Type (optional)

string

Media type of the body sent to the API.
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.

{
  "AllTenancies": true,
  "Surname": "Heritage"
}

{
  "description": "The search criteria.",
  "type": "object",
  "properties": {
    "AllDemographics": {
      "description": "Gets or sets a value indicating whether [all demographics].",
      "type": "boolean"
    },
    "AllTenancies": {
      "description": "Gets or sets All tenancies.",
      "type": "boolean"
    },
    "DateOfBirth": {
      "description": "Gets or sets the date of birth.",
      "type": "string"
    },
    "Forename": {
      "description": "Gets or sets The forename.",
      "type": "string"
    },
    "Gender": {
      "description": "Gets or sets The gender.",
      "type": "string"
    },
    "GPCode": {
      "description": "Gets or sets The general practitioner code.",
      "type": "string"
    },
    "GPPracticeCode": {
      "description": "Gets or sets The general practitioner practice code.",
      "type": "string"
    },
    "NhsNumber": {
      "description": "Gets or sets The national hospital service number.",
      "type": "string"
    },
    "PageNumber": {
      "format": "int32",
      "description": "Gets or sets the page number.",
      "type": "integer"
    },
    "PageSize": {
      "format": "int32",
      "description": "Gets or sets The page size.",
      "type": "integer"
    },
    "PatientListId": {
      "format": "int32",
      "description": "Gets or sets The patient list identifier.",
      "type": "integer"
    },
    "PatientNumber": {
      "description": "Gets or sets The patient number.",
      "type": "string"
    },
    "PatientTenancyId": {
      "format": "int32",
      "description": "Gets or sets The patient tenancy identifier.",
      "type": "integer"
    },
    "PostCode": {
      "description": "Gets or sets The post code.",
      "type": "string"
    },
    "RetrieveMinorNumbers": {
      "description": "Gets or sets The retrieve minor numbers.",
      "type": "boolean"
    },
    "Surname": {
      "description": "Gets or sets The surname.",
      "type": "string"
    }
  }
}

Sample
Schema

{
  "AllDemographics": true,
  "AllTenancies": true,
  "DateOfBirth": "string",
  "Forename": "string",
  "Gender": "string",
  "GPCode": "string",
  "GPPracticeCode": "string",
  "NhsNumber": "string",
  "PageNumber": 0,
  "PageSize": 0,
  "PatientListId": 0,
  "PatientNumber": "string",
  "PatientTenancyId": 0,
  "PostCode": "string",
  "RetrieveMinorNumbers": true,
  "Surname": "string"
}

{
  "description": "The search criteria.",
  "type": "object",
  "properties": {
    "AllDemographics": {
      "description": "Gets or sets a value indicating whether [all demographics].",
      "type": "boolean"
    },
    "AllTenancies": {
      "description": "Gets or sets All tenancies.",
      "type": "boolean"
    },
    "DateOfBirth": {
      "description": "Gets or sets the date of birth.",
      "type": "string"
    },
    "Forename": {
      "description": "Gets or sets The forename.",
      "type": "string"
    },
    "Gender": {
      "description": "Gets or sets The gender.",
      "type": "string"
    },
    "GPCode": {
      "description": "Gets or sets The general practitioner code.",
      "type": "string"
    },
    "GPPracticeCode": {
      "description": "Gets or sets The general practitioner practice code.",
      "type": "string"
    },
    "NhsNumber": {
      "description": "Gets or sets The national hospital service number.",
      "type": "string"
    },
    "PageNumber": {
      "format": "int32",
      "description": "Gets or sets the page number.",
      "type": "integer"
    },
    "PageSize": {
      "format": "int32",
      "description": "Gets or sets The page size.",
      "type": "integer"
    },
    "PatientListId": {
      "format": "int32",
      "description": "Gets or sets The patient list identifier.",
      "type": "integer"
    },
    "PatientNumber": {
      "description": "Gets or sets The patient number.",
      "type": "string"
    },
    "PatientTenancyId": {
      "format": "int32",
      "description": "Gets or sets The patient tenancy identifier.",
      "type": "integer"
    },
    "PostCode": {
      "description": "Gets or sets The post code.",
      "type": "string"
    },
    "RetrieveMinorNumbers": {
      "description": "Gets or sets The retrieve minor numbers.",
      "type": "boolean"
    },
    "Surname": {
      "description": "Gets or sets The surname.",
      "type": "string"
    }
  }
}

Sample
Schema

<PatientSearch.Models.SearchCriteria>
  <AllDemographics>true</AllDemographics>
  <AllTenancies>true</AllTenancies>
  <DateOfBirth>string</DateOfBirth>
  <Forename>string</Forename>
  <Gender>string</Gender>
  <GPCode>string</GPCode>
  <GPPracticeCode>string</GPPracticeCode>
  <NhsNumber>string</NhsNumber>
  <PageNumber>0</PageNumber>
  <PageSize>0</PageSize>
  <PatientListId>0</PatientListId>
  <PatientNumber>string</PatientNumber>
  <PatientTenancyId>0</PatientTenancyId>
  <PostCode>string</PostCode>
  <RetrieveMinorNumbers>true</RetrieveMinorNumbers>
  <Surname>string</Surname>
</PatientSearch.Models.SearchCriteria>

{
  "description": "The search criteria.",
  "type": "object",
  "properties": {
    "AllDemographics": {
      "description": "Gets or sets a value indicating whether [all demographics].",
      "type": "boolean"
    },
    "AllTenancies": {
      "description": "Gets or sets All tenancies.",
      "type": "boolean"
    },
    "DateOfBirth": {
      "description": "Gets or sets the date of birth.",
      "type": "string"
    },
    "Forename": {
      "description": "Gets or sets The forename.",
      "type": "string"
    },
    "Gender": {
      "description": "Gets or sets The gender.",
      "type": "string"
    },
    "GPCode": {
      "description": "Gets or sets The general practitioner code.",
      "type": "string"
    },
    "GPPracticeCode": {
      "description": "Gets or sets The general practitioner practice code.",
      "type": "string"
    },
    "NhsNumber": {
      "description": "Gets or sets The national hospital service number.",
      "type": "string"
    },
    "PageNumber": {
      "format": "int32",
      "description": "Gets or sets the page number.",
      "type": "integer"
    },
    "PageSize": {
      "format": "int32",
      "description": "Gets or sets The page size.",
      "type": "integer"
    },
    "PatientListId": {
      "format": "int32",
      "description": "Gets or sets The patient list identifier.",
      "type": "integer"
    },
    "PatientNumber": {
      "description": "Gets or sets The patient number.",
      "type": "string"
    },
    "PatientTenancyId": {
      "format": "int32",
      "description": "Gets or sets The patient tenancy identifier.",
      "type": "integer"
    },
    "PostCode": {
      "description": "Gets or sets The post code.",
      "type": "string"
    },
    "RetrieveMinorNumbers": {
      "description": "Gets or sets The retrieve minor numbers.",
      "type": "boolean"
    },
    "Surname": {
      "description": "Gets or sets The surname.",
      "type": "string"
    }
  }
}

Sample
Schema

<PatientSearch.Models.SearchCriteria>
  <AllDemographics>true</AllDemographics>
  <AllTenancies>true</AllTenancies>
  <DateOfBirth>string</DateOfBirth>
  <Forename>string</Forename>
  <Gender>string</Gender>
  <GPCode>string</GPCode>
  <GPPracticeCode>string</GPPracticeCode>
  <NhsNumber>string</NhsNumber>
  <PageNumber>0</PageNumber>
  <PageSize>0</PageSize>
  <PatientListId>0</PatientListId>
  <PatientNumber>string</PatientNumber>
  <PatientTenancyId>0</PatientTenancyId>
  <PostCode>string</PostCode>
  <RetrieveMinorNumbers>true</RetrieveMinorNumbers>
  <Surname>string</Surname>
</PatientSearch.Models.SearchCriteria>

{
  "description": "The search criteria.",
  "type": "object",
  "properties": {
    "AllDemographics": {
      "description": "Gets or sets a value indicating whether [all demographics].",
      "type": "boolean"
    },
    "AllTenancies": {
      "description": "Gets or sets All tenancies.",
      "type": "boolean"
    },
    "DateOfBirth": {
      "description": "Gets or sets the date of birth.",
      "type": "string"
    },
    "Forename": {
      "description": "Gets or sets The forename.",
      "type": "string"
    },
    "Gender": {
      "description": "Gets or sets The gender.",
      "type": "string"
    },
    "GPCode": {
      "description": "Gets or sets The general practitioner code.",
      "type": "string"
    },
    "GPPracticeCode": {
      "description": "Gets or sets The general practitioner practice code.",
      "type": "string"
    },
    "NhsNumber": {
      "description": "Gets or sets The national hospital service number.",
      "type": "string"
    },
    "PageNumber": {
      "format": "int32",
      "description": "Gets or sets the page number.",
      "type": "integer"
    },
    "PageSize": {
      "format": "int32",
      "description": "Gets or sets The page size.",
      "type": "integer"
    },
    "PatientListId": {
      "format": "int32",
      "description": "Gets or sets The patient list identifier.",
      "type": "integer"
    },
    "PatientNumber": {
      "description": "Gets or sets The patient number.",
      "type": "string"
    },
    "PatientTenancyId": {
      "format": "int32",
      "description": "Gets or sets The patient tenancy identifier.",
      "type": "integer"
    },
    "PostCode": {
      "description": "Gets or sets The post code.",
      "type": "string"
    },
    "RetrieveMinorNumbers": {
      "description": "Gets or sets The retrieve minor numbers.",
      "type": "boolean"
    },
    "Surname": {
      "description": "Gets or sets The surname.",
      "type": "string"
    }
  }
}

Responses

200 OK

Successful operation

Representations

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 POST "https://graphnet-api-nonprod.azure-api.net/demographics/patients/search"
-H "Content-Type: application/json"
-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}");

            var uri = "https://graphnet-api-nonprod.azure-api.net/demographics/patients/search?" + queryString;

            HttpResponseMessage response;

            // Request body
            byte[] byteData = Encoding.UTF8.GetBytes("{body}");

            using (var content = new ByteArrayContent(byteData))
            {
               content.Headers.ContentType = new MediaTypeHeaderValue("< your content type, i.e. application/json >");
               response = await client.PostAsync(uri, content);
            }

        }
    }
}

// // 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/demographics/patients/search");


            URI uri = builder.build();
            HttpPost request = new HttpPost(uri);
            request.setHeader("Content-Type", "application/json");
            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
        };
      
        $.ajax({
            url: "https://graphnet-api-nonprod.azure-api.net/demographics/patients/search?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("Content-Type","application/json");
                xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
                xhrObj.setRequestHeader("Authorization","{access token}");
            },
            type: "POST",
            // 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/demographics/patients/search";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                      ];
    
    NSString* string = [array componentsJoinedByString:@"&"];
    path = [path stringByAppendingFormat:@"?%@", string];

    NSLog(@"%@", path);

    NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
    [_request setHTTPMethod:@"POST"];
    // Request headers
    [_request setValue:@"application/json" forHTTPHeaderField:@"Content-Type"];
    [_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/demographics/patients/search');
$url = $request->getUrl();

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

$request->setHeader($headers);

$parameters = array(
    // Request parameters
);

$url->setQueryVariables($parameters);

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

// 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
    'Content-Type': 'application/json',
    'Ocp-Apim-Subscription-Key': '{subscription key}',
    'Authorization': '{access token}',
}

params = urllib.urlencode({
})

try:
    conn = httplib.HTTPSConnection('graphnet-api-nonprod.azure-api.net')
    conn.request("POST", "/demographics/patients/search?%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
    'Content-Type': 'application/json',
    'Ocp-Apim-Subscription-Key': '{subscription key}',
    'Authorization': '{access token}',
}

params = urllib.parse.urlencode({
})

try:
    conn = http.client.HTTPSConnection('graphnet-api-nonprod.azure-api.net')
    conn.request("POST", "/demographics/patients/search?%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/demographics/patients/search')


request = Net::HTTP::Post.new(uri.request_uri)
# Request headers
request['Content-Type'] = 'application/json'
# 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