Patient

Patient

patientBirthdateFamilyGet

Search for Patient resources based on a combination of patient birthdate and family name.


/patient/[birthdate]&[family]

Usage and SDK Samples

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

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

public class PatientApiExample {

    public static void main(String[] args) {
        
        PatientApi apiInstance = new PatientApi();
        String birthdate = birthdate_example; // String | Patient date of birth. For more information on format, go to Patient Birthdate.
        String family = family_example; // String | Patient family (last) name.
        try {
            Patient result = apiInstance.patientBirthdateFamilyGet(birthdate, family);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PatientApi#patientBirthdateFamilyGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PatientApi;

public class PatientApiExample {

    public static void main(String[] args) {
        PatientApi apiInstance = new PatientApi();
        String birthdate = birthdate_example; // String | Patient date of birth. For more information on format, go to Patient Birthdate.
        String family = family_example; // String | Patient family (last) name.
        try {
            Patient result = apiInstance.patientBirthdateFamilyGet(birthdate, family);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PatientApi#patientBirthdateFamilyGet");
            e.printStackTrace();
        }
    }
}
String *birthdate = birthdate_example; // Patient date of birth. For more information on format, go to Patient Birthdate. (optional)
String *family = family_example; // Patient family (last) name. (optional)

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

[apiInstance patientBirthdateFamilyGetWith:birthdate
    family:family
              completionHandler: ^(Patient output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Patient = require('patient');

var api = new Patient.PatientApi()
var opts = { 
  'birthdate': birthdate_example, // {{String}} Patient date of birth. For more information on format, go to Patient Birthdate.
  'family': family_example // {{String}} Patient family (last) name.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.patientBirthdateFamilyGet(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new PatientApi();
            var birthdate = birthdate_example;  // String | Patient date of birth. For more information on format, go to Patient Birthdate. (optional) 
            var family = family_example;  // String | Patient family (last) name. (optional) 

            try
            {
                Patient result = apiInstance.patientBirthdateFamilyGet(birthdate, family);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PatientApi.patientBirthdateFamilyGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiPatientApi();
$birthdate = birthdate_example; // String | Patient date of birth. For more information on format, go to Patient Birthdate.
$family = family_example; // String | Patient family (last) name.

try {
    $result = $api_instance->patientBirthdateFamilyGet($birthdate, $family);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PatientApi->patientBirthdateFamilyGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PatientApi;

my $api_instance = WWW::SwaggerClient::PatientApi->new();
my $birthdate = birthdate_example; # String | Patient date of birth. For more information on format, go to Patient Birthdate.
my $family = family_example; # String | Patient family (last) name.

eval { 
    my $result = $api_instance->patientBirthdateFamilyGet(birthdate => $birthdate, family => $family);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PatientApi->patientBirthdateFamilyGet: $@\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.PatientApi()
birthdate = birthdate_example # String | Patient date of birth. For more information on format, go to Patient Birthdate. (optional)
family = family_example # String | Patient family (last) name. (optional)

try: 
    api_response = api_instance.patient_birthdate_family_get(birthdate=birthdate, family=family)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PatientApi->patientBirthdateFamilyGet: %s\n" % e)

Parameters

Query parameters
Name Description
birthdate
String
Patient date of birth. For more information on format, go to <a href="http://hl7.org/fhir/us/core/STU5.0.1/SearchParameter-us-core-patient-birthdate.html">Patient Birthdate</a>.
family
String
Patient family (last) name.

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


patientFamilyGenderGet

Search for Patient resources based on a combination of patient family name and gender.


/patient/[family]&[gender]

Usage and SDK Samples

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

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

public class PatientApiExample {

    public static void main(String[] args) {
        
        PatientApi apiInstance = new PatientApi();
        String gender = gender_example; // String | Patient gender.
        String family = family_example; // String | Patient family (last) name.
        try {
            Patient result = apiInstance.patientFamilyGenderGet(gender, family);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PatientApi#patientFamilyGenderGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PatientApi;

public class PatientApiExample {

    public static void main(String[] args) {
        PatientApi apiInstance = new PatientApi();
        String gender = gender_example; // String | Patient gender.
        String family = family_example; // String | Patient family (last) name.
        try {
            Patient result = apiInstance.patientFamilyGenderGet(gender, family);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PatientApi#patientFamilyGenderGet");
            e.printStackTrace();
        }
    }
}
String *gender = gender_example; // Patient gender. (optional)
String *family = family_example; // Patient family (last) name. (optional)

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

[apiInstance patientFamilyGenderGetWith:gender
    family:family
              completionHandler: ^(Patient output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Patient = require('patient');

var api = new Patient.PatientApi()
var opts = { 
  'gender': gender_example, // {{String}} Patient gender.
  'family': family_example // {{String}} Patient family (last) name.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.patientFamilyGenderGet(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new PatientApi();
            var gender = gender_example;  // String | Patient gender. (optional) 
            var family = family_example;  // String | Patient family (last) name. (optional) 

            try
            {
                Patient result = apiInstance.patientFamilyGenderGet(gender, family);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PatientApi.patientFamilyGenderGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiPatientApi();
$gender = gender_example; // String | Patient gender.
$family = family_example; // String | Patient family (last) name.

try {
    $result = $api_instance->patientFamilyGenderGet($gender, $family);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PatientApi->patientFamilyGenderGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PatientApi;

my $api_instance = WWW::SwaggerClient::PatientApi->new();
my $gender = gender_example; # String | Patient gender.
my $family = family_example; # String | Patient family (last) name.

eval { 
    my $result = $api_instance->patientFamilyGenderGet(gender => $gender, family => $family);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PatientApi->patientFamilyGenderGet: $@\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.PatientApi()
gender = gender_example # String | Patient gender. (optional)
family = family_example # String | Patient family (last) name. (optional)

try: 
    api_response = api_instance.patient_family_gender_get(gender=gender, family=family)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PatientApi->patientFamilyGenderGet: %s\n" % e)

Parameters

Query parameters
Name Description
gender
String
Patient gender.
family
String
Patient family (last) name.

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


patientGenderNameGet

Search for Patient resources based on a combination of patient gender and name.


/patient/[gender]&[name]

Usage and SDK Samples

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

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

public class PatientApiExample {

    public static void main(String[] args) {
        
        PatientApi apiInstance = new PatientApi();
        String gender = gender_example; // String | Patient gender.
        String name = name_example; // String | Patient name.
        try {
            Patient result = apiInstance.patientGenderNameGet(gender, name);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PatientApi#patientGenderNameGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PatientApi;

public class PatientApiExample {

    public static void main(String[] args) {
        PatientApi apiInstance = new PatientApi();
        String gender = gender_example; // String | Patient gender.
        String name = name_example; // String | Patient name.
        try {
            Patient result = apiInstance.patientGenderNameGet(gender, name);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PatientApi#patientGenderNameGet");
            e.printStackTrace();
        }
    }
}
String *gender = gender_example; // Patient gender. (optional)
String *name = name_example; // Patient name. (optional)

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

[apiInstance patientGenderNameGetWith:gender
    name:name
              completionHandler: ^(Patient output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Patient = require('patient');

var api = new Patient.PatientApi()
var opts = { 
  'gender': gender_example, // {{String}} Patient gender.
  'name': name_example // {{String}} Patient name.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.patientGenderNameGet(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new PatientApi();
            var gender = gender_example;  // String | Patient gender. (optional) 
            var name = name_example;  // String | Patient name. (optional) 

            try
            {
                Patient result = apiInstance.patientGenderNameGet(gender, name);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PatientApi.patientGenderNameGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiPatientApi();
$gender = gender_example; // String | Patient gender.
$name = name_example; // String | Patient name.

try {
    $result = $api_instance->patientGenderNameGet($gender, $name);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PatientApi->patientGenderNameGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PatientApi;

my $api_instance = WWW::SwaggerClient::PatientApi->new();
my $gender = gender_example; # String | Patient gender.
my $name = name_example; # String | Patient name.

eval { 
    my $result = $api_instance->patientGenderNameGet(gender => $gender, name => $name);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PatientApi->patientGenderNameGet: $@\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.PatientApi()
gender = gender_example # String | Patient gender. (optional)
name = name_example # String | Patient name. (optional)

try: 
    api_response = api_instance.patient_gender_name_get(gender=gender, name=name)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PatientApi->patientGenderNameGet: %s\n" % e)

Parameters

Query parameters
Name Description
gender
String
Patient gender.
name
String
Patient name.

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


patientGet

Search for Patient resources by ID, identifier, gender, birthdate, name, family (name), or given (name).


/patient/

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json,application/xml"\
"//patient/?_id=&identifier=&gender=&birthdate=&name=&given=&family="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PatientApi;

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

public class PatientApiExample {

    public static void main(String[] args) {
        
        PatientApi apiInstance = new PatientApi();
        Integer id = 56; // Integer | Resource identifier.
        String identifier = identifier_example; // String | Patient identifier.
        String gender = gender_example; // String | Patient gender.
        String birthdate = birthdate_example; // String | Patient date of birth. For more information on format, go to Patient Birthdate.
        String name = name_example; // String | Patient name
        String given = given_example; // String | Patient given (first) name
        String family = family_example; // String | Patient family (last) name
        try {
            Patient result = apiInstance.patientGet(id, identifier, gender, birthdate, name, given, family);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PatientApi#patientGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PatientApi;

public class PatientApiExample {

    public static void main(String[] args) {
        PatientApi apiInstance = new PatientApi();
        Integer id = 56; // Integer | Resource identifier.
        String identifier = identifier_example; // String | Patient identifier.
        String gender = gender_example; // String | Patient gender.
        String birthdate = birthdate_example; // String | Patient date of birth. For more information on format, go to Patient Birthdate.
        String name = name_example; // String | Patient name
        String given = given_example; // String | Patient given (first) name
        String family = family_example; // String | Patient family (last) name
        try {
            Patient result = apiInstance.patientGet(id, identifier, gender, birthdate, name, given, family);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PatientApi#patientGet");
            e.printStackTrace();
        }
    }
}
Integer *id = 56; // Resource identifier. (optional)
String *identifier = identifier_example; // Patient identifier. (optional)
String *gender = gender_example; // Patient gender. (optional)
String *birthdate = birthdate_example; // Patient date of birth. For more information on format, go to Patient Birthdate. (optional)
String *name = name_example; // Patient name (optional)
String *given = given_example; // Patient given (first) name (optional)
String *family = family_example; // Patient family (last) name (optional)

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

[apiInstance patientGetWith:id
    identifier:identifier
    gender:gender
    birthdate:birthdate
    name:name
    given:given
    family:family
              completionHandler: ^(Patient output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Patient = require('patient');

var api = new Patient.PatientApi()
var opts = { 
  'id': 56, // {{Integer}} Resource identifier.
  'identifier': identifier_example, // {{String}} Patient identifier.
  'gender': gender_example, // {{String}} Patient gender.
  'birthdate': birthdate_example, // {{String}} Patient date of birth. For more information on format, go to Patient Birthdate.
  'name': name_example, // {{String}} Patient name
  'given': given_example, // {{String}} Patient given (first) name
  'family': family_example // {{String}} Patient family (last) name
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.patientGet(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new PatientApi();
            var id = 56;  // Integer | Resource identifier. (optional) 
            var identifier = identifier_example;  // String | Patient identifier. (optional) 
            var gender = gender_example;  // String | Patient gender. (optional) 
            var birthdate = birthdate_example;  // String | Patient date of birth. For more information on format, go to Patient Birthdate. (optional) 
            var name = name_example;  // String | Patient name (optional) 
            var given = given_example;  // String | Patient given (first) name (optional) 
            var family = family_example;  // String | Patient family (last) name (optional) 

            try
            {
                Patient result = apiInstance.patientGet(id, identifier, gender, birthdate, name, given, family);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PatientApi.patientGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiPatientApi();
$id = 56; // Integer | Resource identifier.
$identifier = identifier_example; // String | Patient identifier.
$gender = gender_example; // String | Patient gender.
$birthdate = birthdate_example; // String | Patient date of birth. For more information on format, go to Patient Birthdate.
$name = name_example; // String | Patient name
$given = given_example; // String | Patient given (first) name
$family = family_example; // String | Patient family (last) name

try {
    $result = $api_instance->patientGet($id, $identifier, $gender, $birthdate, $name, $given, $family);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PatientApi->patientGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PatientApi;

my $api_instance = WWW::SwaggerClient::PatientApi->new();
my $id = 56; # Integer | Resource identifier.
my $identifier = identifier_example; # String | Patient identifier.
my $gender = gender_example; # String | Patient gender.
my $birthdate = birthdate_example; # String | Patient date of birth. For more information on format, go to Patient Birthdate.
my $name = name_example; # String | Patient name
my $given = given_example; # String | Patient given (first) name
my $family = family_example; # String | Patient family (last) name

eval { 
    my $result = $api_instance->patientGet(id => $id, identifier => $identifier, gender => $gender, birthdate => $birthdate, name => $name, given => $given, family => $family);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PatientApi->patientGet: $@\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.PatientApi()
id = 56 # Integer | Resource identifier. (optional)
identifier = identifier_example # String | Patient identifier. (optional)
gender = gender_example # String | Patient gender. (optional)
birthdate = birthdate_example # String | Patient date of birth. For more information on format, go to Patient Birthdate. (optional)
name = name_example # String | Patient name (optional)
given = given_example # String | Patient given (first) name (optional)
family = family_example # String | Patient family (last) name (optional)

try: 
    api_response = api_instance.patient_get(id=id, identifier=identifier, gender=gender, birthdate=birthdate, name=name, given=given, family=family)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PatientApi->patientGet: %s\n" % e)

Parameters

Query parameters
Name Description
_id
Integer
Resource identifier.
identifier
String
Patient identifier.
gender
String
Patient gender.
birthdate
String
Patient date of birth. For more information on format, go to <a href="http://hl7.org/fhir/us/core/STU5.0.1/SearchParameter-us-core-patient-birthdate.html">Patient Birthdate</a>.
name
String
Patient name
given
String
Patient given (first) name
family
String
Patient family (last) name

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


patientNameBirthdateGet

Search for Patient resources based on a combination of patient name and birthdate.


/patient/[name]&[birthdate]

Usage and SDK Samples

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

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

public class PatientApiExample {

    public static void main(String[] args) {
        
        PatientApi apiInstance = new PatientApi();
        String birthdate = birthdate_example; // String | Patient date of birth. For more information on format, go to Patient Birthdate.
        String name = name_example; // String | Patient name.
        try {
            Patient result = apiInstance.patientNameBirthdateGet(birthdate, name);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PatientApi#patientNameBirthdateGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PatientApi;

public class PatientApiExample {

    public static void main(String[] args) {
        PatientApi apiInstance = new PatientApi();
        String birthdate = birthdate_example; // String | Patient date of birth. For more information on format, go to Patient Birthdate.
        String name = name_example; // String | Patient name.
        try {
            Patient result = apiInstance.patientNameBirthdateGet(birthdate, name);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PatientApi#patientNameBirthdateGet");
            e.printStackTrace();
        }
    }
}
String *birthdate = birthdate_example; // Patient date of birth. For more information on format, go to Patient Birthdate. (optional)
String *name = name_example; // Patient name. (optional)

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

[apiInstance patientNameBirthdateGetWith:birthdate
    name:name
              completionHandler: ^(Patient output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Patient = require('patient');

var api = new Patient.PatientApi()
var opts = { 
  'birthdate': birthdate_example, // {{String}} Patient date of birth. For more information on format, go to Patient Birthdate.
  'name': name_example // {{String}} Patient name.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.patientNameBirthdateGet(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new PatientApi();
            var birthdate = birthdate_example;  // String | Patient date of birth. For more information on format, go to Patient Birthdate. (optional) 
            var name = name_example;  // String | Patient name. (optional) 

            try
            {
                Patient result = apiInstance.patientNameBirthdateGet(birthdate, name);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PatientApi.patientNameBirthdateGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiPatientApi();
$birthdate = birthdate_example; // String | Patient date of birth. For more information on format, go to Patient Birthdate.
$name = name_example; // String | Patient name.

try {
    $result = $api_instance->patientNameBirthdateGet($birthdate, $name);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PatientApi->patientNameBirthdateGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PatientApi;

my $api_instance = WWW::SwaggerClient::PatientApi->new();
my $birthdate = birthdate_example; # String | Patient date of birth. For more information on format, go to Patient Birthdate.
my $name = name_example; # String | Patient name.

eval { 
    my $result = $api_instance->patientNameBirthdateGet(birthdate => $birthdate, name => $name);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PatientApi->patientNameBirthdateGet: $@\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.PatientApi()
birthdate = birthdate_example # String | Patient date of birth. For more information on format, go to Patient Birthdate. (optional)
name = name_example # String | Patient name. (optional)

try: 
    api_response = api_instance.patient_name_birthdate_get(birthdate=birthdate, name=name)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PatientApi->patientNameBirthdateGet: %s\n" % e)

Parameters

Query parameters
Name Description
birthdate
String
Patient date of birth. For more information on format, go to <a href="http://hl7.org/fhir/us/core/STU5.0.1/SearchParameter-us-core-patient-birthdate.html">Patient Birthdate</a>.
name
String
Patient name.

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