DocumentReference

DocumentReference

documentReferenceCategoryDateGet

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


/DocumentReference/[category]&[date]

Usage and SDK Samples

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

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

public class DocumentReferenceApiExample {

    public static void main(String[] args) {
        
        DocumentReferenceApi apiInstance = new DocumentReferenceApi();
        String category = category_example; // String | Categorization of document.
        String date = date_example; // String | When the document reference was created. For more information on date formats, see dates.
        try {
            DocumentReference result = apiInstance.documentReferenceCategoryDateGet(category, date);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DocumentReferenceApi#documentReferenceCategoryDateGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DocumentReferenceApi;

public class DocumentReferenceApiExample {

    public static void main(String[] args) {
        DocumentReferenceApi apiInstance = new DocumentReferenceApi();
        String category = category_example; // String | Categorization of document.
        String date = date_example; // String | When the document reference was created. For more information on date formats, see dates.
        try {
            DocumentReference result = apiInstance.documentReferenceCategoryDateGet(category, date);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DocumentReferenceApi#documentReferenceCategoryDateGet");
            e.printStackTrace();
        }
    }
}
String *category = category_example; // Categorization of document. (optional)
String *date = date_example; // When the document reference was created. For more information on date formats, see dates. (optional)

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

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

var api = new DocumentReference.DocumentReferenceApi()
var opts = { 
  'category': category_example, // {{String}} Categorization of document.
  'date': date_example // {{String}} When the document reference was created. For more information on date formats, see dates.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.documentReferenceCategoryDateGet(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new DocumentReferenceApi();
            var category = category_example;  // String | Categorization of document. (optional) 
            var date = date_example;  // String | When the document reference was created. For more information on date formats, see dates. (optional) 

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

$api_instance = new Swagger\Client\ApiDocumentReferenceApi();
$category = category_example; // String | Categorization of document.
$date = date_example; // String | When the document reference was created. For more information on date formats, see dates.

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

my $api_instance = WWW::SwaggerClient::DocumentReferenceApi->new();
my $category = category_example; # String | Categorization of document.
my $date = date_example; # String | When the document reference was created. For more information on date formats, see dates.

eval { 
    my $result = $api_instance->documentReferenceCategoryDateGet(category => $category, date => $date);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DocumentReferenceApi->documentReferenceCategoryDateGet: $@\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.DocumentReferenceApi()
category = category_example # String | Categorization of document. (optional)
date = date_example # String | When the document reference was created. For more information on date formats, see dates. (optional)

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

Parameters

Query parameters
Name Description
category
String
Categorization of document.
date
String
When the document reference was created. For more information on date formats, see <a href="http://hl7.org/fhir/search.html#date">dates</a>.

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


documentReferenceGet

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


/DocumentReference/

Usage and SDK Samples

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

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

public class DocumentReferenceApiExample {

    public static void main(String[] args) {
        
        DocumentReferenceApi apiInstance = new DocumentReferenceApi();
        String id = id_example; // String | Resource ID.
        String patient = patient_example; // String | Patient ID.
        String date = date_example; // String | When the document reference was created. For more information on date formats, see dates.
        String period = period_example; // String | Time of service that is being documented.For more information on date formats, see dates.
        String type = type_example; // String | Kind of document (LOINC code).
        String category = category_example; // String | Categorization of document.
        String status = status_example; // String | Document reference status. Values include current, superseded, and entered-in-error.
        try {
            DocumentReference result = apiInstance.documentReferenceGet(id, patient, date, period, type, category, status);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DocumentReferenceApi#documentReferenceGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DocumentReferenceApi;

public class DocumentReferenceApiExample {

    public static void main(String[] args) {
        DocumentReferenceApi apiInstance = new DocumentReferenceApi();
        String id = id_example; // String | Resource ID.
        String patient = patient_example; // String | Patient ID.
        String date = date_example; // String | When the document reference was created. For more information on date formats, see dates.
        String period = period_example; // String | Time of service that is being documented.For more information on date formats, see dates.
        String type = type_example; // String | Kind of document (LOINC code).
        String category = category_example; // String | Categorization of document.
        String status = status_example; // String | Document reference status. Values include current, superseded, and entered-in-error.
        try {
            DocumentReference result = apiInstance.documentReferenceGet(id, patient, date, period, type, category, status);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DocumentReferenceApi#documentReferenceGet");
            e.printStackTrace();
        }
    }
}
String *id = id_example; // Resource ID. (optional)
String *patient = patient_example; // Patient ID. (optional)
String *date = date_example; // When the document reference was created. For more information on date formats, see dates. (optional)
String *period = period_example; // Time of service that is being documented.For more information on date formats, see dates. (optional)
String *type = type_example; // Kind of document (LOINC code). (optional)
String *category = category_example; // Categorization of document. (optional)
String *status = status_example; // Document reference status. Values include current, superseded, and entered-in-error. (optional)

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

[apiInstance documentReferenceGetWith:id
    patient:patient
    date:date
    period:period
    type:type
    category:category
    status:status
              completionHandler: ^(DocumentReference output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DocumentReference = require('document_reference');

var api = new DocumentReference.DocumentReferenceApi()
var opts = { 
  'id': id_example, // {{String}} Resource ID.
  'patient': patient_example, // {{String}} Patient ID.
  'date': date_example, // {{String}} When the document reference was created. For more information on date formats, see dates.
  'period': period_example, // {{String}} Time of service that is being documented.For more information on date formats, see dates.
  'type': type_example, // {{String}} Kind of document (LOINC code).
  'category': category_example, // {{String}} Categorization of document.
  'status': status_example // {{String}} Document reference status. Values include current, superseded, and entered-in-error.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.documentReferenceGet(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new DocumentReferenceApi();
            var id = id_example;  // String | Resource ID. (optional) 
            var patient = patient_example;  // String | Patient ID. (optional) 
            var date = date_example;  // String | When the document reference was created. For more information on date formats, see dates. (optional) 
            var period = period_example;  // String | Time of service that is being documented.For more information on date formats, see dates. (optional) 
            var type = type_example;  // String | Kind of document (LOINC code). (optional) 
            var category = category_example;  // String | Categorization of document. (optional) 
            var status = status_example;  // String | Document reference status. Values include current, superseded, and entered-in-error. (optional) 

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

$api_instance = new Swagger\Client\ApiDocumentReferenceApi();
$id = id_example; // String | Resource ID.
$patient = patient_example; // String | Patient ID.
$date = date_example; // String | When the document reference was created. For more information on date formats, see dates.
$period = period_example; // String | Time of service that is being documented.For more information on date formats, see dates.
$type = type_example; // String | Kind of document (LOINC code).
$category = category_example; // String | Categorization of document.
$status = status_example; // String | Document reference status. Values include current, superseded, and entered-in-error.

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

my $api_instance = WWW::SwaggerClient::DocumentReferenceApi->new();
my $id = id_example; # String | Resource ID.
my $patient = patient_example; # String | Patient ID.
my $date = date_example; # String | When the document reference was created. For more information on date formats, see dates.
my $period = period_example; # String | Time of service that is being documented.For more information on date formats, see dates.
my $type = type_example; # String | Kind of document (LOINC code).
my $category = category_example; # String | Categorization of document.
my $status = status_example; # String | Document reference status. Values include current, superseded, and entered-in-error.

eval { 
    my $result = $api_instance->documentReferenceGet(id => $id, patient => $patient, date => $date, period => $period, type => $type, category => $category, status => $status);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DocumentReferenceApi->documentReferenceGet: $@\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.DocumentReferenceApi()
id = id_example # String | Resource ID. (optional)
patient = patient_example # String | Patient ID. (optional)
date = date_example # String | When the document reference was created. For more information on date formats, see dates. (optional)
period = period_example # String | Time of service that is being documented.For more information on date formats, see dates. (optional)
type = type_example # String | Kind of document (LOINC code). (optional)
category = category_example # String | Categorization of document. (optional)
status = status_example # String | Document reference status. Values include current, superseded, and entered-in-error. (optional)

try: 
    api_response = api_instance.document_reference_get(id=id, patient=patient, date=date, period=period, type=type, category=category, status=status)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DocumentReferenceApi->documentReferenceGet: %s\n" % e)

Parameters

Query parameters
Name Description
_id
String
Resource ID.
patient
String
Patient ID.
date
String
When the document reference was created. For more information on date formats, see <a href="http://hl7.org/fhir/search.html#date">dates</a>.
period
String
Time of service that is being documented.For more information on date formats, see <a href="http://hl7.org/fhir/search.html#date">dates</a>.
type
String
Kind of document (LOINC code).
category
String
Categorization of document.
status
String
Document reference status. Values include current, superseded, and entered-in-error.

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


documentReferencePatientCategoryGet

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


/DocumentReference/[patient]&[category]

Usage and SDK Samples

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

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

public class DocumentReferenceApiExample {

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

public class DocumentReferenceApiExample {

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

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

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

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

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

            var apiInstance = new DocumentReferenceApi();
            var patient = patient_example;  // String | Patient ID. (optional) 
            var category = category_example;  // String | Categorization of document. (optional) 

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

$api_instance = new Swagger\Client\ApiDocumentReferenceApi();
$patient = patient_example; // String | Patient ID.
$category = category_example; // String | Categorization of document.

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

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

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

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

Parameters

Query parameters
Name Description
patient
String
Patient ID.
category
String
Categorization of document.

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


documentReferencePatientCateogryDateGet

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


/DocumentReference/[patient]&[cateogry]&[date]

Usage and SDK Samples

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

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

public class DocumentReferenceApiExample {

    public static void main(String[] args) {
        
        DocumentReferenceApi apiInstance = new DocumentReferenceApi();
        String patient = patient_example; // String | Patient ID.
        String category = category_example; // String | Categorization of document.
        String date = date_example; // String | When the document reference was created. For more information on date formats, see dates.
        try {
            DocumentReference result = apiInstance.documentReferencePatientCateogryDateGet(patient, category, date);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DocumentReferenceApi#documentReferencePatientCateogryDateGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DocumentReferenceApi;

public class DocumentReferenceApiExample {

    public static void main(String[] args) {
        DocumentReferenceApi apiInstance = new DocumentReferenceApi();
        String patient = patient_example; // String | Patient ID.
        String category = category_example; // String | Categorization of document.
        String date = date_example; // String | When the document reference was created. For more information on date formats, see dates.
        try {
            DocumentReference result = apiInstance.documentReferencePatientCateogryDateGet(patient, category, date);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DocumentReferenceApi#documentReferencePatientCateogryDateGet");
            e.printStackTrace();
        }
    }
}
String *patient = patient_example; // Patient ID. (optional)
String *category = category_example; // Categorization of document. (optional)
String *date = date_example; // When the document reference was created. For more information on date formats, see dates. (optional)

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

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

var api = new DocumentReference.DocumentReferenceApi()
var opts = { 
  'patient': patient_example, // {{String}} Patient ID.
  'category': category_example, // {{String}} Categorization of document.
  'date': date_example // {{String}} When the document reference was created. For more information on date formats, see dates.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.documentReferencePatientCateogryDateGet(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new DocumentReferenceApi();
            var patient = patient_example;  // String | Patient ID. (optional) 
            var category = category_example;  // String | Categorization of document. (optional) 
            var date = date_example;  // String | When the document reference was created. For more information on date formats, see dates. (optional) 

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

$api_instance = new Swagger\Client\ApiDocumentReferenceApi();
$patient = patient_example; // String | Patient ID.
$category = category_example; // String | Categorization of document.
$date = date_example; // String | When the document reference was created. For more information on date formats, see dates.

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

my $api_instance = WWW::SwaggerClient::DocumentReferenceApi->new();
my $patient = patient_example; # String | Patient ID.
my $category = category_example; # String | Categorization of document.
my $date = date_example; # String | When the document reference was created. For more information on date formats, see dates.

eval { 
    my $result = $api_instance->documentReferencePatientCateogryDateGet(patient => $patient, category => $category, date => $date);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DocumentReferenceApi->documentReferencePatientCateogryDateGet: $@\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.DocumentReferenceApi()
patient = patient_example # String | Patient ID. (optional)
category = category_example # String | Categorization of document. (optional)
date = date_example # String | When the document reference was created. For more information on date formats, see dates. (optional)

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

Parameters

Query parameters
Name Description
patient
String
Patient ID.
category
String
Categorization of document.
date
String
When the document reference was created. For more information on date formats, see <a href="http://hl7.org/fhir/search.html#date">dates</a>.

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


documentReferencePatientDateGet

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


/DocumentReference/[patient]&[date]

Usage and SDK Samples

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

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

public class DocumentReferenceApiExample {

    public static void main(String[] args) {
        
        DocumentReferenceApi apiInstance = new DocumentReferenceApi();
        String patient = patient_example; // String | Patient ID.
        String date = date_example; // String | When the document reference was created. For more information on date formats, see dates.
        try {
            DocumentReference result = apiInstance.documentReferencePatientDateGet(patient, date);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DocumentReferenceApi#documentReferencePatientDateGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DocumentReferenceApi;

public class DocumentReferenceApiExample {

    public static void main(String[] args) {
        DocumentReferenceApi apiInstance = new DocumentReferenceApi();
        String patient = patient_example; // String | Patient ID.
        String date = date_example; // String | When the document reference was created. For more information on date formats, see dates.
        try {
            DocumentReference result = apiInstance.documentReferencePatientDateGet(patient, date);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DocumentReferenceApi#documentReferencePatientDateGet");
            e.printStackTrace();
        }
    }
}
String *patient = patient_example; // Patient ID. (optional)
String *date = date_example; // When the document reference was created. For more information on date formats, see dates. (optional)

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

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

var api = new DocumentReference.DocumentReferenceApi()
var opts = { 
  'patient': patient_example, // {{String}} Patient ID.
  'date': date_example // {{String}} When the document reference was created. For more information on date formats, see dates.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.documentReferencePatientDateGet(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new DocumentReferenceApi();
            var patient = patient_example;  // String | Patient ID. (optional) 
            var date = date_example;  // String | When the document reference was created. For more information on date formats, see dates. (optional) 

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

$api_instance = new Swagger\Client\ApiDocumentReferenceApi();
$patient = patient_example; // String | Patient ID.
$date = date_example; // String | When the document reference was created. For more information on date formats, see dates.

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

my $api_instance = WWW::SwaggerClient::DocumentReferenceApi->new();
my $patient = patient_example; # String | Patient ID.
my $date = date_example; # String | When the document reference was created. For more information on date formats, see dates.

eval { 
    my $result = $api_instance->documentReferencePatientDateGet(patient => $patient, date => $date);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DocumentReferenceApi->documentReferencePatientDateGet: $@\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.DocumentReferenceApi()
patient = patient_example # String | Patient ID. (optional)
date = date_example # String | When the document reference was created. For more information on date formats, see dates. (optional)

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

Parameters

Query parameters
Name Description
patient
String
Patient ID.
date
String
When the document reference was created. For more information on date formats, see <a href="http://hl7.org/fhir/search.html#date">dates</a>.

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


documentReferencePatientPeriodGet

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


/DocumentReference/[patient]&[period]

Usage and SDK Samples

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

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

public class DocumentReferenceApiExample {

    public static void main(String[] args) {
        
        DocumentReferenceApi apiInstance = new DocumentReferenceApi();
        String patient = patient_example; // String | Patient ID.
        String period = period_example; // String | Time of service that is being documented.For more information on date formats, see dates.
        try {
            DocumentReference result = apiInstance.documentReferencePatientPeriodGet(patient, period);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DocumentReferenceApi#documentReferencePatientPeriodGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DocumentReferenceApi;

public class DocumentReferenceApiExample {

    public static void main(String[] args) {
        DocumentReferenceApi apiInstance = new DocumentReferenceApi();
        String patient = patient_example; // String | Patient ID.
        String period = period_example; // String | Time of service that is being documented.For more information on date formats, see dates.
        try {
            DocumentReference result = apiInstance.documentReferencePatientPeriodGet(patient, period);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DocumentReferenceApi#documentReferencePatientPeriodGet");
            e.printStackTrace();
        }
    }
}
String *patient = patient_example; // Patient ID. (optional)
String *period = period_example; // Time of service that is being documented.For more information on date formats, see dates. (optional)

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

[apiInstance documentReferencePatientPeriodGetWith:patient
    period:period
              completionHandler: ^(DocumentReference output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DocumentReference = require('document_reference');

var api = new DocumentReference.DocumentReferenceApi()
var opts = { 
  'patient': patient_example, // {{String}} Patient ID.
  'period': period_example // {{String}} Time of service that is being documented.For more information on date formats, see dates.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.documentReferencePatientPeriodGet(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new DocumentReferenceApi();
            var patient = patient_example;  // String | Patient ID. (optional) 
            var period = period_example;  // String | Time of service that is being documented.For more information on date formats, see dates. (optional) 

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

$api_instance = new Swagger\Client\ApiDocumentReferenceApi();
$patient = patient_example; // String | Patient ID.
$period = period_example; // String | Time of service that is being documented.For more information on date formats, see dates.

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

my $api_instance = WWW::SwaggerClient::DocumentReferenceApi->new();
my $patient = patient_example; # String | Patient ID.
my $period = period_example; # String | Time of service that is being documented.For more information on date formats, see dates.

eval { 
    my $result = $api_instance->documentReferencePatientPeriodGet(patient => $patient, period => $period);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DocumentReferenceApi->documentReferencePatientPeriodGet: $@\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.DocumentReferenceApi()
patient = patient_example # String | Patient ID. (optional)
period = period_example # String | Time of service that is being documented.For more information on date formats, see dates. (optional)

try: 
    api_response = api_instance.document_reference_patient_period_get(patient=patient, period=period)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DocumentReferenceApi->documentReferencePatientPeriodGet: %s\n" % e)

Parameters

Query parameters
Name Description
patient
String
Patient ID.
period
String
Time of service that is being documented.For more information on date formats, see <a href="http://hl7.org/fhir/search.html#date">dates</a>.

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


documentReferencePatientStatusGet

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


/DocumentReference/[patient]&[status]

Usage and SDK Samples

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

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

public class DocumentReferenceApiExample {

    public static void main(String[] args) {
        
        DocumentReferenceApi apiInstance = new DocumentReferenceApi();
        String patient = patient_example; // String | Patient ID.
        String status = status_example; // String | Document reference status. Values include current, superseded, and entered-in-error.
        try {
            DocumentReference result = apiInstance.documentReferencePatientStatusGet(patient, status);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DocumentReferenceApi#documentReferencePatientStatusGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DocumentReferenceApi;

public class DocumentReferenceApiExample {

    public static void main(String[] args) {
        DocumentReferenceApi apiInstance = new DocumentReferenceApi();
        String patient = patient_example; // String | Patient ID.
        String status = status_example; // String | Document reference status. Values include current, superseded, and entered-in-error.
        try {
            DocumentReference result = apiInstance.documentReferencePatientStatusGet(patient, status);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DocumentReferenceApi#documentReferencePatientStatusGet");
            e.printStackTrace();
        }
    }
}
String *patient = patient_example; // Patient ID. (optional)
String *status = status_example; // Document reference status. Values include current, superseded, and entered-in-error. (optional)

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

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

var api = new DocumentReference.DocumentReferenceApi()
var opts = { 
  'patient': patient_example, // {{String}} Patient ID.
  'status': status_example // {{String}} Document reference status. Values include current, superseded, and entered-in-error.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.documentReferencePatientStatusGet(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new DocumentReferenceApi();
            var patient = patient_example;  // String | Patient ID. (optional) 
            var status = status_example;  // String | Document reference status. Values include current, superseded, and entered-in-error. (optional) 

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

$api_instance = new Swagger\Client\ApiDocumentReferenceApi();
$patient = patient_example; // String | Patient ID.
$status = status_example; // String | Document reference status. Values include current, superseded, and entered-in-error.

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

my $api_instance = WWW::SwaggerClient::DocumentReferenceApi->new();
my $patient = patient_example; # String | Patient ID.
my $status = status_example; # String | Document reference status. Values include current, superseded, and entered-in-error.

eval { 
    my $result = $api_instance->documentReferencePatientStatusGet(patient => $patient, status => $status);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DocumentReferenceApi->documentReferencePatientStatusGet: $@\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.DocumentReferenceApi()
patient = patient_example # String | Patient ID. (optional)
status = status_example # String | Document reference status. Values include current, superseded, and entered-in-error. (optional)

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

Parameters

Query parameters
Name Description
patient
String
Patient ID.
status
String
Document reference status. Values include current, superseded, and entered-in-error.

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


documentReferencePatientTypeGet

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


/DocumentReference/[patient]&[type]

Usage and SDK Samples

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

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

public class DocumentReferenceApiExample {

    public static void main(String[] args) {
        
        DocumentReferenceApi apiInstance = new DocumentReferenceApi();
        String patient = patient_example; // String | Patient ID.
        String type = type_example; // String | Kind of document (LOINC code).
        try {
            DocumentReference result = apiInstance.documentReferencePatientTypeGet(patient, type);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DocumentReferenceApi#documentReferencePatientTypeGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DocumentReferenceApi;

public class DocumentReferenceApiExample {

    public static void main(String[] args) {
        DocumentReferenceApi apiInstance = new DocumentReferenceApi();
        String patient = patient_example; // String | Patient ID.
        String type = type_example; // String | Kind of document (LOINC code).
        try {
            DocumentReference result = apiInstance.documentReferencePatientTypeGet(patient, type);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DocumentReferenceApi#documentReferencePatientTypeGet");
            e.printStackTrace();
        }
    }
}
String *patient = patient_example; // Patient ID. (optional)
String *type = type_example; // Kind of document (LOINC code). (optional)

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

[apiInstance documentReferencePatientTypeGetWith:patient
    type:type
              completionHandler: ^(DocumentReference output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DocumentReference = require('document_reference');

var api = new DocumentReference.DocumentReferenceApi()
var opts = { 
  'patient': patient_example, // {{String}} Patient ID.
  'type': type_example // {{String}} Kind of document (LOINC code).
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.documentReferencePatientTypeGet(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new DocumentReferenceApi();
            var patient = patient_example;  // String | Patient ID. (optional) 
            var type = type_example;  // String | Kind of document (LOINC code). (optional) 

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

$api_instance = new Swagger\Client\ApiDocumentReferenceApi();
$patient = patient_example; // String | Patient ID.
$type = type_example; // String | Kind of document (LOINC code).

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

my $api_instance = WWW::SwaggerClient::DocumentReferenceApi->new();
my $patient = patient_example; # String | Patient ID.
my $type = type_example; # String | Kind of document (LOINC code).

eval { 
    my $result = $api_instance->documentReferencePatientTypeGet(patient => $patient, type => $type);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DocumentReferenceApi->documentReferencePatientTypeGet: $@\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.DocumentReferenceApi()
patient = patient_example # String | Patient ID. (optional)
type = type_example # String | Kind of document (LOINC code). (optional)

try: 
    api_response = api_instance.document_reference_patient_type_get(patient=patient, type=type)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DocumentReferenceApi->documentReferencePatientTypeGet: %s\n" % e)

Parameters

Query parameters
Name Description
patient
String
Patient ID.
type
String
Kind of document (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


documentReferencePatientTypePeriodGet

Search for DocumentReference resources based on a combination of patient, type, and period. For more information on the syntax used for searches, go to Searching.


/DocumentReference/[patient]&[type]&[period]

Usage and SDK Samples

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

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

public class DocumentReferenceApiExample {

    public static void main(String[] args) {
        
        DocumentReferenceApi apiInstance = new DocumentReferenceApi();
        String patient = patient_example; // String | Patient ID.
        String type = type_example; // String | Kind of document (LOINC code).
        String period = period_example; // String | Time of service that is being documented.For more information on date formats, see dates.
        try {
            DocumentReference result = apiInstance.documentReferencePatientTypePeriodGet(patient, type, period);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DocumentReferenceApi#documentReferencePatientTypePeriodGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DocumentReferenceApi;

public class DocumentReferenceApiExample {

    public static void main(String[] args) {
        DocumentReferenceApi apiInstance = new DocumentReferenceApi();
        String patient = patient_example; // String | Patient ID.
        String type = type_example; // String | Kind of document (LOINC code).
        String period = period_example; // String | Time of service that is being documented.For more information on date formats, see dates.
        try {
            DocumentReference result = apiInstance.documentReferencePatientTypePeriodGet(patient, type, period);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DocumentReferenceApi#documentReferencePatientTypePeriodGet");
            e.printStackTrace();
        }
    }
}
String *patient = patient_example; // Patient ID. (optional)
String *type = type_example; // Kind of document (LOINC code). (optional)
String *period = period_example; // Time of service that is being documented.For more information on date formats, see dates. (optional)

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

[apiInstance documentReferencePatientTypePeriodGetWith:patient
    type:type
    period:period
              completionHandler: ^(DocumentReference output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DocumentReference = require('document_reference');

var api = new DocumentReference.DocumentReferenceApi()
var opts = { 
  'patient': patient_example, // {{String}} Patient ID.
  'type': type_example, // {{String}} Kind of document (LOINC code).
  'period': period_example // {{String}} Time of service that is being documented.For more information on date formats, see dates.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.documentReferencePatientTypePeriodGet(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new DocumentReferenceApi();
            var patient = patient_example;  // String | Patient ID. (optional) 
            var type = type_example;  // String | Kind of document (LOINC code). (optional) 
            var period = period_example;  // String | Time of service that is being documented.For more information on date formats, see dates. (optional) 

            try
            {
                DocumentReference result = apiInstance.documentReferencePatientTypePeriodGet(patient, type, period);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DocumentReferenceApi.documentReferencePatientTypePeriodGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiDocumentReferenceApi();
$patient = patient_example; // String | Patient ID.
$type = type_example; // String | Kind of document (LOINC code).
$period = period_example; // String | Time of service that is being documented.For more information on date formats, see dates.

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

my $api_instance = WWW::SwaggerClient::DocumentReferenceApi->new();
my $patient = patient_example; # String | Patient ID.
my $type = type_example; # String | Kind of document (LOINC code).
my $period = period_example; # String | Time of service that is being documented.For more information on date formats, see dates.

eval { 
    my $result = $api_instance->documentReferencePatientTypePeriodGet(patient => $patient, type => $type, period => $period);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DocumentReferenceApi->documentReferencePatientTypePeriodGet: $@\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.DocumentReferenceApi()
patient = patient_example # String | Patient ID. (optional)
type = type_example # String | Kind of document (LOINC code). (optional)
period = period_example # String | Time of service that is being documented.For more information on date formats, see dates. (optional)

try: 
    api_response = api_instance.document_reference_patient_type_period_get(patient=patient, type=type, period=period)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DocumentReferenceApi->documentReferencePatientTypePeriodGet: %s\n" % e)

Parameters

Query parameters
Name Description
patient
String
Patient ID.
type
String
Kind of document (LOINC code).
period
String
Time of service that is being documented.For more information on date formats, see <a href="http://hl7.org/fhir/search.html#date">dates</a>.

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


documentReferenceTypePeriodGet

Search for DocumentReference resources based on a combination of type and period. For more information on the syntax used for searches, go to Searching.


/DocumentReference/[type]&[period]

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json,application/xml"\
"//DocumentReference/[type]&[period]?type=&period="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DocumentReferenceApi;

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

public class DocumentReferenceApiExample {

    public static void main(String[] args) {
        
        DocumentReferenceApi apiInstance = new DocumentReferenceApi();
        String type = type_example; // String | Kind of document (LOINC code).
        String period = period_example; // String | Time of service that is being documented.For more information on date formats, see dates.
        try {
            DocumentReference result = apiInstance.documentReferenceTypePeriodGet(type, period);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DocumentReferenceApi#documentReferenceTypePeriodGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DocumentReferenceApi;

public class DocumentReferenceApiExample {

    public static void main(String[] args) {
        DocumentReferenceApi apiInstance = new DocumentReferenceApi();
        String type = type_example; // String | Kind of document (LOINC code).
        String period = period_example; // String | Time of service that is being documented.For more information on date formats, see dates.
        try {
            DocumentReference result = apiInstance.documentReferenceTypePeriodGet(type, period);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DocumentReferenceApi#documentReferenceTypePeriodGet");
            e.printStackTrace();
        }
    }
}
String *type = type_example; // Kind of document (LOINC code). (optional)
String *period = period_example; // Time of service that is being documented.For more information on date formats, see dates. (optional)

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

[apiInstance documentReferenceTypePeriodGetWith:type
    period:period
              completionHandler: ^(DocumentReference output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DocumentReference = require('document_reference');

var api = new DocumentReference.DocumentReferenceApi()
var opts = { 
  'type': type_example, // {{String}} Kind of document (LOINC code).
  'period': period_example // {{String}} Time of service that is being documented.For more information on date formats, see dates.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.documentReferenceTypePeriodGet(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new DocumentReferenceApi();
            var type = type_example;  // String | Kind of document (LOINC code). (optional) 
            var period = period_example;  // String | Time of service that is being documented.For more information on date formats, see dates. (optional) 

            try
            {
                DocumentReference result = apiInstance.documentReferenceTypePeriodGet(type, period);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DocumentReferenceApi.documentReferenceTypePeriodGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiDocumentReferenceApi();
$type = type_example; // String | Kind of document (LOINC code).
$period = period_example; // String | Time of service that is being documented.For more information on date formats, see dates.

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

my $api_instance = WWW::SwaggerClient::DocumentReferenceApi->new();
my $type = type_example; # String | Kind of document (LOINC code).
my $period = period_example; # String | Time of service that is being documented.For more information on date formats, see dates.

eval { 
    my $result = $api_instance->documentReferenceTypePeriodGet(type => $type, period => $period);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DocumentReferenceApi->documentReferenceTypePeriodGet: $@\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.DocumentReferenceApi()
type = type_example # String | Kind of document (LOINC code). (optional)
period = period_example # String | Time of service that is being documented.For more information on date formats, see dates. (optional)

try: 
    api_response = api_instance.document_reference_type_period_get(type=type, period=period)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DocumentReferenceApi->documentReferenceTypePeriodGet: %s\n" % e)

Parameters

Query parameters
Name Description
type
String
Kind of document (LOINC code).
period
String
Time of service that is being documented.For more information on date formats, see <a href="http://hl7.org/fhir/search.html#date">dates</a>.

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