goalGet
Get a Goal resource based on the resource ID, or search by ID, patient ID, lifecycle status, target date, or achievement status. For more information on the syntax used for searches, go to Searching.
/goal/
Usage and SDK Samples
curl -X GET\
-H "Accept: application/json,application/xml"\
"//goal/?_id=&patient=&lifecycle-status=&target-date=&achievement-status="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.GoalApi;
import java.io.File;
import java.util.*;
public class GoalApiExample {
public static void main(String[] args) {
GoalApi apiInstance = new GoalApi();
String id = id_example; // String | Resource ID.
String patient = patient_example; // String | Patient ID.
String lifecycleStatus = lifecycleStatus_example; // String | Lifecycle goal status. Values include proposed, planned, accepted, active, on-hold, completed, cancelled, entered-in-error, and rejected.
String targetDate = targetDate_example; // String | Reach goal on or before date.
String achievementStatus = achievementStatus_example; // String | Achievement of goal status. Values include in-proress, improving, worsening, no-change, achieved, sustaining, not-achieved, no-progress, and not-attainable.
try {
Goal result = apiInstance.goalGet(id, patient, lifecycleStatus, targetDate, achievementStatus);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling GoalApi#goalGet");
e.printStackTrace();
}
}
}
import io.swagger.client.api.GoalApi;
public class GoalApiExample {
public static void main(String[] args) {
GoalApi apiInstance = new GoalApi();
String id = id_example; // String | Resource ID.
String patient = patient_example; // String | Patient ID.
String lifecycleStatus = lifecycleStatus_example; // String | Lifecycle goal status. Values include proposed, planned, accepted, active, on-hold, completed, cancelled, entered-in-error, and rejected.
String targetDate = targetDate_example; // String | Reach goal on or before date.
String achievementStatus = achievementStatus_example; // String | Achievement of goal status. Values include in-proress, improving, worsening, no-change, achieved, sustaining, not-achieved, no-progress, and not-attainable.
try {
Goal result = apiInstance.goalGet(id, patient, lifecycleStatus, targetDate, achievementStatus);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling GoalApi#goalGet");
e.printStackTrace();
}
}
}
String *id = id_example; // Resource ID. (optional)
String *patient = patient_example; // Patient ID. (optional)
String *lifecycleStatus = lifecycleStatus_example; // Lifecycle goal status. Values include proposed, planned, accepted, active, on-hold, completed, cancelled, entered-in-error, and rejected. (optional)
String *targetDate = targetDate_example; // Reach goal on or before date. (optional)
String *achievementStatus = achievementStatus_example; // Achievement of goal status. Values include in-proress, improving, worsening, no-change, achieved, sustaining, not-achieved, no-progress, and not-attainable. (optional)
GoalApi *apiInstance = [[GoalApi alloc] init];
[apiInstance goalGetWith:id
patient:patient
lifecycleStatus:lifecycleStatus
targetDate:targetDate
achievementStatus:achievementStatus
completionHandler: ^(Goal output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
if (error) {
NSLog(@"Error: %@", error);
}
}];
var Goal = require('goal');
var api = new Goal.GoalApi()
var opts = {
'id': id_example, // {{String}} Resource ID.
'patient': patient_example, // {{String}} Patient ID.
'lifecycleStatus': lifecycleStatus_example, // {{String}} Lifecycle goal status. Values include proposed, planned, accepted, active, on-hold, completed, cancelled, entered-in-error, and rejected.
'targetDate': targetDate_example, // {{String}} Reach goal on or before date.
'achievementStatus': achievementStatus_example // {{String}} Achievement of goal status. Values include in-proress, improving, worsening, no-change, achieved, sustaining, not-achieved, no-progress, and not-attainable.
};
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.goalGet(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;
namespace Example
{
public class goalGetExample
{
public void main()
{
var apiInstance = new GoalApi();
var id = id_example; // String | Resource ID. (optional)
var patient = patient_example; // String | Patient ID. (optional)
var lifecycleStatus = lifecycleStatus_example; // String | Lifecycle goal status. Values include proposed, planned, accepted, active, on-hold, completed, cancelled, entered-in-error, and rejected. (optional)
var targetDate = targetDate_example; // String | Reach goal on or before date. (optional)
var achievementStatus = achievementStatus_example; // String | Achievement of goal status. Values include in-proress, improving, worsening, no-change, achieved, sustaining, not-achieved, no-progress, and not-attainable. (optional)
try
{
Goal result = apiInstance.goalGet(id, patient, lifecycleStatus, targetDate, achievementStatus);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling GoalApi.goalGet: " + e.Message );
}
}
}
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$api_instance = new Swagger\Client\ApiGoalApi();
$id = id_example; // String | Resource ID.
$patient = patient_example; // String | Patient ID.
$lifecycleStatus = lifecycleStatus_example; // String | Lifecycle goal status. Values include proposed, planned, accepted, active, on-hold, completed, cancelled, entered-in-error, and rejected.
$targetDate = targetDate_example; // String | Reach goal on or before date.
$achievementStatus = achievementStatus_example; // String | Achievement of goal status. Values include in-proress, improving, worsening, no-change, achieved, sustaining, not-achieved, no-progress, and not-attainable.
try {
$result = $api_instance->goalGet($id, $patient, $lifecycleStatus, $targetDate, $achievementStatus);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling GoalApi->goalGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::GoalApi;
my $api_instance = WWW::SwaggerClient::GoalApi->new();
my $id = id_example; # String | Resource ID.
my $patient = patient_example; # String | Patient ID.
my $lifecycleStatus = lifecycleStatus_example; # String | Lifecycle goal status. Values include proposed, planned, accepted, active, on-hold, completed, cancelled, entered-in-error, and rejected.
my $targetDate = targetDate_example; # String | Reach goal on or before date.
my $achievementStatus = achievementStatus_example; # String | Achievement of goal status. Values include in-proress, improving, worsening, no-change, achieved, sustaining, not-achieved, no-progress, and not-attainable.
eval {
my $result = $api_instance->goalGet(id => $id, patient => $patient, lifecycleStatus => $lifecycleStatus, targetDate => $targetDate, achievementStatus => $achievementStatus);
print Dumper($result);
};
if ($@) {
warn "Exception when calling GoalApi->goalGet: $@\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.GoalApi()
id = id_example # String | Resource ID. (optional)
patient = patient_example # String | Patient ID. (optional)
lifecycleStatus = lifecycleStatus_example # String | Lifecycle goal status. Values include proposed, planned, accepted, active, on-hold, completed, cancelled, entered-in-error, and rejected. (optional)
targetDate = targetDate_example # String | Reach goal on or before date. (optional)
achievementStatus = achievementStatus_example # String | Achievement of goal status. Values include in-proress, improving, worsening, no-change, achieved, sustaining, not-achieved, no-progress, and not-attainable. (optional)
try:
api_response = api_instance.goal_get(id=id, patient=patient, lifecycleStatus=lifecycleStatus, targetDate=targetDate, achievementStatus=achievementStatus)
pprint(api_response)
except ApiException as e:
print("Exception when calling GoalApi->goalGet: %s\n" % e)
Parameters
Query parameters
| Name | Description |
|---|---|
| _id |
String
Resource ID.
|
| patient |
String
Patient ID.
|
| lifecycle-status |
String
Lifecycle goal status. Values include proposed, planned, accepted, active, on-hold, completed, cancelled, entered-in-error, and rejected.
|
| target-date |
String
Reach goal on or before date.
|
| achievement-status |
String
Achievement of goal status. Values include in-proress, improving, worsening, no-change, achieved, sustaining, not-achieved, no-progress, and not-attainable.
|