Organization

Organization

organizationGet

Get an Organization resource based on the resource ID, or search by ID, name, or address.


/organization/

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json,application/xml"\
"//organization/?_id=&name=&address=&address-state=&address-city=&address-postalcode="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.OrganizationApi;

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

public class OrganizationApiExample {

    public static void main(String[] args) {
        
        OrganizationApi apiInstance = new OrganizationApi();
        String id = id_example; // String | Resource ID.
        String name = name_example; // String | Organization name.
        String address = address_example; // String | A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text.
        String addressState = addressState_example; // String | A state specified in an address.
        String addressCity = addressCity_example; // String | A city specified in an address.
        String addressPostalcode = addressPostalcode_example; // String | A postal code specified in an address.
        try {
            Organization result = apiInstance.organizationGet(id, name, address, addressState, addressCity, addressPostalcode);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrganizationApi#organizationGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.OrganizationApi;

public class OrganizationApiExample {

    public static void main(String[] args) {
        OrganizationApi apiInstance = new OrganizationApi();
        String id = id_example; // String | Resource ID.
        String name = name_example; // String | Organization name.
        String address = address_example; // String | A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text.
        String addressState = addressState_example; // String | A state specified in an address.
        String addressCity = addressCity_example; // String | A city specified in an address.
        String addressPostalcode = addressPostalcode_example; // String | A postal code specified in an address.
        try {
            Organization result = apiInstance.organizationGet(id, name, address, addressState, addressCity, addressPostalcode);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrganizationApi#organizationGet");
            e.printStackTrace();
        }
    }
}
String *id = id_example; // Resource ID. (optional)
String *name = name_example; // Organization name. (optional)
String *address = address_example; // A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text. (optional)
String *addressState = addressState_example; // A state specified in an address. (optional)
String *addressCity = addressCity_example; // A city specified in an address. (optional)
String *addressPostalcode = addressPostalcode_example; // A postal code specified in an address. (optional)

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

[apiInstance organizationGetWith:id
    name:name
    address:address
    addressState:addressState
    addressCity:addressCity
    addressPostalcode:addressPostalcode
              completionHandler: ^(Organization output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Organization = require('organization');

var api = new Organization.OrganizationApi()
var opts = { 
  'id': id_example, // {{String}} Resource ID.
  'name': name_example, // {{String}} Organization name.
  'address': address_example, // {{String}} A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text.
  'addressState': addressState_example, // {{String}} A state specified in an address.
  'addressCity': addressCity_example, // {{String}} A city specified in an address.
  'addressPostalcode': addressPostalcode_example // {{String}} A postal code specified in an address.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.organizationGet(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new OrganizationApi();
            var id = id_example;  // String | Resource ID. (optional) 
            var name = name_example;  // String | Organization name. (optional) 
            var address = address_example;  // String | A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text. (optional) 
            var addressState = addressState_example;  // String | A state specified in an address. (optional) 
            var addressCity = addressCity_example;  // String | A city specified in an address. (optional) 
            var addressPostalcode = addressPostalcode_example;  // String | A postal code specified in an address. (optional) 

            try
            {
                Organization result = apiInstance.organizationGet(id, name, address, addressState, addressCity, addressPostalcode);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling OrganizationApi.organizationGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiOrganizationApi();
$id = id_example; // String | Resource ID.
$name = name_example; // String | Organization name.
$address = address_example; // String | A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text.
$addressState = addressState_example; // String | A state specified in an address.
$addressCity = addressCity_example; // String | A city specified in an address.
$addressPostalcode = addressPostalcode_example; // String | A postal code specified in an address.

try {
    $result = $api_instance->organizationGet($id, $name, $address, $addressState, $addressCity, $addressPostalcode);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OrganizationApi->organizationGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::OrganizationApi;

my $api_instance = WWW::SwaggerClient::OrganizationApi->new();
my $id = id_example; # String | Resource ID.
my $name = name_example; # String | Organization name.
my $address = address_example; # String | A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text.
my $addressState = addressState_example; # String | A state specified in an address.
my $addressCity = addressCity_example; # String | A city specified in an address.
my $addressPostalcode = addressPostalcode_example; # String | A postal code specified in an address.

eval { 
    my $result = $api_instance->organizationGet(id => $id, name => $name, address => $address, addressState => $addressState, addressCity => $addressCity, addressPostalcode => $addressPostalcode);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling OrganizationApi->organizationGet: $@\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.OrganizationApi()
id = id_example # String | Resource ID. (optional)
name = name_example # String | Organization name. (optional)
address = address_example # String | A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text. (optional)
addressState = addressState_example # String | A state specified in an address. (optional)
addressCity = addressCity_example # String | A city specified in an address. (optional)
addressPostalcode = addressPostalcode_example # String | A postal code specified in an address. (optional)

try: 
    api_response = api_instance.organization_get(id=id, name=name, address=address, addressState=addressState, addressCity=addressCity, addressPostalcode=addressPostalcode)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OrganizationApi->organizationGet: %s\n" % e)

Parameters

Query parameters
Name Description
_id
String
Resource ID.
name
String
Organization name.
address
String
A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text.
address-state
String
A state specified in an address.
address-city
String
A city specified in an address.
address-postalcode
String
A postal code specified in an address.

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