Community Mental Health Bundle

API change history

Retrieve Community Mental Health Data

Care Plan - Summary

Gets the Community Mental Health Care Plans Summary.

Try it

Request

Request URL

Request parameters

  • string

Request headers

  • string
    Subscription key which provides access to this API. Found in your Profile.
  • string
    OAuth 2.0 access token obtained from CareCentric OAuth2 Server. Supported grant types: Resource owner password.

Request body

Responses

200 OK

Successful operation

Representations

{
  "Summary": {
    "ActiveCarePlanCount": 0,
    "HistoricCarePlans6MonthsCount": 0,
    "HistoricCarePlansCount": 0,
    "LatestDate": "string"
  },
  "CarePlanCollection": [
    {
      "UpdatedDate": "string",
      "CarePlanType": "string",
      "CarePlanDescription": "string",
      "StartDate": "string",
      "CarePlanID": "string",
      "TenancyDescription": "string"
    }
  ]
}
{
  "description": "The store community mental health care plans response.",
  "type": "object",
  "properties": {
    "Summary": {
      "description": "Gets or sets The Summary result.",
      "type": "object",
      "properties": {
        "ActiveCarePlanCount": {
          "format": "int32",
          "description": "Gets or sets the active care plan count.",
          "type": "integer"
        },
        "HistoricCarePlans6MonthsCount": {
          "format": "int32",
          "description": "Gets or sets the historic care plans6 months count.",
          "type": "integer"
        },
        "HistoricCarePlansCount": {
          "format": "int32",
          "description": "Gets or sets the historic care plans count.",
          "type": "integer"
        },
        "LatestDate": {
          "format": "date-time",
          "description": "Gets or sets the latest date.",
          "type": "string"
        }
      }
    },
    "CarePlanCollection": {
      "description": "Gets or sets Care Plans Collection.",
      "type": "array",
      "items": {
        "description": "The Care Plan.",
        "type": "object",
        "properties": {
          "UpdatedDate": {
            "format": "date-time",
            "description": "Gets or sets This is the date and time this record was last updated in the source system.\r\nIf this can’t be provided then it should be populated with the\r\ndate and time the record is extracted.",
            "type": "string"
          },
          "CarePlanType": {
            "description": "Gets or sets Care plan type e.g. CPA care Plan, Crisis Plan.",
            "type": "string"
          },
          "CarePlanDescription": {
            "description": "Gets or sets Care Plan type description.",
            "type": "string"
          },
          "StartDate": {
            "format": "date-time",
            "description": "Gets or sets Date Care plan initiated.",
            "type": "string"
          },
          "CarePlanID": {
            "description": "Gets or sets Unique identifier for this Care Plan.",
            "type": "string"
          },
          "TenancyDescription": {
            "description": "Gets or sets Tenancy Description.",
            "type": "string"
          }
        }
      }
    }
  }
}
{
  "Summary": {
    "ActiveCarePlanCount": 0,
    "HistoricCarePlans6MonthsCount": 0,
    "HistoricCarePlansCount": 0,
    "LatestDate": "string"
  },
  "CarePlanCollection": [
    {
      "UpdatedDate": "string",
      "CarePlanType": "string",
      "CarePlanDescription": "string",
      "StartDate": "string",
      "CarePlanID": "string",
      "TenancyDescription": "string"
    }
  ]
}
{
  "description": "The store community mental health care plans response.",
  "type": "object",
  "properties": {
    "Summary": {
      "description": "Gets or sets The Summary result.",
      "type": "object",
      "properties": {
        "ActiveCarePlanCount": {
          "format": "int32",
          "description": "Gets or sets the active care plan count.",
          "type": "integer"
        },
        "HistoricCarePlans6MonthsCount": {
          "format": "int32",
          "description": "Gets or sets the historic care plans6 months count.",
          "type": "integer"
        },
        "HistoricCarePlansCount": {
          "format": "int32",
          "description": "Gets or sets the historic care plans count.",
          "type": "integer"
        },
        "LatestDate": {
          "format": "date-time",
          "description": "Gets or sets the latest date.",
          "type": "string"
        }
      }
    },
    "CarePlanCollection": {
      "description": "Gets or sets Care Plans Collection.",
      "type": "array",
      "items": {
        "description": "The Care Plan.",
        "type": "object",
        "properties": {
          "UpdatedDate": {
            "format": "date-time",
            "description": "Gets or sets This is the date and time this record was last updated in the source system.\r\nIf this can’t be provided then it should be populated with the\r\ndate and time the record is extracted.",
            "type": "string"
          },
          "CarePlanType": {
            "description": "Gets or sets Care plan type e.g. CPA care Plan, Crisis Plan.",
            "type": "string"
          },
          "CarePlanDescription": {
            "description": "Gets or sets Care Plan type description.",
            "type": "string"
          },
          "StartDate": {
            "format": "date-time",
            "description": "Gets or sets Date Care plan initiated.",
            "type": "string"
          },
          "CarePlanID": {
            "description": "Gets or sets Unique identifier for this Care Plan.",
            "type": "string"
          },
          "TenancyDescription": {
            "description": "Gets or sets Tenancy Description.",
            "type": "string"
          }
        }
      }
    }
  }
}
<RIOCommunity.Models.CommunityMentalHealthCarePlans.CommunityMentalHealthCarePlansResponse>
  <Summary>
    <ActiveCarePlanCount>0</ActiveCarePlanCount>
    <HistoricCarePlans6MonthsCount>0</HistoricCarePlans6MonthsCount>
    <HistoricCarePlansCount>0</HistoricCarePlansCount>
    <LatestDate>string</LatestDate>
  </Summary>
  <CarePlanCollection>
    <UpdatedDate>string</UpdatedDate>
    <CarePlanType>string</CarePlanType>
    <CarePlanDescription>string</CarePlanDescription>
    <StartDate>string</StartDate>
    <CarePlanID>string</CarePlanID>
    <TenancyDescription>string</TenancyDescription>
  </CarePlanCollection>
</RIOCommunity.Models.CommunityMentalHealthCarePlans.CommunityMentalHealthCarePlansResponse>
{
  "description": "The store community mental health care plans response.",
  "type": "object",
  "properties": {
    "Summary": {
      "description": "Gets or sets The Summary result.",
      "type": "object",
      "properties": {
        "ActiveCarePlanCount": {
          "format": "int32",
          "description": "Gets or sets the active care plan count.",
          "type": "integer"
        },
        "HistoricCarePlans6MonthsCount": {
          "format": "int32",
          "description": "Gets or sets the historic care plans6 months count.",
          "type": "integer"
        },
        "HistoricCarePlansCount": {
          "format": "int32",
          "description": "Gets or sets the historic care plans count.",
          "type": "integer"
        },
        "LatestDate": {
          "format": "date-time",
          "description": "Gets or sets the latest date.",
          "type": "string"
        }
      }
    },
    "CarePlanCollection": {
      "description": "Gets or sets Care Plans Collection.",
      "type": "array",
      "items": {
        "description": "The Care Plan.",
        "type": "object",
        "properties": {
          "UpdatedDate": {
            "format": "date-time",
            "description": "Gets or sets This is the date and time this record was last updated in the source system.\r\nIf this can’t be provided then it should be populated with the\r\ndate and time the record is extracted.",
            "type": "string"
          },
          "CarePlanType": {
            "description": "Gets or sets Care plan type e.g. CPA care Plan, Crisis Plan.",
            "type": "string"
          },
          "CarePlanDescription": {
            "description": "Gets or sets Care Plan type description.",
            "type": "string"
          },
          "StartDate": {
            "format": "date-time",
            "description": "Gets or sets Date Care plan initiated.",
            "type": "string"
          },
          "CarePlanID": {
            "description": "Gets or sets Unique identifier for this Care Plan.",
            "type": "string"
          },
          "TenancyDescription": {
            "description": "Gets or sets Tenancy Description.",
            "type": "string"
          }
        }
      }
    }
  }
}
<RIOCommunity.Models.CommunityMentalHealthCarePlans.CommunityMentalHealthCarePlansResponse>
  <Summary>
    <ActiveCarePlanCount>0</ActiveCarePlanCount>
    <HistoricCarePlans6MonthsCount>0</HistoricCarePlans6MonthsCount>
    <HistoricCarePlansCount>0</HistoricCarePlansCount>
    <LatestDate>string</LatestDate>
  </Summary>
  <CarePlanCollection>
    <UpdatedDate>string</UpdatedDate>
    <CarePlanType>string</CarePlanType>
    <CarePlanDescription>string</CarePlanDescription>
    <StartDate>string</StartDate>
    <CarePlanID>string</CarePlanID>
    <TenancyDescription>string</TenancyDescription>
  </CarePlanCollection>
</RIOCommunity.Models.CommunityMentalHealthCarePlans.CommunityMentalHealthCarePlansResponse>
{
  "description": "The store community mental health care plans response.",
  "type": "object",
  "properties": {
    "Summary": {
      "description": "Gets or sets The Summary result.",
      "type": "object",
      "properties": {
        "ActiveCarePlanCount": {
          "format": "int32",
          "description": "Gets or sets the active care plan count.",
          "type": "integer"
        },
        "HistoricCarePlans6MonthsCount": {
          "format": "int32",
          "description": "Gets or sets the historic care plans6 months count.",
          "type": "integer"
        },
        "HistoricCarePlansCount": {
          "format": "int32",
          "description": "Gets or sets the historic care plans count.",
          "type": "integer"
        },
        "LatestDate": {
          "format": "date-time",
          "description": "Gets or sets the latest date.",
          "type": "string"
        }
      }
    },
    "CarePlanCollection": {
      "description": "Gets or sets Care Plans Collection.",
      "type": "array",
      "items": {
        "description": "The Care Plan.",
        "type": "object",
        "properties": {
          "UpdatedDate": {
            "format": "date-time",
            "description": "Gets or sets This is the date and time this record was last updated in the source system.\r\nIf this can’t be provided then it should be populated with the\r\ndate and time the record is extracted.",
            "type": "string"
          },
          "CarePlanType": {
            "description": "Gets or sets Care plan type e.g. CPA care Plan, Crisis Plan.",
            "type": "string"
          },
          "CarePlanDescription": {
            "description": "Gets or sets Care Plan type description.",
            "type": "string"
          },
          "StartDate": {
            "format": "date-time",
            "description": "Gets or sets Date Care plan initiated.",
            "type": "string"
          },
          "CarePlanID": {
            "description": "Gets or sets Unique identifier for this Care Plan.",
            "type": "string"
          },
          "TenancyDescription": {
            "description": "Gets or sets Tenancy Description.",
            "type": "string"
          }
        }
      }
    }
  }
}

400 Bad Request

Invalid parameter supplied

401 Unauthorized

Invalid credentials supplied

404 Not Found

Specified entity was not found or access denied

Code samples

@ECHO OFF

curl -v -X GET "https://graphnet-api-nonprod.azure-api.net/comm-mh/Patients/{detailID}/CommunityCarePlans"
-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/comm-mh/Patients/{detailID}/CommunityCarePlans?" + 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/comm-mh/Patients/{detailID}/CommunityCarePlans");


            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
        };
      
        $.ajax({
            url: "https://graphnet-api-nonprod.azure-api.net/comm-mh/Patients/{detailID}/CommunityCarePlans?" + $.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/comm-mh/Patients/{detailID}/CommunityCarePlans";
    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:@"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/comm-mh/Patients/{detailID}/CommunityCarePlans');
$url = $request->getUrl();

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

$request->setHeader($headers);

$parameters = array(
    // Request parameters
);

$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({
})

try:
    conn = httplib.HTTPSConnection('graphnet-api-nonprod.azure-api.net')
    conn.request("GET", "/comm-mh/Patients/{detailID}/CommunityCarePlans?%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({
})

try:
    conn = http.client.HTTPSConnection('graphnet-api-nonprod.azure-api.net')
    conn.request("GET", "/comm-mh/Patients/{detailID}/CommunityCarePlans?%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/comm-mh/Patients/{detailID}/CommunityCarePlans')


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