Observation

Observation

observationCategoryDateGet

Search for Observation resources based on the combination of category and date.


/Observation/[category]&[date]

Usage and SDK Samples

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

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

public class ObservationApiExample {

    public static void main(String[] args) {
        
        ObservationApi apiInstance = new ObservationApi();
        String category = category_example; // String | Observation category.
        String date = date_example; // String | Date the observation was recorded.
        try {
            Observation result = apiInstance.observationCategoryDateGet(category, date);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ObservationApi#observationCategoryDateGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ObservationApi;

public class ObservationApiExample {

    public static void main(String[] args) {
        ObservationApi apiInstance = new ObservationApi();
        String category = category_example; // String | Observation category.
        String date = date_example; // String | Date the observation was recorded.
        try {
            Observation result = apiInstance.observationCategoryDateGet(category, date);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ObservationApi#observationCategoryDateGet");
            e.printStackTrace();
        }
    }
}
String *category = category_example; // Observation category. (optional)
String *date = date_example; // Date the observation was recorded. (optional)

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

[apiInstance observationCategoryDateGetWith:category
    date:date
              completionHandler: ^(Observation output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Observation = require('observation');

var api = new Observation.ObservationApi()
var opts = { 
  'category': category_example, // {{String}} Observation category.
  'date': date_example // {{String}} Date the observation was recorded.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.observationCategoryDateGet(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new ObservationApi();
            var category = category_example;  // String | Observation category. (optional) 
            var date = date_example;  // String | Date the observation was recorded. (optional) 

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

$api_instance = new Swagger\Client\ApiObservationApi();
$category = category_example; // String | Observation category.
$date = date_example; // String | Date the observation was recorded.

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

my $api_instance = WWW::SwaggerClient::ObservationApi->new();
my $category = category_example; # String | Observation category.
my $date = date_example; # String | Date the observation was recorded.

eval { 
    my $result = $api_instance->observationCategoryDateGet(category => $category, date => $date);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ObservationApi->observationCategoryDateGet: $@\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.ObservationApi()
category = category_example # String | Observation category. (optional)
date = date_example # String | Date the observation was recorded. (optional)

try: 
    api_response = api_instance.observation_category_date_get(category=category, date=date)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ObservationApi->observationCategoryDateGet: %s\n" % e)

Parameters

Query parameters
Name Description
category
String
Observation category.
date
String
Date the observation was recorded.

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


observationCategoryStatusGet

Search for Observation resources based on the combination of category and status.


/Observation/[category]&[status]

Usage and SDK Samples

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

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

public class ObservationApiExample {

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

public class ObservationApiExample {

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

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

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

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

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

            var apiInstance = new ObservationApi();
            var category = category_example;  // String | Observation category. (optional) 
            var status = status_example;  // String | Observation status. (optional) 

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

$api_instance = new Swagger\Client\ApiObservationApi();
$category = category_example; // String | Observation category.
$status = status_example; // String | Observation status.

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

my $api_instance = WWW::SwaggerClient::ObservationApi->new();
my $category = category_example; # String | Observation category.
my $status = status_example; # String | Observation status.

eval { 
    my $result = $api_instance->observationCategoryStatusGet(category => $category, status => $status);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ObservationApi->observationCategoryStatusGet: $@\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.ObservationApi()
category = category_example # String | Observation category. (optional)
status = status_example # String | Observation status. (optional)

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

Parameters

Query parameters
Name Description
category
String
Observation category.
status
String
Observation 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


observationCodeDateGet

Search for Observation resources based on the combination of code and date.


/Observation/[code]&[date]

Usage and SDK Samples

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

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

public class ObservationApiExample {

    public static void main(String[] args) {
        
        ObservationApi apiInstance = new ObservationApi();
        String code = code_example; // String | Observation LOINC code.
        String date = date_example; // String | Date the observation was recorded.
        try {
            Observation result = apiInstance.observationCodeDateGet(code, date);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ObservationApi#observationCodeDateGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ObservationApi;

public class ObservationApiExample {

    public static void main(String[] args) {
        ObservationApi apiInstance = new ObservationApi();
        String code = code_example; // String | Observation LOINC code.
        String date = date_example; // String | Date the observation was recorded.
        try {
            Observation result = apiInstance.observationCodeDateGet(code, date);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ObservationApi#observationCodeDateGet");
            e.printStackTrace();
        }
    }
}
String *code = code_example; // Observation LOINC code. (optional)
String *date = date_example; // Date the observation was recorded. (optional)

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

[apiInstance observationCodeDateGetWith:code
    date:date
              completionHandler: ^(Observation output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Observation = require('observation');

var api = new Observation.ObservationApi()
var opts = { 
  'code': code_example, // {{String}} Observation LOINC code.
  'date': date_example // {{String}} Date the observation was recorded.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.observationCodeDateGet(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new ObservationApi();
            var code = code_example;  // String | Observation LOINC code. (optional) 
            var date = date_example;  // String | Date the observation was recorded. (optional) 

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

$api_instance = new Swagger\Client\ApiObservationApi();
$code = code_example; // String | Observation LOINC code.
$date = date_example; // String | Date the observation was recorded.

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

my $api_instance = WWW::SwaggerClient::ObservationApi->new();
my $code = code_example; # String | Observation LOINC code.
my $date = date_example; # String | Date the observation was recorded.

eval { 
    my $result = $api_instance->observationCodeDateGet(code => $code, date => $date);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ObservationApi->observationCodeDateGet: $@\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.ObservationApi()
code = code_example # String | Observation LOINC code. (optional)
date = date_example # String | Date the observation was recorded. (optional)

try: 
    api_response = api_instance.observation_code_date_get(code=code, date=date)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ObservationApi->observationCodeDateGet: %s\n" % e)

Parameters

Query parameters
Name Description
code
String
Observation LOINC code.
date
String
Date the observation was recorded.

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


observationGet

Get an Observation resource based on the resource ID, or search by ID, patient, category, code, date, status, or combo-code.


/Observation/

Usage and SDK Samples

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

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

public class ObservationApiExample {

    public static void main(String[] args) {
        
        ObservationApi apiInstance = new ObservationApi();
        String id = id_example; // String | Resource ID.
        String patient = patient_example; // String | Patient ID.
        String category = category_example; // String | Observation category.
        String code = code_example; // String | Observation LOINC code.
        String date = date_example; // String | Date the observation was recorded.
        String status = status_example; // String | Observation status.
        try {
            Observation result = apiInstance.observationGet(id, patient, category, code, date, status);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ObservationApi#observationGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ObservationApi;

public class ObservationApiExample {

    public static void main(String[] args) {
        ObservationApi apiInstance = new ObservationApi();
        String id = id_example; // String | Resource ID.
        String patient = patient_example; // String | Patient ID.
        String category = category_example; // String | Observation category.
        String code = code_example; // String | Observation LOINC code.
        String date = date_example; // String | Date the observation was recorded.
        String status = status_example; // String | Observation status.
        try {
            Observation result = apiInstance.observationGet(id, patient, category, code, date, status);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ObservationApi#observationGet");
            e.printStackTrace();
        }
    }
}
String *id = id_example; // Resource ID. (optional)
String *patient = patient_example; // Patient ID. (optional)
String *category = category_example; // Observation category. (optional)
String *code = code_example; // Observation LOINC code. (optional)
String *date = date_example; // Date the observation was recorded. (optional)
String *status = status_example; // Observation status. (optional)

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

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

var api = new Observation.ObservationApi()
var opts = { 
  'id': id_example, // {{String}} Resource ID.
  'patient': patient_example, // {{String}} Patient ID.
  'category': category_example, // {{String}} Observation category.
  'code': code_example, // {{String}} Observation LOINC code.
  'date': date_example, // {{String}} Date the observation was recorded.
  'status': status_example // {{String}} Observation status.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.observationGet(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new ObservationApi();
            var id = id_example;  // String | Resource ID. (optional) 
            var patient = patient_example;  // String | Patient ID. (optional) 
            var category = category_example;  // String | Observation category. (optional) 
            var code = code_example;  // String | Observation LOINC code. (optional) 
            var date = date_example;  // String | Date the observation was recorded. (optional) 
            var status = status_example;  // String | Observation status. (optional) 

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

$api_instance = new Swagger\Client\ApiObservationApi();
$id = id_example; // String | Resource ID.
$patient = patient_example; // String | Patient ID.
$category = category_example; // String | Observation category.
$code = code_example; // String | Observation LOINC code.
$date = date_example; // String | Date the observation was recorded.
$status = status_example; // String | Observation status.

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

my $api_instance = WWW::SwaggerClient::ObservationApi->new();
my $id = id_example; # String | Resource ID.
my $patient = patient_example; # String | Patient ID.
my $category = category_example; # String | Observation category.
my $code = code_example; # String | Observation LOINC code.
my $date = date_example; # String | Date the observation was recorded.
my $status = status_example; # String | Observation status.

eval { 
    my $result = $api_instance->observationGet(id => $id, patient => $patient, category => $category, code => $code, date => $date, status => $status);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ObservationApi->observationGet: $@\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.ObservationApi()
id = id_example # String | Resource ID. (optional)
patient = patient_example # String | Patient ID. (optional)
category = category_example # String | Observation category. (optional)
code = code_example # String | Observation LOINC code. (optional)
date = date_example # String | Date the observation was recorded. (optional)
status = status_example # String | Observation status. (optional)

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

Parameters

Query parameters
Name Description
_id
String
Resource ID.
patient
String
Patient ID.
category
String
Observation category.
code
String
Observation LOINC code.
date
String
Date the observation was recorded.
status
String
Observation 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


observationPatientCategoryDateGet

Search for Observation resources based on the combination of patient ID, category, and date.


/Observation/[patient]&[category]&[date]

Usage and SDK Samples

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

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

public class ObservationApiExample {

    public static void main(String[] args) {
        
        ObservationApi apiInstance = new ObservationApi();
        String patient = patient_example; // String | Patient ID.
        String category = category_example; // String | Observation category.
        String date = date_example; // String | Date the observation was recorded.
        try {
            Observation result = apiInstance.observationPatientCategoryDateGet(patient, category, date);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ObservationApi#observationPatientCategoryDateGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ObservationApi;

public class ObservationApiExample {

    public static void main(String[] args) {
        ObservationApi apiInstance = new ObservationApi();
        String patient = patient_example; // String | Patient ID.
        String category = category_example; // String | Observation category.
        String date = date_example; // String | Date the observation was recorded.
        try {
            Observation result = apiInstance.observationPatientCategoryDateGet(patient, category, date);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ObservationApi#observationPatientCategoryDateGet");
            e.printStackTrace();
        }
    }
}
String *patient = patient_example; // Patient ID. (optional)
String *category = category_example; // Observation category. (optional)
String *date = date_example; // Date the observation was recorded. (optional)

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

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

var api = new Observation.ObservationApi()
var opts = { 
  'patient': patient_example, // {{String}} Patient ID.
  'category': category_example, // {{String}} Observation category.
  'date': date_example // {{String}} Date the observation was recorded.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.observationPatientCategoryDateGet(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new ObservationApi();
            var patient = patient_example;  // String | Patient ID. (optional) 
            var category = category_example;  // String | Observation category. (optional) 
            var date = date_example;  // String | Date the observation was recorded. (optional) 

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

$api_instance = new Swagger\Client\ApiObservationApi();
$patient = patient_example; // String | Patient ID.
$category = category_example; // String | Observation category.
$date = date_example; // String | Date the observation was recorded.

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

my $api_instance = WWW::SwaggerClient::ObservationApi->new();
my $patient = patient_example; # String | Patient ID.
my $category = category_example; # String | Observation category.
my $date = date_example; # String | Date the observation was recorded.

eval { 
    my $result = $api_instance->observationPatientCategoryDateGet(patient => $patient, category => $category, date => $date);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ObservationApi->observationPatientCategoryDateGet: $@\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.ObservationApi()
patient = patient_example # String | Patient ID. (optional)
category = category_example # String | Observation category. (optional)
date = date_example # String | Date the observation was recorded. (optional)

try: 
    api_response = api_instance.observation_patient_category_date_get(patient=patient, category=category, date=date)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ObservationApi->observationPatientCategoryDateGet: %s\n" % e)

Parameters

Query parameters
Name Description
patient
String
Patient ID.
category
String
Observation category.
date
String
Date the observation was recorded.

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


observationPatientCategoryGet

Search for Observation resources based on the combination of patient ID and category.


/Observation/[patient]&[category]

Usage and SDK Samples

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

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

public class ObservationApiExample {

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

public class ObservationApiExample {

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

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

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

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

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

            var apiInstance = new ObservationApi();
            var patient = patient_example;  // String | Patient ID. (optional) 
            var category = category_example;  // String | Observation category. (optional) 

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

$api_instance = new Swagger\Client\ApiObservationApi();
$patient = patient_example; // String | Patient ID.
$category = category_example; // String | Observation category.

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

my $api_instance = WWW::SwaggerClient::ObservationApi->new();
my $patient = patient_example; # String | Patient ID.
my $category = category_example; # String | Observation category.

eval { 
    my $result = $api_instance->observationPatientCategoryGet(patient => $patient, category => $category);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ObservationApi->observationPatientCategoryGet: $@\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.ObservationApi()
patient = patient_example # String | Patient ID. (optional)
category = category_example # String | Observation category. (optional)

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

Parameters

Query parameters
Name Description
patient
String
Patient ID.
category
String
Observation category.

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


observationPatientCategoryStatusGet

Search for Observation resources based on the combination of patient ID, category, and status.


/Observation/[patient]&[category]&[status]

Usage and SDK Samples

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

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

public class ObservationApiExample {

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

public class ObservationApiExample {

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

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

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

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

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

            var apiInstance = new ObservationApi();
            var patient = patient_example;  // String | Patient ID. (optional) 
            var category = category_example;  // String | Observation category. (optional) 
            var status = status_example;  // String | Observation status. (optional) 

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

$api_instance = new Swagger\Client\ApiObservationApi();
$patient = patient_example; // String | Patient ID.
$category = category_example; // String | Observation category.
$status = status_example; // String | Observation status.

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

my $api_instance = WWW::SwaggerClient::ObservationApi->new();
my $patient = patient_example; # String | Patient ID.
my $category = category_example; # String | Observation category.
my $status = status_example; # String | Observation status.

eval { 
    my $result = $api_instance->observationPatientCategoryStatusGet(patient => $patient, category => $category, status => $status);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ObservationApi->observationPatientCategoryStatusGet: $@\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.ObservationApi()
patient = patient_example # String | Patient ID. (optional)
category = category_example # String | Observation category. (optional)
status = status_example # String | Observation status. (optional)

try: 
    api_response = api_instance.observation_patient_category_status_get(patient=patient, category=category, status=status)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ObservationApi->observationPatientCategoryStatusGet: %s\n" % e)

Parameters

Query parameters
Name Description
patient
String
Patient ID.
category
String
Observation category.
status
String
Observation 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


observationPatientCodeDateGet

Search for Observation resources based on the combination of patient ID, code, and date.


/Observation/[patient]&[code]&[date]

Usage and SDK Samples

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

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

public class ObservationApiExample {

    public static void main(String[] args) {
        
        ObservationApi apiInstance = new ObservationApi();
        String patient = patient_example; // String | Patient ID.
        String code = code_example; // String | Observation LOINC code.
        String date = date_example; // String | Date the observation was recorded.
        try {
            Observation result = apiInstance.observationPatientCodeDateGet(patient, code, date);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ObservationApi#observationPatientCodeDateGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ObservationApi;

public class ObservationApiExample {

    public static void main(String[] args) {
        ObservationApi apiInstance = new ObservationApi();
        String patient = patient_example; // String | Patient ID.
        String code = code_example; // String | Observation LOINC code.
        String date = date_example; // String | Date the observation was recorded.
        try {
            Observation result = apiInstance.observationPatientCodeDateGet(patient, code, date);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ObservationApi#observationPatientCodeDateGet");
            e.printStackTrace();
        }
    }
}
String *patient = patient_example; // Patient ID. (optional)
String *code = code_example; // Observation LOINC code. (optional)
String *date = date_example; // Date the observation was recorded. (optional)

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

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

var api = new Observation.ObservationApi()
var opts = { 
  'patient': patient_example, // {{String}} Patient ID.
  'code': code_example, // {{String}} Observation LOINC code.
  'date': date_example // {{String}} Date the observation was recorded.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.observationPatientCodeDateGet(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new ObservationApi();
            var patient = patient_example;  // String | Patient ID. (optional) 
            var code = code_example;  // String | Observation LOINC code. (optional) 
            var date = date_example;  // String | Date the observation was recorded. (optional) 

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

$api_instance = new Swagger\Client\ApiObservationApi();
$patient = patient_example; // String | Patient ID.
$code = code_example; // String | Observation LOINC code.
$date = date_example; // String | Date the observation was recorded.

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

my $api_instance = WWW::SwaggerClient::ObservationApi->new();
my $patient = patient_example; # String | Patient ID.
my $code = code_example; # String | Observation LOINC code.
my $date = date_example; # String | Date the observation was recorded.

eval { 
    my $result = $api_instance->observationPatientCodeDateGet(patient => $patient, code => $code, date => $date);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ObservationApi->observationPatientCodeDateGet: $@\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.ObservationApi()
patient = patient_example # String | Patient ID. (optional)
code = code_example # String | Observation LOINC code. (optional)
date = date_example # String | Date the observation was recorded. (optional)

try: 
    api_response = api_instance.observation_patient_code_date_get(patient=patient, code=code, date=date)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ObservationApi->observationPatientCodeDateGet: %s\n" % e)

Parameters

Query parameters
Name Description
patient
String
Patient ID.
code
String
Observation LOINC code.
date
String
Date the observation was recorded.

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


observationPatientCodeGet

Search for Observation resources based on the combination of patient ID and code.


/Observation/[patient]&[code]

Usage and SDK Samples

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

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

public class ObservationApiExample {

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

public class ObservationApiExample {

    public static void main(String[] args) {
        ObservationApi apiInstance = new ObservationApi();
        String patient = patient_example; // String | Patient ID.
        String code = code_example; // String | Observation LOINC code.
        try {
            Observation result = apiInstance.observationPatientCodeGet(patient, code);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ObservationApi#observationPatientCodeGet");
            e.printStackTrace();
        }
    }
}
String *patient = patient_example; // Patient ID. (optional)
String *code = code_example; // Observation LOINC code. (optional)

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

[apiInstance observationPatientCodeGetWith:patient
    code:code
              completionHandler: ^(Observation output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Observation = require('observation');

var api = new Observation.ObservationApi()
var opts = { 
  'patient': patient_example, // {{String}} Patient ID.
  'code': code_example // {{String}} Observation LOINC code.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.observationPatientCodeGet(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new ObservationApi();
            var patient = patient_example;  // String | Patient ID. (optional) 
            var code = code_example;  // String | Observation LOINC code. (optional) 

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

$api_instance = new Swagger\Client\ApiObservationApi();
$patient = patient_example; // String | Patient ID.
$code = code_example; // String | Observation LOINC code.

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

my $api_instance = WWW::SwaggerClient::ObservationApi->new();
my $patient = patient_example; # String | Patient ID.
my $code = code_example; # String | Observation LOINC code.

eval { 
    my $result = $api_instance->observationPatientCodeGet(patient => $patient, code => $code);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ObservationApi->observationPatientCodeGet: $@\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.ObservationApi()
patient = patient_example # String | Patient ID. (optional)
code = code_example # String | Observation LOINC code. (optional)

try: 
    api_response = api_instance.observation_patient_code_get(patient=patient, code=code)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ObservationApi->observationPatientCodeGet: %s\n" % e)

Parameters

Query parameters
Name Description
patient
String
Patient ID.
code
String
Observation LOINC code.

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


observationPatientDateGet

Search for Observation resources based on the combination of patient ID and date.


/Observation/[patient]&[date]

Usage and SDK Samples

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

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

public class ObservationApiExample {

    public static void main(String[] args) {
        
        ObservationApi apiInstance = new ObservationApi();
        String patient = patient_example; // String | Patient ID.
        String date = date_example; // String | Date the observation was recorded.
        try {
            Observation result = apiInstance.observationPatientDateGet(patient, date);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ObservationApi#observationPatientDateGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ObservationApi;

public class ObservationApiExample {

    public static void main(String[] args) {
        ObservationApi apiInstance = new ObservationApi();
        String patient = patient_example; // String | Patient ID.
        String date = date_example; // String | Date the observation was recorded.
        try {
            Observation result = apiInstance.observationPatientDateGet(patient, date);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ObservationApi#observationPatientDateGet");
            e.printStackTrace();
        }
    }
}
String *patient = patient_example; // Patient ID. (optional)
String *date = date_example; // Date the observation was recorded. (optional)

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

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

var api = new Observation.ObservationApi()
var opts = { 
  'patient': patient_example, // {{String}} Patient ID.
  'date': date_example // {{String}} Date the observation was recorded.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.observationPatientDateGet(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new ObservationApi();
            var patient = patient_example;  // String | Patient ID. (optional) 
            var date = date_example;  // String | Date the observation was recorded. (optional) 

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

$api_instance = new Swagger\Client\ApiObservationApi();
$patient = patient_example; // String | Patient ID.
$date = date_example; // String | Date the observation was recorded.

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

my $api_instance = WWW::SwaggerClient::ObservationApi->new();
my $patient = patient_example; # String | Patient ID.
my $date = date_example; # String | Date the observation was recorded.

eval { 
    my $result = $api_instance->observationPatientDateGet(patient => $patient, date => $date);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ObservationApi->observationPatientDateGet: $@\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.ObservationApi()
patient = patient_example # String | Patient ID. (optional)
date = date_example # String | Date the observation was recorded. (optional)

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

Parameters

Query parameters
Name Description
patient
String
Patient ID.
date
String
Date the observation was recorded.

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


observationPatientStatusGet

Search for Observation resources based on the combination of patient ID and status.


/Observation/[patient]&[status]

Usage and SDK Samples

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

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

public class ObservationApiExample {

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

public class ObservationApiExample {

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

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

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

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

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

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

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

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

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

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

eval { 
    my $result = $api_instance->observationPatientStatusGet(patient => $patient, status => $status);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ObservationApi->observationPatientStatusGet: $@\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.ObservationApi()
patient = patient_example # String | Patient ID. (optional)
status = status_example # String | Observation status. (optional)

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

Parameters

Query parameters
Name Description
patient
String
Patient ID.
status
String
Observation 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