CarePlan

CarePlan

careplanPatientCategoryGet

Search for CarePlan resources based on a combination of patient ID and CarePlan category/type of plan. For more information on the syntax used for searches, go to Searching.


/careplan/[patient]&[category]

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json,application/xml"\
"//careplan/[patient]&[category]?patient=&category="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CarePlanApi;

import java.io.File;
import java.util.*;

public class CarePlanApiExample {

    public static void main(String[] args) {
        
        CarePlanApi apiInstance = new CarePlanApi();
        String patient = patient_example; // String | Patient ID.
        String category = category_example; // String | Type of plan.
        try {
            CarePlan result = apiInstance.careplanPatientCategoryGet(patient, category);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CarePlanApi#careplanPatientCategoryGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CarePlanApi;

public class CarePlanApiExample {

    public static void main(String[] args) {
        CarePlanApi apiInstance = new CarePlanApi();
        String patient = patient_example; // String | Patient ID.
        String category = category_example; // String | Type of plan.
        try {
            CarePlan result = apiInstance.careplanPatientCategoryGet(patient, category);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CarePlanApi#careplanPatientCategoryGet");
            e.printStackTrace();
        }
    }
}
String *patient = patient_example; // Patient ID. (optional)
String *category = category_example; // Type of plan. (optional)

CarePlanApi *apiInstance = [[CarePlanApi alloc] init];

[apiInstance careplanPatientCategoryGetWith:patient
    category:category
              completionHandler: ^(CarePlan output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CarePlan = require('care_plan');

var api = new CarePlan.CarePlanApi()
var opts = { 
  'patient': patient_example, // {{String}} Patient ID.
  'category': category_example // {{String}} Type of plan.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.careplanPatientCategoryGet(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class careplanPatientCategoryGetExample
    {
        public void main()
        {

            var apiInstance = new CarePlanApi();
            var patient = patient_example;  // String | Patient ID. (optional) 
            var category = category_example;  // String | Type of plan. (optional) 

            try
            {
                CarePlan result = apiInstance.careplanPatientCategoryGet(patient, category);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CarePlanApi.careplanPatientCategoryGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCarePlanApi();
$patient = patient_example; // String | Patient ID.
$category = category_example; // String | Type of plan.

try {
    $result = $api_instance->careplanPatientCategoryGet($patient, $category);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CarePlanApi->careplanPatientCategoryGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CarePlanApi;

my $api_instance = WWW::SwaggerClient::CarePlanApi->new();
my $patient = patient_example; # String | Patient ID.
my $category = category_example; # String | Type of plan.

eval { 
    my $result = $api_instance->careplanPatientCategoryGet(patient => $patient, category => $category);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CarePlanApi->careplanPatientCategoryGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CarePlanApi()
patient = patient_example # String | Patient ID. (optional)
category = category_example # String | Type of plan. (optional)

try: 
    api_response = api_instance.careplan_patient_category_get(patient=patient, category=category)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CarePlanApi->careplanPatientCategoryGet: %s\n" % e)

Parameters

Query parameters
Name Description
patient
String
Patient ID.
category
String
Type of plan.

Responses

Status: 200 - Successful operation

Status: 400 - Bad request. The error was encountered when parsing the content into the appropriate FHIR resource.

Status: 401 - Unauthorized. Possible causes
  • a token failed authorization
  • a user could not be found

Status: 403 - Forbidden. Possible causes
  • a code or query parameter was not supported
  • a code may have had no valid equivalent in the EHR
  • a user does not have enough permissions to perform a certain action
  • a query was invalid, for example a search token value ended in an escape character

Status: 404 - Resource not found. Possible causes
  • an operation was not supported
  • the FHIR resource was not implemented by the product adapter
  • the FHIR resource was not found
  • the service was unable to generate the FHIR resource possibly because a required element was not provided
  • the specified patient could not be found in the EHR
  • the paging information that was sent to the product was not correct indicating that the request for the page could not be honored

Status: 405 - Method not allowed. Possible cause
  • resource does not exist

Status: 412 - Precondition failed. Possible causes
  • certain precondition checks failed, for example a version mismatch
  • an update could not be processed as the If-Match tag didn't match the version

Status: 413 - Request entity too large. Possible cause
  • a request could not be honored because it was too expensive for the server to execute, for example a search that would return a million records

Status: 422 - Unprocessable entity. Possible cause
  • an exception was thrown upon violated constraint, for example missing or invalid element for resource or if an update on a resource did not happen

Status: 429 - Too many requests. Possible causes
  • too many concurrent FHIR requests

Status: 500 - Internal server error. Possible causes
  • the system was missing configuration information, for example if a URL to a service was missing or a security group was not found for the user
  • none of the available exceptions are appropriate


careplanPatientDateGet

Search for CarePlan resources based on a combination of patient ID and CarePlan date. For more information on the syntax used for searches, go to Searching.


/careplan/[patient]&[date]

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json,application/xml"\
"//careplan/[patient]&[date]?patient=&date="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CarePlanApi;

import java.io.File;
import java.util.*;

public class CarePlanApiExample {

    public static void main(String[] args) {
        
        CarePlanApi apiInstance = new CarePlanApi();
        String patient = patient_example; // String | Patient ID.
        String date = date_example; // String | Time period plan covers.
        try {
            CarePlan result = apiInstance.careplanPatientDateGet(patient, date);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CarePlanApi#careplanPatientDateGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CarePlanApi;

public class CarePlanApiExample {

    public static void main(String[] args) {
        CarePlanApi apiInstance = new CarePlanApi();
        String patient = patient_example; // String | Patient ID.
        String date = date_example; // String | Time period plan covers.
        try {
            CarePlan result = apiInstance.careplanPatientDateGet(patient, date);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CarePlanApi#careplanPatientDateGet");
            e.printStackTrace();
        }
    }
}
String *patient = patient_example; // Patient ID. (optional)
String *date = date_example; // Time period plan covers. (optional)

CarePlanApi *apiInstance = [[CarePlanApi alloc] init];

[apiInstance careplanPatientDateGetWith:patient
    date:date
              completionHandler: ^(CarePlan output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CarePlan = require('care_plan');

var api = new CarePlan.CarePlanApi()
var opts = { 
  'patient': patient_example, // {{String}} Patient ID.
  'date': date_example // {{String}} Time period plan covers.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.careplanPatientDateGet(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class careplanPatientDateGetExample
    {
        public void main()
        {

            var apiInstance = new CarePlanApi();
            var patient = patient_example;  // String | Patient ID. (optional) 
            var date = date_example;  // String | Time period plan covers. (optional) 

            try
            {
                CarePlan result = apiInstance.careplanPatientDateGet(patient, date);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CarePlanApi.careplanPatientDateGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCarePlanApi();
$patient = patient_example; // String | Patient ID.
$date = date_example; // String | Time period plan covers.

try {
    $result = $api_instance->careplanPatientDateGet($patient, $date);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CarePlanApi->careplanPatientDateGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CarePlanApi;

my $api_instance = WWW::SwaggerClient::CarePlanApi->new();
my $patient = patient_example; # String | Patient ID.
my $date = date_example; # String | Time period plan covers.

eval { 
    my $result = $api_instance->careplanPatientDateGet(patient => $patient, date => $date);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CarePlanApi->careplanPatientDateGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CarePlanApi()
patient = patient_example # String | Patient ID. (optional)
date = date_example # String | Time period plan covers. (optional)

try: 
    api_response = api_instance.careplan_patient_date_get(patient=patient, date=date)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CarePlanApi->careplanPatientDateGet: %s\n" % e)

Parameters

Query parameters
Name Description
patient
String
Patient ID.
date
String
Time period plan covers.

Responses

Status: 200 - Successful operation

Status: 400 - Bad request. The error was encountered when parsing the content into the appropriate FHIR resource.

Status: 401 - Unauthorized. Possible causes
  • a token failed authorization
  • a user could not be found

Status: 403 - Forbidden. Possible causes
  • a code or query parameter was not supported
  • a code may have had no valid equivalent in the EHR
  • a user does not have enough permissions to perform a certain action
  • a query was invalid, for example a search token value ended in an escape character

Status: 404 - Resource not found. Possible causes
  • an operation was not supported
  • the FHIR resource was not implemented by the product adapter
  • the FHIR resource was not found
  • the service was unable to generate the FHIR resource possibly because a required element was not provided
  • the specified patient could not be found in the EHR
  • the paging information that was sent to the product was not correct indicating that the request for the page could not be honored

Status: 405 - Method not allowed. Possible cause
  • resource does not exist

Status: 412 - Precondition failed. Possible causes
  • certain precondition checks failed, for example a version mismatch
  • an update could not be processed as the If-Match tag didn't match the version

Status: 413 - Request entity too large. Possible cause
  • a request could not be honored because it was too expensive for the server to execute, for example a search that would return a million records

Status: 422 - Unprocessable entity. Possible cause
  • an exception was thrown upon violated constraint, for example missing or invalid element for resource or if an update on a resource did not happen

Status: 429 - Too many requests. Possible causes
  • too many concurrent FHIR requests

Status: 500 - Internal server error. Possible causes
  • the system was missing configuration information, for example if a URL to a service was missing or a security group was not found for the user
  • none of the available exceptions are appropriate


careplanPatientGet

Get the CarePlan resource based on resource ID, or search by patient ID, status, or category. For more information on the syntax used for searches, go to Searching.


/careplan/[patient]

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json,application/xml"\
"//careplan/[patient]?_id=&patient=&status=&category=&date="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CarePlanApi;

import java.io.File;
import java.util.*;

public class CarePlanApiExample {

    public static void main(String[] args) {
        
        CarePlanApi apiInstance = new CarePlanApi();
        String id = id_example; // String | Resource ID.
        String patient = patient_example; // String | Patient ID.
        String status = status_example; // String | CarePlan status.
        String category = category_example; // String | Type of CarePlan.
        String date = date_example; // String | Time period plan covers.
        try {
            CarePlan result = apiInstance.careplanPatientGet(id, patient, status, category, date);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CarePlanApi#careplanPatientGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CarePlanApi;

public class CarePlanApiExample {

    public static void main(String[] args) {
        CarePlanApi apiInstance = new CarePlanApi();
        String id = id_example; // String | Resource ID.
        String patient = patient_example; // String | Patient ID.
        String status = status_example; // String | CarePlan status.
        String category = category_example; // String | Type of CarePlan.
        String date = date_example; // String | Time period plan covers.
        try {
            CarePlan result = apiInstance.careplanPatientGet(id, patient, status, category, date);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CarePlanApi#careplanPatientGet");
            e.printStackTrace();
        }
    }
}
String *id = id_example; // Resource ID. (optional)
String *patient = patient_example; // Patient ID. (optional)
String *status = status_example; // CarePlan status. (optional)
String *category = category_example; // Type of CarePlan. (optional)
String *date = date_example; // Time period plan covers. (optional)

CarePlanApi *apiInstance = [[CarePlanApi alloc] init];

[apiInstance careplanPatientGetWith:id
    patient:patient
    status:status
    category:category
    date:date
              completionHandler: ^(CarePlan output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CarePlan = require('care_plan');

var api = new CarePlan.CarePlanApi()
var opts = { 
  'id': id_example, // {{String}} Resource ID.
  'patient': patient_example, // {{String}} Patient ID.
  'status': status_example, // {{String}} CarePlan status.
  'category': category_example, // {{String}} Type of CarePlan.
  'date': date_example // {{String}} Time period plan covers.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.careplanPatientGet(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class careplanPatientGetExample
    {
        public void main()
        {

            var apiInstance = new CarePlanApi();
            var id = id_example;  // String | Resource ID. (optional) 
            var patient = patient_example;  // String | Patient ID. (optional) 
            var status = status_example;  // String | CarePlan status. (optional) 
            var category = category_example;  // String | Type of CarePlan. (optional) 
            var date = date_example;  // String | Time period plan covers. (optional) 

            try
            {
                CarePlan result = apiInstance.careplanPatientGet(id, patient, status, category, date);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CarePlanApi.careplanPatientGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCarePlanApi();
$id = id_example; // String | Resource ID.
$patient = patient_example; // String | Patient ID.
$status = status_example; // String | CarePlan status.
$category = category_example; // String | Type of CarePlan.
$date = date_example; // String | Time period plan covers.

try {
    $result = $api_instance->careplanPatientGet($id, $patient, $status, $category, $date);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CarePlanApi->careplanPatientGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CarePlanApi;

my $api_instance = WWW::SwaggerClient::CarePlanApi->new();
my $id = id_example; # String | Resource ID.
my $patient = patient_example; # String | Patient ID.
my $status = status_example; # String | CarePlan status.
my $category = category_example; # String | Type of CarePlan.
my $date = date_example; # String | Time period plan covers.

eval { 
    my $result = $api_instance->careplanPatientGet(id => $id, patient => $patient, status => $status, category => $category, date => $date);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CarePlanApi->careplanPatientGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CarePlanApi()
id = id_example # String | Resource ID. (optional)
patient = patient_example # String | Patient ID. (optional)
status = status_example # String | CarePlan status. (optional)
category = category_example # String | Type of CarePlan. (optional)
date = date_example # String | Time period plan covers. (optional)

try: 
    api_response = api_instance.careplan_patient_get(id=id, patient=patient, status=status, category=category, date=date)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CarePlanApi->careplanPatientGet: %s\n" % e)

Parameters

Query parameters
Name Description
_id
String
Resource ID.
patient
String
Patient ID.
status
String
CarePlan status.
category
String
Type of CarePlan.
date
String
Time period plan covers.

Responses

Status: 200 - Successful operation

Status: 400 - Bad request. The error was encountered when parsing the content into the appropriate FHIR resource.

Status: 401 - Unauthorized. Possible causes
  • a token failed authorization
  • a user could not be found

Status: 403 - Forbidden. Possible causes
  • a code or query parameter was not supported
  • a code may have had no valid equivalent in the EHR
  • a user does not have enough permissions to perform a certain action
  • a query was invalid, for example a search token value ended in an escape character

Status: 404 - Resource not found. Possible causes
  • an operation was not supported
  • the FHIR resource was not implemented by the product adapter
  • the FHIR resource was not found
  • the service was unable to generate the FHIR resource possibly because a required element was not provided
  • the specified patient could not be found in the EHR
  • the paging information that was sent to the product was not correct indicating that the request for the page could not be honored

Status: 405 - Method not allowed. Possible cause
  • resource does not exist

Status: 412 - Precondition failed. Possible causes
  • certain precondition checks failed, for example a version mismatch
  • an update could not be processed as the If-Match tag didn't match the version

Status: 413 - Request entity too large. Possible cause
  • a request could not be honored because it was too expensive for the server to execute, for example a search that would return a million records

Status: 422 - Unprocessable entity. Possible cause
  • an exception was thrown upon violated constraint, for example missing or invalid element for resource or if an update on a resource did not happen

Status: 429 - Too many requests. Possible causes
  • too many concurrent FHIR requests

Status: 500 - Internal server error. Possible causes
  • the system was missing configuration information, for example if a URL to a service was missing or a security group was not found for the user
  • none of the available exceptions are appropriate


careplanPatientStatusCategoryDateGet

Search for CarePlan resources based on a combination of patient ID, CarePlan status, and CarePlan category. For more information on the syntax used for searches, go to Searching.


/careplan/[patient]&[status]&[category]&[date]

Usage and SDK Samples

curl -X GET\
"//careplan/[patient]&[status]&[category]&[date]?patient=&status=&category=&date="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CarePlanApi;

import java.io.File;
import java.util.*;

public class CarePlanApiExample {

    public static void main(String[] args) {
        
        CarePlanApi apiInstance = new CarePlanApi();
        String patient = patient_example; // String | Patient ID.
        String status = status_example; // String | CarePlan status.
        String category = category_example; // String | Type of plan.
        String date = date_example; // String | Time period plan covers.
        try {
            apiInstance.careplanPatientStatusCategoryDateGet(patient, status, category, date);
        } catch (ApiException e) {
            System.err.println("Exception when calling CarePlanApi#careplanPatientStatusCategoryDateGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CarePlanApi;

public class CarePlanApiExample {

    public static void main(String[] args) {
        CarePlanApi apiInstance = new CarePlanApi();
        String patient = patient_example; // String | Patient ID.
        String status = status_example; // String | CarePlan status.
        String category = category_example; // String | Type of plan.
        String date = date_example; // String | Time period plan covers.
        try {
            apiInstance.careplanPatientStatusCategoryDateGet(patient, status, category, date);
        } catch (ApiException e) {
            System.err.println("Exception when calling CarePlanApi#careplanPatientStatusCategoryDateGet");
            e.printStackTrace();
        }
    }
}
String *patient = patient_example; // Patient ID. (optional)
String *status = status_example; // CarePlan status. (optional)
String *category = category_example; // Type of plan. (optional)
String *date = date_example; // Time period plan covers. (optional)

CarePlanApi *apiInstance = [[CarePlanApi alloc] init];

[apiInstance careplanPatientStatusCategoryDateGetWith:patient
    status:status
    category:category
    date:date
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CarePlan = require('care_plan');

var api = new CarePlan.CarePlanApi()
var opts = { 
  'patient': patient_example, // {{String}} Patient ID.
  'status': status_example, // {{String}} CarePlan status.
  'category': category_example, // {{String}} Type of plan.
  'date': date_example // {{String}} Time period plan covers.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.careplanPatientStatusCategoryDateGet(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class careplanPatientStatusCategoryDateGetExample
    {
        public void main()
        {

            var apiInstance = new CarePlanApi();
            var patient = patient_example;  // String | Patient ID. (optional) 
            var status = status_example;  // String | CarePlan status. (optional) 
            var category = category_example;  // String | Type of plan. (optional) 
            var date = date_example;  // String | Time period plan covers. (optional) 

            try
            {
                apiInstance.careplanPatientStatusCategoryDateGet(patient, status, category, date);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CarePlanApi.careplanPatientStatusCategoryDateGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCarePlanApi();
$patient = patient_example; // String | Patient ID.
$status = status_example; // String | CarePlan status.
$category = category_example; // String | Type of plan.
$date = date_example; // String | Time period plan covers.

try {
    $api_instance->careplanPatientStatusCategoryDateGet($patient, $status, $category, $date);
} catch (Exception $e) {
    echo 'Exception when calling CarePlanApi->careplanPatientStatusCategoryDateGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CarePlanApi;

my $api_instance = WWW::SwaggerClient::CarePlanApi->new();
my $patient = patient_example; # String | Patient ID.
my $status = status_example; # String | CarePlan status.
my $category = category_example; # String | Type of plan.
my $date = date_example; # String | Time period plan covers.

eval { 
    $api_instance->careplanPatientStatusCategoryDateGet(patient => $patient, status => $status, category => $category, date => $date);
};
if ($@) {
    warn "Exception when calling CarePlanApi->careplanPatientStatusCategoryDateGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CarePlanApi()
patient = patient_example # String | Patient ID. (optional)
status = status_example # String | CarePlan status. (optional)
category = category_example # String | Type of plan. (optional)
date = date_example # String | Time period plan covers. (optional)

try: 
    api_instance.careplan_patient_status_category_date_get(patient=patient, status=status, category=category, date=date)
except ApiException as e:
    print("Exception when calling CarePlanApi->careplanPatientStatusCategoryDateGet: %s\n" % e)

Parameters

Query parameters
Name Description
patient
String
Patient ID.
status
String
CarePlan status.
category
String
Type of plan.
date
String
Time period plan covers.

Responses

Status: 400 - Bad request. The error was encountered when parsing the content into the appropriate FHIR resource.

Status: 401 - Unauthorized. Possible causes
  • a token failed authorization
  • a user could not be found

Status: 403 - Forbidden. Possible causes
  • a code or query parameter was not supported
  • a code may have had no valid equivalent in the EHR
  • a user does not have enough permissions to perform a certain action
  • a query was invalid, for example a search token value ended in an escape character

Status: 404 - Resource not found. Possible causes
  • an operation was not supported
  • the FHIR resource was not implemented by the product adapter
  • the FHIR resource was not found
  • the service was unable to generate the FHIR resource possibly because a required element was not provided
  • the specified patient could not be found in the EHR
  • the paging information that was sent to the product was not correct indicating that the request for the page could not be honored

Status: 405 - Method not allowed. Possible cause
  • resource does not exist

Status: 412 - Precondition failed. Possible causes
  • certain precondition checks failed, for example a version mismatch
  • an update could not be processed as the If-Match tag didn't match the version

Status: 413 - Request entity too large. Possible cause
  • a request could not be honored because it was too expensive for the server to execute, for example a search that would return a million records

Status: 422 - Unprocessable entity. Possible cause
  • an exception was thrown upon violated constraint, for example missing or invalid element for resource or if an update on a resource did not happen

Status: 429 - Too many requests. Possible causes
  • too many concurrent FHIR requests

Status: 500 - Internal server error. Possible causes
  • the system was missing configuration information, for example if a URL to a service was missing or a security group was not found for the user
  • none of the available exceptions are appropriate


careplanPatientStatusCategoryGet

Search for CarePlan resources based on a combination of patient ID, CarePlan status, and CarePlan category. For more information on the syntax used for searches, go to Searching.


/careplan/[patient]&[status]&[category]

Usage and SDK Samples

curl -X GET\
"//careplan/[patient]&[status]&[category]?patient=&status=&category="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CarePlanApi;

import java.io.File;
import java.util.*;

public class CarePlanApiExample {

    public static void main(String[] args) {
        
        CarePlanApi apiInstance = new CarePlanApi();
        String patient = patient_example; // String | Patient ID.
        String status = status_example; // String | CarePlan status.
        String category = category_example; // String | Type of plan.
        try {
            apiInstance.careplanPatientStatusCategoryGet(patient, status, category);
        } catch (ApiException e) {
            System.err.println("Exception when calling CarePlanApi#careplanPatientStatusCategoryGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CarePlanApi;

public class CarePlanApiExample {

    public static void main(String[] args) {
        CarePlanApi apiInstance = new CarePlanApi();
        String patient = patient_example; // String | Patient ID.
        String status = status_example; // String | CarePlan status.
        String category = category_example; // String | Type of plan.
        try {
            apiInstance.careplanPatientStatusCategoryGet(patient, status, category);
        } catch (ApiException e) {
            System.err.println("Exception when calling CarePlanApi#careplanPatientStatusCategoryGet");
            e.printStackTrace();
        }
    }
}
String *patient = patient_example; // Patient ID. (optional)
String *status = status_example; // CarePlan status. (optional)
String *category = category_example; // Type of plan. (optional)

CarePlanApi *apiInstance = [[CarePlanApi alloc] init];

[apiInstance careplanPatientStatusCategoryGetWith:patient
    status:status
    category:category
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CarePlan = require('care_plan');

var api = new CarePlan.CarePlanApi()
var opts = { 
  'patient': patient_example, // {{String}} Patient ID.
  'status': status_example, // {{String}} CarePlan status.
  'category': category_example // {{String}} Type of plan.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.careplanPatientStatusCategoryGet(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class careplanPatientStatusCategoryGetExample
    {
        public void main()
        {

            var apiInstance = new CarePlanApi();
            var patient = patient_example;  // String | Patient ID. (optional) 
            var status = status_example;  // String | CarePlan status. (optional) 
            var category = category_example;  // String | Type of plan. (optional) 

            try
            {
                apiInstance.careplanPatientStatusCategoryGet(patient, status, category);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CarePlanApi.careplanPatientStatusCategoryGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCarePlanApi();
$patient = patient_example; // String | Patient ID.
$status = status_example; // String | CarePlan status.
$category = category_example; // String | Type of plan.

try {
    $api_instance->careplanPatientStatusCategoryGet($patient, $status, $category);
} catch (Exception $e) {
    echo 'Exception when calling CarePlanApi->careplanPatientStatusCategoryGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CarePlanApi;

my $api_instance = WWW::SwaggerClient::CarePlanApi->new();
my $patient = patient_example; # String | Patient ID.
my $status = status_example; # String | CarePlan status.
my $category = category_example; # String | Type of plan.

eval { 
    $api_instance->careplanPatientStatusCategoryGet(patient => $patient, status => $status, category => $category);
};
if ($@) {
    warn "Exception when calling CarePlanApi->careplanPatientStatusCategoryGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CarePlanApi()
patient = patient_example # String | Patient ID. (optional)
status = status_example # String | CarePlan status. (optional)
category = category_example # String | Type of plan. (optional)

try: 
    api_instance.careplan_patient_status_category_get(patient=patient, status=status, category=category)
except ApiException as e:
    print("Exception when calling CarePlanApi->careplanPatientStatusCategoryGet: %s\n" % e)

Parameters

Query parameters
Name Description
patient
String
Patient ID.
status
String
CarePlan status.
category
String
Type of plan.

Responses

Status: 400 - Bad request. The error was encountered when parsing the content into the appropriate FHIR resource.

Status: 401 - Unauthorized. Possible causes
  • a token failed authorization
  • a user could not be found

Status: 403 - Forbidden. Possible causes
  • a code or query parameter was not supported
  • a code may have had no valid equivalent in the EHR
  • a user does not have enough permissions to perform a certain action
  • a query was invalid, for example a search token value ended in an escape character

Status: 404 - Resource not found. Possible causes
  • an operation was not supported
  • the FHIR resource was not implemented by the product adapter
  • the FHIR resource was not found
  • the service was unable to generate the FHIR resource possibly because a required element was not provided
  • the specified patient could not be found in the EHR
  • the paging information that was sent to the product was not correct indicating that the request for the page could not be honored

Status: 405 - Method not allowed. Possible cause
  • resource does not exist

Status: 412 - Precondition failed. Possible causes
  • certain precondition checks failed, for example a version mismatch
  • an update could not be processed as the If-Match tag didn't match the version

Status: 413 - Request entity too large. Possible cause
  • a request could not be honored because it was too expensive for the server to execute, for example a search that would return a million records

Status: 422 - Unprocessable entity. Possible cause
  • an exception was thrown upon violated constraint, for example missing or invalid element for resource or if an update on a resource did not happen

Status: 429 - Too many requests. Possible causes
  • too many concurrent FHIR requests

Status: 500 - Internal server error. Possible causes
  • the system was missing configuration information, for example if a URL to a service was missing or a security group was not found for the user
  • none of the available exceptions are appropriate


careplanPatientStatusGet

Search for CarePlan resources based on a combination of patient ID and CarePlan status. For more information on the syntax used for searches, go to Searching.


/careplan/[patient]&[status]

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json,application/xml"\
"//careplan/[patient]&[status]?patient=&status="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CarePlanApi;

import java.io.File;
import java.util.*;

public class CarePlanApiExample {

    public static void main(String[] args) {
        
        CarePlanApi apiInstance = new CarePlanApi();
        String patient = patient_example; // String | Patient ID.
        String status = status_example; // String | CarePlan status.
        try {
            CarePlan result = apiInstance.careplanPatientStatusGet(patient, status);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CarePlanApi#careplanPatientStatusGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CarePlanApi;

public class CarePlanApiExample {

    public static void main(String[] args) {
        CarePlanApi apiInstance = new CarePlanApi();
        String patient = patient_example; // String | Patient ID.
        String status = status_example; // String | CarePlan status.
        try {
            CarePlan result = apiInstance.careplanPatientStatusGet(patient, status);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CarePlanApi#careplanPatientStatusGet");
            e.printStackTrace();
        }
    }
}
String *patient = patient_example; // Patient ID. (optional)
String *status = status_example; // CarePlan status. (optional)

CarePlanApi *apiInstance = [[CarePlanApi alloc] init];

[apiInstance careplanPatientStatusGetWith:patient
    status:status
              completionHandler: ^(CarePlan output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CarePlan = require('care_plan');

var api = new CarePlan.CarePlanApi()
var opts = { 
  'patient': patient_example, // {{String}} Patient ID.
  'status': status_example // {{String}} CarePlan status.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.careplanPatientStatusGet(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class careplanPatientStatusGetExample
    {
        public void main()
        {

            var apiInstance = new CarePlanApi();
            var patient = patient_example;  // String | Patient ID. (optional) 
            var status = status_example;  // String | CarePlan status. (optional) 

            try
            {
                CarePlan result = apiInstance.careplanPatientStatusGet(patient, status);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CarePlanApi.careplanPatientStatusGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCarePlanApi();
$patient = patient_example; // String | Patient ID.
$status = status_example; // String | CarePlan status.

try {
    $result = $api_instance->careplanPatientStatusGet($patient, $status);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CarePlanApi->careplanPatientStatusGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CarePlanApi;

my $api_instance = WWW::SwaggerClient::CarePlanApi->new();
my $patient = patient_example; # String | Patient ID.
my $status = status_example; # String | CarePlan status.

eval { 
    my $result = $api_instance->careplanPatientStatusGet(patient => $patient, status => $status);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CarePlanApi->careplanPatientStatusGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CarePlanApi()
patient = patient_example # String | Patient ID. (optional)
status = status_example # String | CarePlan status. (optional)

try: 
    api_response = api_instance.careplan_patient_status_get(patient=patient, status=status)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CarePlanApi->careplanPatientStatusGet: %s\n" % e)

Parameters

Query parameters
Name Description
patient
String
Patient ID.
status
String
CarePlan status.

Responses

Status: 200 - Successful operation

Status: 400 - Bad request. The error was encountered when parsing the content into the appropriate FHIR resource.

Status: 401 - Unauthorized. Possible causes
  • a token failed authorization
  • a user could not be found

Status: 403 - Forbidden. Possible causes
  • a code or query parameter was not supported
  • a code may have had no valid equivalent in the EHR
  • a user does not have enough permissions to perform a certain action
  • a query was invalid, for example a search token value ended in an escape character

Status: 404 - Resource not found. Possible causes
  • an operation was not supported
  • the FHIR resource was not implemented by the product adapter
  • the FHIR resource was not found
  • the service was unable to generate the FHIR resource possibly because a required element was not provided
  • the specified patient could not be found in the EHR
  • the paging information that was sent to the product was not correct indicating that the request for the page could not be honored

Status: 405 - Method not allowed. Possible cause
  • resource does not exist

Status: 412 - Precondition failed. Possible causes
  • certain precondition checks failed, for example a version mismatch
  • an update could not be processed as the If-Match tag didn't match the version

Status: 413 - Request entity too large. Possible cause
  • a request could not be honored because it was too expensive for the server to execute, for example a search that would return a million records

Status: 422 - Unprocessable entity. Possible cause
  • an exception was thrown upon violated constraint, for example missing or invalid element for resource or if an update on a resource did not happen

Status: 429 - Too many requests. Possible causes
  • too many concurrent FHIR requests

Status: 500 - Internal server error. Possible causes
  • the system was missing configuration information, for example if a URL to a service was missing or a security group was not found for the user
  • none of the available exceptions are appropriate


careplanStatusCategoryGet

Search for CarePlan resources based on a combination of status and category. For more information on the syntax used for searches, go to Searching.


/careplan/[status]&[category]

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json,application/xml"\
"//careplan/[status]&[category]?status=&category="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CarePlanApi;

import java.io.File;
import java.util.*;

public class CarePlanApiExample {

    public static void main(String[] args) {
        
        CarePlanApi apiInstance = new CarePlanApi();
        String status = status_example; // String | CarePlan status.
        String category = category_example; // String | Type of plan.
        try {
            CarePlan result = apiInstance.careplanStatusCategoryGet(status, category);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CarePlanApi#careplanStatusCategoryGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CarePlanApi;

public class CarePlanApiExample {

    public static void main(String[] args) {
        CarePlanApi apiInstance = new CarePlanApi();
        String status = status_example; // String | CarePlan status.
        String category = category_example; // String | Type of plan.
        try {
            CarePlan result = apiInstance.careplanStatusCategoryGet(status, category);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CarePlanApi#careplanStatusCategoryGet");
            e.printStackTrace();
        }
    }
}
String *status = status_example; // CarePlan status. (optional)
String *category = category_example; // Type of plan. (optional)

CarePlanApi *apiInstance = [[CarePlanApi alloc] init];

[apiInstance careplanStatusCategoryGetWith:status
    category:category
              completionHandler: ^(CarePlan output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CarePlan = require('care_plan');

var api = new CarePlan.CarePlanApi()
var opts = { 
  'status': status_example, // {{String}} CarePlan status.
  'category': category_example // {{String}} Type of plan.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.careplanStatusCategoryGet(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class careplanStatusCategoryGetExample
    {
        public void main()
        {

            var apiInstance = new CarePlanApi();
            var status = status_example;  // String | CarePlan status. (optional) 
            var category = category_example;  // String | Type of plan. (optional) 

            try
            {
                CarePlan result = apiInstance.careplanStatusCategoryGet(status, category);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CarePlanApi.careplanStatusCategoryGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCarePlanApi();
$status = status_example; // String | CarePlan status.
$category = category_example; // String | Type of plan.

try {
    $result = $api_instance->careplanStatusCategoryGet($status, $category);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CarePlanApi->careplanStatusCategoryGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CarePlanApi;

my $api_instance = WWW::SwaggerClient::CarePlanApi->new();
my $status = status_example; # String | CarePlan status.
my $category = category_example; # String | Type of plan.

eval { 
    my $result = $api_instance->careplanStatusCategoryGet(status => $status, category => $category);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CarePlanApi->careplanStatusCategoryGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CarePlanApi()
status = status_example # String | CarePlan status. (optional)
category = category_example # String | Type of plan. (optional)

try: 
    api_response = api_instance.careplan_status_category_get(status=status, category=category)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CarePlanApi->careplanStatusCategoryGet: %s\n" % e)

Parameters

Query parameters
Name Description
status
String
CarePlan status.
category
String
Type of plan.

Responses

Status: 200 - Successful operation

Status: 400 - Bad request. The error was encountered when parsing the content into the appropriate FHIR resource.

Status: 401 - Unauthorized. Possible causes
  • a token failed authorization
  • a user could not be found

Status: 403 - Forbidden. Possible causes
  • a code or query parameter was not supported
  • a code may have had no valid equivalent in the EHR
  • a user does not have enough permissions to perform a certain action
  • a query was invalid, for example a search token value ended in an escape character

Status: 404 - Resource not found. Possible causes
  • an operation was not supported
  • the FHIR resource was not implemented by the product adapter
  • the FHIR resource was not found
  • the service was unable to generate the FHIR resource possibly because a required element was not provided
  • the specified patient could not be found in the EHR
  • the paging information that was sent to the product was not correct indicating that the request for the page could not be honored

Status: 405 - Method not allowed. Possible cause
  • resource does not exist

Status: 412 - Precondition failed. Possible causes
  • certain precondition checks failed, for example a version mismatch
  • an update could not be processed as the If-Match tag didn't match the version

Status: 413 - Request entity too large. Possible cause
  • a request could not be honored because it was too expensive for the server to execute, for example a search that would return a million records

Status: 422 - Unprocessable entity. Possible cause
  • an exception was thrown upon violated constraint, for example missing or invalid element for resource or if an update on a resource did not happen

Status: 429 - Too many requests. Possible causes
  • too many concurrent FHIR requests

Status: 500 - Internal server error. Possible causes
  • the system was missing configuration information, for example if a URL to a service was missing or a security group was not found for the user
  • none of the available exceptions are appropriate