Immunization

Immunization

immunizationGet

Get an Immunization resource based on the resource ID, or search by resource ID, patient ID, status, or date.


/immunization/

Usage and SDK Samples

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

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

public class ImmunizationApiExample {

    public static void main(String[] args) {
        
        ImmunizationApi apiInstance = new ImmunizationApi();
        String id = id_example; // String | Resource ID.
        String patient = patient_example; // String | Patient ID.
        String status = status_example; // String | Immunization status.
        String date = date_example; // String | Immunization administration date.
        try {
            Immunization result = apiInstance.immunizationGet(id, patient, status, date);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ImmunizationApi#immunizationGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ImmunizationApi;

public class ImmunizationApiExample {

    public static void main(String[] args) {
        ImmunizationApi apiInstance = new ImmunizationApi();
        String id = id_example; // String | Resource ID.
        String patient = patient_example; // String | Patient ID.
        String status = status_example; // String | Immunization status.
        String date = date_example; // String | Immunization administration date.
        try {
            Immunization result = apiInstance.immunizationGet(id, patient, status, date);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ImmunizationApi#immunizationGet");
            e.printStackTrace();
        }
    }
}
String *id = id_example; // Resource ID. (optional)
String *patient = patient_example; // Patient ID. (optional)
String *status = status_example; // Immunization status. (optional)
String *date = date_example; // Immunization administration date. (optional)

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

[apiInstance immunizationGetWith:id
    patient:patient
    status:status
    date:date
              completionHandler: ^(Immunization output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var Immunization = require('immunization');

var api = new Immunization.ImmunizationApi()
var opts = { 
  'id': id_example, // {{String}} Resource ID.
  'patient': patient_example, // {{String}} Patient ID.
  'status': status_example, // {{String}} Immunization status.
  'date': date_example // {{String}} Immunization administration date.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.immunizationGet(opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new ImmunizationApi();
            var id = id_example;  // String | Resource ID. (optional) 
            var patient = patient_example;  // String | Patient ID. (optional) 
            var status = status_example;  // String | Immunization status. (optional) 
            var date = date_example;  // String | Immunization administration date. (optional) 

            try
            {
                Immunization result = apiInstance.immunizationGet(id, patient, status, date);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ImmunizationApi.immunizationGet: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiImmunizationApi();
$id = id_example; // String | Resource ID.
$patient = patient_example; // String | Patient ID.
$status = status_example; // String | Immunization status.
$date = date_example; // String | Immunization administration date.

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

my $api_instance = WWW::SwaggerClient::ImmunizationApi->new();
my $id = id_example; # String | Resource ID.
my $patient = patient_example; # String | Patient ID.
my $status = status_example; # String | Immunization status.
my $date = date_example; # String | Immunization administration date.

eval { 
    my $result = $api_instance->immunizationGet(id => $id, patient => $patient, status => $status, date => $date);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ImmunizationApi->immunizationGet: $@\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.ImmunizationApi()
id = id_example # String | Resource ID. (optional)
patient = patient_example # String | Patient ID. (optional)
status = status_example # String | Immunization status. (optional)
date = date_example # String | Immunization administration date. (optional)

try: 
    api_response = api_instance.immunization_get(id=id, patient=patient, status=status, date=date)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ImmunizationApi->immunizationGet: %s\n" % e)

Parameters

Query parameters
Name Description
_id
String
Resource ID.
patient
String
Patient ID.
status
String
Immunization status.
date
String
Immunization administration date.

Responses

Status: 200 - Successful operation

Status: 400 - Bad request. The error was encountered when parsing the content into the appropriate FHIR resource.

Status: 401 - Unauthorized. Possible causes
  • a token failed authorization
  • a user could not be found

Status: 403 - Forbidden. Possible causes
  • a code or query parameter was not supported
  • a code may have had no valid equivalent in the EHR
  • a user does not have enough permissions to perform a certain action
  • a query was invalid, for example a search token value ended in an escape character

Status: 404 - Resource not found. Possible causes
  • an operation was not supported
  • the FHIR resource was not implemented by the product adapter
  • the FHIR resource was not found
  • the service was unable to generate the FHIR resource possibly because a required element was not provided
  • the specified patient could not be found in the EHR
  • the paging information that was sent to the product was not correct indicating that the request for the page could not be honored

Status: 405 - Method not allowed. Possible cause
  • resource does not exist

Status: 412 - Precondition failed. Possible causes
  • certain precondition checks failed, for example a version mismatch
  • an update could not be processed as the If-Match tag didn't match the version

Status: 413 - Request entity too large. Possible cause
  • a request could not be honored because it was too expensive for the server to execute, for example a search that would return a million records

Status: 422 - Unprocessable entity. Possible cause
  • an exception was thrown upon violated constraint, for example missing or invalid element for resource or if an update on a resource did not happen

Status: 429 - Too many requests. Possible causes
  • too many concurrent FHIR requests

Status: 500 - Internal server error. Possible causes
  • the system was missing configuration information, for example if a URL to a service was missing or a security group was not found for the user
  • none of the available exceptions are appropriate

immunizationPatientDateGet

Search for Immunization resources based on a combination of patient ID and date.


/immunization/[patient]&[date]

Usage and SDK Samples

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

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

public class ImmunizationApiExample {

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

public class ImmunizationApiExample {

    public static void main(String[] args) {
        ImmunizationApi apiInstance = new ImmunizationApi();
        String patient = patient_example; // String | Patient ID.
        String date = date_example; // String | Immunization administration date.
        try {
            Immunization result = apiInstance.immunizationPatientDateGet(patient, date);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ImmunizationApi#immunizationPatientDateGet");
            e.printStackTrace();
        }
    }
}
String *patient = patient_example; // Patient ID. (optional)
String *date = date_example; // Immunization administration date. (optional)

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

[apiInstance immunizationPatientDateGetWith:patient
    date:date
              completionHandler: ^(Immunization output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var Immunization = require('immunization');

var api = new Immunization.ImmunizationApi()
var opts = { 
  'patient': patient_example, // {{String}} Patient ID.
  'date': date_example // {{String}} Immunization administration date.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.immunizationPatientDateGet(opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new ImmunizationApi();
            var patient = patient_example;  // String | Patient ID. (optional) 
            var date = date_example;  // String | Immunization administration date. (optional) 

            try
            {
                Immunization result = apiInstance.immunizationPatientDateGet(patient, date);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ImmunizationApi.immunizationPatientDateGet: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiImmunizationApi();
$patient = patient_example; // String | Patient ID.
$date = date_example; // String | Immunization administration date.

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

my $api_instance = WWW::SwaggerClient::ImmunizationApi->new();
my $patient = patient_example; # String | Patient ID.
my $date = date_example; # String | Immunization administration date.

eval { 
    my $result = $api_instance->immunizationPatientDateGet(patient => $patient, date => $date);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ImmunizationApi->immunizationPatientDateGet: $@\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.ImmunizationApi()
patient = patient_example # String | Patient ID. (optional)
date = date_example # String | Immunization administration date. (optional)

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

Parameters

Query parameters
Name Description
patient
String
Patient ID.
date
String
Immunization administration date.

Responses

Status: 200 - Successful operation

Status: 400 - Bad request. The error was encountered when parsing the content into the appropriate FHIR resource.

Status: 401 - Unauthorized. Possible causes
  • a token failed authorization
  • a user could not be found

Status: 403 - Forbidden. Possible causes
  • a code or query parameter was not supported
  • a code may have had no valid equivalent in the EHR
  • a user does not have enough permissions to perform a certain action
  • a query was invalid, for example a search token value ended in an escape character

Status: 404 - Resource not found. Possible causes
  • an operation was not supported
  • the FHIR resource was not implemented by the product adapter
  • the FHIR resource was not found
  • the service was unable to generate the FHIR resource possibly because a required element was not provided
  • the specified patient could not be found in the EHR
  • the paging information that was sent to the product was not correct indicating that the request for the page could not be honored

Status: 405 - Method not allowed. Possible cause
  • resource does not exist

Status: 412 - Precondition failed. Possible causes
  • certain precondition checks failed, for example a version mismatch
  • an update could not be processed as the If-Match tag didn't match the version

Status: 413 - Request entity too large. Possible cause
  • a request could not be honored because it was too expensive for the server to execute, for example a search that would return a million records

Status: 422 - Unprocessable entity. Possible cause
  • an exception was thrown upon violated constraint, for example missing or invalid element for resource or if an update on a resource did not happen

Status: 429 - Too many requests. Possible causes
  • too many concurrent FHIR requests

Status: 500 - Internal server error. Possible causes
  • the system was missing configuration information, for example if a URL to a service was missing or a security group was not found for the user
  • none of the available exceptions are appropriate

immunizationPatientStatusGet

Search for Immunization resources based on a combination of patient ID and status.


/immunization/[patient]&[status]

Usage and SDK Samples

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

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

public class ImmunizationApiExample {

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

public class ImmunizationApiExample {

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

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

[apiInstance immunizationPatientStatusGetWith:patient
    status:status
              completionHandler: ^(Immunization output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var Immunization = require('immunization');

var api = new Immunization.ImmunizationApi()
var opts = { 
  'patient': patient_example, // {{String}} Patient ID.
  'status': status_example // {{String}} Immunization status.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.immunizationPatientStatusGet(opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

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

            try
            {
                Immunization result = apiInstance.immunizationPatientStatusGet(patient, status);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ImmunizationApi.immunizationPatientStatusGet: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

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

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

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

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

Parameters

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

immunizationVaccinecodeDateGet

Search for Immunization resources based on a combination of vaccine code and date.


/immunization/[vaccinecode]&[date]

Usage and SDK Samples

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

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

public class ImmunizationApiExample {

    public static void main(String[] args) {
        
        ImmunizationApi apiInstance = new ImmunizationApi();
        String vaccinecode = vaccinecode_example; // String | Vaccine code.
        String date = date_example; // String | Immunization administration date.
        try {
            Immunization result = apiInstance.immunizationVaccinecodeDateGet(vaccinecode, date);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ImmunizationApi#immunizationVaccinecodeDateGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ImmunizationApi;

public class ImmunizationApiExample {

    public static void main(String[] args) {
        ImmunizationApi apiInstance = new ImmunizationApi();
        String vaccinecode = vaccinecode_example; // String | Vaccine code.
        String date = date_example; // String | Immunization administration date.
        try {
            Immunization result = apiInstance.immunizationVaccinecodeDateGet(vaccinecode, date);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ImmunizationApi#immunizationVaccinecodeDateGet");
            e.printStackTrace();
        }
    }
}
String *vaccinecode = vaccinecode_example; // Vaccine code. (optional)
String *date = date_example; // Immunization administration date. (optional)

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

[apiInstance immunizationVaccinecodeDateGetWith:vaccinecode
    date:date
              completionHandler: ^(Immunization output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var Immunization = require('immunization');

var api = new Immunization.ImmunizationApi()
var opts = { 
  'vaccinecode': vaccinecode_example, // {{String}} Vaccine code.
  'date': date_example // {{String}} Immunization administration date.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.immunizationVaccinecodeDateGet(opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new ImmunizationApi();
            var vaccinecode = vaccinecode_example;  // String | Vaccine code. (optional) 
            var date = date_example;  // String | Immunization administration date. (optional) 

            try
            {
                Immunization result = apiInstance.immunizationVaccinecodeDateGet(vaccinecode, date);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ImmunizationApi.immunizationVaccinecodeDateGet: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiImmunizationApi();
$vaccinecode = vaccinecode_example; // String | Vaccine code.
$date = date_example; // String | Immunization administration date.

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

my $api_instance = WWW::SwaggerClient::ImmunizationApi->new();
my $vaccinecode = vaccinecode_example; # String | Vaccine code.
my $date = date_example; # String | Immunization administration date.

eval { 
    my $result = $api_instance->immunizationVaccinecodeDateGet(vaccinecode => $vaccinecode, date => $date);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ImmunizationApi->immunizationVaccinecodeDateGet: $@\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.ImmunizationApi()
vaccinecode = vaccinecode_example # String | Vaccine code. (optional)
date = date_example # String | Immunization administration date. (optional)

try: 
    api_response = api_instance.immunization_vaccinecode_date_get(vaccinecode=vaccinecode, date=date)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ImmunizationApi->immunizationVaccinecodeDateGet: %s\n" % e)

Parameters

Query parameters
Name Description
vaccinecode
String
Vaccine code.
date
String
Immunization administration date.

Responses

Status: 200 - Successful operation

Status: 400 - Bad request. The error was encountered when parsing the content into the appropriate FHIR resource.

Status: 401 - Unauthorized. Possible causes
  • a token failed authorization
  • a user could not be found

Status: 403 - Forbidden. Possible causes
  • a code or query parameter was not supported
  • a code may have had no valid equivalent in the EHR
  • a user does not have enough permissions to perform a certain action
  • a query was invalid, for example a search token value ended in an escape character

Status: 404 - Resource not found. Possible causes
  • an operation was not supported
  • the FHIR resource was not implemented by the product adapter
  • the FHIR resource was not found
  • the service was unable to generate the FHIR resource possibly because a required element was not provided
  • the specified patient could not be found in the EHR
  • the paging information that was sent to the product was not correct indicating that the request for the page could not be honored

Status: 405 - Method not allowed. Possible cause
  • resource does not exist

Status: 412 - Precondition failed. Possible causes
  • certain precondition checks failed, for example a version mismatch
  • an update could not be processed as the If-Match tag didn't match the version

Status: 413 - Request entity too large. Possible cause
  • a request could not be honored because it was too expensive for the server to execute, for example a search that would return a million records

Status: 422 - Unprocessable entity. Possible cause
  • an exception was thrown upon violated constraint, for example missing or invalid element for resource or if an update on a resource did not happen

Status: 429 - Too many requests. Possible causes
  • too many concurrent FHIR requests

Status: 500 - Internal server error. Possible causes
  • the system was missing configuration information, for example if a URL to a service was missing or a security group was not found for the user
  • none of the available exceptions are appropriate

immunizationVaccinecodeDatePatientGet

Search for Immunization resources based on a combination of vaccine code, date, and patient ID.


/immunization/[vaccinecode]&[date]&[patient]

Usage and SDK Samples

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

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

public class ImmunizationApiExample {

    public static void main(String[] args) {
        
        ImmunizationApi apiInstance = new ImmunizationApi();
        String vaccinecode = vaccinecode_example; // String | Vaccine code.
        String date = date_example; // String | Immunization administration date.
        String patient = patient_example; // String | Patient ID.
        try {
            Immunization result = apiInstance.immunizationVaccinecodeDatePatientGet(vaccinecode, date, patient);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ImmunizationApi#immunizationVaccinecodeDatePatientGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ImmunizationApi;

public class ImmunizationApiExample {

    public static void main(String[] args) {
        ImmunizationApi apiInstance = new ImmunizationApi();
        String vaccinecode = vaccinecode_example; // String | Vaccine code.
        String date = date_example; // String | Immunization administration date.
        String patient = patient_example; // String | Patient ID.
        try {
            Immunization result = apiInstance.immunizationVaccinecodeDatePatientGet(vaccinecode, date, patient);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ImmunizationApi#immunizationVaccinecodeDatePatientGet");
            e.printStackTrace();
        }
    }
}
String *vaccinecode = vaccinecode_example; // Vaccine code. (optional)
String *date = date_example; // Immunization administration date. (optional)
String *patient = patient_example; // Patient ID. (optional)

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

[apiInstance immunizationVaccinecodeDatePatientGetWith:vaccinecode
    date:date
    patient:patient
              completionHandler: ^(Immunization output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var Immunization = require('immunization');

var api = new Immunization.ImmunizationApi()
var opts = { 
  'vaccinecode': vaccinecode_example, // {{String}} Vaccine code.
  'date': date_example, // {{String}} Immunization administration date.
  'patient': patient_example // {{String}} Patient ID.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.immunizationVaccinecodeDatePatientGet(opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new ImmunizationApi();
            var vaccinecode = vaccinecode_example;  // String | Vaccine code. (optional) 
            var date = date_example;  // String | Immunization administration date. (optional) 
            var patient = patient_example;  // String | Patient ID. (optional) 

            try
            {
                Immunization result = apiInstance.immunizationVaccinecodeDatePatientGet(vaccinecode, date, patient);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ImmunizationApi.immunizationVaccinecodeDatePatientGet: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiImmunizationApi();
$vaccinecode = vaccinecode_example; // String | Vaccine code.
$date = date_example; // String | Immunization administration date.
$patient = patient_example; // String | Patient ID.

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

my $api_instance = WWW::SwaggerClient::ImmunizationApi->new();
my $vaccinecode = vaccinecode_example; # String | Vaccine code.
my $date = date_example; # String | Immunization administration date.
my $patient = patient_example; # String | Patient ID.

eval { 
    my $result = $api_instance->immunizationVaccinecodeDatePatientGet(vaccinecode => $vaccinecode, date => $date, patient => $patient);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ImmunizationApi->immunizationVaccinecodeDatePatientGet: $@\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.ImmunizationApi()
vaccinecode = vaccinecode_example # String | Vaccine code. (optional)
date = date_example # String | Immunization administration date. (optional)
patient = patient_example # String | Patient ID. (optional)

try: 
    api_response = api_instance.immunization_vaccinecode_date_patient_get(vaccinecode=vaccinecode, date=date, patient=patient)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ImmunizationApi->immunizationVaccinecodeDatePatientGet: %s\n" % e)

Parameters

Query parameters
Name Description
vaccinecode
String
Vaccine code.
date
String
Immunization administration date.
patient
String
Patient ID.

Responses

Status: 200 - Successful operation

Status: 400 - Bad request. The error was encountered when parsing the content into the appropriate FHIR resource.

Status: 401 - Unauthorized. Possible causes
  • a token failed authorization
  • a user could not be found

Status: 403 - Forbidden. Possible causes
  • a code or query parameter was not supported
  • a code may have had no valid equivalent in the EHR
  • a user does not have enough permissions to perform a certain action
  • a query was invalid, for example a search token value ended in an escape character

Status: 404 - Resource not found. Possible causes
  • an operation was not supported
  • the FHIR resource was not implemented by the product adapter
  • the FHIR resource was not found
  • the service was unable to generate the FHIR resource possibly because a required element was not provided
  • the specified patient could not be found in the EHR
  • the paging information that was sent to the product was not correct indicating that the request for the page could not be honored

Status: 405 - Method not allowed. Possible cause
  • resource does not exist

Status: 412 - Precondition failed. Possible causes
  • certain precondition checks failed, for example a version mismatch
  • an update could not be processed as the If-Match tag didn't match the version

Status: 413 - Request entity too large. Possible cause
  • a request could not be honored because it was too expensive for the server to execute, for example a search that would return a million records

Status: 422 - Unprocessable entity. Possible cause
  • an exception was thrown upon violated constraint, for example missing or invalid element for resource or if an update on a resource did not happen

Status: 429 - Too many requests. Possible causes
  • too many concurrent FHIR requests

Status: 500 - Internal server error. Possible causes
  • the system was missing configuration information, for example if a URL to a service was missing or a security group was not found for the user
  • none of the available exceptions are appropriate