Goal

Goal

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.

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


goalPatientLifecycleStatusGet

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


/goal/[patient]&[lifecycle-status]

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json,application/xml"\
"//goal/[patient]&[lifecycle-status]?lifecycle-status=&patient="
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 lifecycleStatus = lifecycleStatus_example; // String | Lifecycle goal status. Values include proposed, planned, accepted, active, on-hold, completed, cancelled, entered-in-error, and rejected.
        String patient = patient_example; // String | Patient ID.
        try {
            Goal result = apiInstance.goalPatientLifecycleStatusGet(lifecycleStatus, patient);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GoalApi#goalPatientLifecycleStatusGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.GoalApi;

public class GoalApiExample {

    public static void main(String[] args) {
        GoalApi apiInstance = new GoalApi();
        String lifecycleStatus = lifecycleStatus_example; // String | Lifecycle goal status. Values include proposed, planned, accepted, active, on-hold, completed, cancelled, entered-in-error, and rejected.
        String patient = patient_example; // String | Patient ID.
        try {
            Goal result = apiInstance.goalPatientLifecycleStatusGet(lifecycleStatus, patient);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GoalApi#goalPatientLifecycleStatusGet");
            e.printStackTrace();
        }
    }
}
String *lifecycleStatus = lifecycleStatus_example; // Lifecycle goal status. Values include proposed, planned, accepted, active, on-hold, completed, cancelled, entered-in-error, and rejected. (optional)
String *patient = patient_example; // Patient ID. (optional)

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

[apiInstance goalPatientLifecycleStatusGetWith:lifecycleStatus
    patient:patient
              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 = { 
  'lifecycleStatus': lifecycleStatus_example, // {{String}} Lifecycle goal status. Values include proposed, planned, accepted, active, on-hold, completed, cancelled, entered-in-error, and rejected.
  'patient': patient_example // {{String}} Patient ID.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.goalPatientLifecycleStatusGet(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new GoalApi();
            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 patient = patient_example;  // String | Patient ID. (optional) 

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

$api_instance = new Swagger\Client\ApiGoalApi();
$lifecycleStatus = lifecycleStatus_example; // String | Lifecycle goal status. Values include proposed, planned, accepted, active, on-hold, completed, cancelled, entered-in-error, and rejected.
$patient = patient_example; // String | Patient ID.

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

my $api_instance = WWW::SwaggerClient::GoalApi->new();
my $lifecycleStatus = lifecycleStatus_example; # String | Lifecycle goal status. Values include proposed, planned, accepted, active, on-hold, completed, cancelled, entered-in-error, and rejected.
my $patient = patient_example; # String | Patient ID.

eval { 
    my $result = $api_instance->goalPatientLifecycleStatusGet(lifecycleStatus => $lifecycleStatus, patient => $patient);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GoalApi->goalPatientLifecycleStatusGet: $@\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()
lifecycleStatus = lifecycleStatus_example # String | Lifecycle goal status. Values include proposed, planned, accepted, active, on-hold, completed, cancelled, entered-in-error, and rejected. (optional)
patient = patient_example # String | Patient ID. (optional)

try: 
    api_response = api_instance.goal_patient_lifecycle_status_get(lifecycleStatus=lifecycleStatus, patient=patient)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GoalApi->goalPatientLifecycleStatusGet: %s\n" % e)

Parameters

Query parameters
Name Description
lifecycle-status
String
Lifecycle goal status. Values include proposed, planned, accepted, active, on-hold, completed, cancelled, entered-in-error, and rejected.
patient
String
Patient ID.

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


goalPatientTargetDateGet

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


/goal/[patient]&[target-date]

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json,application/xml"\
"//goal/[patient]&[target-date]?patient=&target-date="
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 patient = patient_example; // String | Patient ID.
        String targetDate = targetDate_example; // String | Reach goal on or before date.
        try {
            Goal result = apiInstance.goalPatientTargetDateGet(patient, targetDate);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GoalApi#goalPatientTargetDateGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.GoalApi;

public class GoalApiExample {

    public static void main(String[] args) {
        GoalApi apiInstance = new GoalApi();
        String patient = patient_example; // String | Patient ID.
        String targetDate = targetDate_example; // String | Reach goal on or before date.
        try {
            Goal result = apiInstance.goalPatientTargetDateGet(patient, targetDate);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GoalApi#goalPatientTargetDateGet");
            e.printStackTrace();
        }
    }
}
String *patient = patient_example; // Patient ID. (optional)
String *targetDate = targetDate_example; // Reach goal on or before date. (optional)

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

[apiInstance goalPatientTargetDateGetWith:patient
    targetDate:targetDate
              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 = { 
  'patient': patient_example, // {{String}} Patient ID.
  'targetDate': targetDate_example // {{String}} Reach goal on or before date.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.goalPatientTargetDateGet(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new GoalApi();
            var patient = patient_example;  // String | Patient ID. (optional) 
            var targetDate = targetDate_example;  // String | Reach goal on or before date. (optional) 

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

$api_instance = new Swagger\Client\ApiGoalApi();
$patient = patient_example; // String | Patient ID.
$targetDate = targetDate_example; // String | Reach goal on or before date.

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

my $api_instance = WWW::SwaggerClient::GoalApi->new();
my $patient = patient_example; # String | Patient ID.
my $targetDate = targetDate_example; # String | Reach goal on or before date.

eval { 
    my $result = $api_instance->goalPatientTargetDateGet(patient => $patient, targetDate => $targetDate);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GoalApi->goalPatientTargetDateGet: $@\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()
patient = patient_example # String | Patient ID. (optional)
targetDate = targetDate_example # String | Reach goal on or before date. (optional)

try: 
    api_response = api_instance.goal_patient_target_date_get(patient=patient, targetDate=targetDate)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GoalApi->goalPatientTargetDateGet: %s\n" % e)

Parameters

Query parameters
Name Description
patient
String
Patient ID.
target-date
String
Reach goal on or before date.

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