Care Community Public API

PublicCarePlan

publicCarePlancreateFormPost

Creates a care plan for a patient. Requires the patient's MPIID and the care plan TemplateID. The care plan will be saved in Draft-Incomplete status if there are required questions, and Draft status if there are not.


/public-care-plan/$create-form

Usage and SDK Samples

curl -X POST\
-H "Accept: application/vnd.intersystems.com.hs.hscc.careplan.v1+json,application/json,default"\
-H "Content-Type: application/vnd.intersystems.com.hs.hscc.careplan.v1+json"\
"//public-care-plan/$create-form"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PublicCarePlanApi;

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

public class PublicCarePlanApiExample {

    public static void main(String[] args) {

        PublicCarePlanApi apiInstance = new PublicCarePlanApi();
        Create-form-request_input body = ; // Create-form-request_input |
        try {
            create-form-response_output result = apiInstance.publicCarePlancreateFormPost(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PublicCarePlanApi#publicCarePlancreateFormPost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PublicCarePlanApi;

public class PublicCarePlanApiExample {

    public static void main(String[] args) {
        PublicCarePlanApi apiInstance = new PublicCarePlanApi();
        Create-form-request_input body = ; // Create-form-request_input |
        try {
            create-form-response_output result = apiInstance.publicCarePlancreateFormPost(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PublicCarePlanApi#publicCarePlancreateFormPost");
            e.printStackTrace();
        }
    }
}
Create-form-request_input *body = ; //

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

[apiInstance publicCarePlancreateFormPostWith:body
              completionHandler: ^(create-form-response_output output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CareCommunityPublicApi_ = require('care_community_public_api_');

var api = new CareCommunityPublicApi_.PublicCarePlanApi()
var body = ; // {{Create-form-request_input}}

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.publicCarePlancreateFormPost(body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new PublicCarePlanApi();
            var body = new Create-form-request_input(); // Create-form-request_input |

            try
            {
                create-form-response_output result = apiInstance.publicCarePlancreateFormPost(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PublicCarePlanApi.publicCarePlancreateFormPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiPublicCarePlanApi();
$body = ; // Create-form-request_input |

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

my $api_instance = WWW::SwaggerClient::PublicCarePlanApi->new();
my $body = WWW::SwaggerClient::Object::Create-form-request_input->new(); # Create-form-request_input |

eval {
    my $result = $api_instance->publicCarePlancreateFormPost(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PublicCarePlanApi->publicCarePlancreateFormPost: $@\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.PublicCarePlanApi()
body =  # Create-form-request_input |

try:
    api_response = api_instance.public_care_plancreate_form_post(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PublicCarePlanApi->publicCarePlancreateFormPost: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - A successful response

Status: 403 - Forbidden: Authentication Failure

Status: 406 - Unsupported Mediatype: The requested mediatype is not compatible with any supported response mediatypes.

Status: 415 - Unsupported Mediatype: Mediatype is not compatible with any supported request mediatypes.


PublicPatient

publicPatientpatientMPIIDCareplanRootIDTaskPost

Creates a task for the care team associated with the specified care plan. If no care team is associated with the plan, the task is left unassigned.


/public-patient/$patient/{MPIID}/careplan/{rootID}/task

Usage and SDK Samples

curl -X POST\
-H "Accept: application/vnd.intersystems.com.hs.hscc.public-patient.v1+json,application/json,default"\
-H "Content-Type: application/vnd.intersystems.com.hs.hscc.public-patient.v1+json"\
"//public-patient/$patient/{MPIID}/careplan/{rootID}/task"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PublicPatientApi;

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

public class PublicPatientApiExample {

    public static void main(String[] args) {

        PublicPatientApi apiInstance = new PublicPatientApi();
        string_input mPIID = ; // string_input |
        string_input rootID = ; // string_input |
        Create-task-request_input body = ; // Create-task-request_input |
        try {
            task-summary_output result = apiInstance.publicPatientpatientMPIIDCareplanRootIDTaskPost(mPIID, rootID, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PublicPatientApi#publicPatientpatientMPIIDCareplanRootIDTaskPost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PublicPatientApi;

public class PublicPatientApiExample {

    public static void main(String[] args) {
        PublicPatientApi apiInstance = new PublicPatientApi();
        string_input mPIID = ; // string_input |
        string_input rootID = ; // string_input |
        Create-task-request_input body = ; // Create-task-request_input |
        try {
            task-summary_output result = apiInstance.publicPatientpatientMPIIDCareplanRootIDTaskPost(mPIID, rootID, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PublicPatientApi#publicPatientpatientMPIIDCareplanRootIDTaskPost");
            e.printStackTrace();
        }
    }
}
string_input *mPIID = ; //
string_input *rootID = ; //
Create-task-request_input *body = ; //  (optional)

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

[apiInstance publicPatientpatientMPIIDCareplanRootIDTaskPostWith:mPIID
    rootID:rootID
    body:body
              completionHandler: ^(task-summary_output output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CareCommunityPublicApi_ = require('care_community_public_api_');

var api = new CareCommunityPublicApi_.PublicPatientApi()
var mPIID = ; // {{string_input}}
var rootID = ; // {{string_input}}
var opts = {
  'body':  // {{Create-task-request_input}}
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.publicPatientpatientMPIIDCareplanRootIDTaskPost(mPIIDrootID, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new PublicPatientApi();
            var mPIID = new string_input(); // string_input |
            var rootID = new string_input(); // string_input |
            var body = new Create-task-request_input(); // Create-task-request_input |  (optional)

            try
            {
                task-summary_output result = apiInstance.publicPatientpatientMPIIDCareplanRootIDTaskPost(mPIID, rootID, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PublicPatientApi.publicPatientpatientMPIIDCareplanRootIDTaskPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiPublicPatientApi();
$mPIID = ; // string_input |
$rootID = ; // string_input |
$body = ; // Create-task-request_input |

try {
    $result = $api_instance->publicPatientpatientMPIIDCareplanRootIDTaskPost($mPIID, $rootID, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PublicPatientApi->publicPatientpatientMPIIDCareplanRootIDTaskPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PublicPatientApi;

my $api_instance = WWW::SwaggerClient::PublicPatientApi->new();
my $mPIID = ; # string_input |
my $rootID = ; # string_input |
my $body = WWW::SwaggerClient::Object::Create-task-request_input->new(); # Create-task-request_input |

eval {
    my $result = $api_instance->publicPatientpatientMPIIDCareplanRootIDTaskPost(mPIID => $mPIID, rootID => $rootID, body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PublicPatientApi->publicPatientpatientMPIIDCareplanRootIDTaskPost: $@\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.PublicPatientApi()
mPIID =  # string_input |
rootID =  # string_input |
body =  # Create-task-request_input |  (optional)

try:
    api_response = api_instance.public_patientpatient_mpiid_careplan_root_id_task_post(mPIID, rootID, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PublicPatientApi->publicPatientpatientMPIIDCareplanRootIDTaskPost: %s\n" % e)

Parameters

Path parameters
Name Description
MPIID*
string_input
Required
rootID*
string_input
Required
Body parameters
Name Description
body

Responses

Status: 200 - A successful response

Status: 403 - Forbidden: Authentication Failure

Status: 406 - Unsupported Mediatype: The requested mediatype is not compatible with any supported response mediatypes.

Status: 415 - Unsupported Mediatype: Mediatype is not compatible with any supported request mediatypes.


publicPatientpatientPatientMPIIDCareplanCareplanIDEditPost

Edits a care plan for a patient. Requires the patient's MPIID and the care plan ID. The care plan will be saved in Draft-Incomplete status if there are required questions, and Draft status if there are not.


/public-patient/$patient/{patientMPIID}/careplan/{careplanID}/edit

Usage and SDK Samples

curl -X POST\
-H "Accept: application/vnd.intersystems.com.hs.hscc.public-patient.v1+json,application/json,default"\
-H "Content-Type: application/vnd.intersystems.com.hs.hscc.public-patient.v1+json"\
"//public-patient/$patient/{patientMPIID}/careplan/{careplanID}/edit"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PublicPatientApi;

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

public class PublicPatientApiExample {

    public static void main(String[] args) {

        PublicPatientApi apiInstance = new PublicPatientApi();
        string_input careplanID = ; // string_input |
        string_input patientMPIID = ; // string_input |
        Update-patient-care-plan-request_input body = ; // Update-patient-care-plan-request_input |
        try {
            patient-care-plan-form-summary_output result = apiInstance.publicPatientpatientPatientMPIIDCareplanCareplanIDEditPost(careplanID, patientMPIID, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PublicPatientApi#publicPatientpatientPatientMPIIDCareplanCareplanIDEditPost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PublicPatientApi;

public class PublicPatientApiExample {

    public static void main(String[] args) {
        PublicPatientApi apiInstance = new PublicPatientApi();
        string_input careplanID = ; // string_input |
        string_input patientMPIID = ; // string_input |
        Update-patient-care-plan-request_input body = ; // Update-patient-care-plan-request_input |
        try {
            patient-care-plan-form-summary_output result = apiInstance.publicPatientpatientPatientMPIIDCareplanCareplanIDEditPost(careplanID, patientMPIID, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PublicPatientApi#publicPatientpatientPatientMPIIDCareplanCareplanIDEditPost");
            e.printStackTrace();
        }
    }
}
string_input *careplanID = ; //
string_input *patientMPIID = ; //
Update-patient-care-plan-request_input *body = ; //  (optional)

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

[apiInstance publicPatientpatientPatientMPIIDCareplanCareplanIDEditPostWith:careplanID
    patientMPIID:patientMPIID
    body:body
              completionHandler: ^(patient-care-plan-form-summary_output output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CareCommunityPublicApi_ = require('care_community_public_api_');

var api = new CareCommunityPublicApi_.PublicPatientApi()
var careplanID = ; // {{string_input}}
var patientMPIID = ; // {{string_input}}
var opts = {
  'body':  // {{Update-patient-care-plan-request_input}}
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.publicPatientpatientPatientMPIIDCareplanCareplanIDEditPost(careplanIDpatientMPIID, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new PublicPatientApi();
            var careplanID = new string_input(); // string_input |
            var patientMPIID = new string_input(); // string_input |
            var body = new Update-patient-care-plan-request_input(); // Update-patient-care-plan-request_input |  (optional)

            try
            {
                patient-care-plan-form-summary_output result = apiInstance.publicPatientpatientPatientMPIIDCareplanCareplanIDEditPost(careplanID, patientMPIID, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PublicPatientApi.publicPatientpatientPatientMPIIDCareplanCareplanIDEditPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiPublicPatientApi();
$careplanID = ; // string_input |
$patientMPIID = ; // string_input |
$body = ; // Update-patient-care-plan-request_input |

try {
    $result = $api_instance->publicPatientpatientPatientMPIIDCareplanCareplanIDEditPost($careplanID, $patientMPIID, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PublicPatientApi->publicPatientpatientPatientMPIIDCareplanCareplanIDEditPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PublicPatientApi;

my $api_instance = WWW::SwaggerClient::PublicPatientApi->new();
my $careplanID = ; # string_input |
my $patientMPIID = ; # string_input |
my $body = WWW::SwaggerClient::Object::Update-patient-care-plan-request_input->new(); # Update-patient-care-plan-request_input |

eval {
    my $result = $api_instance->publicPatientpatientPatientMPIIDCareplanCareplanIDEditPost(careplanID => $careplanID, patientMPIID => $patientMPIID, body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PublicPatientApi->publicPatientpatientPatientMPIIDCareplanCareplanIDEditPost: $@\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.PublicPatientApi()
careplanID =  # string_input |
patientMPIID =  # string_input |
body =  # Update-patient-care-plan-request_input |  (optional)

try:
    api_response = api_instance.public_patientpatient_patient_mpiid_careplan_careplan_id_edit_post(careplanID, patientMPIID, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PublicPatientApi->publicPatientpatientPatientMPIIDCareplanCareplanIDEditPost: %s\n" % e)

Parameters

Path parameters
Name Description
careplanID*
string_input
Required
patientMPIID*
string_input
Required
Body parameters
Name Description
body

Responses

Status: 200 - A successful response

Status: 403 - Forbidden: Authentication Failure

Status: 406 - Unsupported Mediatype: The requested mediatype is not compatible with any supported response mediatypes.

Status: 415 - Unsupported Mediatype: Mediatype is not compatible with any supported request mediatypes.


publicPatientpatientPatientMPIIDCareplanCareplanIDGet

Returns information about a particular care plan for a patient.


/public-patient/$patient/{patientMPIID}/careplan/{careplanID}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/vnd.intersystems.com.hs.hscc.public-patient.v1+json,application/json,default"\
"//public-patient/$patient/{patientMPIID}/careplan/{careplanID}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PublicPatientApi;

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

public class PublicPatientApiExample {

    public static void main(String[] args) {

        PublicPatientApi apiInstance = new PublicPatientApi();
        string_input careplanID = ; // string_input |
        string_input patientMPIID = ; // string_input |
        try {
            patient-care-plan-detailed_output result = apiInstance.publicPatientpatientPatientMPIIDCareplanCareplanIDGet(careplanID, patientMPIID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PublicPatientApi#publicPatientpatientPatientMPIIDCareplanCareplanIDGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PublicPatientApi;

public class PublicPatientApiExample {

    public static void main(String[] args) {
        PublicPatientApi apiInstance = new PublicPatientApi();
        string_input careplanID = ; // string_input |
        string_input patientMPIID = ; // string_input |
        try {
            patient-care-plan-detailed_output result = apiInstance.publicPatientpatientPatientMPIIDCareplanCareplanIDGet(careplanID, patientMPIID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PublicPatientApi#publicPatientpatientPatientMPIIDCareplanCareplanIDGet");
            e.printStackTrace();
        }
    }
}
string_input *careplanID = ; //
string_input *patientMPIID = ; //

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

[apiInstance publicPatientpatientPatientMPIIDCareplanCareplanIDGetWith:careplanID
    patientMPIID:patientMPIID
              completionHandler: ^(patient-care-plan-detailed_output output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CareCommunityPublicApi_ = require('care_community_public_api_');

var api = new CareCommunityPublicApi_.PublicPatientApi()
var careplanID = ; // {{string_input}}
var patientMPIID = ; // {{string_input}}

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.publicPatientpatientPatientMPIIDCareplanCareplanIDGet(careplanID, patientMPIID, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new PublicPatientApi();
            var careplanID = new string_input(); // string_input |
            var patientMPIID = new string_input(); // string_input |

            try
            {
                patient-care-plan-detailed_output result = apiInstance.publicPatientpatientPatientMPIIDCareplanCareplanIDGet(careplanID, patientMPIID);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PublicPatientApi.publicPatientpatientPatientMPIIDCareplanCareplanIDGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiPublicPatientApi();
$careplanID = ; // string_input |
$patientMPIID = ; // string_input |

try {
    $result = $api_instance->publicPatientpatientPatientMPIIDCareplanCareplanIDGet($careplanID, $patientMPIID);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PublicPatientApi->publicPatientpatientPatientMPIIDCareplanCareplanIDGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PublicPatientApi;

my $api_instance = WWW::SwaggerClient::PublicPatientApi->new();
my $careplanID = ; # string_input |
my $patientMPIID = ; # string_input |

eval {
    my $result = $api_instance->publicPatientpatientPatientMPIIDCareplanCareplanIDGet(careplanID => $careplanID, patientMPIID => $patientMPIID);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PublicPatientApi->publicPatientpatientPatientMPIIDCareplanCareplanIDGet: $@\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.PublicPatientApi()
careplanID =  # string_input |
patientMPIID =  # string_input |

try:
    api_response = api_instance.public_patientpatient_patient_mpiid_careplan_careplan_id_get(careplanID, patientMPIID)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PublicPatientApi->publicPatientpatientPatientMPIIDCareplanCareplanIDGet: %s\n" % e)

Parameters

Path parameters
Name Description
careplanID*
string_input
Required
patientMPIID*
string_input
Required

Responses

Status: 200 - A successful response

Status: 403 - Forbidden: Authentication Failure

Status: 406 - Unsupported Mediatype: The requested mediatype is not compatible with any supported response mediatypes.

Status: 415 - Unsupported Mediatype: Mediatype is not compatible with any supported request mediatypes.


publicPatientpatientPatientMPIIDGet

Returns a patient's Care Community ID and information about all the care plans associated with that patient.


/public-patient/$patient/{patientMPIID}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/vnd.intersystems.com.hs.hscc.public-patient.v1+json,application/json,default"\
"//public-patient/$patient/{patientMPIID}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PublicPatientApi;

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

public class PublicPatientApiExample {

    public static void main(String[] args) {

        PublicPatientApi apiInstance = new PublicPatientApi();
        string_input patientMPIID = ; // string_input |
        try {
            patient-summary_output result = apiInstance.publicPatientpatientPatientMPIIDGet(patientMPIID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PublicPatientApi#publicPatientpatientPatientMPIIDGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PublicPatientApi;

public class PublicPatientApiExample {

    public static void main(String[] args) {
        PublicPatientApi apiInstance = new PublicPatientApi();
        string_input patientMPIID = ; // string_input |
        try {
            patient-summary_output result = apiInstance.publicPatientpatientPatientMPIIDGet(patientMPIID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PublicPatientApi#publicPatientpatientPatientMPIIDGet");
            e.printStackTrace();
        }
    }
}
string_input *patientMPIID = ; //

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

[apiInstance publicPatientpatientPatientMPIIDGetWith:patientMPIID
              completionHandler: ^(patient-summary_output output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CareCommunityPublicApi_ = require('care_community_public_api_');

var api = new CareCommunityPublicApi_.PublicPatientApi()
var patientMPIID = ; // {{string_input}}

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.publicPatientpatientPatientMPIIDGet(patientMPIID, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new PublicPatientApi();
            var patientMPIID = new string_input(); // string_input |

            try
            {
                patient-summary_output result = apiInstance.publicPatientpatientPatientMPIIDGet(patientMPIID);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PublicPatientApi.publicPatientpatientPatientMPIIDGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiPublicPatientApi();
$patientMPIID = ; // string_input |

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

my $api_instance = WWW::SwaggerClient::PublicPatientApi->new();
my $patientMPIID = ; # string_input |

eval {
    my $result = $api_instance->publicPatientpatientPatientMPIIDGet(patientMPIID => $patientMPIID);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PublicPatientApi->publicPatientpatientPatientMPIIDGet: $@\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.PublicPatientApi()
patientMPIID =  # string_input |

try:
    api_response = api_instance.public_patientpatient_patient_mpiid_get(patientMPIID)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PublicPatientApi->publicPatientpatientPatientMPIIDGet: %s\n" % e)

Parameters

Path parameters
Name Description
patientMPIID*
string_input
Required

Responses

Status: 200 - A successful response

Status: 403 - Forbidden: Authentication Failure

Status: 406 - Unsupported Mediatype: The requested mediatype is not compatible with any supported response mediatypes.

Status: 415 - Unsupported Mediatype: Mediatype is not compatible with any supported request mediatypes.


PublicReport

publicReportreportCareplansCountsGet

API endpoint for a count of the number of care plans that were created in the system for a date range by day. IDs: Comma-separated values of DataModel.Template.ID. Example input values: "" or "1" or "2,3,4". startDate: The start of the date range to be counted. Example input values: "" or "YYYY-MM-DD" or "YYYY-MM". If only Year-Month is specified, Day defaults to the first day of the month. endDate: The end of the date range to be counted. Example input values: "" or "YYYY-MM-DD" or "YYYY-MM". If only Year-Month is specified, Day defaults to the last day of the month.


/public-report/$report/careplans/counts

Usage and SDK Samples

curl -X GET\
-H "Accept: application/vnd.intersystems.com.hs.hscc.public-report.v1+json,application/json,default"\
"//public-report/$report/careplans/counts?IDs=&startDate=&endDate="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PublicReportApi;

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

public class PublicReportApiExample {

    public static void main(String[] args) {

        PublicReportApi apiInstance = new PublicReportApi();
        string_input iDs = ; // string_input |
        string_input startDate = ; // string_input |
        string_input endDate = ; // string_input |
        try {
            care-plan-counts-report_output result = apiInstance.publicReportreportCareplansCountsGet(iDs, startDate, endDate);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PublicReportApi#publicReportreportCareplansCountsGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PublicReportApi;

public class PublicReportApiExample {

    public static void main(String[] args) {
        PublicReportApi apiInstance = new PublicReportApi();
        string_input iDs = ; // string_input |
        string_input startDate = ; // string_input |
        string_input endDate = ; // string_input |
        try {
            care-plan-counts-report_output result = apiInstance.publicReportreportCareplansCountsGet(iDs, startDate, endDate);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PublicReportApi#publicReportreportCareplansCountsGet");
            e.printStackTrace();
        }
    }
}
string_input *iDs = ; //  (optional)
string_input *startDate = ; //  (optional)
string_input *endDate = ; //  (optional)

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

[apiInstance publicReportreportCareplansCountsGetWith:iDs
    startDate:startDate
    endDate:endDate
              completionHandler: ^(care-plan-counts-report_output output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CareCommunityPublicApi_ = require('care_community_public_api_');

var api = new CareCommunityPublicApi_.PublicReportApi()
var opts = {
  'iDs': , // {{string_input}}
  'startDate': , // {{string_input}}
  'endDate':  // {{string_input}}
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.publicReportreportCareplansCountsGet(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new PublicReportApi();
            var iDs = new string_input(); // string_input |  (optional)
            var startDate = new string_input(); // string_input |  (optional)
            var endDate = new string_input(); // string_input |  (optional)

            try
            {
                care-plan-counts-report_output result = apiInstance.publicReportreportCareplansCountsGet(iDs, startDate, endDate);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PublicReportApi.publicReportreportCareplansCountsGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiPublicReportApi();
$iDs = ; // string_input |
$startDate = ; // string_input |
$endDate = ; // string_input |

try {
    $result = $api_instance->publicReportreportCareplansCountsGet($iDs, $startDate, $endDate);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PublicReportApi->publicReportreportCareplansCountsGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PublicReportApi;

my $api_instance = WWW::SwaggerClient::PublicReportApi->new();
my $iDs = ; # string_input |
my $startDate = ; # string_input |
my $endDate = ; # string_input |

eval {
    my $result = $api_instance->publicReportreportCareplansCountsGet(iDs => $iDs, startDate => $startDate, endDate => $endDate);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PublicReportApi->publicReportreportCareplansCountsGet: $@\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.PublicReportApi()
iDs =  # string_input |  (optional)
startDate =  # string_input |  (optional)
endDate =  # string_input |  (optional)

try:
    api_response = api_instance.public_reportreport_careplans_counts_get(iDs=iDs, startDate=startDate, endDate=endDate)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PublicReportApi->publicReportreportCareplansCountsGet: %s\n" % e)

Parameters

Query parameters
Name Description
IDs
string_input
startDate
string_input
endDate
string_input

Responses

Status: 200 - A successful response

Status: 400 - Invalid Date Parameters: The input dates are in the wrong format, or are not valid dates, or the input start date is not earlier than the input end date.

Status: 403 - Forbidden: Authentication Failure

Status: 406 - Unsupported Mediatype: The requested mediatype is not compatible with any supported response mediatypes.

Status: 415 - Unsupported Mediatype: Mediatype is not compatible with any supported request mediatypes.

Status: 500 - Unable to retrieve care plan report counts.


publicReportreportCareplansGet

API endpoint for retrieving all care plans that exist in the system.


/public-report/$report/careplans

Usage and SDK Samples

curl -X GET\
-H "Accept: application/vnd.intersystems.com.hs.hscc.public-report.v1+json,application/json,default"\
"//public-report/$report/careplans"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PublicReportApi;

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

public class PublicReportApiExample {

    public static void main(String[] args) {

        PublicReportApi apiInstance = new PublicReportApi();
        try {
            care-plan-report_output result = apiInstance.publicReportreportCareplansGet();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PublicReportApi#publicReportreportCareplansGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PublicReportApi;

public class PublicReportApiExample {

    public static void main(String[] args) {
        PublicReportApi apiInstance = new PublicReportApi();
        try {
            care-plan-report_output result = apiInstance.publicReportreportCareplansGet();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PublicReportApi#publicReportreportCareplansGet");
            e.printStackTrace();
        }
    }
}

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

[apiInstance publicReportreportCareplansGetWithCompletionHandler:
              ^(care-plan-report_output output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CareCommunityPublicApi_ = require('care_community_public_api_');

var api = new CareCommunityPublicApi_.PublicReportApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.publicReportreportCareplansGet(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new PublicReportApi();

            try
            {
                care-plan-report_output result = apiInstance.publicReportreportCareplansGet();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PublicReportApi.publicReportreportCareplansGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiPublicReportApi();

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

my $api_instance = WWW::SwaggerClient::PublicReportApi->new();

eval {
    my $result = $api_instance->publicReportreportCareplansGet();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PublicReportApi->publicReportreportCareplansGet: $@\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.PublicReportApi()

try:
    api_response = api_instance.public_reportreport_careplans_get()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PublicReportApi->publicReportreportCareplansGet: %s\n" % e)

Parameters

Responses

Status: 200 - A successful response

Status: 403 - Forbidden: Authentication Failure

Status: 406 - Unsupported Mediatype: The requested mediatype is not compatible with any supported response mediatypes.

Status: 415 - Unsupported Mediatype: Mediatype is not compatible with any supported request mediatypes.

Status: 500 - Unable to retrieve care plan report.


publicReportreportTasksUsersGet

API endpoint for getting a list of assigned tasks for given users. users: Comma-separated list of usernames.


/public-report/$report/tasks/{users}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/vnd.intersystems.com.hs.hscc.public-report.v1+json,application/json,default"\
"//public-report/$report/tasks/{users}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PublicReportApi;

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

public class PublicReportApiExample {

    public static void main(String[] args) {

        PublicReportApi apiInstance = new PublicReportApi();
        string_input users = ; // string_input |
        try {
            task-report_output result = apiInstance.publicReportreportTasksUsersGet(users);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PublicReportApi#publicReportreportTasksUsersGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PublicReportApi;

public class PublicReportApiExample {

    public static void main(String[] args) {
        PublicReportApi apiInstance = new PublicReportApi();
        string_input users = ; // string_input |
        try {
            task-report_output result = apiInstance.publicReportreportTasksUsersGet(users);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PublicReportApi#publicReportreportTasksUsersGet");
            e.printStackTrace();
        }
    }
}
string_input *users = ; //

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

[apiInstance publicReportreportTasksUsersGetWith:users
              completionHandler: ^(task-report_output output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CareCommunityPublicApi_ = require('care_community_public_api_');

var api = new CareCommunityPublicApi_.PublicReportApi()
var users = ; // {{string_input}}

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.publicReportreportTasksUsersGet(users, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new PublicReportApi();
            var users = new string_input(); // string_input |

            try
            {
                task-report_output result = apiInstance.publicReportreportTasksUsersGet(users);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PublicReportApi.publicReportreportTasksUsersGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiPublicReportApi();
$users = ; // string_input |

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

my $api_instance = WWW::SwaggerClient::PublicReportApi->new();
my $users = ; # string_input |

eval {
    my $result = $api_instance->publicReportreportTasksUsersGet(users => $users);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PublicReportApi->publicReportreportTasksUsersGet: $@\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.PublicReportApi()
users =  # string_input |

try:
    api_response = api_instance.public_reportreport_tasks_users_get(users)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PublicReportApi->publicReportreportTasksUsersGet: %s\n" % e)

Parameters

Path parameters
Name Description
users*
string_input
Required

Responses

Status: 200 - A successful response

Status: 403 - Forbidden: Authentication Failure

Status: 404 - Invalid input username, or acquired task from FHIR in invalid format.

Status: 406 - Unsupported Mediatype: The requested mediatype is not compatible with any supported response mediatypes.

Status: 415 - Unsupported Mediatype: Mediatype is not compatible with any supported request mediatypes.

Status: 500 - Failed to get user's assigned tasks.